Advanced debug/log system. More...

Public Member Functions
	__construct ()
	errorHandler ($errno, $errstr, $errfile, $errline)
	isDebugAllowed ()
	isGlobalLogFileEnabled ()
	isLogFileEnabled ($type)
	logFiles ()
	messageName ($messageType)
	messageTypes ()
	reset ()
	setIsGlobalLogFileEnabled ($enabled)
	setIsLogFileEnabled ($type, $enabled)
	setLogOnly ($enabled)
	setMessageOutput ($output)
	setStoreLog ($store)
Static Public Member Functions
static	accumulatorStart ($key, $inGroup=false, $name=false, $recursive=false)
static	accumulatorStop ($key, $recursive=false)
static	addTimingPoint ($description="")
static	alwaysLogMessage ($level)
static	appendBottomReport ($reportName, $reportContent)
static	appendTopReport ($reportName, $reportContent)
static	checkDebugByUser ()
static	createAccumulator ($key, $inGroup=false, $name=false)
static	createAccumulatorGroup ($key, $name=false)
static	instance ()
static	isDebugEnabled ()
static	isIPInNet ($ipaddress, $network, $mask=24)
static	isLogOnlyEnabled ()
static	maxLogrotateFiles ()
static	maxLogSize ()
static	printBottomReportsList ()
static	printReport ($newWindow=false, $as_html=true, $returnReport=false, $allowedDebugLevels=false, $useAccumulators=true, $useTiming=true, $useIncludedFiles=false)
static	printTopReportsList ()
static	rotateLog ($fileName)
static	setHandleType ($type)
static	setLogFileEnabled ($enabled, $types=false)
static	setLogrotateFiles ($files)
static	setMaxLogSize ($size)
static	setScriptStart ($time=false)
static	setUseExternalCSS ($use)
static	showMessage ($type)
static	showTypes ($types=false)
static	updateSettings ($settings)
static	writeDebug ($string, $label="", $backgroundClass="")
static	writeError ($string, $label="", $backgroundClass="")
static	writeNotice ($string, $label="", $backgroundClass="")
static	writeStrict ($string, $label="", $backgroundClass="")
static	writeWarning ($string, $label="", $backgroundClass="")
Public Attributes
	$bottomReportsList
	A list of debug reports that appears at the bottom of debug output.
	$DebugStrings = array()
	String array containing the debug information.
	$GlobalLogFileEnabled
	Controls whether logfiles are used at all.
	$HandleType
	Determines what to do with php errors, ignore, fetch or output.
	$LogFileEnabled
	A map with message types and whether they should do file logging.
	$LogFiles
	An array of logfiles used by the debug class with each key being the debug level.
	$MessageOutput
	Determines how messages are output (screen/log)
	$MessageTypes
	A list of message types.
	$OutputFormat
	An array of the outputformats for the different debug levels.
	$OverrideList
	A list of override directories.
	$PercentAccuracy = 4
	How many places behing . should be displayed when showing percentages.
	$ScriptStart
	The time when the script was started.
	$ShowTypes
	Determines which debug messages should be shown.
	$TimeAccumulatorList = array()
	Array wich contains time accumulators.
	$TimePoints = array()
	Array which contains the time points.
	$TimingAccuracy = 4
	How many places behing . should be displayed when showing times.
	$TmpTimePoints
	Array which contains the temporary time points.
	$topReportsList
	A list of debug reports that appears at the top of debug output.
	$UseCSS
	Whether to use external CSS or output own CSS. True if external is to be used.
const	HANDLE_FROM_PHP = 1
const	HANDLE_NONE = 0
const	HANDLE_TO_PHP = 2
const	LEVEL_DEBUG = 5
const	LEVEL_ERROR = 3
const	LEVEL_NOTICE = 1
const	LEVEL_STRICT = 6
const	LEVEL_TIMING_POINT = 4
const	LEVEL_WARNING = 2
const	MAX_LOGFILE_SIZE = 204800
const	MAX_LOGROTATE_FILES = 3
const	OUTPUT_MESSAGE_SCREEN = 1
const	OUTPUT_MESSAGE_STORE = 2
const	SHOW_ALL = 63
const	SHOW_DEBUG = 16
const	SHOW_ERROR = 4
const	SHOW_NOTICE = 1
const	SHOW_STRICT = 32
const	SHOW_TIMING_POINT = 8
const	SHOW_WARNING = 2
const	XDEBUG_SIGNATURE = '--XDEBUG--'
Private Member Functions
	printReportInternal ($as_html=true, $returnReport=true, $allowedDebugLevels=false, $useAccumulators=true, $useTiming=true, $useIncludedFiles=false)
	write ($string, $verbosityLevel=self::LEVEL_NOTICE, $label="", $backgroundClass="", $alwaysLog=false)
	writeFile (&$logFileData, &$string, $verbosityLevel, $alwaysLog=false)
Static Private Member Functions
static	dumpVariable ($var)
static	isAllowedByCurrentIP ($allowedIpList)
static	timeToFloat ($mtime)

Detailed Description

Advanced debug/log system.

The eZ debug library is used to handle debug information. It can display information on screen and/or write it to log files.

You can enable on-screen debug information for specific IP addresses.

Timing points can be placed in the code to time the different sections of code.

Each debug message can be turned on/off by using the showTypes() function.

PHP error messages can also be shown using setHandleType().

  require_once( "lib/ezutils/classes/ezdebug.php" );

  // write a temporary debug message
  eZDebug::writeDebug( "Test" );

  // write a notice
  eZDebug::writeNotice( "Image found" );

  // write a warning
  eZDebug::writeWarning( "Image not found, using default" );

  // write an error
  eZDebug::writeError( "Object not found, bailing.." );

  // add a timing points
  eZDebug::addTimingPoint( "Module Found" );

  //.... code

  eZDebug::addTimingPoint( "Module loading" );

  // print the results on screen.
  eZDebug::printReport();

Definition at line 79 of file ezdebug.php.

Constructor & Destructor Documentation

eZDebug::__construct ( )

Creates a new debug object.

Definition at line 111 of file ezdebug.php.

Member Function Documentation

static eZDebug::accumulatorStart	(	$	key,
		$	inGroup = `false`,
		$	name = `false`,
		$	recursive = `false`
	)		`[static]`

Starts an time count for the accumulator $key. You can also specify a name which will be displayed.

Definition at line 1288 of file ezdebug.php.

static eZDebug::accumulatorStop	(	$	key,
		$	recursive = `false`
	)		`[static]`

Stops a previous time count and adds the total time to the accumulator $key.

Definition at line 1315 of file ezdebug.php.

static eZDebug::addTimingPoint ( $ description = "" ) [static]

Adds a new timing point for the benchmark report.

Definition at line 659 of file ezdebug.php.

Referenced by eZTemplate\fetch(), eZTemplateMultiPassParser\parseIntoTextElements(), eZTemplateMultiPassParser\parseIntoTree(), eZTemplateMultiPassParser\parseWhitespaceRemoval(), and eZTemplateDebugFunction\process().

static eZDebug::alwaysLogMessage ( $ level ) [static]

Returns:: true if the debug level $level should always log to file.

Definition at line 243 of file ezdebug.php.

Referenced by writeDebug(), writeError(), writeNotice(), writeStrict(), and writeWarning().

static eZDebug::appendBottomReport	(	$	reportName,
		$	reportContent
	)		`[static]`

Appends report to 'bottom' reports list.

Definition at line 1806 of file ezdebug.php.

static eZDebug::appendTopReport	(	$	reportName,
		$	reportContent
	)		`[static]`

Appends report to 'top' reports list.

Definition at line 1784 of file ezdebug.php.

static eZDebug::checkDebugByUser ( ) [static]

Final checking for debug by user id. Checks if we should enable debug.

Returns false if debug-by-user is not active, was already checked before or if there is no current user. Returns true otherwise.

Definition at line 1106 of file ezdebug.php.

static eZDebug::createAccumulator	(	$	key,
		$	inGroup = `false`,
		$	name = `false`
	)		`[static]`

Creates a new accumulator entry if one does not already exist and initializes with default data. If $name is not supplied name is taken from $key. If $inGroup is supplied it will place the accumulator under the specified group.

Definition at line 1260 of file ezdebug.php.

static eZDebug::createAccumulatorGroup	(	$	key,
		$	name = `false`
	)		`[static]`

Creates an accumulator group with key $key and group name $name. If $name is not supplied name is taken from $key.

Definition at line 1241 of file ezdebug.php.

Referenced by eZMySQLDB\eZMySQLDB(), eZMySQLiDB\eZMySQLiDB(), eZTemplate\eZTemplate(), and eZTSTranslator\initialize().

static eZDebug::dumpVariable ( $ var ) [static, private]

Dumps the variables contents using the var_dump function

Definition at line 610 of file ezdebug.php.

Referenced by writeDebug(), writeError(), writeNotice(), writeStrict(), eZPaymentLogger\writeString(), eZPaymentLogger\writeTimedString(), and writeWarning().

eZDebug::errorHandler	(	$	errno,
		$	errstr,
		$	errfile,
		$	errline
	)

Handles PHP errors, creates notice, warning and error messages for the various PHP error types.

Definition at line 327 of file ezdebug.php.

static eZDebug::instance ( ) [static]

Will return the current eZDebug object. If no object exists one will be created.

Definition at line 221 of file ezdebug.php.

Referenced by accumulatorStart(), accumulatorStop(), addTimingPoint(), alwaysLogMessage(), appendBottomReport(), appendTopReport(), createAccumulator(), createAccumulatorGroup(), eZDebugErrorHandler(), eZDebugSetting\isConditionTrue(), printBottomReportsList(), printReport(), printTopReportsList(), eZPostgreSQLDB\query(), setHandleType(), setLogFileEnabled(), setScriptStart(), setUseExternalCSS(), showMessage(), showTypes(), writeDebug(), writeError(), writeFile(), writeNotice(), writeStrict(), and writeWarning().

static eZDebug::isAllowedByCurrentIP ( $ allowedIpList ) [static, private]

If debugging is allowed for the current IP address.

Definition at line 1836 of file ezdebug.php.

Referenced by updateSettings().

eZDebug::isDebugAllowed ( )

If debugging is allowed, given the limitations of the DebugByIP and DebugByUser settings.

Definition at line 1828 of file ezdebug.php.

static eZDebug::isDebugEnabled ( ) [static]

Returns:: true if debug should be enabled.

Note:: Will return false until the real settings has been updated with updateSettings()

Definition at line 1003 of file ezdebug.php.

Referenced by accumulatorStart(), accumulatorStop(), addTimingPoint(), createAccumulator(), createAccumulatorGroup(), errorHandler(), printReport(), eZScript\shutdown(), write(), writeDebug(), writeError(), writeFile(), writeNotice(), writeStrict(), and writeWarning().

eZDebug::isGlobalLogFileEnabled ( )

Returns:: true if the message type $type has logging to file enabled.

See also:: isLogFileEnabled, setIsGlobalLogFileEnabled

Definition at line 950 of file ezdebug.php.

Referenced by isLogFileEnabled().

static eZDebug::isIPInNet	(	$	ipaddress,
		$	network,
		$	mask = `24`
	)		`[static]`

Determine if an ipaddress is in a network. E.G. 120.120.120.120 in 120.120.0.0/24.

Returns:: true or false.

Definition at line 1033 of file ezdebug.php.

Referenced by eZUser\isUserIPInList().

eZDebug::isLogFileEnabled ( $ type )

Returns:: true if the message type $type has logging to file enabled.

See also:: isGlobalLogFileEnabled, setIsLogFileEnabled

Definition at line 939 of file ezdebug.php.

Referenced by write(), and writeFile().

static eZDebug::isLogOnlyEnabled ( ) [static]

