eZDebug Class Reference
[Utility classes]

Advanced debug/log system. More...

List of all members.

Public Member Functions

 accumulatorStart ($key, $inGroup=false, $name=false, $recursive=false)
 accumulatorStop ($key, $recursive=false)
 addTimingPoint ($description="")
 alwaysLogMessage ($level)
 appendBottomReport ($reportName, &$reportContent)
 appendTopReport ($reportName, &$reportContent)
 createAccumulator ($key, $inGroup=false, $name=false)
 createAccumulatorGroup ($key, $name=false)
 errorHandler ($errno, $errstr, $errfile, $errline)
 eZDebug ()
& instance ()
 isGlobalLogFileEnabled ()
 isLogFileEnabled ($type)
& logFiles ()
 messageName ($messageType)
 messageTypes ()
 printBottomReportsList ()
 printTopReportsList ()
 reset ()
 setHandleType ($type)
 setIsGlobalLogFileEnabled ($enabled)
 setIsLogFileEnabled ($type, $enabled)
 setLogOnly ($enabled)
 setMessageOutput ($output)
 setScriptStart ($mtime=false)
 setStoreLog ($store)
 setUseExternalCSS ($use)

Static Public Member Functions

 checkDebugByUser ()
 isDebugEnabled ()
 isIPInNet ($ipaddress, $network, $mask=24)
 isLogOnlyEnabled ()
 maxLogrotateFiles ()
 maxLogSize ()
 printReport ($newWindow=false, $as_html=true, $returnReport=false, $allowedDebugLevels=false, $useAccumulators=true, $useTiming=true, $useIncludedFiles=false)
 rotateLog ($fileName)
 setLogFileEnabled ($enabled, $types=false)
 setLogrotateFiles ($files)
 setMaxLogSize ($size)
 showMessage ($type)
 showTypes ($types=false)
 updateSettings ($settings)
 writeDebug ($string, $label="", $backgroundClass="")
 writeError ($string, $label="", $backgroundClass="")
 writeNotice ($string, $label="", $backgroundClass="")
 writeWarning ($string, $label="", $backgroundClass="")

Private Member Functions

 printReportInternal ($as_html=true, $returnReport=true, $allowedDebugLevels=false, $useAccumulators=true, $useTiming=true, $useIncludedFiles=false)
 timeToFloat ($mtime)
 write ($string, $verbosityLevel=EZ_LEVEL_NOTICE, $label="", $backgroundClass="", $alwaysLog=false)
 writeFile (&$logFileData, &$string, $verbosityLevel, $alwaysLog=false)

Static Private Member Functions

 dumpVariable ($var)

Private Attributes

 $bottomReportsList
 A list of debug reports that appears at the bottom of debug output.
 $DebugStrings = array()
 $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.

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().

  include_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 104 of file ezdebug.php.

Member Function Documentation

eZDebug::accumulatorStart ( $  key,
$  inGroup = false,
$  name = false,
$  recursive = false 
)

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

Definition at line 1272 of file ezdebug.php.

Referenced by eZMySQLDB::arrayQuery(), eZContentCacheManager::clearContentCache(), eZContentCacheManager::clearContentCacheIfNeeded(), eZContentCacheManager::clearObjectViewCache(), eZContentObjectAttribute::contentClassAttribute(), eZContentObjectAttribute::contentClassAttributeCanTranslate(), eZContentObjectAttribute::contentClassAttributeIdentifier(), eZContentObjectAttribute::contentClassAttributeIsInformationCollector(), eZContentObjectAttribute::contentClassAttributeIsRequired(), eZContentObjectAttribute::contentClassAttributeName(), eZTextCodec::convertCodepage(), eZTextCodec::convertCodepageMapper(), eZTextCodec::convertCodepageRev(), eZTextCodec::convertCodepageToUnicode(), eZTextCodec::convertMBString(), eZTextCodec::convertString(), eZTextCodec::convertUnicodeToCodepage(), eZTextCodec::convertUnicodeToUTF8(), eZTextCodec::convertUTF8ToUnicode(), eZFSFileHandler::delete(), eZTemplate::fetch(), eZFSFileHandler::fetchContents(), eZFSFileHandler::fileCopy(), eZFSFileHandler::fileDelete(), eZFSFileHandler::fileDeleteByDirList(), eZFSFileHandler::fileDeleteByRegex(), eZFSFileHandler::fileDeleteByWildcard(), eZFSFileHandler::fileExists(), eZFSFileHandler::fileFetchContents(), eZFSFileHandler::fileLinkCopy(), eZTemplateDesignResource::fileMatchingRules(), eZFSFileHandler::fileMove(), eZFSFileHandler::fileStoreContents(), eZContentCacheManager::generateObjectViewCache(), eZTemplateDesignResource::handleResource(), eZTemplateFileResource::handleResourceData(), eZTSTranslator::initialize(), eZTemplate::loadAndRegisterFunctions(), eZINI::loadCache(), eZFSFileHandler::loadMetaData(), eZTSTranslator::loadTranslationFile(), eZFSFileHandler::move(), eZTemplateMultiPassParser::parse(), eZINI::parseFile(), eZFSFileHandler::passthrough(), eZTemplateDebugFunction::process(), eZPostgreSQLDB::query(), eZMySQLDB::query(), and eZFSFileHandler::storeContents().

eZDebug::accumulatorStop ( $  key,
$  recursive = false 
)

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

Definition at line 1299 of file ezdebug.php.

Referenced by eZMySQLDB::arrayQuery(), eZContentCacheManager::clearContentCache(), eZContentCacheManager::clearContentCacheIfNeeded(), eZContentCacheManager::clearObjectViewCache(), eZContentObjectAttribute::contentClassAttribute(), eZContentObjectAttribute::contentClassAttributeCanTranslate(), eZContentObjectAttribute::contentClassAttributeIdentifier(), eZContentObjectAttribute::contentClassAttributeIsInformationCollector(), eZContentObjectAttribute::contentClassAttributeIsRequired(), eZContentObjectAttribute::contentClassAttributeName(), eZTextCodec::convertCodepage(), eZTextCodec::convertCodepageMapper(), eZTextCodec::convertCodepageRev(), eZTextCodec::convertCodepageToUnicode(), eZTextCodec::convertMBString(), eZTextCodec::convertString(), eZTextCodec::convertUnicodeToCodepage(), eZTextCodec::convertUnicodeToUTF8(), eZTextCodec::convertUTF8ToUnicode(), eZFSFileHandler::delete(), eZTemplate::fetch(), eZFSFileHandler::fetchContents(), eZFSFileHandler::fileCopy(), eZFSFileHandler::fileDelete(), eZFSFileHandler::fileDeleteByDirList(), eZFSFileHandler::fileDeleteByRegex(), eZFSFileHandler::fileDeleteByWildcard(), eZFSFileHandler::fileExists(), eZFSFileHandler::fileFetchContents(), eZFSFileHandler::fileLinkCopy(), eZTemplateDesignResource::fileMatchingRules(), eZFSFileHandler::fileMove(), eZFSFileHandler::fileStoreContents(), eZContentCacheManager::generateObjectViewCache(), eZTemplateDesignResource::handleResource(), eZTemplateFileResource::handleResourceData(), eZTSTranslator::initialize(), eZTemplate::loadAndRegisterFunctions(), eZINI::loadCache(), eZFSFileHandler::loadMetaData(), eZTSTranslator::loadTranslationFile(), eZFSFileHandler::move(), eZTemplateMultiPassParser::parse(), eZINI::parseFile(), eZFSFileHandler::passthrough(), eZTemplateDebugFunction::process(), eZPostgreSQLDB::query(), eZMySQLDB::query(), and eZFSFileHandler::storeContents().

eZDebug::addTimingPoint ( $  description = ""  ) 

Adds a new timing point for the benchmark report.

Definition at line 622 of file ezdebug.php.

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

eZDebug::alwaysLogMessage ( $  level  ) 
Returns:
true if the debug level $level should always log to file.

Definition at line 237 of file ezdebug.php.

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

eZDebug::appendBottomReport ( $  reportName,
&$  reportContent 
)

Appends report to 'bottom' reports list.

Definition at line 1785 of file ezdebug.php.

eZDebug::appendTopReport ( $  reportName,
&$  reportContent 
)

Appends report to 'top' reports list.

Definition at line 1762 of file ezdebug.php.

eZDebug::checkDebugByUser (  )  [static]

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

Definition at line 1101 of file ezdebug.php.

eZDebug::createAccumulator ( $  key,
$  inGroup = false,
$  name = false 
)

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 1244 of file ezdebug.php.

eZDebug::createAccumulatorGroup ( $  key,
$  name = false 
)

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

Definition at line 1225 of file ezdebug.php.

Referenced by eZMySQLDB::eZMySQLDB(), eZTemplate::eZTemplate(), and eZTSTranslator::initialize().

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

Dumps the variables contents using the var_dump function

Definition at line 558 of file ezdebug.php.

Referenced by writeDebug(), writeError(), writeNotice(), 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 328 of file ezdebug.php.

eZDebug::eZDebug (  ) 

Creates a new debug object.

Definition at line 109 of file ezdebug.php.

Referenced by instance().

& eZDebug::instance (  ) 

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

Definition at line 212 of file ezdebug.php.

Referenced by accumulatorStart(), accumulatorStop(), addTimingPoint(), alwaysLogMessage(), appendBottomReport(), appendTopReport(), createAccumulator(), createAccumulatorGroup(), eZDebugErrorHandler(), messageName(), printBottomReportsList(), printReport(), printTopReportsList(), setHandleType(), setLogFileEnabled(), setMessageOutput(), setScriptStart(), setStoreLog(), setUseExternalCSS(), showMessage(), showTypes(), writeDebug(), writeError(), writeNotice(), and writeWarning().

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 959 of file ezdebug.php.

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

eZDebug::isGlobalLogFileEnabled (  ) 
Returns:
true if the message type $type has logging to file enabled.
See also:
isLogFileEnabled, setIsGlobalLogFileEnabled

Definition at line 906 of file ezdebug.php.

Referenced by isLogFileEnabled().

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 989 of file ezdebug.php.

Referenced by eZUser::isUserIPInList(), and updateSettings().

eZDebug::isLogFileEnabled ( $  type  ) 
Returns:
true if the message type $type has logging to file enabled.
See also:
isGlobalLogFileEnabled, setIsLogFileEnabled

Definition at line 895 of file ezdebug.php.

Referenced by write(), and writeFile().

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 974 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 (EZ_LEVEL_NOTICE, EZ_LEVEL_WARNING or EZ_LEVEL_ERROR or EZ_LEVEL_DEBUG).

Definition at line 949 of file ezdebug.php.

Referenced by write().

eZDebug::maxLogrotateFiles (  )  [static]
Returns:
the maxium number of logrotate files to keep.

Definition at line 753 of file ezdebug.php.

Referenced by rotateLog().

eZDebug::maxLogSize (  )  [static]
Returns:
the maxium size for a log file in bytes.

Definition at line 732 of file ezdebug.php.

Referenced by writeFile().

eZDebug::messageName ( $  messageType  ) 
Returns:
the name of the message type.

Definition at line 198 of file ezdebug.php.

Referenced by eZDebugSetting::isConditionTrue().

eZDebug::messageTypes (  ) 
Returns:
an array with the available message types.

Definition at line 940 of file ezdebug.php.

eZDebug::printBottomReportsList (  ) 

Prints all 'bottom' reports

Definition at line 1794 of file ezdebug.php.

Referenced by printReportInternal().

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 1128 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 1333 of file ezdebug.php.

eZDebug::printTopReportsList (  ) 

Prints all 'top' reports

Definition at line 1771 of file ezdebug.php.

Referenced by printReportInternal().

eZDebug::reset (  ) 

Definition at line 182 of file ezdebug.php.

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 777 of file ezdebug.php.

Referenced by writeFile().

eZDebug::setHandleType ( $  type  ) 

Determines how PHP errors are handled. If $type is EZ_HANDLE_TO_PHP all error messages is sent to PHP using trigger_error(), if $type is EZ_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 EZ_HANDLE_NONE there is no error exchange between PHP and eZDebug.

Definition at line 264 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 924 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 915 of file ezdebug.php.

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 874 of file ezdebug.php.

Referenced by writeFile().

eZDebug::setLogOnly ( $  enabled  ) 

Sets whether debug output should be logged only

Definition at line 932 of file ezdebug.php.

eZDebug::setLogrotateFiles ( $  files  )  [static]

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

Definition at line 765 of file ezdebug.php.

eZDebug::setMaxLogSize ( $  size  )  [static]

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

Definition at line 744 of file ezdebug.php.

eZDebug::setMessageOutput ( $  output  ) 

Determines the way messages are output, the $output parameter is EZ_OUTPUT_MESSAGE_SCREEN and EZ_OUTPUT_MESSAGE_STORE ored together.

Definition at line 597 of file ezdebug.php.

eZDebug::setScriptStart ( $  mtime = false  ) 

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

Definition at line 1212 of file ezdebug.php.

eZDebug::setStoreLog ( $  store  ) 

Definition at line 609 of file ezdebug.php.

eZDebug::setUseExternalCSS ( $  use  ) 

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 583 of file ezdebug.php.

eZDebug::showMessage ( $  type  )  [static]

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

