Class: Log_mail

Source Location: /Log-1.9.8/Log/mail.php

Class Overview

Log
   |
   --Log_mail

The Log_mail class is a concrete implementation of the Log:: abstract class which sends log messages to a mailbox.

Author(s):

Jon Parise <jon at php.net>
Ronnie Garcia <ronnie at mk2.net>

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

Class Details

[line 28]
The Log_mail class is a concrete implementation of the Log:: abstract class which sends log messages to a mailbox.

The mail is actually sent when you close() the logger, or when the destructor is called (when the script is terminated).

PLEASE NOTE that you must create a Log_mail object using =&, like this : $logger =& Log::factory("mail", "recipient@example.com", ...)

This is a PEAR requirement for destructors to work properly. See http://pear.php.net/manual/en/class.pear.php

Author: Jon Parise <jon@php.net>
Author: Ronnie Garcia <ronnie@mk2.net>
Since: Log 1.3
Example: example not found

[ Top ]

Method Detail

Log_mail (Constructor) [line 95]

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

Constructs a new Log_mail object.

Here is how you can customize the mail driver with the conf[] hash : $conf['from'] : the mail's "From" header line, $conf['subject'] : the mail's "Subject" line.

Access: public

Parameters:

string	`$name`	—	The filename of the logfile.
string	`$ident`	—	The identity string.
array	`$conf`	—	The configuration array.
int	`$level`	—	Log messages up to and including this level.

[ Top ]

close [line 165]

void close(
)

Closes the message, if it is open, and sends the mail.

This is implicitly called by the destructor, if necessary.

Access: public

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

[ Top ]

flush [line 195]

void flush(
)

Flushes the log output by forcing the email message to be sent now.

Events that are logged after flush() is called will be appended to a new email message.

Since: Log 1.8.2
Access: public

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

[ Top ]

log [line 216]

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

Writes $message to the currently open mail message.

Calls open(), if necessary.

Return: True on success or false on failure.
Access: public

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

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.

[ Top ]

open [line 147]

void open(
)

Starts a new mail message.

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

Access: public

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

[ Top ]