MediaWiki master
|
Debug toolbar. 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 | clearDeprecationFilters () |
Clear all deprecation filters. | |
static | clearLog () |
Clears internal log array and deprecation tracking. | |
static | debugMsg ( $str, $context=[]) |
This method receives messages from LoggerFactory, wfDebugLog, and MWExceptionHandler. | |
static | deinit () |
Disable the debugger. | |
static | deprecated ( $function, $version=false, $component=false, $callerOffset=2) |
Show a warning that $function is deprecated. | |
static | deprecatedMsg ( $msg, $version=false, $component=false, $callerOffset=2) |
Log a deprecation warning with arbitrary message text. | |
static | detectDeprecatedOverride ( $instance, $class, $method, $version=false, $component=false, $callerOffset=2) |
Show a warning if $method declared in $class is overridden in $instance. | |
static | filterDeprecationForTest (string $regex, ?callable $callback=null) |
Deprecation messages matching the supplied regex will be suppressed. | |
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 | parseCallerDescription ( $msg) |
Append a caller description to an error message. | |
static | query ( $sql, $function, $runTime, $dbhost) |
Begins profiling on a database query. | |
static | sendRawDeprecated ( $msg, $sendToLog=true, $callerFunc='') |
Send a raw deprecation message to the log and the debug toolbar, without filtering of duplicate messages. | |
static | setup () |
static | warning ( $msg, $callerOffset=1, $level=E_USER_NOTICE, $log='auto') |
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 array | $debug = [] |
Debug messages from wfDebug(). | |
static array | $deprecationFilters = [] |
Keys are regexes, values are optional callbacks to call if the filter is hit. | |
static array | $deprecationWarnings = [] |
Array of functions that have already been warned, formatted function-caller to prevent a buttload of warnings. | |
static bool | $enabled = false |
Is the debugger enabled? | |
static array | $log = [] |
Log lines. | |
static array | $query = [] |
SQL statements of the database queries. | |
Debug toolbar.
By default most of these methods do nothing, as enforced by self::$enabled = false.
To enable the debug toolbar, use $wgDebugToolbar = true in LocalSettings.php. That ensures MWDebug::init() is called from Setup.php.
Definition at line 41 of file MWDebug.php.
|
static |
Add ResourceLoader modules to the OutputPage object if debugging is enabled.
OutputPage | $out |
Definition at line 133 of file MWDebug.php.
References MediaWiki\Output\OutputPage\addModules().
|
static |
Append the debug info to given ApiResult.
IContextSource | $context | |
ApiResult | $result |
Definition at line 698 of file MWDebug.php.
References ApiResult\addValue().
|
static |
Clear all deprecation filters.
Definition at line 401 of file MWDebug.php.
|
static |
Clears internal log array and deprecation tracking.
Definition at line 172 of file MWDebug.php.
|
static |
This method receives messages from LoggerFactory, wfDebugLog, and MWExceptionHandler.
Do NOT call this method directly.
string | $str | |
array | $context |
Definition at line 507 of file MWDebug.php.
References $wgDebugComments, and $wgShowDebug.
Referenced by MediaWiki\Logger\LegacyLogger\log().
|
static |
|
static |
Show a warning that $function is deprecated.
string | $function | Function that is deprecated. |
string | false | $version | Version in which the function was deprecated. |
string | bool | $component | Component to which the function belongs. If false, it is assumed the function is in MediaWiki core. |
int | $callerOffset | How far up the callstack is the original caller. 2 = function that called the function that called MWDebug::deprecated() (Added in 1.20). |
Definition at line 221 of file MWDebug.php.
|
static |
Log a deprecation warning with arbitrary message text.
A caller description will be appended. If the message has already been sent for this caller, it won't be sent again.
Although there are component and version parameters, they are not automatically appended to the message. The message text should include information about when the thing was deprecated.
The warning will be sent to the following locations:
string | $msg | The message |
string | false | $version | Version of MediaWiki that the function was deprecated in. |
string | bool | $component | Component to which the function belongs. If false, it is assumed the function is in MediaWiki core. |
int | false | $callerOffset | How far up the call stack is the original caller. 2 = function that called the function that called us. If false, the caller description will not be appended. |
Definition at line 303 of file MWDebug.php.
References $wgDeprecationReleaseLimit.
|
static |
Show a warning if $method declared in $class is overridden in $instance.
phpcs:ignore MediaWiki.Commenting.FunctionComment.ObjectTypeHintParam
object | $instance | Object on which to detect deprecated overrides (typically $this). |
string | $class | Class declaring the deprecated method (typically CLASS ) |
string | $method | The name of the deprecated method. |
string | false | $version | Version in which the method was deprecated. Does not issue deprecation warnings if false. |
string | bool | $component | Component to which the class belongs. If false, it is assumed the class is in MediaWiki core. |
int | $callerOffset | How far up the callstack is the original caller. 2 = function that called the function that called MWDebug::detectDeprecatedOverride() |
Definition at line 255 of file MWDebug.php.
|
static |
Deprecation messages matching the supplied regex will be suppressed.
Use this to filter deprecation warnings when testing deprecated code.
string | $regex | |
?callable | $callback To call if $regex is hit |
Definition at line 389 of file MWDebug.php.
|
static |
Returns the HTML to add to the page for the toolbar.
IContextSource | $context |
Definition at line 637 of file MWDebug.php.
References $wgDebugComments.
|
static |
Returns the HTML to add to the page for the toolbar.
IContextSource | $context |
Definition at line 732 of file MWDebug.php.
References IContextSource\getLanguage(), IContextSource\getRequest(), and MW_VERSION.
|
staticprotected |
Returns a list of files included, along with their size.
IContextSource | $context |
Definition at line 616 of file MWDebug.php.
References $file, and IContextSource\getLanguage().
|
static |
Generate debug log in HTML for displaying at the bottom of the main content area.
If $wgShowDebug is false, an empty string is always returned.
Definition at line 672 of file MWDebug.php.
References $wgShowDebug.
|
static |
|
static |
Enabled the debugger and load resource module.
This is called by Setup.php when $wgDebugToolbar is true.
Definition at line 113 of file MWDebug.php.
|
static |
Adds a line to the log.
mixed | $str |
Definition at line 145 of file MWDebug.php.
References wfGetCaller().
|
static |
Append a caller description to an error message.
string | $msg | Formatted message from formatCallerDescription() and getCallerDescription() |
Definition at line 466 of file MWDebug.php.
|
static |
Begins profiling on a database query.
string | $sql | |
string | $function | |
float | $runTime | Query run time |
string | $dbhost |
Definition at line 571 of file MWDebug.php.
Referenced by MediaWiki\Logger\LegacyLogger\log().
|
static |
Send a raw deprecation message to the log and the debug toolbar, without filtering of duplicate messages.
A caller description will not be appended.
string | $msg | The complete message including relevant caller information. |
bool | $sendToLog | If true, the message will be sent to the debug toolbar, the debug log, and raised as a warning to PHP. If false, the message will only be sent to the debug toolbar. |
string | $callerFunc | The caller, for display in the debug toolbar's caller column. |
Definition at line 367 of file MWDebug.php.
|
static |
Definition at line 86 of file MWDebug.php.
References $wgCommandLineMode, $wgDebugToolbar, $wgUseCdn, and $wgUseFileCache.
|
static |
Adds a warning entry to the log.
string | $msg | |
int | $callerOffset | |
int | $level | A PHP error level. See sendMessage() |
string | $log | 'production' will always trigger a php error, 'auto' will trigger an error if $wgDevelopmentWarnings is true, and 'debug' will only write to the debug log(s). |
Definition at line 188 of file MWDebug.php.
References $wgDevelopmentWarnings.
|
staticprotected |
Debug messages from wfDebug().
Definition at line 54 of file MWDebug.php.
|
staticprotected |
Keys are regexes, values are optional callbacks to call if the filter is hit.
Definition at line 81 of file MWDebug.php.
|
staticprotected |
Array of functions that have already been warned, formatted function-caller to prevent a buttload of warnings.
Definition at line 76 of file MWDebug.php.
|
staticprotected |
Is the debugger enabled?
Definition at line 68 of file MWDebug.php.
|
staticprotected |
Log lines.
Definition at line 47 of file MWDebug.php.
|
staticprotected |
SQL statements of the database queries.
Definition at line 61 of file MWDebug.php.