Class LegacyLogger

Collects information for a page request Records information about database queries, blocks, and execution time and can display it as HTML. It also catches php runtime errors.

LegacyLogger implements Psr\Log\LoggerInterface

Package: Logger
Category: Logger
Copyright: 2013 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: trabis lusopoemas@gmail.com
Author: Richard Griffith richard@geekwright.com
Version: Release: 1.0
Since: 1.0
Link: http://xoops.org
Located at odules/logger/class/legacylogger.php

Methods summary
`public`	# `__construct( )` constructor constructor
`public static object`	# `getInstance( )` Get a reference to the only instance of this class Get a reference to the only instance of this class Returns object LoggerAbstract reference to the only instance
`public`	# `setConfigs( array $configs )` Save a copy of our config array Save a copy of our config array Parameters `$configs` array of module/user config options
`public`	# `disable( )` disable logging disable logging
`public`	# `enable( )` Enable logger output rendering When output rendering is enabled, the logger will insert its output within the page content. If the string is found in the page content, the logger output will replace it, otherwise it will be inserted after all the page output. Enable logger output rendering When output rendering is enabled, the logger will insert its output within the page content. If the string is found in the page content, the logger output will replace it, otherwise it will be inserted after all the page output.
`public boolean`	# `isEnable( )` report enabled status report enabled status Returns boolean
`public`	# `quiet( )` disable output for the benefit of ajax scripts disable output for the benefit of ajax scripts
`public`	# `startTime( string $name = 'XOOPS' )` Start a timer Start a timer Parameters `$name` name of the timer
`public`	# `stopTime( string $name = 'XOOPS' )` Stop a timer Stop a timer Parameters `$name` name of the timer
`public`	# `addQuery( string $sql, string $error = null, integer $errno = null, float $query_time = null )` Log a database query Log a database query Parameters `$sql` sql that was processed `$error` error message `$errno` error number `$query_time` execution time
`public`	# `addBlock( string $name, boolean $cached = false, integer $cachetime = 0 )` Log display of a block Log display of a block Parameters `$name` name of the block `$cached` was the block cached? `$cachetime` cachetime of the block
`public`	# `addExtra( string $name, string $msg )` Log extra information Log extra information Parameters `$name` name for the entry `$msg` text message for the entry
`public`	# `addDeprecated( string $msg )` Log messages for deprecated functions Log messages for deprecated functions Parameters `$msg` name for the entry
`public`	# `addException( Exception $e )` Log exceptions Log exceptions Parameters `$e` name for the entry
`public string`	# `sanitizePath( string $path )` sanitizePath sanitizePath Parameters `$path` path name to sanitize Returns string path with top levels removed
`public`	# `enableRendering( )` Enable logger output rendering When output rendering is enabled, the logger will insert its output within the page content. If the string is found in the page content, the logger output will replace it, otherwise it will be inserted after all the page output. Enable logger output rendering When output rendering is enabled, the logger will insert its output within the page content. If the string is found in the page content, the logger output will replace it, otherwise it will be inserted after all the page output.
`public string`	# `render( string $output )` Output buffering callback inserting logger dump in page output Output buffering callback inserting logger dump in page output Parameters `$output` output buffer to add logger rendering to Returns string output
`public string`	# `dump( string $mode = '' )` Dump output Dump output Parameters `$mode` unused Returns string output
`public float`	# `dumpTime( string $name = 'XOOPS', boolean $unset = false )` get the current execution time of a timer get the current execution time of a timer Parameters `$name` name of the counter `$unset` removes counter from global log Returns float current execution time of the counter
`public null`	# `emergency( string $message, array $context = array() )` PSR-3 System is unusable. PSR-3 System is unusable. Parameters `$message` message `$context` array of additional context Returns null
`public null`	# `alert( string $message, array $context = array() )` PSR-3 Action must be taken immediately. PSR-3 Action must be taken immediately. Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up. Parameters `$message` message `$context` array of additional context Returns null
`public null`	# `critical( string $message, array $context = array() )` PSR-3 Critical conditions. PSR-3 Critical conditions. Example: Application component unavailable, unexpected exception. Parameters `$message` message `$context` array of additional context Returns null
`public null`	# `error( string $message, array $context = array() )` PSR-3 Runtime errors that do not require immediate action but should typically be logged and monitored. PSR-3 Runtime errors that do not require immediate action but should typically be logged and monitored. Parameters `$message` message `$context` array of additional context Returns null
`public null`	# `warning( string $message, array $context = array() )` PSR-3 Exceptional occurrences that are not errors. PSR-3 Exceptional occurrences that are not errors. Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong. Parameters `$message` message `$context` array of additional context Returns null
`public null`	# `notice( string $message, array $context = array() )` PSR-3 Normal but significant events. PSR-3 Normal but significant events. Parameters `$message` message `$context` array of additional context Returns null
`public null`	# `info( string $message, array $context = array() )` PSR-3 Interesting events. PSR-3 Interesting events. Example: User logs in, SQL logs. Parameters `$message` message `$context` array of additional context Returns null
`public null`	# `debug( string $message, array $context = array() )` PSR-3 Detailed debug information. PSR-3 Detailed debug information. Parameters `$message` message `$context` array of additional context Returns null
`public null`	# `log( mixed $level, string $message, array $context = array() )` PSR-3 Logs with an arbitrary level. PSR-3 Logs with an arbitrary level. Parameters `$level` logging level `$message` message `$context` array of additional context Returns null

Properties summary
`protected array`	`$queries` array of query log lines array of query log lines	# `array()`
`protected array`	`$blocks` array of block log lines array of block log lines	# `array()`
`protected array`	`$extra` array of extra log lines array of extra log lines	# `array()`
`protected start`	`$logstart` time information by name time information by name	# `array()`
`protected end`	`$logend` time information by name time information by name	# `array()`
`protected array`	`$errors` array of error log lines array of error log lines	# `array()`
`protected array`	`$deprecated` array of deprecated log lines array of deprecated log lines	# `array()`
`protected true`	`$renderingEnabled` if rendering enables if rendering enables	# `false`
`protected true`	`$activated` is logging is activated is logging is activated	# `false`
`protected mixed`	`$configs` boolean false if configs no set or read, array of module/user configs boolean false if configs no set or read, array of module/user configs	# `false`
`protected true`	`$usePopup` if rendering enables if rendering enables	# `false`

Namespaces

Classes

Interfaces

Functions

Class LegacyLogger

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns