Log
[ class tree: Log ] [ index: Log ] [ all elements ]

Class: Log_composite

Source Location: /Log-1.12.8/Log/composite.php

Class Overview

Log
   |
   --Log_composite

The Log_composite:: class implements a Composite pattern which allows multiple Log implementations to receive the same events.


Author(s):

Methods


Inherited Variables

Inherited Methods

Class: Log

Log::alert()
A convenience function for logging an alert event. It will log a message at the PEAR_LOG_ALERT log level.
Log::attach()
Adds a Log_observer instance to the list of observers that are listening for messages emitted by this Log instance.
Log::close()
Abstract implementation of the close() method.
Log::crit()
A convenience function for logging a critical event. It will log a message at the PEAR_LOG_CRIT log level.
Log::debug()
A convenience function for logging a debug event. It will log a message at the PEAR_LOG_DEBUG log level.
Log::detach()
Removes a Log_observer instance from the list of observers.
Log::emerg()
A convenience function for logging a emergency event. It will log a message at the PEAR_LOG_EMERG log level.
Log::err()
A convenience function for logging a error event. It will log a message at the PEAR_LOG_ERR log level.
Log::factory()
Attempts to return a concrete Log instance of type $handler.
Log::flush()
Abstract implementation of the flush() method.
Log::getIdent()
Returns the current identification string.
Log::getMask()
Returns the current level mask.
Log::getPriority()
Returns the current default priority.
Log::info()
A convenience function for logging a information event. It will log a message at the PEAR_LOG_INFO log level.
Log::isComposite()
Indicates whether this is a composite class.
Log::log()
Abstract implementation of the log() method.
Log::MASK()
Calculate the log mask for the given priority.
Log::MAX()
Calculate the log mask for all priorities less than or equal to the given priority. In other words, $priority will be the highests priority matched by the resulting mask.
Log::MIN()
Calculate the log mask for all priorities greater than or equal to the given priority. In other words, $priority will be the lowest priority matched by the resulting mask.
Log::notice()
A convenience function for logging a notice event. It will log a message at the PEAR_LOG_NOTICE log level.
Log::open()
Abstract implementation of the open() method.
Log::priorityToString()
Returns the string representation of a PEAR_LOG_* integer constant.
Log::setBacktraceDepth()
Sets the starting depth to use when walking a backtrace in search of the function that invoked the log system. This is used on conjunction with the 'file', 'line', 'function', and 'class' formatters.
Log::setIdent()
Sets this Log instance's identification string.
Log::setMask()
Set and return the level mask for the current Log instance.
Log::setPriority()
Sets the default priority to the specified value.
Log::singleton()
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.
Log::stringToPriority()
Returns the the PEAR_LOG_* integer constant for the given string representation of a priority name. This function performs a case-insensitive search.
Log::UPTO()
Calculate the log mask for all priorities up to the given priority.
Log::warning()
A convenience function for logging a warning event. It will log a message at the PEAR_LOG_WARNING log level.
Log::_announce()
Informs each registered observer instance that a new message has been logged.
Log::_extractMessage()
Returns the string representation of the message data.
Log::_format()
Produces a formatted log line based on a format string and a set of variables representing the current log record and state.
Log::_isMasked()
Check if the given priority is included in the current level mask.

Class Details

[line 23]
The Log_composite:: class implements a Composite pattern which allows multiple Log implementations to receive the same events.
  • Author: Jon Parise <jon@php.net>
  • Author: Chuck Hagenbuch <chuck@horde.org>
  • Since: Horde 1.3
  • Since: Log 1.0
  • Example: example not found


[ Top ]


Method Detail

Log_composite (Constructor)   [line 45]

Log_composite Log_composite( boolean $name, [boolean $ident = ''], [boolean $conf = array()], [boolean $level = PEAR_LOG_DEBUG])

Constructs a new composite Log object.
  • Access: public

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.

[ Top ]

addChild   [line 242]

boolean addChild( &$child, object $child)

Adds a Log instance to the list of children.
  • Return: True if the Log instance was successfully added.
  • Access: public

Parameters:

object   $child     The Log instance to add.
   &$child     

[ Top ]

close   [line 78]

True close( )

Closes all open child instances.
  • Return: if all of the opened child instances were successfully closed.
  • Access: public

Overrides Log::close() (Abstract implementation of the close() method.)
[ Top ]

flush   [line 109]

True flush( )

Flushes all child instances. It is assumed that all of the children have been successfully opened.
  • Return: if all of the child instances were successfully flushed.
  • Since: Log 1.8.2
  • Access: public

Overrides Log::flush() (Abstract implementation of the flush() method.)
[ Top ]

isComposite   [line 209]

boolean isComposite( )

Returns true if this is a composite.
  • Return: True if this is a composite class.
  • Access: public

Overrides Log::isComposite() (Indicates whether this is a composite class.)
[ Top ]

log   [line 138]

boolean log( mixed $message, [string $priority = null])

Sends $message and $priority to each child of this composite. If the appropriate children aren't already open, they will be opened here.
  • Return: True if the entry is successfully logged.
  • Access: public

Overrides Log::log() (Abstract implementation of the log() method.)

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.

[ Top ]

open   [line 58]

True open( )

Opens all of the child instances.
  • Return: if all of the child instances were successfully opened.
  • Access: public

Overrides Log::open() (Abstract implementation of the open() method.)
[ Top ]

removeChild   [line 263]

boolean removeChild( object $child)

Removes a Log instance from the list of children.
  • Return: True if the Log instance was successfully removed.
  • Access: public

Parameters:

object   $child     The Log instance to remove.

[ Top ]

setIdent   [line 222]

void setIdent( string $ident)

Sets this identification string for all of this composite's children.
  • Since: Log 1.6.7
  • Access: public

Overrides Log::setIdent() (Sets this Log instance's identification string.)

Parameters:

string   $ident     The new identification string.

[ Top ]


Documentation generated on Sat, 12 Jul 2014 20:30:04 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.