Inheritance diagram for Log_mcal:

Collaboration diagram for Log_mcal:

Public Member Functions
	Log_mcal ($name, $ident= '', $conf=array(), $level=PEAR_LOG_DEBUG)
	Constructs a new Log_mcal object.
	open ()
	Opens a calendar stream, if it has not already been opened.
	close ()
	Closes the calendar stream, if it is open.
	log ($message, $priority=null)
	Logs $message and associated information to the currently open calendar stream.
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.
	flush ()
	Abstract implementation of the flush() method.
	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.
	isComposite ()
	Indicates whether this is a composite class.
	setIdent ($ident)
	Sets this Log instance's identification string.
	getIdent ()
	Returns the current identification string.

Data Fields
	$_calendar = '{localhost/mstore}'
	$_username = ''
	$_password = ''
	$_options = 0
	$_stream = ''
	$_name = LOG_SYSLOG
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 20 of file mcal.php.

Member Function Documentation

Log_mcal::close ( )

Closes the calendar stream, if it is open.

public

Reimplemented from Log.

Definition at line 107 of file mcal.php.

    {
        if ($this->_opened) {
            mcal_close($this->_stream);
            $this->_opened = false;
        }
        return ($this->_opened === false);
    }

Log_mcal::log	(	$message,
		$priority = `null`
	)

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.

Parameters

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.

Returns: boolean True on success or false on failure. public

Reimplemented from Log.

Definition at line 131 of file mcal.php.

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

    {
        /* If a priority hasn't been specified, use the default value. */
        if ($priority === null) {
            $priority = $this->_priority;
        }
        /* Abort early if the priority is above the maximum logging level. */
        if (!$this->_isMasked($priority)) {
            return false;
        }
        /* If the connection isn't open and can't be opened, return failure. */
        if (!$this->_opened && !$this->open()) {
            return false;
        }
        /* Extract the string representation of the message. */
        $message = $this->_extractMessage($message);
        $date_str = date('Y:n:j:G:i:s');
        $dates = explode(':', $date_str);
        mcal_event_init($this->_stream);
        mcal_event_set_title($this->_stream, $this->_ident);
        mcal_event_set_category($this->_stream, $this->_name);
        mcal_event_set_description($this->_stream, $message);
        mcal_event_add_attribute($this->_stream, 'priority', $priority);
        mcal_event_set_start($this->_stream, $dates[0], $dates[1], $dates[2],
            $dates[3], $dates[4], $dates[5]);
        mcal_event_set_end($this->_stream, $dates[0], $dates[1], $dates[2],
            $dates[3], $dates[4], $dates[5]);
        mcal_append_event($this->_stream);
        $this->_announce(array('priority' => $priority, 'message' => $message));
        return true;
    }

Here is the call graph for this function:

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

Constructs a new Log_mcal object.

Parameters

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. public

Definition at line 74 of file mcal.php.

References $name, and Log\UPTO().

    {
        $this->_id = md5(microtime());
        $this->_name = $name;
        $this->_ident = $ident;
        $this->_mask = Log::UPTO($level);
        $this->_calendar = $conf['calendar'];
        $this->_username = $conf['username'];
        $this->_password = $conf['password'];
        $this->_options = $conf['options'];
    }

Here is the call graph for this function:

Log_mcal::open ( )

Opens a calendar stream, if it has not already been opened.

This is implicitly called by log(), if necessary. public

Reimplemented from Log.

Definition at line 92 of file mcal.php.

References Log\$_opened.

Referenced by log().

    {
        if (!$this->_opened) {
            $this->_stream = mcal_open($this->_calendar, $this->_username,
                $this->_password, $this->_options);
            $this->_opened = true;
        }
        return $this->_opened;
    }

Here is the caller graph for this function:

Field Documentation

Log_mcal::$_calendar = '{localhost/mstore}'

Definition at line 27 of file mcal.php.

Log_mcal::$_name = LOG_SYSLOG

Definition at line 62 of file mcal.php.

Log_mcal::$_options = 0

Definition at line 48 of file mcal.php.

Log_mcal::$_password = ''

Definition at line 41 of file mcal.php.

Log_mcal::$_stream = ''

Definition at line 55 of file mcal.php.

Log_mcal::$_username = ''

Definition at line 34 of file mcal.php.

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

Services/PEAR/lib/Log/mcal.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation