eZDebugSetting Class Reference

Conditional debug output. More...

List of all members.

Public Member Functions
	eZDebugSetting ()
Static Public Member Functions
	addTimingPoint ($conditionName, $label="")
	changeLabel ($conditionName, $label)
	isConditionTrue ($conditionName, $messageType)
	setDebugINI ($ini)
	writeDebug ($conditionName, $string, $label="")
	writeError ($conditionName, $string, $label="")
	writeNotice ($conditionName, $string, $label="")
	writeWarning ($conditionName, $string, $label="")

---

Detailed Description

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 68 of file ezdebugsetting.php.

---

Member Function Documentation

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

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

Definition at line 162 of file ezdebugsetting.php.

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

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

Definition at line 106 of file ezdebugsetting.php.

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

eZDebugSetting::eZDebugSetting

(

)

Constructor

Definition at line 73 of file ezdebugsetting.php.

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

Returns:

true if the condition $conditionName is considered enabled.

Definition at line 81 of file ezdebugsetting.php.

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

eZDebugSetting::setDebugINI

(

$

ini

)

[static]

Sets the INI object

Definition at line 173 of file ezdebugsetting.php.

Referenced by eZScript::initialize().

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

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

Definition at line 151 of file ezdebugsetting.php.

Referenced by eZSearch::buildSearchArray(), eZTemplateTreeCache::cachedTree(), eZContentObjectTreeNode::canCreateClassList(), eZContentObject::canCreateClassList(), eZContentClass::canInstantiateClassList(), eZSSLZone::checkModuleView(), eZSSLZone::checkNodePath(), eZSSLZone::clearCache(), eZContentCacheManager::clearObjectViewCache(), eZContentClass::contentObjectName(), eZContentObject::copy(), eZContentObject::copyVersion(), eZNotificationEventType::create(), eZNotificationEvent::create(), eZUser::createHash(), eZFSFileHandler::delete(), eZDBFileHandler::delete(), eZFSFileHandler::deleteLocal(), eZDBFileHandler::deleteLocal(), eZApproveType::execute(), eZFSFileHandler::exists(), eZDBFileHandler::exists(), eZContentCache::exists(), eZDBFileHandler::eZDBFileHandler(), eZFSFileHandler::eZFSFileHandler(), eZPostgreSQLDB::eZPostgreSQLDB(), eZFSFileHandler::fetch(), eZDBFileHandler::fetch(), eZFSFileHandler::fetchContents(), eZDBFileHandler::fetchContents(), eZWorkflow::fetchEventIndexed(), eZCollaborationItem::fetchListTool(), eZUserType::fetchObjectAttributeHTTPInput(), eZFSFileHandler::fetchUnique(), eZDBFileHandler::fetchUnique(), eZFSFileHandler::fileCopy(), eZDBFileHandler::fileCopy(), eZFSFileHandler::fileDelete(), eZDBFileHandler::fileDelete(), eZFSFileHandler::fileDeleteByDirList(), eZDBFileHandler::fileDeleteByDirList(), eZFSFileHandler::fileDeleteByRegex(), eZDBFileHandler::fileDeleteByRegex(), eZFSFileHandler::fileDeleteByWildcard(), eZDBFileHandler::fileDeleteByWildcard(), eZFSFileHandler::fileDeleteLocal(), eZDBFileHandler::fileDeleteLocal(), eZFSFileHandler::fileExists(), eZDBFileHandler::fileExists(), eZFSFileHandler::fileFetch(), eZDBFileHandler::fileFetch(), eZFSFileHandler::fileFetchContents(), eZDBFileHandler::fileFetchContents(), eZFSFileHandler::fileLinkCopy(), eZDBFileHandler::fileLinkCopy(), eZFSFileHandler::fileMove(), eZDBFileHandler::fileMove(), eZFSFileHandler::fileStore(), eZDBFileHandler::fileStore(), eZFSFileHandler::fileStoreContents(), eZDBFileHandler::fileStoreContents(), eZDBFileHandler::getFileList(), eZContentObjectTreeNode::getLimitationList(), eZSubTreeHandler::handle(), eZGeneralDigestHandler::handle(), eZCollaborationNotificationHandler::handle(), eZTemplateCompiler::hasCompiledTemplate(), eZWeb::init(), eZPublishType::initializeEvent(), eZCurrentTimeType::initializeEvent(), eZCollaborationEventType::initializeEvent(), eZNotificationEvent::initializeEventType(), eZSSLZone::isKeepModeView(), eZPolicy::limitationList(), eZUser::loginUser(), eZTextFileUser::loginUser(), eZLDAPUser::loginUser(), eZFSFileHandler::move(), eZDBFileHandler::move(), eZFSFileHandler::mtime(), eZDBFileHandler::mtime(), eZFSFileHandler::name(), eZDBFileHandler::name(), eZUserType::objectAttributeContent(), eZFSFileHandler::passthrough(), eZDBFileHandler::passthrough(), eZContentObject::relatedContentObjectCount(), eZContentObject::relatedContentObjectList(), eZContentCache::restore(), eZWorkflowProcess::run(), eZSubTreeHandler::sendMessage(), eZWebDAVContentServer::setCurrentSite(), eZNotificationSchedule::setDateForItem(), eZFSFileHandler::size(), eZDBFileHandler::size(), eZFSFileHandler::stat(), eZDBFileHandler::stat(), eZFSFileHandler::storeContents(), eZDBFileHandler::storeContents(), eZCollaborationGroup::subTree(), eZSSLZone::switchIfNeeded(), eZDBSchemaInterface::transformData(), eZDBSchemaInterface::transformSchema(), and eZContentObjectTreeNode::updateSubTreePath().

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

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

Definition at line 140 of file ezdebugsetting.php.

Referenced by eZGZIPShellCompressionHandler::doSeek(), eZWaitUntilDateType::execute(), and eZApproveType::execute().

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

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

Definition at line 118 of file ezdebugsetting.php.

Referenced by eZTSTranslator::loadTranslationFile().

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

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

Definition at line 129 of file ezdebugsetting.php.

Referenced by eZContentObjectTreeNode::createClassFilteringSQLString(), and eZContentObjectTreeNode::subTreeCount().

---

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

• ezdebugsetting.php