Returns:: true if there should only be logging of debug strings to file.

Note:: Will return false until the real settings has been updated with updateSettings()

Definition at line 1018 of file ezdebug.php.

Referenced by write().

eZDebug::logFiles ( )

Returns an associative array of all the log files used by this class where each key is the debug level (self::LEVEL_NOTICE, self::LEVEL_WARNING or self::LEVEL_ERROR or self::LEVEL_DEBUG).

Definition at line 993 of file ezdebug.php.

Referenced by write().

static eZDebug::maxLogrotateFiles ( ) [static]

Returns:: the maxium number of logrotate files to keep.

Definition at line 792 of file ezdebug.php.

Referenced by rotateLog().

static eZDebug::maxLogSize ( ) [static]

Returns:: the maxium size for a log file in bytes.

Definition at line 770 of file ezdebug.php.

Referenced by writeFile().

eZDebug::messageName ( $ messageType )

Returns:: the name of the message type.

Definition at line 212 of file ezdebug.php.

eZDebug::messageTypes ( )

Returns:: an array with the available message types.

Definition at line 984 of file ezdebug.php.

static eZDebug::printBottomReportsList ( ) [static]

Prints all 'bottom' reports

Definition at line 1815 of file ezdebug.php.

Referenced by printReportInternal().

static eZDebug::printReport	(	$	newWindow = `false`,
		$	as_html = `true`,
		$	returnReport = `false`,
		$	allowedDebugLevels = `false`,
		$	useAccumulators = `true`,
		$	useTiming = `true`,
		$	useIncludedFiles = `false`
	)		`[static]`

Prints the debug report

Definition at line 1146 of file ezdebug.php.

Referenced by eZFatalError(), eZDBInterface\reportError(), and eZScript\shutdown().

eZDebug::printReportInternal	(	$	as_html = `true`,
		$	returnReport = `true`,
		$	allowedDebugLevels = `false`,
		$	useAccumulators = `true`,
		$	useTiming = `true`,
		$	useIncludedFiles = `false`
	)		`[private]`

Prints a full debug report with notice, warnings, errors and a timing report.

Definition at line 1350 of file ezdebug.php.

static eZDebug::printTopReportsList ( ) [static]

Prints all 'top' reports

Definition at line 1793 of file ezdebug.php.

Referenced by printReportInternal().

eZDebug::reset ( )

Definition at line 195 of file ezdebug.php.

static eZDebug::rotateLog ( $ fileName ) [static]

Rotates logfiles so the current logfile is backed up, old rotate logfiles are rotated once more and those that exceed maxLogrotateFiles() will be removed. Rotated files will get the extension .1, .2 etc.

Definition at line 817 of file ezdebug.php.

Referenced by writeFile().

static eZDebug::setHandleType ( $ type ) [static]

Determines how PHP errors are handled. If $type is self::HANDLE_TO_PHP all error messages is sent to PHP using trigger_error(), if $type is self::HANDLE_FROM_PHP all error messages from PHP is fetched using a custom error handler and output as a usual eZDebug message. If $type is self::HANDLE_NONE there is no error exchange between PHP and eZDebug.

Definition at line 267 of file ezdebug.php.

Referenced by eZFatalError(), eZScript\initialize(), eZDBInterface\reportError(), eZScript\startup(), updateSettings(), and writeFile().

eZDebug::setIsGlobalLogFileEnabled ( $ enabled )

Sets whether logfiles are enabled or disabled globally. Sets the value to $enabled.

See also:: isLogFileEnabled, isGlobalLogFileEnabled

Definition at line 968 of file ezdebug.php.

eZDebug::setIsLogFileEnabled	(	$	type,
		$	enabled
	)

Sets whether the logfile $type is enabled or disabled to $enabled.

See also:: isLogFileEnabled

Definition at line 959 of file ezdebug.php.

static eZDebug::setLogFileEnabled	(	$	enabled,
		$	types = `false`
	)		`[static]`

