Inheritance diagram for Log_error_log:

Collaboration diagram for Log_error_log:

Public Member Functions
	Log_error_log ($name, $ident= '', $conf=array(), $level=PEAR_LOG_DEBUG)
	Constructs a new Log_error_log object.
	open ()
	Opens the handler.
	close ()
	Closes the handler.
	log ($message, $priority=null)
	Logs $message using PHP's error_log() function.
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.
&	factory ($handler, $name= '', $ident= '', $conf=array(), $level=PEAR_LOG_DEBUG)
	Attempts to return a concrete Log instance of type $handler.
&	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.
	flush ()
	Abstract implementation of the flush() method.
	emerg ($message)
	A convenience function for logging a emergency event.
	alert ($message)
	A convenience function for logging an alert event.
	crit ($message)
	A convenience function for logging a critical event.
	err ($message)
	A convenience function for logging a error event.
	warning ($message)
	A convenience function for logging a warning event.
	notice ($message)
	A convenience function for logging a notice event.
	info ($message)
	A convenience function for logging a information event.
	debug ($message)
	A convenience function for logging a debug event.
	_extractMessage ($message)
	Returns the string representation of the message data.
	_getBacktraceVars ($depth)
	Using debug_backtrace(), returns the file, line, and enclosing function name of the source code context from which log() was invoked.
	_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.
	priorityToString ($priority)
	Returns the string representation of a PEAR_LOG_* integer constant.
	stringToPriority ($name)
	Returns the the PEAR_LOG_* integer constant for the given string representation of a priority name.
	MASK ($priority)
	Calculate the log mask for the given priority.
	UPTO ($priority)
	Calculate the log mask for all priorities up to the given priority.
	MIN ($priority)
	Calculate the log mask for all priorities greater than or equal to the given priority.
	MAX ($priority)
	Calculate the log mask for all priorities less than or equal to the given priority.
	setMask ($mask)
	Set and return the level mask for the current Log instance.
	getMask ()
	Returns the current level mask.
	_isMasked ($priority)
	Check if the given priority is included in the current level mask.
	getPriority ()
	Returns the current default priority.
	setPriority ($priority)
	Sets the default priority to the specified value.
	attach (&$observer)
	Adds a Log_observer instance to the list of observers that are listening for messages emitted by this Log instance.
	detach ($observer)
	Removes a Log_observer instance from the list of observers.
	_announce ($event)
	Informs each registered observer instance that a new message has been logged.
	isComposite ()
	Indicates whether this is a composite class.
	setIdent ($ident)
	Sets this Log instance's identification string.
	getIdent ()
	Returns the current identification string.

Data Fields
	$_type = PEAR_LOG_TYPE_SYSTEM
	$_destination = ''
	$_extra_headers = ''
	$_lineFormat = '%2$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 error_log.php.

Member Function Documentation

Log_error_log::close ( )

Closes the handler.

public

Since: Log 1.9.6

Reimplemented from Log.

Definition at line 113 of file error_log.php.

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

Log_error_log::log	(	$message,
		$priority = `null`
	)

Logs $message using PHP's error_log() function.

The message is also passed 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

Reimplemented from Log.

Definition at line 131 of file error_log.php.

References Log\$_priority, $success, 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);
        /* Pass the log line and parameters to the error_log() function. */
        $success = error_log($line, $this->_type, $this->_destination,
                             $this->_extra_headers);
        $this->_announce(array('priority' => $priority, 'message' => $message));
        return $success;
    }

Here is the call graph for this function:

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

Constructs a new Log_error_log 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 68 of file error_log.php.

References Log\UPTO().

    {
        $this->_id = md5(microtime());
        $this->_type = $name;
        $this->_ident = $ident;
        $this->_mask = Log::UPTO($level);
        if (!empty($conf['destination'])) {
            $this->_destination = $conf['destination'];
        }
        if (!empty($conf['extra_headers'])) {
            $this->_extra_headers = $conf['extra_headers'];
        }
        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'];
        }
    }

Here is the call graph for this function:

Log_error_log::open ( )

Opens the handler.

public

Since: Log 1.9.6

Reimplemented from Log.

Definition at line 101 of file error_log.php.

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

Field Documentation

Log_error_log::$_destination = ''

Definition at line 33 of file error_log.php.

Log_error_log::$_extra_headers = ''

Definition at line 41 of file error_log.php.

Log_error_log::$_lineFormat = '%2$s: %4$s'

Definition at line 48 of file error_log.php.

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

Definition at line 57 of file error_log.php.

Log_error_log::$_type = PEAR_LOG_TYPE_SYSTEM

Definition at line 26 of file error_log.php.

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

Services/PEAR/lib/Log/error_log.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation