eZ Publish  [trunk]
Static Public Member Functions
eZDebugSetting Class Reference

Provides conditional debug output. More...

List of all members.

Static Public Member Functions

static addTimingPoint ($conditionName, $label="")
 Adds the timing point if the condition $conditionName is enabled.
static changeLabel ($conditionName, $label= '')
 Creates a new debug label from the original and the condition and returns it.
static isConditionTrue ($conditionName, $messageType)
 Returns true if the condition $conditionName is considered enabled.
static setDebugINI ($ini)
 Sets the INI object.
static writeDebug ($conditionName, $string, $label="")
 Writes a debug message if the condition $conditionName is enabled.
static writeError ($conditionName, $string, $label="")
 Writes a debug error if the condition $conditionName is enabled.
static writeNotice ($conditionName, $string, $label="")
 Writes a debug notice if the condition $conditionName is enabled.
static writeWarning ($conditionName, $string, $label="")
 Writes a debug warning if the condition $conditionName is enabled.

Detailed Description

Provides conditional debug output.

This works as a wrapper for the eZDebug class by checking some conditions defined in site.ini before writing the message. The condition must be true for the message to be written.

It will check the debug.ini file and first see if conditions are enabled globally by reading DebugSettings/ConditionDebug. If true if will then see if the condition exists in the GeneralCondition group, if so it will use it for condition check. If it doesn't exists generally it will check it specifically according to the message type for instance ErrorCondition, DebugCondition etc.

Example of debug.ini: [DebugSettings] ConditionDebug=enabled

[GeneralCondition] my-flag=enabled other-flag=disabled

[ErrorCondition] bad-name-flag=disabled

Definition at line 38 of file ezdebugsetting.php.

Member Function Documentation

static eZDebugSetting::addTimingPoint ( $  conditionName,
$  label = "" 
) [static]

Adds the timing point if the condition $conditionName is enabled.

Parameters:
string$conditionNameName of the condition
string$labelOptional label

Definition at line 140 of file ezdebugsetting.php.

static eZDebugSetting::changeLabel ( $  conditionName,
$  label = '' 
) [static]

Creates a new debug label from the original and the condition and returns it.

Parameters:
string$conditionNameName of the condition
string$labelOptional label
Returns:
string $label . '<' . $conditionName . '>'

Definition at line 70 of file ezdebugsetting.php.

Referenced by addTimingPoint(), eZSimplifiedXMLInput\inputXML(), eZXMLInputParser\process(), eZXMLInputParser\processNewElements(), eZXMLInputParser\processSubtree(), writeDebug(), writeError(), writeNotice(), and writeWarning().

static eZDebugSetting::isConditionTrue ( $  conditionName,
$  messageType 
) [static]

Returns true if the condition $conditionName is considered enabled.

Parameters:
string$conditionNameName of the condition
Returns:
bool

Definition at line 47 of file ezdebugsetting.php.

Referenced by addTimingPoint(), eZSimplifiedXMLInput\inputXML(), eZXMLInputParser\process(), eZXMLInputParser\processNewElements(), eZXMLInputParser\processSubtree(), writeDebug(), writeError(), writeNotice(), and writeWarning().

static eZDebugSetting::setDebugINI ( $  ini) [static]

Sets the INI object.

Parameters:
eZINI$iniThe eZINI object to set.
Deprecated:
Since 4.5

Definition at line 154 of file ezdebugsetting.php.

Referenced by eZScript\initialize().

static eZDebugSetting::writeDebug ( $  conditionName,
$  string,
$  label = "" 
) [static]

Writes a debug message if the condition $conditionName is enabled.

Parameters:
string$conditionNameName of the condition
string$stringText to write
string$labelOptional label

Definition at line 127 of file ezdebugsetting.php.

