New debugger system that outputs a toolbar on page view. More...

Static Public Member Functions
static	addModules (OutputPage $out)
	Add ResourceLoader modules to the OutputPage object if debugging is enabled.
static	appendDebugInfoToApiResult (IContextSource $context, ApiResult $result)
	Append the debug info to given ApiResult.
static	clearLog ()
	Clears internal log array and deprecation tracking.
static	debugMsg ($str)
	This is a method to pass messages from wfDebug to the pretty debugger.
static	deprecated ($function, $version=false, $component=false, $callerOffset=2)
	Show a warning that $function is deprecated.
static	getDebugHTML (IContextSource $context)
	Returns the HTML to add to the page for the toolbar.
static	getDebugInfo (IContextSource $context)
	Returns the HTML to add to the page for the toolbar.
static	getHTMLDebugLog ()
	Generate debug log in HTML for displaying at the bottom of the main content area.
static	getLog ()
	Returns internal log array.
static	init ()
	Enabled the debugger and load resource module.
static	log ($str)
	Adds a line to the log.
static	query ($sql, $function, $isMaster)
	Begins profiling on a database query.
static	queryTime ($id)
	Calculates how long a query took.
static	warning ($msg, $callerOffset=1, $level=E_USER_NOTICE)
	Adds a warning entry to the log.
Static Protected Member Functions
static	getFilesIncluded (IContextSource $context)
	Returns a list of files included, along with their size.
Static Protected Attributes
static	$debug = array()
static	$deprecationWarnings = array()
static	$enabled = false
static	$log = array()
static	$query = array()
Static Private Member Functions
static	getCallerDescription ($callerOffset)
	Get an array describing the calling function at a specified offset.
static	sendWarning ($msg, $caller, $level)
	Send a warning either to the debug log or by triggering an user PHP error depending on $wgDevelopmentWarnings.

Detailed Description

New debugger system that outputs a toolbar on page view.

By default, most methods do nothing ( self::$enabled = false ). You have to explicitly call MWDebug::init() to enabled them.

Todo:: Profiler support

Since:: 1.19

Definition at line 33 of file Debug.php.

Member Function Documentation

static MWDebug::addModules ( OutputPage $ out ) [static]

Add ResourceLoader modules to the OutputPage object if debugging is enabled.

Since:: 1.19

Parameters:

$out	OutputPage

Definition at line 88 of file Debug.php.

References OutputPage\addModules().

static MWDebug::appendDebugInfoToApiResult	(	IContextSource $	context,
		ApiResult $	result
	)		`[static]`

Append the debug info to given ApiResult.

Parameters:

$context	IContextSource
$result	ApiResult

Definition at line 466 of file Debug.php.

References ApiResult\addValue(), array(), as, debugMsg(), getDebugInfo(), log(), ApiResult\setContent(), ApiResult\setIndexedTagName(), and Sanitizer\stripAllTags().

static MWDebug::clearLog ( ) [static]

Clears internal log array and deprecation tracking.

Since:: 1.19

Definition at line 127 of file Debug.php.

References array().

Referenced by MWDebugTest\setUp().

static MWDebug::debugMsg ( $ str ) [static]

This is a method to pass messages from wfDebug to the pretty debugger.

Do NOT use this method, use MWDebug::log or wfDebug()

Since:: 1.19

Parameters:

$str string

Definition at line 296 of file Debug.php.

References $debug, and global.

Referenced by appendDebugInfoToApiResult(), and wfDebug().

static MWDebug::deprecated	(	$	function,
		$	version = `false`,
		$	component = `false`,
		$	callerOffset = `2`
	)		`[static]`

Show a warning that $function is deprecated.

This will send it to the following locations:

Debug toolbar, with one item per function and caller, if $wgDebugToolbar is set to true.
PHP's error log, with level E_USER_DEPRECATED, if $wgDevelopmentWarnings is set to true.
MediaWiki's debug log, if $wgDevelopmentWarnings is set to false.

Since:: 1.19

Parameters:

string	$function	Function that is deprecated.
string \| bool	$version	Version in which the function was deprecated.
string \| bool	$component	Component to which the function belongs. If false, it is assumbed the function is in MediaWiki core.
	$callerOffset	integer: How far up the callstack is the original caller. 2 = function that called the function that called MWDebug::deprecated() (Added in 1.20).