Class PlgSystemDebug

Description

Joomla! Debug plugin

  • since: 1.5

Located in /plugins/system/debug/debug.php (line 19)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --PlgSystemDebug
Variable Summary
 mixed $linkFormat
Method Summary
 PlgSystemDebug __construct (object &$subject, array $config)
 void __destruct ()
 string display (string $item, [array $errors = array()])
 string displayErrors ()
 string displayLogs ()
 string displayMemoryUsage ()
 string displayQueries ()
 string displaySession ([string $key = ''], [mixed $session = null], [integer $id = 0])
 string formatLink (string $file, [string $line = ''])
 string highlightQuery (string $query)
 void logger (JLogEntry $entry)
 void onAfterDispatch ()
 string renderBacktrace (Exception $error)
 string renderBars (array &$bars, [string $class = ''], [integer $id = null])
 string tableToHtml (array $table,  &$hasWarnings, boolean $hasWarnings)
Variables
mixed $linkFormat = '' (line 21)
  • access: protected

Inherited Variables

Inherited from JPlugin

JPlugin::$autoloadLanguage
JPlugin::$params
JPlugin::$_name
JPlugin::$_type

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors
Methods
Constructor __construct (line 71)

Constructor.

  • since: 1.5
  • access: public
PlgSystemDebug __construct (object &$subject, array $config)
  • object &$subject: The object to observe
  • array $config: An array that holds the plugin configuration

Redefinition of:
JPlugin::__construct()
Constructor
Destructor __destruct (line 150)

Show the debug info

  • since: 1.6
  • access: public
void __destruct ()
display (line 303)

General display method.

  • since: 2.5
  • access: protected
string display (string $item, [array $errors = array()])
  • string $item: The item to display
  • array $errors: Errors occured during execution
displayErrors (line 432)

Display errors.

  • since: 2.5
  • access: protected
string displayErrors ()
displayLanguageFilesInError (line 1364)

Displays errors in language files.

  • since: 2.5
  • access: protected
string displayLanguageFilesInError ()
displayLanguageFilesLoaded (line 1394)

Display loaded language files.

  • since: 2.5
  • access: protected
string displayLanguageFilesLoaded ()
displayLogs (line 1671)

Display log messages

  • since: 3.1
  • access: protected
string displayLogs ()
displayMemoryUsage (line 618)

Display memory usage

  • since: 2.5
  • access: protected
string displayMemoryUsage ()
displayProfileInformation (line 468)

Display profile information.

  • since: 2.5
  • access: protected
string displayProfileInformation ()
displayQueries (line 633)

Display logged queries.

  • since: 2.5
  • access: protected
string displayQueries ()
displaySession (line 352)

Display session information.

Called recursive.

  • since: 2.5
  • access: protected
string displaySession ([string $key = ''], [mixed $session = null], [integer $id = 0])
  • string $key: A session key
  • mixed $session: The session array, initially null
  • integer $id: The id is used for JS toggling the div
displayUntranslatedStrings (line 1428)

Display untranslated language strings.

  • since: 2.5
  • access: protected
string displayUntranslatedStrings ()
formatLink (line 1630)

Replaces the Joomla! root with "JROOT" to improve readability.

Formats a link with a special value xdebug.file_link_format from the php.ini file.

  • since: 2.5
  • access: protected
string formatLink (string $file, [string $line = ''])
  • string $file: The full path to the file.
  • string $line: The line number.
highlightQuery (line 1521)

Simple highlight for SQL queries.

  • since: 2.5
  • access: protected
string highlightQuery (string $query)
  • string $query: The query to highlight
logger (line 1659)

Store log messages so they can be displayed later.

This function is passed log entries by JLogLoggerCallback.

  • since: 3.1
  • access: public
void logger (JLogEntry $entry)
mysqlDisconnectHandler (line 1294)

Disconnect-handler for database to collect profiling and explain information

  • since: 3.1.2
  • access: public
void mysqlDisconnectHandler (JDatabaseDriver &$db)
onAfterDispatch (line 129)

Add the CSS for debug. We can't do this in the constructor because stuff breaks.

  • since: 2.5
  • access: public
void onAfterDispatch ()
renderBacktrace (line 1563)

Render the backtrace.

Stolen from JError to prevent it's removal.

  • return: Contents of the backtrace
  • since: 2.5
  • access: protected
string renderBacktrace (Exception $error)
  • Exception $error: The error
renderBars (line 1134)
  • since: 3.1.2
  • access: protected
string renderBars (array &$bars, [string $class = ''], [integer $id = null])
  • array &$bars: Array of bar data
  • string $class: Optional class for items
  • integer $id: Id if the bar to highlight
tableToHtml (line 1174)
  • since: 3.1.2
  • access: protected
string tableToHtml (array $table,  &$hasWarnings, boolean $hasWarnings)
  • array $table
  • boolean $hasWarnings: Changes value to true if warnings are displayed, otherwise untouched
  • &$hasWarnings

Inherited Methods

Inherited From JPlugin

 JPlugin::__construct()
 JPlugin::loadLanguage()

Inherited From JEvent

 JEvent::__construct()
 JEvent::update()

Inherited From JObject

 JObject::__construct()
 JObject::def()
 JObject::get()
 JObject::getError()
 JObject::getErrors()
 JObject::getProperties()
 JObject::set()
 JObject::setError()
 JObject::setProperties()
 JObject::__toString()

Documentation generated on Tue, 19 Nov 2013 14:58:03 +0100 by phpDocumentor 1.4.3