Class XoopsLogger

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.

Direct known subclasses

XoopsErrorHandler

Package: kernel\logger
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Author: Skalpa Keo skalpa@xoops.org
Author: Taiwen Jiang phppp@users.sourceforge.net
Located at lass/logger/xoopslogger.php

Methods summary
`public`	# `__construct( )` XoopsLogger::__construct() XoopsLogger::__construct()
`public`	# `XoopsLogger( )` XoopsLogger::XoopsLogger() XoopsLogger::XoopsLogger()
`public`	# `instance( )` Deprecated, use getInstance() instead Deprecated, use getInstance() instead
`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 XoopsLogger reference to the only instance
`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 float`	# `microtime( )` Returns the current microtime in seconds. Returns the current microtime in seconds. Returns float
`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, null $query_time = null )` Log a database query Log a database query Parameters `$sql` SQL string `$error` error message (if any) `$errno` error number (if any) `$query_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, integer $msg )` Log extra information Log extra information Parameters `$name` name for the entry `$msg` text message for the entry
`public`	# `addDeprecated( integer $msg )` Log messages for deprecated functions Log messages for deprecated functions Deprecated Parameters `$msg` text message for the entry
`public`	# `handleError( integer $errno, string $errstr, string $errfile, string $errline )` Error handling callback (called by the zend engine) Error handling callback (called by the zend engine) Parameters `$errno` `$errstr` `$errfile` `$errline`
`public`	# `handleException( Exception\|Throwable $e )` Exception handling callback. Exception handling callback. Parameters `$e` uncaught Exception or Error
`protected boolean`	# `isThrowable( mixed $e )` Determine if an object implements Throwable (or is an Exception that would under PHP 7.) Determine if an object implements Throwable (or is an Exception that would under PHP 7.) Parameters `$e` Expected to be an object related to Exception or Throwable Returns boolean true if related to Throwable or Exception, otherwise false
`public mixed\|string`	# `sanitizePath( string $path )` Parameters `$path` Returns mixed\|string
`public string`	# `render( $output )` Output buffering callback inserting logger dump in page output Output buffering callback inserting logger dump in page output Parameters `$output` Returns string
`public`	# `dump( string $mode = '' )` #@+ #@+ Parameters `$mode` Returns Protected
`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`	# `triggerError( integer $errkey = 0, string $errStr = '', string $errFile = '', string $errLine = '', integer $errNo = 0 )` XoopsLogger::triggerError() XoopsLogger::triggerError() Deprecated Parameters `$errkey` `$errStr` `$errFile` `$errLine` `$errNo`
`public`	# `dumpAll( )` #@+ #@+ Deprecated
`public XoopsLogger::dump()`	# `dumpBlocks( )` dnmp Blocks @deprecated dnmp Blocks @deprecated Returns `XoopsLogger::dump()`
`public dimp`	# `dumpExtra( )` dumpExtra @deprecated dumpExtra @deprecated Returns dimp
`public unknown`	# `dumpQueries( )` dump Queries @deprecated dump Queries @deprecated Returns unknown

Properties summary
`public array`	`$queries` #@+ #@+	# `array()`
`public array`	`$blocks`	# `array()`
`public array`	`$extra`	# `array()`
`public array`	`$logstart`	# `array()`
`public array`	`$logend`	# `array()`
`public array`	`$errors`	# `array()`
`public array`	`$deprecated`	# `array()`
`public boolean`	`$usePopup` #@- #@-	# `false`
`public boolean`	`$activated`	# `true`
`public boolean`	`$renderingEnabled` @access protected @access protected	# `false`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsLogger

Direct known subclasses

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Deprecated

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Protected

Parameters

Returns

Deprecated

Parameters

Deprecated

Returns

Returns

Returns