Extension:DebugMode

MediaWiki extensions manual

DebugMode Release status: unmaintained
Implementation	User interface
Description	Puts wiki into debug mode
Author(s)	Ike Hecht (Tosfostalk)
Latest version	0.1.0 (2014-10-28)
MediaWiki	1.23
PHP	5.3
Database changes	No
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Parameters $wgDebugMode $wgDebugModeIgnoreVars
Quarterly downloads	1 (Ranked 144th)
Translate the DebugMode extension if it is available at translatewiki.net

The DebugMode extension puts the wiki into debug mode, which means all MediaWiki debugging parameters are switched on.

Installation

• Download and move the extracted DebugMode folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/DebugMode
• Add the following code at the bottom of your LocalSettings.php file:

  require_once "$IP/extensions/DebugMode/DebugMode.php";
  

•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters

$wgDebugMode

Level of debugging. Can be set to true to enable all debugging or false to do nothing.

Setting to false does not turn debugging off! It just leaves the existing settings alone.

Can be set using named constants in the DebugMode class, using bitwise operators:

• DebugMode::DEBUG_MODE_NONE: the extension does nothing, equivalent to false;
  Except in this mode, the following MediaWiki’s parameters are activated:
  • $wgColorErrors
  • $wgDebugAPI
  • $wgDebugComments
  • $wgDebugDBTransactions
  • $wgDebugDumpSql
  • $wgDebugFunctionEntry
  • $wgDebugPrintHttpHeaders
  • $wgDebugTimestamps
  • $wgDebugToolbar
  • $wgDevelopmentWarnings
  • $wgLogExceptionBacktrace
  • $wgShowDBErrorBacktrace
  • $wgShowExceptionDetails
  • $wgShowSQLErrors
  • $wgProfileLimit is set to 0.0,
• DebugMode::DEBUG_MODE_INI: set PHP’s display_errors to true;
• DebugMode::DEBUG_MODE_PHP: set PHP’s error_reporting to -1 (all debugging messages);
• DebugMode::DEBUG_MODE_VERBOSE: activate MediaWiki’s $wgShowDebug ;
• DebugMode::DEBUG_MODE_CACHE: deactivate MediaWiki’s $wgCachePages , $wgDeprecationReleaseLimit , and $wgEnableParserCache ;
• DebugMode::DEBUG_MODE_RESOURCE_LOADER: activate MediaWiki’s $wgResourceLoaderDebug and set MediaWiki’s $wgResourceLoaderMaxage to 1;
• DebugMode::DEBUG_MODE_INSECURE: (unused);
• DebugMode::DEBUG_MODE_ALL: all debugging modes are activated, equivalent to true.

Default value is a reasonable level of debugging, which is DebugMode::DEBUG_MODE_ALL minus DebugMode::DEBUG_MODE_VERBOSE.

Example: DebugMode::DEBUG_MODE_ALL ^ DebugMode::DEBUG_MODE_INI ^ DebugMode::DEBUG_MODE_PHP for “all but no PHP settings”.

$wgDebugModeIgnoreVars

An array of variables that should be ignored by the extension. Can be used for more fine-tuning of variables than allowed by $wgDebugMode. These vars can be any named variables known to the extension, including MediaWiki globals and PHP settings. Default is an empty array, nothing is ignored.

Example: array( 'wgDebugAPI' ) to ignore setting of $wgDebugAPI .

See also

• The file DevelopmentSettings.php.