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

Class: Log_daemon

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

Class Overview

Log
   |
   --Log_daemon

The Log_daemon class is a concrete implementation of the Log:: abstract class which sends messages to syslog daemon on UNIX-like machines.


Author(s):

Version:

  • $Revision$

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 18]
The Log_daemon class is a concrete implementation of the Log:: abstract class which sends messages to syslog daemon on UNIX-like machines.

This class uses the syslog protocol: http://www.ietf.org/rfc/rfc3164.txt

  • Author: Bart van der Schans <schans@dds.nl>
  • Version: $Revision$


[ Top ]


Method Detail

Log_daemon (Constructor)   [line 74]

Log_daemon Log_daemon( string $name, [string $ident = ''], [array $conf = array()], [ $level = PEAR_LOG_DEBUG], int $maxLevel)

Constructs a new syslog object.
  • Access: public

Parameters:

string   $name     The syslog facility.
string   $ident     The identity string.
array   $conf     The configuration array.
int   $maxLevel     Maximum level at which to log.
   $level     

[ Top ]

close   [line 139]

void close( )

Closes the connection to the system logger, if it is open.
  • Access: public

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

log   [line 160]

void log( string $message, [int $priority = null])

Sends $message to the currently open syslog connection. Calls open() if necessary. Also passes the message along to any Log_observer instances that are observing this Log.
  • Access: public

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

Parameters:

string   $message     The textual message to be logged.
int   $priority     (optional) The priority of the message. Valid values are: LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, and LOG_DEBUG. The default is LOG_INFO.

[ Top ]

open   [line 122]

void open( )

Opens a connection to the system logger, if it has not already been opened. This is implicitly called by log(), if necessary.
  • Access: public

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


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