Log_console Class Reference

Inheritance diagram for Log_console:

Collaboration diagram for Log_console:

Public Member Functions
	Log_console ($name, $ident='', $conf=array(), $level=PEAR_LOG_DEBUG)
	Constructs a new Log_console object. More...
	_Log_console ()
	Destructor. More...
	open ()
	Open the output stream. More...
	close ()
	Closes the output stream. More...
	flush ()
	Flushes all pending ("buffered") data to the output stream. More...
	log ($message, $priority=null)
	Writes $message to the text console. More...
Public Member Functions inherited from Log
	_classExists ($class)
	Utility function which wraps PHP's class_exists() function to ensure consistent behavior between PHP versions 4 and 5. More...
&	factory ($handler, $name='', $ident='', $conf=array(), $level=PEAR_LOG_DEBUG)
	Attempts to return a concrete Log instance of type $handler. More...
&	singleton ($handler, $name='', $ident='', $conf=array(), $level=PEAR_LOG_DEBUG)
	Attempts to return a reference to a concrete Log instance of type $handler, only creating a new instance if no log instance with the same parameters currently exists. More...
	open ()
	Abstract implementation of the open() method. More...
	close ()
	Abstract implementation of the close() method. More...
	flush ()
	Abstract implementation of the flush() method. More...
	log ($message, $priority=null)
	Abstract implementation of the log() method. More...
	emerg ($message)
	A convenience function for logging a emergency event. More...
	alert ($message)
	A convenience function for logging an alert event. More...
	crit ($message)
	A convenience function for logging a critical event. More...
	err ($message)
	A convenience function for logging a error event. More...
	warning ($message)
	A convenience function for logging a warning event. More...
	notice ($message)
	A convenience function for logging a notice event. More...
	info ($message)
	A convenience function for logging a information event. More...
	debug ($message)
	A convenience function for logging a debug event. More...
	_extractMessage ($message)
	Returns the string representation of the message data. More...
	_getBacktraceVars ($depth)
	Using debug_backtrace(), returns the file, line, and enclosing function name of the source code context from which log() was invoked. More...
	_format ($format, $timestamp, $priority, $message)
	Produces a formatted log line based on a format string and a set of variables representing the current log record and state. More...
	priorityToString ($priority)
	Returns the string representation of a PEAR_LOG_* integer constant. More...
	stringToPriority ($name)
	Returns the the PEAR_LOG_* integer constant for the given string representation of a priority name. More...
	MASK ($priority)
	Calculate the log mask for the given priority. More...
	UPTO ($priority)
	Calculate the log mask for all priorities up to the given priority. More...
	MIN ($priority)
	Calculate the log mask for all priorities greater than or equal to the given priority. More...
	MAX ($priority)
	Calculate the log mask for all priorities less than or equal to the given priority. More...
	setMask ($mask)
	Set and return the level mask for the current Log instance. More...
	getMask ()
	Returns the current level mask. More...
	_isMasked ($priority)
	Check if the given priority is included in the current level mask. More...
	getPriority ()
	Returns the current default priority. More...
	setPriority ($priority)
	Sets the default priority to the specified value. More...
	attach (&$observer)
	Adds a Log_observer instance to the list of observers that are listening for messages emitted by this Log instance. More...
	detach ($observer)
	Removes a Log_observer instance from the list of observers. More...
	_announce ($event)
	Informs each registered observer instance that a new message has been logged. More...
	isComposite ()
	Indicates whether this is a composite class. More...
	setIdent ($ident)
	Sets this Log instance's identification string. More...
	getIdent ()
	Returns the current identification string. More...

Data Fields
	$_stream = STDOUT
	$_buffering = false
	$_buffer = ''
	$_lineFormat = '%1$s %2$s [%3$s] %4$s'
	$_timeFormat = '%b %d %H:%M:%S'
Data Fields inherited from Log
	$_opened = false
	$_id = 0
	$_ident = ''
	$_priority = PEAR_LOG_INFO
	$_mask = PEAR_LOG_ALL
	$_listeners = array()
	$_formatMap

Detailed Description

Definition at line 19 of file console.php.

Member Function Documentation

_Log_console()

Log_console::_Log_console

(

)

Destructor.

Definition at line 104 of file console.php.

References close().

    {
        $this->close();
    }

Here is the call graph for this function:

close()

Log_console::close

(

)

Closes the output stream.

This results in a call to flush().

public

Since

Log 1.9.0

Definition at line 129 of file console.php.

References flush().

Referenced by _Log_console().

    {
        $this->flush();
        $this->_opened = false;
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

flush()

Log_console::flush

(

)

Flushes all pending ("buffered") data to the output stream.

public

Since

Log 1.8.2

Definition at line 142 of file console.php.

Referenced by close().

    {
        /*
         * If output buffering is enabled, dump the contents of the buffer to
         * the output stream.
         */
        if ($this->_buffering && (strlen($this->_buffer) > 0)) {
            fwrite($this->_stream, $this->_buffer);
            $this->_buffer = '';
        }
 
        if (is_resource($this->_stream)) {
            return fflush($this->_stream);
        }

        return false;
    }

Here is the caller graph for this function:

log()

Log_console::log	(		$message,
			$priority = null
	)

Writes $message to the text console.

Also, passes the message along to any Log_observer instances that are observing this Log.

Parameters

mixed	$message	String or object containing the message to log.
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.

Returns

boolean True on success or false on failure. public

Definition at line 172 of file console.php.

References Log\$_priority, Log\_announce(), Log\_extractMessage(), Log\_format(), and Log\_isMasked().

    {
        /* 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 the string containing the complete log line. */
        $line = $this->_format($this->_lineFormat,
                               strftime($this->_timeFormat),
                               $priority, $message) . "\n";

        /*
         * If buffering is enabled, append this line to the output buffer.
         * Otherwise, print the line to the output stream immediately.
         */
        if ($this->_buffering) {
            $this->_buffer .= $line;
        } else {
            fwrite($this->_stream, $line);
        }

        /* Notify observers about this log message. */
        $this->_announce(array('priority' => $priority, 'message' => $message));

        return true;
    }

Here is the call graph for this function:

Log_console()

Log_console::Log_console	(		$name,
			$ident = '',
			$conf = array(),
			$level = PEAR_LOG_DEBUG
	)

Constructs a new Log_console object.

Parameters

string	$name	Ignored.
string	$ident	The identity string.
array	$conf	The configuration array.
int	$level	Log messages up to and including this level. public

Definition at line 67 of file console.php.

References Log\UPTO().

    {
        $this->_id = md5(microtime());
        $this->_ident = $ident;
        $this->_mask = Log::UPTO($level);

        if (!empty($conf['stream'])) {
            $this->_stream = $conf['stream'];
        }

        if (isset($conf['buffering'])) {
            $this->_buffering = $conf['buffering'];
        }

        if (!empty($conf['lineFormat'])) {
            $this->_lineFormat = str_replace(array_keys($this->_formatMap),
                                             array_values($this->_formatMap),
                                             $conf['lineFormat']);
        }

        if (!empty($conf['timeFormat'])) {
            $this->_timeFormat = $conf['timeFormat'];
        }

        /*
         * If output buffering has been requested, we need to register a
         * shutdown function that will dump the buffer upon termination.
         */
        if ($this->_buffering) {
            register_shutdown_function(array(&$this, '_Log_console'));
        }
    }

Here is the call graph for this function:

open()

Log_console::open

(

)

Open the output stream.

public

Since

Log 1.9.7

Definition at line 115 of file console.php.

    {
        $this->_opened = true;
        return true;
    }

Field Documentation

$_buffer

Log_console::$_buffer = ''

Definition at line 40 of file console.php.

$_buffering

Log_console::$_buffering = false

Definition at line 33 of file console.php.

$_lineFormat

Log_console::$_lineFormat = '%1$s %2$s [%3$s] %4$s'

Definition at line 47 of file console.php.

$_stream

Log_console::$_stream = STDOUT

Definition at line 26 of file console.php.

$_timeFormat

Log_console::$_timeFormat = '%b %d %H:%M:%S'

Definition at line 56 of file console.php.

---

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

• Services/PEAR/lib/Log/console.php