Definition at line 228 of file ezdebug.php.

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

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 EZ_SHOW_NOTICE, EZ_SHOW_WARNING, EZ_SHOW_ERROR, EZ_SHOW_TIMING_POINT or'ed together.

Definition at line 310 of file ezdebug.php.

eZDebug::timeToFloat ( $  mtime  )  [private]

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

Definition at line 1199 of file ezdebug.php.

Referenced by eZDebug(), printReportInternal(), and setScriptStart().

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 1010 of file ezdebug.php.

Referenced by eZScript::updateDebugSettings().

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

Writes a debug log message.

Definition at line 660 of file ezdebug.php.

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 517 of file ezdebug.php.

Referenced by eZCollaborationItemMessageLink::addMessage(), eZDefaultVATHandler::chooseVatType(), eZWaitUntilDateType::customWorkflowEventHTTPAction(), eZWaitUntilDateType::execute(), eZTemplate::fetch(), eZVATManager::getUserCountry(), eZFilePasstroughHandler::handleFileDownload(), eZDBPackageHandler::install(), eZTemplateDebugFunction::process(), eZTemplate::processFunction(), eZTemplate::processOperator(), eZTemplate::processURI(), eZProductCategory::remove(), eZWaitUntilDate::removeEntry(), eZVatRule::removeReferencesToProductCategory(), eZImageGDHandler::setImageColorThresholdName(), eZImageGDHandler::setImageLuminanceNamed(), eZContentObjectAssignmentHandler::setupAssignments(), eZPersistentObject::storeObject(), and eZContentCacheManager::writeDebugBits().

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 474 of file ezdebug.php.

Referenced by eZDBFileHandlerPgsqlBackend::_copy(), eZDBFileHandlerMysqlBackend::_copy(), eZDBFileHandlerPgsqlBackend::_delete(), eZDBFileHandlerMysqlBackend::_delete(), eZDBFileHandlerPgsqlBackend::_deleteByDirList(), eZDBFileHandlerMysqlBackend::_deleteByDirList(), eZDBFileHandlerPgsqlBackend::_deleteByLike(), eZDBFileHandlerMysqlBackend::_deleteByLike(), eZDBFileHandlerPgsqlBackend::_deleteByRegex(), eZDBFileHandlerMysqlBackend::_deleteByRegex(), eZDBFileHandlerPgsqlBackend::_deleteByWildcard(), eZDBFileHandlerMysqlBackend::_deleteByWildcard(), eZDBFileHandlerPgsqlBackend::_die(), eZDBFileHandlerMysqlBackend::_die(), eZTARArchiveHandler::_error(), eZDBFileHandlerMysqlBackend::_exists(), eZDBFileHandlerPgsqlBackend::_fetch(), eZDBFileHandlerMysqlBackend::_fetch(), eZDBFileHandlerMysqlBackend::_fetchContents(), eZDBFileHandlerPgsqlBackend::_fetchMetadata(), eZDBFileHandlerMysqlBackend::_fetchMetadata(), eZDBFileHandlerPgsqlBackend::_getFileList(), eZDBFileHandlerMysqlBackend::_getFileList(), eZDBFileHandlerMysqlBackend::_passThrough(), eZDBFileHandlerPgsqlBackend::_rename(), eZDBFileHandlerMysqlBackend::_rename(), eZDBFileHandlerPgsqlBackend::_store(), eZDBFileHandlerMysqlBackend::_store(), eZDBFileHandlerPgsqlBackend::_storeContents(), eZModule::actionParameter(), eZContentObject::addContentObjectRelation(), eZContentLanguage::addLanguage(), eZCollaborationItemMessageLink::addMessage(), Cpdf::addPngFromFile(), eZImageInterface::allocateColor(), eZPolicyLimitation::allValuesAsArrayWithNames(), eZCodeTemplate::apply(), eZXMLText::attribute(), eZXMLOutputHandler::attribute(), eZXMLInputHandler::attribute(), eZWorkflowType::attribute(), eZWizardBase::attribute(), eZWaitUntilDate::attribute(), eZURI::attribute(), eZTime::attribute(), eZTemplateSectionIterator::attribute(), eZSysInfo::attribute(), eZSys::attribute(), eZRangeOption::attribute(), eZPersistentObject::attribute(), eZPackageInstallationHandler::attribute(), eZPackageCreationHandler::attribute(), eZOption::attribute(), eZNotificationEventType::attribute(), eZNotificationEventHandler::attribute(), eZMultiOption::attribute(), eZModule::attribute(), eZMatrixDefinition::attribute(), eZMatrix::attribute(), eZLocale::attribute(), eZKeyword::attribute(), eZImageInterface::attribute(), eZHTTPFile::attribute(), eZEnum::attribute(), eZDiffContent::attribute(), eZDBInterface::attribute(), eZDateTime::attribute(), eZDate::attribute(), eZDataType::attribute(), eZContentUpload::attribute(), eZContentObjectTranslation::attribute(), eZContentBrowse::attribute(), eZCollaborationItemHandler::attribute(), eZBinaryFileHandler::attribute(), eZAuthor::attribute(), eZContentBrowse::browse(), eZPDFTable::callImage(), eZOrder::canModifyStatus(), eZImageHandler::changeFilePermissions(), eZSSLZone::checkModuleView(), eZSSLZone::checkNodeID(), eZSSLZone::checkObject(), eZDB::checkTransactionCounter(), eZDefaultVATHandler::chooseVatType(), eZContentObject::cleanupAllInternalDrafts(), eZContentObject::cleanupInternalDrafts(), eZFileHandler::close(), eZImageInterface::color(), eZDBInterface::commit(), eZPersistentObject::conditionTextByRow(), eZMySQLDB::connect(), eZDataType::contentActionList(), eZImageShellHandler::convert(), eZImageManager::convert(), eZImageGDHandler::convert(), eZFileHandler::copy(), eZDir::copy(), eZNodeAssignment::create(), eZImageManager::createAliasFromINI(), eZContentFunctions::createAndPublishObject(), eZContentObjectTreeNode::createAttributeFilterSQLStrings(), eZWizardBaseClassLoader::createClass(), eZImageTextLayer::createForText(), eZImageShellHandler::createFromINI(), eZImageGDHandler::createFromINI(), eZImageManager::createImageAlias(), eZObjectRelationListType::createNewObject(), eZImageVariation::createOriginal(), eZTemplateDesignResource::createOverrideCache(), eZWorkflowType::createType(), eZINIAddonPackageHandler::currentID(), eZObjectRelationType::customClassAttributeHTTPAction(), eZObjectRelationListType::customClassAttributeHTTPAction(), eZMatrixType::customClassAttributeHTTPAction(), eZEnumType::customClassAttributeHTTPAction(), eZOptionType::customObjectAttributeHTTPAction(), eZObjectRelationType::customObjectAttributeHTTPAction(), eZObjectRelationListType::customObjectAttributeHTTPAction(), eZMultiPriceType::customObjectAttributeHTTPAction(), eZMultiOptionType::customObjectAttributeHTTPAction(), eZMatrixType::customObjectAttributeHTTPAction(), eZAuthorType::customObjectAttributeHTTPAction(), eZWaitUntilDateType::customWorkflowEventHTTPAction(), eZPostgreSQLDB::databaseServerVersion(), eZCodeMapper::decodeCommand(), eZSOAPResponse::decodeStream(), eZFSFileHandler::delete(), eZXML::domTree(), eZGZIPZLIBCompressionHandler::doSeek(), eZXMLInputType::editorName(), eZSys::environmentVariable(), eZFileHandler::eof(), eZTemplate::error(), eZCodeMapper::error(), errorHandler(), eZOperationHandler::execute(), eZModuleOperationInfo::execute(), eZModuleFunctionInfo::execute(), eZFunctionHandler::execute(), eZFunctionHandler::executeAlias(), eZModuleOperationInfo::executeBody(), eZTemplateCompiler::executeCompilation(), eZCodeMapper::expandInheritance(), eZDB::eZDB(), eZDBFileHandler::eZDBFileHandler(), eZLocale::eZLocale(), eZMBStringMapper::eZMBStringMapper(), eZPostgreSQLDB::eZPostgreSQLDB(), eZTextCodec::eZTextCodec(), eZHTTPFile::fetch(), eZContentObject::fetch(), eZContentObject::fetchByNodeID(), eZXMLText::fetchHandler(), eZUser::fetchLoggedInList(), eZObjectRelationListType::fetchObjectAttributeHTTPInput(), eZMediaType::fetchObjectAttributeHTTPInput(), eZBinaryFileType::fetchObjectAttributeHTTPInput(), eZContentObjectPackageHandler::fetchObjectFromFile(), eZWorkflowType::fetchRegisteredTypes(), eZPgsqlSchema::fetchTableIndexes(), eZTemplateExecuteOperator::fetchTransform(), eZFSFileHandler::fileDelete(), eZFSFileHandler::fileDeleteByRegex(), eZFSFileHandler::fileStoreContents(), eZContentUpload::findHandler(), eZContentObjectTreeNode::findMainNode(), eZFileHandler::flush(), eZMutex::fp(), eZPgsqlSchema::generateAddIndexSql(), eZCodeMapper::generateCharsetMappingTable(), eZContentObjectPackageHandler::generateFetchAliasArray(), eZNodeviewfunctions::generateNodeView(), eZFile::getContents(), eZDefaultVATHandler::getProductCategory(), eZSSLZone::getSSLZones(), eZVATManager::getUserCountry(), eZVATManager::getUserCountryAttributeName(), eZLDAPUser::getUserGroupsTree(), eZLDAPUser::goAndPublishGroups(), eZINI::group(), eZCharTransform::groupCommands(), eZCollaborationItemHandler::handleCollaborationEvent(), eZTSTranslator::handleContextNode(), eZTSTranslator::handleMessageNode(), eZUser::hasAccessToView(), eZContentObjectEditHandler::initialize(), eZImageAliasHandler::initializeFromFile(), eZDBSchemaInterface::insertSchema(), eZDBPackageHandler::install(), eZContentObjectPackageHandler::installOverrides(), eZContentObjectPackageHandler::installSuspendedNodeAssignment(), eZContentObjectPackageHandler::installSuspendedObjectRelations(), eZXMLInputType::instance(), eZNotificationTransport::instance(), eZDbSchema::instance(), eZDB::instance(), eZClusterFileHandler::instance(), eZBinaryFileHandler::instance(), eZPostgreSQLDB::lastSerialID(), eZFileHandler::link(), eZImageInterface::load(), eZCodePageMapper::load(), eZWorkflowType::loadAndRegisterType(), eZNotificationEventType::loadAndRegisterType(), eZDataType::loadAndRegisterType(), eZShippingManager::loadBasketInfoHandler(), eZModuleOperationInfo::loadDefinition(), eZModuleFunctionInfo::loadDefinition(), eZNotificationEventFilter::loadHandler(), eZDBSchemaInterface::loadSchemaTransformationRules(), eZShippingManager::loadShippingHandler(), eZTSTranslator::loadTranslationFile(), eZVATManager::loadVATHandler(), eZLDAPUser::loginUser(), eZTopMenuOperator::modify(), eZTemplateImageOperator::modify(), eZPDF::modify(), eZKernelOperator::modify(), eZFileHandler::move(), eZContentObjectAssignmentHandler::nodeID(), eZIniSettingType::onPublish(), eZPHPCreator::open(), eZFileHandler::open(), eZTemplateDesignResource::overrideArray(), eZXML::parseAttributes(), eZINI::parseFile(), eZCLI::parseOptionString(), eZFileHandler::passtrough(), eZContentObjectTreeNode::pathWithNames(), eZSOAPRequest::payload(), eZModuleFunctionInfo::preExecute(), eZTemplateWhileFunction::process(), eZTemplateIfFunction::process(), eZTemplateDoFunction::process(), eZNotificationEventFilter::process(), eZGIFImageAnalyzer::process(), eZTemplate::processNode(), eZTemplate::processURI(), eZLDAPUser::publishUpdateUser(), eZPostgreSQLDB::query(), eZMySQLDB::query(), eZFileHandler::read(), eZDbSchema::read(), eZModule::redirect(), eZModule::redirectionURI(), eZPaymentGatewayType::registerGateway(), eZTranslatorGroup::registerHandler(), eZWorkflowType::registerType(), eZPostgreSQLDB::relationCount(), eZMySQLDB::relationCount(), eZPostgreSQLDB::relationList(), eZMySQLDB::relationList(), eZContentClassAttribute::remove(), eZImageAliasHandler::removeAliases(), eZPostgreSQLDB::removeRelation(), eZMySQLDB::removeRelation(), eZObjectRelationListType::removeRelationObject(), eZContentObjectVersion::removeVersions(), eZDBInterface::reportError(), eZImageVariation::requestVariation(), eZPHPCreator::restore(), eZContentBrowse::result(), eZFileHandler::rewind(), eZDBInterface::rollback(), eZPackageInstallationHandler::rootDOMNode(), eZWorkflowProcess::run(), eZModule::run(), eZModule::runHooks(), eZINI::save(), eZINI::saveCache(), eZFileHandler::seek(), eZMailTransport::send(), eZMailNotificationTransport::send(), eZSMTPTransport::sendMail(), eZMailTransport::sendMail(), eZDateTimeType::serializeContentClassAttribute(), eZDataType::serializeContentObjectAttribute(), eZSys::serverVariable(), eZPersistentObject::setAttribute(), eZCodePageMapper::setSubstituteCharacter(), eZVATManager::setUserCountry(), eZPreferences::setValue(), eZOrder::statusModificationList(), eZPHPCreator::store(), eZImageInterface::store(), eZHTTPFile::store(), eZCharTransform::storeCacheFile(), eZCodePage::storeCacheObject(), eZImageAliasHandler::storeDOMTree(), eZTemplateCacheFunction::subtreeCacheSubDir(), eZContentObjectTreeNode::subTreeCount(), eZContentObjectTreeNode::subTreeGroupByDateField(), eZFileHandler::symlink(), eZFileHandler::tell(), eZExpiryHandler::timestamp(), eZFileHandler::unlink(), eZContentObjectTreeNode::unserialize(), eZDateTimeType::unserializeContentClassAttribute(), eZEnumType::unserializeContentObjectAttribute(), eZDataType::unserializeContentObjectAttribute(), eZBinaryFileType::unserializeContentObjectAttribute(), eZINI::variable(), eZINI::variableMulti(), eZFileHandler::write(), and writeFile().

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

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

Definition at line 814 of file ezdebug.php.

Referenced by write().

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 388 of file ezdebug.php.

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

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

Writes a debug warning.

The global variable 'eZDebugWarning' 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 431 of file ezdebug.php.

Referenced by eZImageManager::_exclusiveLock(), eZDBFileHandlerPgsqlBackend::_rename(), eZTARArchiveHandler::_warning(), accumulatorStop(), eZExtension::activateExtensions(), eZModule::activeModuleRepositories(), eZContentObject::addContentObjectRelation(), eZContentLanguage::addLanguage(), eZImageObject::appendLayer(), eZImageInterface::attribute(), eZModuleManager::aviableModules(), eZXMLInputParser::callInputHandler(), eZXMLInputParser::callOutputHandler(), eZSimplifiedXMLEditOutput::callOutputHandler(), eZXMLOutputHandler::callTagRenderHandler(), eZMySQLDB::checkCharsetPriv(), eZContentCacheManager::clearViewCache(), eZMySQLDB::connect(), eZImageShellHandler::convert(), eZImageManager::convert(), eZImageGDHandler::convert(), eZImageAnalyzer::create(), eZImageInterface::createImage(), eZImageManager::createImageAlias(), eZContentObjectTreeNode::createSortingSQLStrings(), eZModule::currentAction(), eZTemplateDesignResource::designSetting(), eZBinaryFileHandler::downloadURL(), eZImageInterface::drawText(), errorHandler(), eZFunctionHandler::executeAlias(), eZImageAliasHandler::eZImageAliasHandler(), eZMySQLDB::eZMySQLDB(), eZPostgreSQLDB::eZPostgreSQLDB(), eZImageManager::factoryFor(), eZContentObjectTreeNode::fetch(), eZContentObjectTreeNode::fetchByCRC(), eZContentObjectTreeNode::fetchByURLPath(), eZInformationCollection::fetchCollectionsList(), eZCollaborationItem::fetchListTool(), eZRSSExport::fetchRSS1_0(), eZRSSExport::fetchRSS2_0(), eZExtension::findExtensionType(), eZModule::findModule(), eZImageObject::flatten(), eZObjectRelationListType::fromString(), eZInformationCollection::getSortArrayFromParam(), eZHTTPTool::getVariable(), eZVATManager::getVAT(), eZLDAPUser::goAndPublishGroups(), eZModule::handleError(), eZSerializedObjectNameList::hasNameInLocale(), eZXHTMLXMLOutput::initHandlerEmbed(), eZXHTMLXMLOutput::initHandlerLink(), eZDataType::insertHTTPFile(), eZDataType::insertRegularFile(), eZDataType::insertSimpleString(), eZContentClassPackageHandler::install(), eZUserLoginHandler::instance(), eZUser::instance(), eZCollaborationItemHandler::instantiate(), eZLintSchema::lintCheckSchema(), eZCodePageMapper::load(), eZCodePage::load(), eZDataType::loadAndRegisterType(), eZDBSchemaInterface::loadSchemaTransformationRules(), eZTSTranslator::loadTranslationFile(), eZBinaryFile::metaData(), eZMimeType::mimeTypeFor(), eZXMLOutputHandler::outputTag(), eZXMLTextType::postUnserializeContentObjectAttribute(), eZObjectRelationListType::postUnserializeContentObjectAttribute(), eZHTTPTool::postVariable(), eZImageObject::prependLayer(), eZContentLanguage::prioritizedLanguages(), eZImageInterface::processImage(), eZDataType::productOptionInformation(), eZLDAPUser::publishNewUserGroup(), eZLDAPUser::publishUpdateUser(), eZImageAnalyzer::readAnalyzerSettingsFromINI(), eZImageManager::readImageAliasesFromINI(), eZImageManager::readImageHandlersFromINI(), eZSubtreeCache::renameDir(), eZTranslationCache::restoreCache(), eZTemplateTreeCache::restoreCache(), eZWorkflowProcess::run(), eZProcess::runFile(), eZModule::runHooks(), eZSendmailTransport::sendMail(), eZContentObjectVersion::serialize(), eZXMLInputParser::setAttributes(), eZTemplateTreeCache::setCachedTree(), eZTranslationCache::setContextCache(), eZSerializedObjectNameList::setDefaultLanguageByLocale(), eZTemplateDesignResource::setDesignSetting(), eZSerializedObjectNameList::setNameByLanguageLocale(), eZMultiPrice::setPriceByCurrency(), eZContentObjectTreeNode::sortFieldID(), eZContentObjectTreeNode::sortFieldName(), eZTranslationCache::storeCache(), eZTemplateTreeCache::storeCache(), eZSOAPResponse::stripHTTPHeader(), eZCollaborationGroup::subTree(), eZTemplateCacheFunction::subtreeCacheSubDirForNode(), eZContentObjectTreeNode::subTreeMultiPaths(), eZDBSchemaInterface::transformSchema(), eZContentObjectVersion::unpublish(), eZTemplate::warning(), and eZCodeMapper::warning().

Member Data Documentation

eZDebug::$bottomReportsList [private]

A list of debug reports that appears at the bottom of debug output.

Definition at line 1858 of file ezdebug.php.

eZDebug::$DebugStrings = array() [private]

String array containing the debug information

Definition at line 1807 of file ezdebug.php.

eZDebug::$GlobalLogFileEnabled [private]

Controls whether logfiles are used at all.

Definition at line 1849 of file ezdebug.php.

eZDebug::$HandleType [private]

Determines what to do with php errors, ignore, fetch or output.

Definition at line 1822 of file ezdebug.php.

eZDebug::$LogFileEnabled [private]

A map with message types and whether they should do file logging.

Definition at line 1846 of file ezdebug.php.

eZDebug::$LogFiles [private]

An array of logfiles used by the debug class with each key being the debug level.

Definition at line 1828 of file ezdebug.php.

eZDebug::$MessageOutput [private]

Determines how messages are output (screen/log).

Definition at line 1840 of file ezdebug.php.

eZDebug::$MessageTypes [private]

A list of message types.

Definition at line 1843 of file ezdebug.php.

eZDebug::$OutputFormat [private]

An array of the outputformats for the different debug levels.

Definition at line 1825 of file ezdebug.php.

eZDebug::$OverrideList [private]

A list of override directories.

Definition at line 1855 of file ezdebug.php.

eZDebug::$PercentAccuracy = 4 [private]

How many places behing . should be displayed when showing percentages.

Definition at line 1834 of file ezdebug.php.

eZDebug::$ScriptStart [private]

The time when the script was started.

Definition at line 1852 of file ezdebug.php.

eZDebug::$ShowTypes [private]

Determines which debug messages should be shown.

Definition at line 1819 of file ezdebug.php.

eZDebug::$TimeAccumulatorList = array() [private]

Array wich contains time accumulators.

Definition at line 1816 of file ezdebug.php.

eZDebug::$TimePoints = array() [private]

Array which contains the time points.

Definition at line 1810 of file ezdebug.php.

eZDebug::$TimingAccuracy = 4 [private]

How many places behing . should be displayed when showing times.

Definition at line 1831 of file ezdebug.php.

eZDebug::$TmpTimePoints [private]

Array which contains the temporary time points.

Definition at line 1813 of file ezdebug.php.

eZDebug::$topReportsList [private]

A list of debug reports that appears at the top of debug output.

Definition at line 1861 of file ezdebug.php.

eZDebug::$UseCSS [private]

Whether to use external CSS or output own CSS. True if external is to be used.

Definition at line 1837 of file ezdebug.php.

The documentation for this class was generated from the following file:
Generated on Mon Jul 12 07:10:25 2010 for eZ publish by  doxygen 1.6.3