Monolog\Handler\SwiftMailerHandler Class Reference

SwiftMailerHandler uses Swift_Mailer to send the emails. More...

Inheritance diagram for Monolog\Handler\SwiftMailerHandler:

Collaboration diagram for Monolog\Handler\SwiftMailerHandler:

Public Member Functions
	__construct (\Swift_Mailer $mailer, $message, $level=Logger::ERROR, $bubble=true)
	__get ($name)
	BC getter, to be removed in 2.0. More...
Public Member Functions inherited from 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) } 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 bool 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 bool } 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 ()
	reset ()

Protected Member Functions
	send ($content, array $records)
	{} More...
	getSubjectFormatter ($format)
	Gets the formatter for the Swift_Message subject. More...
	buildMessage ($content, array $records)
	Creates instance of Swift_Message to be sent. More...
Protected Member Functions inherited from Monolog\Handler\MailHandler
	send ($content, array $records)
	Send a mail with the given content. More...
	write (array $record)
	{} More...
	getHighestRecord (array $records)
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...

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

Private Attributes
	$messageTemplate

Detailed Description

SwiftMailerHandler uses Swift_Mailer to send the emails.

Author

Gyula Sallai

Definition at line 24 of file SwiftMailerHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\SwiftMailerHandler::__construct	(	\Swift_Mailer	$mailer,
			$message,
			$level = Logger::ERROR,
			$bubble = true
	)

Parameters

\Swift_Mailer	$mailer	The mailer to use
callable | \Swift_Message	$message	An example message for real messages, only the body will be replaced
int	$level	The minimum logging level at which this handler will be triggered
bool	$bubble	Whether the messages that are handled can bubble up the stack or not

Definition at line 35 of file SwiftMailerHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\AbstractHandler\$level, Monolog\Handler\SwiftMailerHandler\$mailer, and $message.

    {
        parent::__construct($level, $bubble);

        $this->mailer = $mailer;
        $this->messageTemplate = $message;
    }

Member Function Documentation

__get()

Monolog\Handler\SwiftMailerHandler::__get

(

$name

)

BC getter, to be removed in 2.0.

Definition at line 101 of file SwiftMailerHandler.php.

References $name, and Monolog\Handler\SwiftMailerHandler\buildMessage().

    {
        if ($name === 'message') {
            trigger_error('SwiftMailerHandler->message is deprecated, use ->buildMessage() instead to retrieve the message', E_USER_DEPRECATED);

            return $this->buildMessage(null, array());
        }

        throw new \InvalidArgumentException('Invalid property '.$name);
    }

Here is the call graph for this function:

buildMessage()

Monolog\Handler\SwiftMailerHandler::buildMessage (   $content, array  $records  )

protected

Creates instance of Swift_Message to be sent.

Parameters

string	$content	formatted email body to be sent
array	$records	Log records that formed the content

Returns

Definition at line 69 of file SwiftMailerHandler.php.

References $message, Monolog\Handler\SwiftMailerHandler\$messageTemplate, and Monolog\Handler\SwiftMailerHandler\getSubjectFormatter().

Referenced by Monolog\Handler\SwiftMailerHandler\__get(), and Monolog\Handler\SwiftMailerHandler\send().

    {
        $message = null;
        if ($this->messageTemplate instanceof \Swift_Message) {
            $message = clone $this->messageTemplate;
            $message->generateId();
        } elseif (is_callable($this->messageTemplate)) {
            $message = call_user_func($this->messageTemplate, $content, $records);
        }

        if (!$message instanceof \Swift_Message) {
            throw new \InvalidArgumentException('Could not resolve message as instance of Swift_Message or a callable returning it');
        }

        if ($records) {
            $subjectFormatter = $this->getSubjectFormatter($message->getSubject());
            $message->setSubject($subjectFormatter->format($this->getHighestRecord($records)));
        }

        $message->setBody($content);
        if (version_compare(Swift::VERSION, '6.0.0', '>=')) {
            $message->setDate(new \DateTimeImmutable());
        } else {
            $message->setDate(time());
        }

        return $message;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubjectFormatter()

Monolog\Handler\SwiftMailerHandler::getSubjectFormatter (   $format )

protected

Gets the formatter for the Swift_Message subject.

Parameters

string

$format

The format of the subject

Returns

FormatterInterface

Definition at line 57 of file SwiftMailerHandler.php.

References $format.

Referenced by Monolog\Handler\SwiftMailerHandler\buildMessage().

    {
        return new LineFormatter($format);
    }

Here is the caller graph for this function:

send()

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

protected

{}

Definition at line 46 of file SwiftMailerHandler.php.

References Monolog\Handler\SwiftMailerHandler\buildMessage().

    {
        $this->mailer->send($this->buildMessage($content, $records));
    }

Here is the call graph for this function:

Field Documentation

$mailer

Monolog\Handler\SwiftMailerHandler::$mailer

protected

Definition at line 26 of file SwiftMailerHandler.php.

Referenced by Monolog\Handler\SwiftMailerHandler\__construct().

$messageTemplate

Monolog\Handler\SwiftMailerHandler::$messageTemplate

private

Definition at line 27 of file SwiftMailerHandler.php.

Referenced by Monolog\Handler\SwiftMailerHandler\buildMessage().

---

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

• libs/composer/vendor/monolog/monolog/src/Monolog/Handler/SwiftMailerHandler.php