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.
	open ()
	Opens all of the child instances.
	close ()
	Closes all of the child instances.
	flush ()
	Flushes all child instances.
	log ($message, $priority=null)
	Sends $message and $priority to each child of this composite.
	isComposite ()
	Returns true if this is a composite.
	setIdent ($ident)
	Sets this identification string for all of this composite's children.
	addChild (&$child)
	Adds a Log instance to the list of children.
	removeChild ($child)
	Removes a Log instance from the list of children.
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.
	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.
	getIdent ()
	Returns the current identification string.

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

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;
    }

Log_composite::close ( )

Closes all of the child instances.

Returns: True if all of the child instances were successfully closed.

public

Reimplemented from Log.

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;
    }

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

Reimplemented from Log.

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;
    }

Log_composite::isComposite ( )

Returns true if this is a composite.

Returns: boolean True if this is a composite class.

public

Reimplemented from Log.

Definition at line 166 of file composite.php.

    {
        return true;
    }

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

Reimplemented from Log.

Definition at line 130 of file composite.php.

References Log\$_priority, 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	(	$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;
    }

Log_composite::open ( )

Opens all of the child instances.

Returns: True if all of the child instances were successfully opened.

public

Reimplemented from Log.

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:

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;
    }

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

Reimplemented from Log.

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

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

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation