Each of the four fields can be individually enabled or * disabled. The time format depends on the DateFormat used.
* *If no dateFormat is specified it defaults to '%c'. * See php {@link PHP_MANUAL#date} function for details.
* * Params: * - {@link $threadPrinting} (true|false) enable/disable pid reporting. * - {@link $categoryPrefixing} (true|false) enable/disable logger category reporting. * - {@link $contextPrinting} (true|false) enable/disable NDC reporting. * - {@link $microSecondsPrinting} (true|false) enable/disable micro seconds reporting in timestamp. * - {@link $dateFormat} (string) set date format. See php {@link PHP_MANUAL#date} function for details. * * @author Marco Vassura * @version $Revision: 635069 $ * @package log4php * @subpackage layouts */ class LoggerLayoutTTCC extends LoggerLayout { // Internal representation of options protected $threadPrinting = true; protected $categoryPrefixing = true; protected $contextPrinting = true; protected $microSecondsPrinting = true; /** * @var string date format. See {@link PHP_MANUAL#strftime} for details */ protected $dateFormat = '%c'; /** * Constructor * * @param string date format * @see dateFormat */ public function __construct($dateFormat = '') { if (!empty($dateFormat)) $this->dateFormat = $dateFormat; return; } public function activateOptions() { return; } /** * The ThreadPrinting option specifies whether the name of the * current thread is part of log output or not. This is true by default. */ public function setThreadPrinting($threadPrinting) { $this->threadPrinting = is_bool($threadPrinting) ? $threadPrinting : (bool)(strtolower($threadPrinting) == 'true'); } /** * @return boolean Returns value of the ThreadPrinting option. */ public function getThreadPrinting() { return $this->threadPrinting; } /** * The CategoryPrefixing option specifies whether {@link Category} * name is part of log output or not. This is true by default. */ public function setCategoryPrefixing($categoryPrefixing) { $this->categoryPrefixing = is_bool($categoryPrefixing) ? $categoryPrefixing : (bool)(strtolower($categoryPrefixing) == 'true'); } /** * @return boolean Returns value of the CategoryPrefixing option. */ public function getCategoryPrefixing() { return $this->categoryPrefixing; } /** * The ContextPrinting option specifies log output will include * the nested context information belonging to the current thread. * This is true by default. */ public function setContextPrinting($contextPrinting) { $this->contextPrinting = is_bool($contextPrinting) ? $contextPrinting : (bool)(strtolower($contextPrinting) == 'true'); } /** * @return boolean Returns value of the ContextPrinting option. */ public function getContextPrinting() { return $this->contextPrinting; } /** * The MicroSecondsPrinting option specifies if microseconds infos * should be printed at the end of timestamp. * This is true by default. */ public function setMicroSecondsPrinting($microSecondsPrinting) { $this->microSecondsPrinting = is_bool($microSecondsPrinting) ? $microSecondsPrinting : (bool)(strtolower($microSecondsPrinting) == 'true'); } /** * @return boolean Returns value of the MicroSecondsPrinting option. */ public function getMicroSecondsPrinting() { return $this->microSecondsPrinting; } public function setDateFormat($dateFormat) { $this->dateFormat = $dateFormat; } /** * @return string */ public function getDateFormat() { return $this->dateFormat; } /** * In addition to the level of the statement and message, the * returned string includes time, thread, category. *Time, thread, category are printed depending on options. * * @param LoggerLoggingEvent $event * @return string */ public function format($event) { $timeStamp = (float)$event->getTimeStamp(); $format = strftime($this->dateFormat, (int)$timeStamp); if ($this->microSecondsPrinting) { $usecs = floor(($timeStamp - (int)$timeStamp) * 1000); $format .= sprintf(',%03d', $usecs); } $format .= ' '; if ($this->threadPrinting) $format .= '['.getmypid().'] '; $level = $event->getLevel(); $format .= $level->toString().' '; if($this->categoryPrefixing) { $format .= $event->getLoggerName().' '; } if($this->contextPrinting) { $ndc = $event->getNDC(); if($ndc != null) { $format .= $ndc.' '; } } $format .= '- '.$event->getRenderedMessage(); $format .= LOG4PHP_LINE_SEP; return $format; } public function ignoresThrowable() { return true; } }