eZPublish(LegacyStack)  5.1
eZDebugSetting Class Reference

Provides conditional debug output. More...

Static Public Member Functions

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

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

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
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 . '>'

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

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

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

Referenced by eZDFSFileHandler\__construct(), ezpKernelWeb\__construct(), eZDFSFileHandlerMySQLiBackend\_checkCacheGenerationTimeout(), eZDFSFileHandlerMySQLiBackend\_fetch(), eZUser\_loginUser(), eZDFSFileHandlerMySQLiBackend\_startCacheGeneration(), eZDFSFileHandler\abortCacheGeneration(), eZSimplifiedXMLInputParser\appendLineParagraph(), eZSearch\buildSearchArray(), eZTemplateTreeCache\cachedTree(), eZContentObject\canCreateClassList(), eZContentObjectTreeNode\canCreateClassList(), eZContentClass\canInstantiateClassList(), eZSiteAccess\change(), eZApproveType\checkApproveCollaboration(), eZDFSFileHandler\checkCacheGenerationTimeout(), eZSSLZone\checkModuleView(), eZSSLZone\checkNodePath(), eZClusterFileHandler\cleanupEmptyDirectories(), eZSSLZone\clearCache(), eZContentCacheManager\clearObjectViewCache(), eZContentCacheManager\clearObjectViewCacheArray(), eZContentObject\copy(), eZContentObject\copyVersion(), eZNotificationEventType\create(), eZNotificationEvent\create(), eZUser\createHash(), eZFSFileHandler\delete(), eZDFSFileHandler\delete(), eZFSFileHandler\deleteLocal(), eZDFSFileHandler\deleteLocal(), ezpKernelWeb\dispatchLoop(), eZDFSFileHandler\endCacheGeneration(), eZApproveType\execute(), eZContentCache\exists(), eZFSFileHandler\exists(), eZDFSFileHandler\exists(), eZFSFileHandler\eZFSFileHandler(), eZPostgreSQLDB\eZPostgreSQLDB(), eZFSFileHandler\fetch(), eZFSFileHandler\fetchContents(), eZDFSFileHandler\fetchContents(), eZWorkflow\fetchEventIndexed(), eZCollaborationItem\fetchListTool(), eZUserType\fetchObjectAttributeHTTPInput(), eZFSFileHandler\fetchUnique(), eZDFSFileHandler\fetchUnique(), eZFSFileHandler\fileCopy(), eZDFSFileHandler\fileCopy(), eZFSFileHandler\fileDelete(), eZDFSFileHandler\fileDelete(), eZFSFileHandler\fileDeleteByDirList(), eZDFSFileHandler\fileDeleteByDirList(), eZFSFileHandler\fileDeleteByWildcard(), eZDFSFileHandler\fileDeleteByWildcard(), eZFSFileHandler\fileDeleteLocal(), eZDFSFileHandler\fileDeleteLocal(), eZFSFileHandler\fileExists(), eZDFSFileHandler\fileExists(), eZFSFileHandler\fileFetch(), eZDFSFileHandler\fileFetch(), eZFSFileHandler\fileFetchContents(), eZDFSFileHandler\fileFetchContents(), eZFSFileHandler\fileLinkCopy(), eZDFSFileHandler\fileLinkCopy(), eZFSFileHandler\fileMove(), eZDFSFileHandler\fileMove(), eZFSFileHandler\fileStore(), eZDFSFileHandler\fileStore(), eZFSFileHandler\fileStoreContents(), eZDFSFileHandler\fileStoreContents(), eZSearch\getEngine(), 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(), eZDFSFileHandler\move(), eZFSFileHandler\mtime(), eZDFSFileHandler\mtime(), eZFSFileHandler\name(), eZDFSFileHandler\name(), eZUserType\objectAttributeContent(), eZFSFileHandler\passthrough(), eZDFSFileHandler\passthrough(), eZFSFileHandler\processCache(), eZDFSFileHandler\processCache(), eZDFSFileHandler\purge(), eZContentObject\relatedContentObjectCount(), eZContentObject\relatedContentObjectList(), eZContentCache\restore(), eZWorkflowProcess\run(), eZSubTreeHandler\sendMessage(), eZContentOperationCollection\sendToPublishingQueue(), eZWebDAVContentBackend\setCurrentSite(), eZNotificationSchedule\setDateForItem(), eZFSFileHandler\size(), eZDFSFileHandler\size(), eZDFSFileHandler\startCacheGeneration(), eZFSFileHandler\stat(), eZDFSFileHandler\stat(), eZDFSFileHandler\storeCache(), 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

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

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

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


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