Class Log_mcal

Description

The Log_mcal class is a concrete implementation of the Log:: abstract class which sends messages to a local or remote calendar store accessed through MCAL.

  • since: Horde 1.3
  • since: Log 1.0
  • author: Chuck Hagenbuch <chuck@horde.org>

Located in /maintenance/libraries/pear/Log/mcal.php (line 20)

Log
   |
   --Log_mcal
Variable Summary
 string $_calendar
 string $_name
 integer $_options
 string $_password
 string $_stream
 string $_username
Method Summary
 Log_mcal Log_mcal (string $name, [string $ident = ''], [array $conf = array()], [int $level = PEAR_LOG_DEBUG])
 void close ()
 boolean log (mixed $message, [string $priority = null])
 void open ()
Variables
string $_calendar = '{localhost/mstore}' (line 27)

holding the calendar specification to connect to.

  • access: private
string $_name = LOG_SYSLOG (line 62)

Integer holding the log facility to use.

  • access: private
integer $_options = 0 (line 48)

holding the options to pass to the calendar stream.

  • access: private
string $_password = '' (line 41)

holding the password to use.

  • access: private
string $_stream = '' (line 55)

ResourceID of the MCAL stream.

  • access: private
string $_username = '' (line 34)

holding the username to use.

  • access: private

Inherited Variables

Inherited from Log

Log::$_id
Log::$_ident
Log::$_listeners
Log::$_mask
Log::$_opened
Log::$_priority
Methods
Constructor Log_mcal (line 74)

Constructs a new Log_mcal object.

  • access: public
Log_mcal Log_mcal (string $name, [string $ident = ''], [array $conf = array()], [int $level = PEAR_LOG_DEBUG])
  • string $name: The category to use for our events.
  • string $ident: The identity string.
  • array $conf: The configuration array.
  • int $level: Log messages up to and including this level.
close (line 107)

Closes the calendar stream, if it is open.

  • access: public
void close ()

Redefinition of:
Log::close()
Abstract implementation of the close() method.
log (line 131)

Logs $message and associated information to the currently open calendar stream. Calls open() if necessary. Also passes the message along to any Log_observer instances that are observing this Log.

  • return: True on success or false on failure.
  • access: public
boolean log (mixed $message, [string $priority = null])
  • 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.

Redefinition of:
Log::log()
Abstract implementation of the log() method.
open (line 92)

Opens a calendar stream, if it has not already been opened. This is implicitly called by log(), if necessary.

  • access: public
void open ()

Redefinition of:
Log::open()
Abstract implementation of the open() method.

Inherited Methods

Inherited From Log

 Log::alert()
 Log::attach()
 Log::close()
 Log::crit()
 Log::debug()
 Log::detach()
 Log::emerg()
 Log::err()
 Log::factory()
 Log::flush()
 Log::getIdent()
 Log::getMask()
 Log::getPriority()
 Log::info()
 Log::isComposite()
 Log::log()
 Log::MASK()
 Log::notice()
 Log::open()
 Log::priorityToString()
 Log::setIdent()
 Log::setMask()
 Log::setPriority()
 Log::singleton()
 Log::UPTO()
 Log::warning()
 Log::_announce()
 Log::_extractMessage()
 Log::_isMasked()

Documentation generated on Fri, 11 Feb 2005 18:13:32 +0000 by phpDocumentor 1.3.0RC3