--- nfo/php/libs/net.php.pear/Log/mcal.php 2002/10/25 15:15:23 1.1 +++ nfo/php/libs/net.php.pear/Log/mcal.php 2003/02/05 21:48:31 1.2 @@ -1,117 +1,147 @@ - - * @version $Revision: 1.1 $ - * @since Horde 1.3 - */ -class Log_mcal extends Log { - - // {{{ properties - - /** String holding the calendar specification to connect to. */ - var $calendar = '{localhost/mstore}'; - - /** String holding the username to use. */ - var $username = ''; - - /** String holding the password to use. */ - var $password = ''; - - /** Integer holding the options to pass to the calendar stream. */ - var $options = 0; - - /** ResourceID of the MCAL stream. */ - var $stream = ''; - - /** Integer holding the log facility to use. */ - var $name = LOG_SYSLOG; - - // }}} - - - // {{{ constructor - /** - * Constructs a new Log_mcal object. - * - * @param $log_name (optional) The category to use for our events. - * @param $ident (optional) The identity string. - * @param $conf (optional) The configuration array. - */ - function Log_mcal ($log_name = LOG_SYSLOG, $ident = '', $conf = false) { - $this->name = $log_name; - $this->ident = $ident; - $this->calendar = $conf['calendar']; - $this->username = $conf['username']; - $this->password = $conf['password']; - $this->options = $conf['options']; - } - // }}} - - - // {{{ open() - /** - * Opens a calendar stream, if it has not already been - * opened. This is implicitly called by log(), if necessary. - */ - function open () { - if (!$this->opened) { - $this->stream = mcal_open($this->calendar, $this->username, $this->password, $this->options); - $this->opened = true; - } - } - // }}} - - // {{{ close() - /** - * Closes the calendar stream, if it is open. - */ - function close () { - if ($this->opened) { - mcal_close($this->stream); - $this->opened = false; - } - } - // }}} - - // {{{ log() - /** - * 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. - * - * @param $message The textual message to be logged. - * @param $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. - */ - function log ($message, $priority = LOG_INFO) { - if (!$this->opened) - $this->open(); - - $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->notifyAll(array('priority' => $priority, 'message' => $message)); - } - // }}} - -} - -?> + + * @version $Revision: 1.2 $ + * @since Horde 1.3 + * @package Log + */ +class Log_mcal extends Log { + + /** + * holding the calendar specification to connect to. + * @var string + */ + var $_calendar = '{localhost/mstore}'; + + /** + * holding the username to use. + * @var string + */ + var $_username = ''; + + /** + * holding the password to use. + * @var string + */ + var $_password = ''; + + /** + * holding the options to pass to the calendar stream. + * @var integer + */ + var $_options = 0; + + /** + * ResourceID of the MCAL stream. + * @var string + */ + var $_stream = ''; + + /** + * Integer holding the log facility to use. + * @var string + */ + var $_name = LOG_SYSLOG; + + + /** + * Constructs a new Log_mcal object. + * + * @param string $name The category to use for our events. + * @param string $ident The identity string. + * @param array $conf The configuration array. + * @param int $maxLevel Maximum level at which to log. + * @access public + */ + function Log_mcal($name, $ident = '', $conf = array(), + $maxLevel = PEAR_LOG_DEBUG) + { + $this->_name = $name; + $this->_ident = $ident; + $this->_maxLevel = $maxLevel; + $this->_calendar = $conf['calendar']; + $this->_username = $conf['username']; + $this->_password = $conf['password']; + $this->_options = $conf['options']; + } + + /** + * Opens a calendar stream, if it has not already been + * opened. This is implicitly called by log(), if necessary. + * @access public + */ + function open() + { + if (!$this->_opened) { + $this->_stream = mcal_open($this->_calendar, $this->_username, + $this->_password, $this->_options); + $this->_opened = true; + } + } + + /** + * Closes the calendar stream, if it is open. + * @access public + */ + function close() + { + if ($this->_opened) { + mcal_close($this->_stream); + $this->_opened = false; + } + } + + /** + * 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. + * + * @param string $message The textual message to be logged. + * @param 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. + * The default is PEAR_LOG_INFO. + * @return boolean True on success or false on failure. + * @access public + */ + function log($message, $priority = PEAR_LOG_INFO) + { + /* Abort early if the priority is above the maximum logging level. */ + if ($priority > $this->_maxLevel) { + return false; + } + + if (!$this->_opened) { + $this->open(); + } + + $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->notifyAll(array('priority' => $priority, 'message' => $message)); + + return true; + } +} + +?>