lib/ezutils/classes/ezdebug.php
Classes
File containing the eZDebug class.
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- lib
- Version
- 4.6.0
\eZDebug
Package: lib
File containing the eZDebug class.
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Version
- 4.6.0
Constants
LEVEL_NOTICE
= 1
LEVEL_WARNING
= 2
LEVEL_ERROR
= 3
LEVEL_TIMING_POINT
= 4
LEVEL_DEBUG
= 5
LEVEL_STRICT
= 6
SHOW_NOTICE
= 1
SHOW_WARNING
= 2
SHOW_ERROR
= 4
SHOW_TIMING_POINT
= 8
SHOW_DEBUG
= 16
SHOW_STRICT
= 32
SHOW_ALL
= 63
HANDLE_NONE
= 0
HANDLE_FROM_PHP
= 1
HANDLE_TO_PHP
= 2
HANDLE_EXCEPTION
= 3
OUTPUT_MESSAGE_SCREEN
= 1
OUTPUT_MESSAGE_STORE
= 2
MAX_LOGFILE_SIZE
= 204800
MAX_LOGROTATE_FILES
= 3
XDEBUG_SIGNATURE
= '--XDEBUG--'
Properties
$DebugStrings= 'array()'
Default value
array()Details- Type
- n/a
$GlobalLogFileEnabled= ''
Details
- Type
- n/a
$HandleType= ''
Details
- Type
- n/a
$LogFileEnabled= ''
Details
- Type
- n/a
$LogFiles= ''
Details
- Type
- n/a
$MessageOutput= ''
Details
- Type
- n/a
$MessageTypes= ''
Details
- Type
- n/a
$OutputFormat= ''
Details
- Type
- n/a
$OverrideList= ''
Details
- Type
- n/a
$PercentAccuracy= '4'
Default value
4Details- Type
- n/a
$ScriptStart= ''
Details
- Type
- n/a
$ShowTypes= ''
Details
- Type
- n/a
$TimeAccumulatorList= 'array()'
Default value
array()Details- Type
- n/a
$TimePoints= 'array()'
Default value
array()Details- Type
- n/a
$TimingAccuracy= '4'
Default value
4Details- Type
- n/a
$TmpTimePoints= ''
Details
- Type
- n/a
$UseCSS= ''
Details
- Type
- n/a
$bottomReportsList= ''
Details
- Type
- n/a
$recursionFlag= 'false'
Default value
falseDetails- Type
- n/a
$topReportsList= ''
Details
- Type
- n/a
Methods
__construct(
)
:
voidaccumulatorStart(
$key, $inGroup
=
false, $name
=
false, $recursive
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $key | ||
| $inGroup | ||
| $name | ||
| $recursive |
accumulatorStop(
$key, $recursive
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $key | ||
| $recursive |
addTimingPoint(
$description
=
""
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $description |
alwaysLogMessage(
$level
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $level |
appendBottomReport(
$reportName, $reportContent
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $reportName | ||
| $reportContent |
appendTopReport(
$reportName, $reportContent
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $reportName | ||
| $reportContent |
checkDebugByUser(
)
:
void
static
createAccumulator(
$key, $inGroup
=
false, $name
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $key | ||
| $inGroup | ||
| $name |
createAccumulatorGroup(
$key, $name
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $key | ||
| $name |
dumpVariable(
$var
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $var |
errorHandler(
$errno, $errstr, $errfile, $errline
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $errno | ||
| $errstr | ||
| $errfile | ||
| $errline |
exceptionErrorHandler(
$errno, $errstr, $errfile, $errline
)
:
void
static
Exception based error handler, very basic
Parameters
Throws
Details
| Name | Type | Description |
|---|---|---|
| $errno | ||
| $errstr | ||
| $errfile | ||
| $errline |
| Exception | Description |
|---|---|
| \ErrorException |
- Since
- 4.5
instance(
)
:
\eZDebug
static
Returns a shared instance of the eZDebug class.
Returns
| Type | Description |
|---|---|
| \eZDebug |
isAllowedByCurrentIP(
$allowedIpList
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $allowedIpList |
isDebugAllowed(
)
:
voidisDebugEnabled(
)
:
void
static
isGlobalLogFileEnabled(
)
:
voidisIPInNet(
$ipaddress, $network, $mask
=
24
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $ipaddress | ||
| $network | ||
| $mask |
isLogFileEnabled(
$type
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $type |
isLogOnlyEnabled(
)
:
void
static
logFiles(
)
:
voidmaxLogSize(
)
:
void
static
maxLogrotateFiles(
)
:
void
static
messageName(
$messageType
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $messageType |
messageTypes(
)
:
voidprintBottomReportsList(
bool $as_html
=
true
)
:
void
static
Loop over all bottom reports and if callable call them with $as_html parameter, if not output as is (string).
Parameters
| Name | Type | Description |
|---|---|---|
| $as_html | bool |
printReport(
$newWindow
=
false, $as_html
=
true, $returnReport
=
false, $allowedDebugLevels
=
false, $useAccumulators
=
true, $useTiming
=
true, $useIncludedFiles
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $newWindow | ||
| $as_html | ||
| $returnReport | ||
| $allowedDebugLevels | ||
| $useAccumulators | ||
| $useTiming | ||
| $useIncludedFiles |
printReportInternal(
$as_html
=
true, $returnReport
=
true, $allowedDebugLevels
=
false, $useAccumulators
=
true, $useTiming
=
true, $useIncludedFiles
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $as_html | ||
| $returnReport | ||
| $allowedDebugLevels | ||
| $useAccumulators | ||
| $useTiming | ||
| $useIncludedFiles |
printTopReportsList(
)
:
void
static
recursionProtectErrorHandler(
$errno, $errstr, $errfile, $errline
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $errno | ||
| $errstr | ||
| $errfile | ||
| $errline |
reset(
)
:
voidrotateLog(
$fileName
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $fileName |
setHandleType(
$type
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $type |
setIsGlobalLogFileEnabled(
$enabled
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $enabled |
setIsLogFileEnabled(
$type, $enabled
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $type | ||
| $enabled |
setLogFileEnabled(
$enabled, $types
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $enabled | ||
| $types |
setLogOnly(
$enabled
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $enabled |
setLogrotateFiles(
$files
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $files |
setMaxLogSize(
$size
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $size |
setMessageOutput(
$output
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $output |
setScriptStart(
$time
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $time |
setStoreLog(
$store
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $store |
setUseExternalCSS(
$use
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $use |
showMessage(
$type
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $type |
showTypes(
$types
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $types |
timeToFloat(
$mtime
)
:
void
static
Returns the microtime as a float value. $mtime must be in microtime() format.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $mtime |
- Deprecated
- Since 4.4.0, use microtime( true ) instead
updateSettings(
$settings
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $settings |
write(
$string, $verbosityLevel
=
self::LEVEL_NOTICE, $label
=
"", $backgroundClass
=
"", $alwaysLog
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $string | ||
| $verbosityLevel | ||
| $label | ||
| $backgroundClass | ||
| $alwaysLog |
writeDebug(
$string, $label
=
"", $backgroundClass
=
""
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $string | ||
| $label | ||
| $backgroundClass |
writeError(
$string, $label
=
"", $backgroundClass
=
""
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $string | ||
| $label | ||
| $backgroundClass |
writeFile(
$logFileData, $string, $verbosityLevel, $alwaysLog
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $logFileData | ||
| $string | ||
| $verbosityLevel | ||
| $alwaysLog |
writeNotice(
$string, $label
=
"", $backgroundClass
=
""
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $string | ||
| $label | ||
| $backgroundClass |
writeStrict(
$string, $label
=
"", $backgroundClass
=
""
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $string | ||
| $label | ||
| $backgroundClass |
writeWarning(
$string, $label
=
"", $backgroundClass
=
""
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $string | ||
| $label | ||
| $backgroundClass |