time, thread, category and nested
* diagnostic context information, hence the name.
*
* 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.
*
* Configurable parameters for this layout are:
* - {@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.
*
* An example how to use this layout:
*
* {@example ../../examples/php/layout_ttcc.php 19}
*
* {@example ../../examples/resources/layout_ttcc.properties 18}
*
* The above would print:
* 02:28 [13714] INFO root - Hello World!
*
* @version $Revision: 883108 $
* @package log4php
* @subpackage layouts
*/
class LoggerLayoutTTCC extends LoggerLayout {
/**
* String constant designating no time information. Current value of
* this constant is NULL.
*/
// TODO: not used?
const LOG4PHP_LOGGER_LAYOUT_NULL_DATE_FORMAT = 'NULL';
/**
* String constant designating relative time. Current value of
* this constant is RELATIVE.
*/
// TODO: not used?
const LOG4PHP_LOGGER_LAYOUT_RELATIVE_TIME_DATE_FORMAT = 'RELATIVE';
// 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;
}
/**
* 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 = LoggerOptionConverter::toBoolean($categoryPrefixing);
}
/**
* @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 = LoggerOptionConverter::toBoolean($contextPrinting);
}
/**
* @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(LoggerLoggingEvent $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 .= PHP_EOL;
return $format;
}
public function ignoresThrowable() {
return true;
}
}