SymfonyMailerHandler
extends MailHandler
in package
SymfonyMailerHandler uses Symfony's Mailer component to send the emails
Tags
Table of Contents
- $bubble : bool
- $formatter : FormatterInterface|null
- $level : int
- $mailer : MailerInterface|TransportInterface
- $processors : array<string|int, callable>
- $emailTemplate : Email|callable
- __construct() : mixed
- __destruct() : mixed
- __sleep() : mixed
- close() : void
- Closes the handler.
- getBubble() : bool
- Gets the bubbling behavior.
- getFormatter() : FormatterInterface
- {@inheritDoc}
- getLevel() : int
- Gets minimum logging level at which this handler will be triggered.
- handle() : bool
- {@inheritDoc}
- handleBatch() : void
- Handles a set of records at once.
- isHandling() : bool
- {@inheritDoc}
- popProcessor() : callable
- {@inheritDoc}
- pushProcessor() : HandlerInterface
- {@inheritDoc}
- reset() : void
- setBubble() : self
- Sets the bubbling behavior.
- setFormatter() : HandlerInterface
- {@inheritDoc}
- setLevel() : self
- Sets minimum logging level at which this handler will be triggered.
- buildMessage() : Email
- Creates instance of Email to be sent
- getDefaultFormatter() : FormatterInterface
- Gets the default formatter.
- getHighestRecord() : array<string|int, mixed>
- getSubjectFormatter() : FormatterInterface
- Gets the formatter for the Swift_Message subject.
- isHtmlBody() : bool
- processRecord() : array<string|int, mixed>
- Processes a record.
- resetProcessors() : void
- send() : void
- Send a mail with the given content
- write() : void
- Writes the record down to the log of the implementing handler
Properties
$bubble
protected
bool
$bubble
= true
$formatter
protected
FormatterInterface|null
$formatter
$level
protected
int
$level
= MonologLogger::DEBUG
Tags
$mailer
protected
MailerInterface|TransportInterface
$mailer
$processors
protected
array<string|int, callable>
$processors
= []
Tags
$emailTemplate
private
Email|callable
$emailTemplate
Methods
__construct()
public
__construct(MailerInterface|TransportInterface $mailer, callable|Email $email[, mixed $level = Logger::ERROR ][, bool $bubble = true ]) : mixed
Parameters
- $mailer : MailerInterface|TransportInterface
-
The mailer to use
- $email : callable|Email
-
An email template, the subject/body will be replaced
- $level : mixed = Logger::ERROR
- $bubble : bool = true
Tags
Return values
mixed —__destruct()
public
__destruct() : mixed
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —close()
Closes the handler.
public
close() : void
Return values
void —getBubble()
Gets the bubbling behavior.
public
getBubble() : bool
Return values
bool —true means that this handler allows bubbling. false means that bubbling is not permitted.
getFormatter()
{@inheritDoc}
public
getFormatter() : FormatterInterface
Return values
FormatterInterface —getLevel()
Gets minimum logging level at which this handler will be triggered.
public
getLevel() : int
Tags
Return values
int —handle()
{@inheritDoc}
public
handle(array<string|int, mixed> $record) : bool
Parameters
- $record : array<string|int, mixed>
Return values
bool —handleBatch()
Handles a set of records at once.
public
handleBatch(array<string|int, mixed> $records) : void
Parameters
- $records : array<string|int, mixed>
-
The records to handle (an array of record arrays)
Return values
void —isHandling()
{@inheritDoc}
public
isHandling(array<string|int, mixed> $record) : bool
Parameters
- $record : array<string|int, mixed>
Return values
bool —popProcessor()
{@inheritDoc}
public
popProcessor() : callable
Return values
callable —pushProcessor()
{@inheritDoc}
public
pushProcessor(callable $callback) : HandlerInterface
Parameters
- $callback : callable
Return values
HandlerInterface —reset()
public
reset() : void
Return values
void —setBubble()
Sets the bubbling behavior.
public
setBubble(bool $bubble) : self
Parameters
- $bubble : bool
-
true means that this handler allows bubbling. false means that bubbling is not permitted.
Return values
self —setFormatter()
{@inheritDoc}
public
setFormatter(FormatterInterface $formatter) : HandlerInterface
Parameters
- $formatter : FormatterInterface
Return values
HandlerInterface —setLevel()
Sets minimum logging level at which this handler will be triggered.
public
setLevel(Level|LevelName|\Psr\Log\LogLevel::* $level) : self
Parameters
- $level : Level|LevelName|\Psr\Log\LogLevel::*
-
Level or level name
Return values
self —buildMessage()
Creates instance of Email to be sent
protected
buildMessage(string $content, array<string|int, mixed> $records) : Email
Parameters
- $content : string
-
formatted email body to be sent
- $records : array<string|int, mixed>
-
Log records that formed the content
Tags
Return values
Email —getDefaultFormatter()
Gets the default formatter.
protected
getDefaultFormatter() : FormatterInterface
Overwrite this if the LineFormatter is not a good default for your handler.
Return values
FormatterInterface —getHighestRecord()
protected
getHighestRecord(array<string|int, mixed> $records) : array<string|int, mixed>
Parameters
- $records : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getSubjectFormatter()
Gets the formatter for the Swift_Message subject.
protected
getSubjectFormatter(string|null $format) : FormatterInterface
Parameters
- $format : string|null
-
The format of the subject
Return values
FormatterInterface —isHtmlBody()
protected
isHtmlBody(string $body) : bool
Parameters
- $body : string
Return values
bool —processRecord()
Processes a record.
protected
processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
- $record : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —resetProcessors()
protected
resetProcessors() : void
Return values
void —send()
Send a mail with the given content
protected
send(string $content, array<string|int, mixed> $records) : void
Parameters
- $content : string
-
formatted email body to be sent
- $records : array<string|int, mixed>
-
the array of log records that formed this content
Return values
void —write()
Writes the record down to the log of the implementing handler
protected
abstract write(array<string|int, mixed> $record) : void
Parameters
- $record : array<string|int, mixed>