Referenced by eZDBFileHandler\__construct(), eZDFSFileHandler\__construct(), eZDFSFileHandlerMySQLBackend\_checkCacheGenerationTimeout(), eZDFSFileHandlerMySQLiBackend\_checkCacheGenerationTimeout(), eZDBFileHandlerMysqlBackend\_checkCacheGenerationTimeout(), eZDBFileHandlerMysqliBackend\_checkCacheGenerationTimeout(), eZDBFileHandlerMysqlBackend\_endCacheGeneration(), eZDBFileHandlerMysqliBackend\_endCacheGeneration(), eZFS2FileHandler\_expire(), eZUser\_loginUser(), eZFS2FileHandler\_recursiveExpire(), eZDFSFileHandlerMySQLBackend\_startCacheGeneration(), eZDFSFileHandlerMySQLiBackend\_startCacheGeneration(), eZDBFileHandlerMysqlBackend\_startCacheGeneration(), eZDBFileHandlerMysqliBackend\_startCacheGeneration(), eZDBFileHandlerMysqlBackend\_verifyExclusiveLock(), eZDBFileHandlerMysqliBackend\_verifyExclusiveLock(), eZFS2FileHandler\abortCacheGeneration(), eZDFSFileHandler\abortCacheGeneration(), eZSimplifiedXMLInputParser\appendLineParagraph(), eZSearch\buildSearchArray(), eZTemplateTreeCache\cachedTree(), eZContentObject\canCreateClassList(), eZContentObjectTreeNode\canCreateClassList(), eZContentClass\canInstantiateClassList(), eZSiteAccess\change(), eZApproveType\checkApproveCollaboration(), eZFS2FileHandler\checkCacheGenerationTimeout(), eZDFSFileHandler\checkCacheGenerationTimeout(), eZSSLZone\checkModuleView(), eZSSLZone\checkNodePath(), eZClusterFileHandler\cleanupEmptyDirectories(), eZSSLZone\clearCache(), eZContentCacheManager\clearObjectViewCache(), eZContentObject\copy(), eZContentObject\copyVersion(), eZNotificationEventType\create(), eZNotificationEvent\create(), eZUser\createHash(), eZFS2FileHandler\delete(), eZFSFileHandler\delete(), eZDBFileHandler\delete(), eZDFSFileHandler\delete(), eZFS2FileHandler\deleteLocal(), eZFSFileHandler\deleteLocal(), eZDBFileHandler\deleteLocal(), eZDFSFileHandler\deleteLocal(), eZFS2FileHandler\endCacheGeneration(), eZDFSFileHandler\endCacheGeneration(), eZApproveType\execute(), eZContentCache\exists(), eZFS2FileHandler\exists(), eZFSFileHandler\exists(), eZDBFileHandler\exists(), eZDFSFileHandler\exists(), eZFSFileHandler\eZFSFileHandler(), eZPostgreSQLDB\eZPostgreSQLDB(), eZFSFileHandler\fetch(), eZDBFileHandler\fetch(), eZFSFileHandler\fetchContents(), eZDFSFileHandler\fetchContents(), eZDBFileHandler\fetchContents(), eZWorkflow\fetchEventIndexed(), eZCollaborationItem\fetchListTool(), eZUserType\fetchObjectAttributeHTTPInput(), eZFSFileHandler\fetchUnique(), eZDFSFileHandler\fetchUnique(), eZDBFileHandler\fetchUnique(), eZFSFileHandler\fileCopy(), eZDBFileHandler\fileCopy(), eZDFSFileHandler\fileCopy(), eZFS2FileHandler\fileDelete(), eZFSFileHandler\fileDelete(), eZDBFileHandler\fileDelete(), eZDFSFileHandler\fileDelete(), eZFS2FileHandler\fileDeleteByDirList(), eZFSFileHandler\fileDeleteByDirList(), eZDBFileHandler\fileDeleteByDirList(), eZDFSFileHandler\fileDeleteByDirList(), eZFSFileHandler\fileDeleteByRegex(), eZDBFileHandler\fileDeleteByRegex(), eZDFSFileHandler\fileDeleteByRegex(), eZFSFileHandler\fileDeleteByWildcard(), eZDBFileHandler\fileDeleteByWildcard(), eZDFSFileHandler\fileDeleteByWildcard(), eZFSFileHandler\fileDeleteLocal(), eZDBFileHandler\fileDeleteLocal(), eZDFSFileHandler\fileDeleteLocal(), eZFS2FileHandler\fileExists(), eZFSFileHandler\fileExists(), eZDBFileHandler\fileExists(), eZDFSFileHandler\fileExists(), eZFSFileHandler\fileFetch(), eZDBFileHandler\fileFetch(), eZDFSFileHandler\fileFetch(), eZFSFileHandler\fileFetchContents(), eZDFSFileHandler\fileFetchContents(), eZDBFileHandler\fileFetchContents(), eZFSFileHandler\fileLinkCopy(), eZDBFileHandler\fileLinkCopy(), eZDFSFileHandler\fileLinkCopy(), eZFSFileHandler\fileMove(), eZDBFileHandler\fileMove(), eZDFSFileHandler\fileMove(), eZDBFileHandler\fileStore(), eZFSFileHandler\fileStore(), eZDFSFileHandler\fileStore(), eZDBFileHandler\fileStoreContents(), eZFSFileHandler\fileStoreContents(), eZDFSFileHandler\fileStoreContents(), eZSearch\getEngine(), eZDBFileHandler\getFileList(), eZDFSFileHandler\getFileList(), eZContentObjectTreeNode\getLimitationList(), eZSubTreeHandler\handle(), eZCollaborationNotificationHandler\handle(), eZGeneralDigestHandler\handle(), handleNodeTemplate(), eZTemplateCompiler\hasCompiledTemplate(), eZCurrentTimeType\initializeEvent(), eZPublishType\initializeEvent(), eZCollaborationEventType\initializeEvent(), eZNotificationEvent\initializeEventType(), eZSSLZone\isKeepModeView(), eZPolicy\limitationList(), eZFSFileHandler\loadMetaData(), eZTSTranslator\loadTranslationFile(), eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), eZSiteAccess\match(), eZFSFileHandler\move(), eZDBFileHandler\move(), eZDFSFileHandler\move(), eZFSFileHandler\mtime(), eZDBFileHandler\mtime(), eZDFSFileHandler\mtime(), eZFSFileHandler\name(), eZDBFileHandler\name(), eZDFSFileHandler\name(), eZUserType\objectAttributeContent(), eZFSFileHandler\passthrough(), eZDBFileHandler\passthrough(), eZDFSFileHandler\passthrough(), eZFS2FileHandler\processCache(), eZDBFileHandler\processCache(), eZFSFileHandler\processCache(), eZDFSFileHandler\processCache(), eZDFSFileHandler\purge(), eZContentObject\relatedContentObjectCount(), eZContentObject\relatedContentObjectList(), eZFS2FileHandler\remainingCacheGenerationTime(), eZContentCache\restore(), eZWorkflowProcess\run(), eZSubTreeHandler\sendMessage(), eZContentOperationCollection\sendToPublishingQueue(), eZWebDAVContentServer\setCurrentSite(), eZWebDAVContentBackend\setCurrentSite(), eZNotificationSchedule\setDateForItem(), eZFSFileHandler\size(), eZDBFileHandler\size(), eZDFSFileHandler\size(), eZFS2FileHandler\startCacheGeneration(), eZDFSFileHandler\startCacheGeneration(), eZFSFileHandler\stat(), eZDBFileHandler\stat(), eZDFSFileHandler\stat(), eZFS2FileHandler\storeCache(), eZDBFileHandler\storeCache(), eZDFSFileHandler\storeCache(), eZDBFileHandler\storeContents(), eZFSFileHandler\storeContents(), eZDFSFileHandler\storeContents(), storeNodeAssignments(), eZCollaborationGroup\subTree(), eZSSLZone\switchIfNeeded(), eZDBSchemaInterface\transformData(), eZDBSchemaInterface\transformSchema(), eZURLWildcard\translate(), eZURLWildcard\translateWithCache(), and eZSimplifiedXMLInput\validateInput().