Enables or disables logging to file for a given message type. If $types is not supplied it will do the operation for all types.

Definition at line 918 of file ezdebug.php.

Referenced by writeFile().

eZDebug::setLogOnly ( $ enabled )

Sets whether debug output should be logged only

Definition at line 976 of file ezdebug.php.

static eZDebug::setLogrotateFiles ( $ files ) [static]

Sets the maxium number of logrotate files to keep to $files.

Definition at line 805 of file ezdebug.php.

static eZDebug::setMaxLogSize ( $ size ) [static]

Sets the maxium size for a log file to $size.

Definition at line 783 of file ezdebug.php.

eZDebug::setMessageOutput ( $ output )

Determines the way messages are output, the $output parameter is self::OUTPUT_MESSAGE_SCREEN and self::OUTPUT_MESSAGE_STORE ored together.

Definition at line 644 of file ezdebug.php.

static eZDebug::setScriptStart ( $ time = false ) [static]

Sets the time of the start of the script ot $time. If $time is not supplied it gets the current microtime( true ). This is used to calculate total execution time and percentages.

Definition at line 1229 of file ezdebug.php.

eZDebug::setStoreLog ( $ store )

Definition at line 651 of file ezdebug.php.

static eZDebug::setUseExternalCSS ( $ use ) [static]

Enables/disables the use of external CSS. If false a <style> tag is output before the debug list. Default is to use internal css.

Definition at line 635 of file ezdebug.php.

static eZDebug::showMessage ( $ type ) [static]

Returns true if the message type $type can be shown.

Definition at line 234 of file ezdebug.php.

Referenced by addTimingPoint(), writeDebug(), writeError(), writeNotice(), writeStrict(), and writeWarning().

static eZDebug::showTypes ( $ types = false ) [static]

Sets types to be shown to $types and returns the old show types. If $types is not supplied the current value is returned and no change is done. $types is one or more of self::SHOW_NOTICE, self::SHOW_WARNING, self::SHOW_ERROR, self::SHOW_TIMING_POINT or'ed together.

Definition at line 310 of file ezdebug.php.

static eZDebug::timeToFloat ( $ mtime ) [static, private]

Returns the microtime as a float value. $mtime must be in microtime() format.

Definition at line 1216 of file ezdebug.php.

static eZDebug::updateSettings ( $ settings ) [static]

Updates the settings for debug handling with the settings array $settings. The array must contain the following keys.

debug-enabled - boolean which controls debug handling
debug-by-ip - boolean which controls IP controlled debugging
debug-ip-list - array of IPs which gets debug
debug-by-user - boolean which controls userID controlled debugging
debug-user-list - array of UserIDs which gets debug

Definition at line 1054 of file ezdebug.php.

Referenced by eZScript\updateDebugSettings().

eZDebug::write	(	$	string,
		$	verbosityLevel = `self::LEVEL_NOTICE`,
		$	label = `""`,
		$	backgroundClass = `""`,
		$	alwaysLog = `false`
	)		`[private]`

Writes a debug log message.

Definition at line 697 of file ezdebug.php.

static eZDebug::writeDebug	(	$	string,
		$	label = `""`,
		$	backgroundClass = `""`
	)		`[static]`

Writes a debug message.

The global variable 'eZDebugDebug' will be set to true if the notice is added.

Parameters:

$label This label will be associated with the notice, e.g. to say where the notice came from.

Definition at line 569 of file ezdebug.php.

Referenced by eZDBFileHandlerMysqlBackend\_getFileList(), eZDefaultVATHandler\chooseVatType(), eZContentClassPackageHandler\classDOMTree(), eZImageManager\createImageAlias(), eZImageAliasHandler\createImageInformationNode(), eZMySQLiDB\escapeString(), eZTemplate\fetch(), eZContentObjectPackageInstaller\finalize(), eZSearch\getEngine(), eZVATManager\getUserCountry(), eZDBPackageHandler\install(), eZPackage\install(), eZCodePageMapper\load(), eZTemplateDebugFunction\process(), eZTemplate\processFunction(), eZTemplate\processOperator(), eZTemplate\processURI(), eZObjectRelationListType\serializeContentObjectAttribute(), eZImageGDHandler\setImageColorThresholdName(), eZImageGDHandler\setImageLuminanceNamed(), eZContentObjectAssignmentHandler\setupAssignments(), eZPersistentObject\storeObject(), and eZContentCacheManager\writeDebugBits().

