* @since Log 1.8.0 * @package Log * * @example display.php Using the display handler. */ class Log_display extends Log { /** * String containing the format of a log line. * @var string * @access private */ var $_lineFormat = '%3$s: %4$s'; /** * String containing the timestamp format. It will be passed directly to * strftime(). Note that the timestamp string will generated using the * current locale. * @var string * @access private */ var $_timeFormat = '%b %d %H:%M:%S'; /** * Constructs a new Log_display object. * * @param string $name Ignored. * @param string $ident The identity string. * @param array $conf The configuration array. * @param int $level Log messages up to and including this level. * @access public */ function __construct($name = '', $ident = '', $conf = array(), $level = PEAR_LOG_DEBUG) { $this->_id = md5(microtime()); $this->_ident = $ident; $this->_mask = Log::UPTO($level); /* Start by configuring the line format. */ if (!empty($conf['lineFormat'])) { $this->_lineFormat = str_replace(array_keys($this->_formatMap), array_values($this->_formatMap), $conf['lineFormat']); } /* We may need to prepend a string to our line format. */ $prepend = null; if (isset($conf['error_prepend'])) { $prepend = $conf['error_prepend']; } else { $prepend = ini_get('error_prepend_string'); } if (!empty($prepend)) { $this->_lineFormat = $prepend . $this->_lineFormat; } /* We may also need to append a string to our line format. */ $append = null; if (isset($conf['error_append'])) { $append = $conf['error_append']; } else { $append = ini_get('error_append_string'); } if (!empty($append)) { $this->_lineFormat .= $append; } /* Lastly, the line ending sequence is also configurable. */ if (isset($conf['linebreak'])) { $this->_lineFormat .= $conf['linebreak']; } else { $this->_lineFormat .= "
\n"; } /* The user can also change the time format. */ if (!empty($conf['timeFormat'])) { $this->_timeFormat = $conf['timeFormat']; } } /** * Opens the display handler. * * @access public * @since Log 1.9.6 */ function open() { $this->_opened = true; return true; } /** * Closes the display handler. * * @access public * @since Log 1.9.6 */ function close() { $this->_opened = false; return true; } /** * Writes $message to the text browser. Also, passes the message * along to any Log_observer instances that are observing this Log. * * @param mixed $message String or object containing the message to log. * @param string $priority The priority of the message. Valid * values are: PEAR_LOG_EMERG, PEAR_LOG_ALERT, * PEAR_LOG_CRIT, PEAR_LOG_ERR, PEAR_LOG_WARNING, * PEAR_LOG_NOTICE, PEAR_LOG_INFO, and PEAR_LOG_DEBUG. * @return boolean True on success or false on failure. * @access public */ function log($message, $priority = null) { /* If a priority hasn't been specified, use the default value. */ if ($priority === null) { $priority = $this->_priority; } /* Abort early if the priority is above the maximum logging level. */ if (!$this->_isMasked($priority)) { return false; } /* Extract the string representation of the message. */ $message = $this->_extractMessage($message); /* Build and output the complete log line. */ echo $this->_format($this->_lineFormat, strftime($this->_timeFormat), $priority, nl2br(htmlspecialchars($message))); /* Notify observers about this log message. */ $this->_announce(array('priority' => $priority, 'message' => $message)); return true; } }