static eZDebugSetting::writeError ( $  conditionName,
$  string,
$  label = "" 
) [static]

Writes a debug error if the condition $conditionName is enabled.

Parameters:
string$conditionNameName of the condition
string$stringText to write
string$labelOptional label

Definition at line 113 of file ezdebugsetting.php.

Referenced by eZGZIPShellCompressionHandler\doSeek(), eZWaitUntilDateType\execute(), eZApproveType\execute(), and eZClusterEventLoggerEzdebug\logError().

static eZDebugSetting::writeNotice ( $  conditionName,
$  string,
$  label = "" 
) [static]

Writes a debug notice if the condition $conditionName is enabled.

Parameters:
string$conditionNameName of the condition
string$stringText to write
string$labelOptional label

Definition at line 85 of file ezdebugsetting.php.

Referenced by eZUserOperationCollection\checkActivation(), eZTSTranslator\loadTranslationFile(), eZUserOperationCollection\publishUserContentObject(), eZUserOperationCollection\sendActivationEmail(), eZUserOperationCollection\sendUserNotification(), eZPackage\storeDOM(), and eZPackage\storeString().

static eZDebugSetting::writeWarning ( $  conditionName,
$  string,
$  label = "" 
) [static]

Writes a debug warning if the condition $conditionName is enabled.

Parameters:
string$conditionNameName of the condition
string$stringText to write
string$labelOptional label

Definition at line 99 of file ezdebugsetting.php.

Referenced by eZContentObjectTreeNode\createClassFilteringSQLString(), and eZContentObjectTreeNode\subTreeCountByNodeID().

The documentation for this class was generated from the following file: