Monolog\Handler\MailHandler Class Reference

Base class for all mail handlers. More...

Inheritance diagram for Monolog\Handler\MailHandler:

Collaboration diagram for Monolog\Handler\MailHandler:

Public Member Functions
	handleBatch (array $records)
	{{Handles a set of records at once. Parameters array $records The records to handle (an array of record arrays) }} More...
Public Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	handle (array $record)
	{Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record. Parameters array $record The record to handle Returns Boolean true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling. } More...
Public Member Functions inherited from Monolog\Handler\AbstractHandler
	__construct ($level=Logger::DEBUG, $bubble=true)
	isHandling (array $record)
	{Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record. Parameters array $record Partial log record containing only a level key Returns Boolean } More...
	handleBatch (array $records)
	{Handles a set of records at once. Parameters array $records The records to handle (an array of record arrays) } More...
	close ()
	Closes the handler. More...
	pushProcessor ($callback)
	{Adds a processor in the stack. Parameters callable $callback Returns self } More...
	popProcessor ()
	{Removes the processor on top of the stack and returns it. Returns callable } More...
	setFormatter (FormatterInterface $formatter)
	{Sets the formatter. Parameters FormatterInterface $formatter Returns self } More...
	getFormatter ()
	{Gets the formatter. Returns FormatterInterface } More...
	setLevel ($level)
	Sets minimum logging level at which this handler will be triggered. More...
	getLevel ()
	Gets minimum logging level at which this handler will be triggered. More...
	setBubble ($bubble)
	Sets the bubbling behavior. More...
	getBubble ()
	Gets the bubbling behavior. More...
	__destruct ()
	isHandling (array $record)
	Checks whether the given record will be handled by this handler. More...
	handle (array $record)
	Handles a record. More...
	handleBatch (array $records)
	Handles a set of records at once. More...
	pushProcessor ($callback)
	Adds a processor in the stack. More...
	popProcessor ()
	Removes the processor on top of the stack and returns it. More...
	setFormatter (FormatterInterface $formatter)
	Sets the formatter. More...
	getFormatter ()
	Gets the formatter. More...

Protected Member Functions
	send ($content, array $records)
	Send a mail with the given content. More...
	write (array $record)
	{Writes the record down to the log of the implementing handler. Parameters array $record Returns void } More...
Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	write (array $record)
	Writes the record down to the log of the implementing handler. More...
	processRecord (array $record)
	Processes a record. More...
Protected Member Functions inherited from Monolog\Handler\AbstractHandler
	getDefaultFormatter ()
	Gets the default formatter. More...

Additional Inherited Members
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Detailed Description

Base class for all mail handlers.

Author

Gyula Sallai

Definition at line 19 of file MailHandler.php.

Member Function Documentation

handleBatch()

Monolog\Handler\MailHandler::handleBatch

(

array

$records

)

{{Handles a set of records at once.

Parameters

array

$records

The records to handle (an array of record arrays)

}}

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 24 of file MailHandler.php.

    {
        $messages = array();
 
        foreach ($records as $record) {
            if ($record['level'] < $this->level) {
                continue;
            }
            $messages[] = $this->processRecord($record);
        }
 
        if (!empty($messages)) {
            $this->send((string) $this->getFormatter()->formatBatch($messages), $messages);
        }
    }

References $messages, $records, Monolog\Handler\AbstractHandler\getFormatter(), Monolog\Handler\AbstractProcessingHandler\processRecord(), and Monolog\Handler\MailHandler\send().

Here is the call graph for this function:

send()

Monolog\Handler\MailHandler::send (   $content, array  $records  )

abstractprotected

Send a mail with the given content.

Parameters

string	$content	formatted email body to be sent
array	$records	the array of log records that formed this content

Reimplemented in Monolog\Handler\MandrillHandler, Monolog\Handler\NativeMailerHandler, and Monolog\Handler\SwiftMailerHandler.

Referenced by Monolog\Handler\MailHandler\handleBatch(), and Monolog\Handler\MailHandler\write().

Here is the caller graph for this function:

write()

Monolog\Handler\MailHandler::write ( array  $record )

protected

{Writes the record down to the log of the implementing handler.

Parameters

array

$record

Returns

void

}

Reimplemented from Monolog\Handler\AbstractProcessingHandler.

Definition at line 51 of file MailHandler.php.

    {
        $this->send((string) $record['formatted'], array($record));
    }

References Monolog\Handler\MailHandler\send().

Here is the call graph for this function:

---

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

• Services/Logging/lib/vendor/monolog/monolog/src/Monolog/Handler/MailHandler.php