Log_composite Class Reference

Inheritance diagram for Log_composite:

Collaboration diagram for Log_composite:

Public Member Functions
	Log_composite ($name, $ident='', $conf=array(), $level=PEAR_LOG_DEBUG)
	Constructs a new composite Log object. More...
	open ()
	Opens all of the child instances. More...
	close ()
	Closes all of the child instances. More...
	flush ()
	Flushes all child instances. More...
	log ($message, $priority=null)
	Sends $message and $priority to each child of this composite. More...
	isComposite ()
	Returns true if this is a composite. More...
	setIdent ($ident)
	Sets this identification string for all of this composite's children. More...
	addChild (&$child)
	Adds a Log instance to the list of children. More...
	removeChild ($child)
	Removes a Log instance from the list of children. 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
	$_children = array()
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 23 of file composite.php.

Member Function Documentation

addChild()

Log_composite::addChild

(

&

$child

)

Adds a Log instance to the list of children.

Parameters

object

$child

The Log instance to add.

Returns

boolean True if the Log instance was successfully added.

public

Definition at line 199 of file composite.php.

    {
        /* Make sure this is a Log instance. */
        if (!is_a($child, 'Log')) {
            return false;
        }

        $this->_children[$child->_id] = &$child;

        return true;
    }

close()

Log_composite::close

(

)

Closes all of the child instances.

Returns

True if all of the child instances were successfully closed.

public

Definition at line 77 of file composite.php.

    {
        /* Attempt to close each of our children. */
        $closed = true;
        foreach ($this->_children as $id => $child) {
            $closed &= $this->_children[$id]->close();
        }

        /* Track the _opened state for consistency. */
        $this->_opened = false;

        /* If all children were closed, return success. */
        return $closed;
    }

flush()

Log_composite::flush

(

)

Flushes all child instances.

It is assumed that all of the children have been successfully opened.

Returns

True if all of the child instances were successfully flushed.

public

Since

Log 1.8.2

Definition at line 101 of file composite.php.

    {
        /* Attempt to flush each of our children. */
        $flushed = true;
        foreach ($this->_children as $id => $child) {
            $flushed &= $this->_children[$id]->flush();
        }

        /* If all children were flushed, return success. */
        return $flushed;
    }

isComposite()

Log_composite::isComposite

(

)

Returns true if this is a composite.

Returns

boolean True if this is a composite class.

public

Definition at line 166 of file composite.php.

    {
        return true;
    }

log()

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

Sends $message and $priority to each child of this composite.

If the children aren't already open, they will be opened here.

Parameters

mixed	$message	String or object containing the message to log.
string	$priority	(optional) 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 if the entry is successfully logged.

public

Definition at line 130 of file composite.php.

References Log\$_priority, $success, Log\_announce(), and open().

    {
        /* If a priority hasn't been specified, use the default value. */
        if ($priority === null) {
            $priority = $this->_priority;
        }

        /*
         * If the handlers haven't been opened, attempt to open them now.
         * However, we don't treat failure to open all of the handlers as a
         * fatal error.  We defer that consideration to the success of calling
         * each handler's log() method below.
         */
        if (!$this->_opened) {
            $this->open();
        }

        /* Attempt to log the event using each of the children. */
        $success = true;
        foreach ($this->_children as $id => $child) {
            $success &= $this->_children[$id]->log($message, $priority);
        }

        $this->_announce(array('priority' => $priority, 'message' => $message));

        /* Return success if all of the children logged the event. */
        return $success;
    }

Here is the call graph for this function:

Log_composite()

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

Constructs a new composite Log object.

Parameters

boolean	$name	This parameter is ignored.
boolean	$ident	This parameter is ignored.
boolean	$conf	This parameter is ignored.
boolean	$level	This parameter is ignored.

public

Definition at line 45 of file composite.php.

    {
        $this->_ident = $ident;
    }

open()

Log_composite::open

(

)

Opens all of the child instances.

Returns

True if all of the child instances were successfully opened.

public

Definition at line 58 of file composite.php.

References Log\$_opened.

Referenced by log().

    {
        /* Attempt to open each of our children. */
        $this->_opened = true;
        foreach ($this->_children as $id => $child) {
            $this->_opened &= $this->_children[$id]->open();
        }

        /* If all children were opened, return success. */
        return $this->_opened;
    }

Here is the caller graph for this function:

removeChild()

Log_composite::removeChild

(

$child

)

Removes a Log instance from the list of children.

Parameters

object

$child

The Log instance to remove.

Returns

boolean True if the Log instance was successfully removed.

public

Definition at line 220 of file composite.php.

    {
        if (!is_a($child, 'Log') || !isset($this->_children[$child->_id])) {
            return false;
        }

        unset($this->_children[$child->_id]);

        return true;
    }

setIdent()

Log_composite::setIdent

(

$ident

)

Sets this identification string for all of this composite's children.

Parameters

string

$ident

The new identification string.

public

Since

Log 1.6.7

Definition at line 179 of file composite.php.

    {
        /* Call our base class's setIdent() method. */
        parent::setIdent($ident);

        /* ... and then call setIdent() on all of our children. */
        foreach ($this->_children as $id => $child) {
            $this->_children[$id]->setIdent($ident);
        }
    }

Field Documentation

$_children

Log_composite::$_children = array()

Definition at line 32 of file composite.php.

---

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

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