static eZDebug::writeError	(	$	string,
		$	label = `""`,
		$	backgroundClass = `""`
	)		`[static]`

Writes a debug error.

The global variable 'eZDebugError' will be set to true if the notice is added.

Parameters:

$label This label will be associated with the notice, e.g. to say where the notice came from.

Definition at line 526 of file ezdebug.php.

eZDebug::writeFile	(	&$	logFileData,
		&$	string,
		$	verbosityLevel,
		$	alwaysLog = `false`
	)		`[private]`

Writes the log message $string to the file $fileName.

Definition at line 854 of file ezdebug.php.

Referenced by write().

static eZDebug::writeNotice	(	$	string,
		$	label = `""`,
		$	backgroundClass = `""`
	)		`[static]`

Writes a debug notice.

The global variable 'eZDebugNotice' will be set to true if the notice is added.

Parameters:

$label	This label will be associated with the notice, e.g. to say where the notice came from.
$backgroundClass	A string defining the class to use in the HTML debug output.

Definition at line 440 of file ezdebug.php.

Referenced by eZDBFileHandlerMysqlBackend\_report(), eZINI\appendOverrideDir(), eZLocale\countryFile(), eZContentObjectTreeNode\createAttributeFilterSQLStrings(), eZWizardBaseClassLoader\createClass(), eZPDF\createPDF(), eZContentUpload\detectLocations(), eZPackageHandler\errorChoosenAction(), errorHandler(), eZDiff\eZDiff(), eZMediaType\fetchObjectAttributeHTTPInput(), eZDefaultVATHandler\getProductCategory(), eZVATManager\getVAT(), eZTemplateFileResource\handleResourceData(), eZINIAddonPackageHandler\iniDOMTree(), eZSys\init(), eZIniSettingType\initializeObjectAttribute(), eZContentClassPackageHandler\install(), eZLocale\languageFile(), eZINI\loadCache(), eZLocale\localeFile(), eZPDF\modify(), eZTreeMenuOperator\modify(), eZIniSettingType\onPublish(), eZINI\parseFile(), eZTextInputParser\parseText(), eZINI\prependOverrideDir(), eZLDAPUser\publishUpdateUser(), eZDBInterface\reportQuery(), eZTemplate\resourceFor(), eZINI\saveCache(), eZObjectRelationType\serializeContentObjectAttribute(), eZDiff\setDiffEngineType(), eZWizardBase\setMetaData(), eZVATManager\setUserCountry(), eZMutex\steal(), eZStaticCache\storeCache(), eZContentObjectTreeNode\subTreeByNodeID(), eZContentObjectTreeNode\subTreeCountByNodeID(), eZContentClassPackageHandler\uninstall(), eZContentObjectPackageHandler\uninstall(), eZContentObject\unserialize(), eZBinaryFileType\unserializeContentObjectAttribute(), eZMediaType\unserializeContentObjectAttribute(), eZIniSettingType\validateClassAttributeHTTPInput(), eZFloatType\validateClassAttributeHTTPInput(), eZIntegerType\validateClassAttributeHTTPInput(), and eZContentObject\versionLanguageName().

static eZDebug::writeStrict	(	$	string,
		$	label = `""`,
		$	backgroundClass = `""`
	)		`[static]`

Writes a strict debug message.

The global variable 'eZDebugStrict' will be set to true if the notice is added.

Parameters:

$label	This label will be associated with the strict message, e.g. to say where the message came from.
$backgroundClass	A string defining the class to use in the HTML debug output.

Definition at line 395 of file ezdebug.php.

Referenced by errorHandler().