Documentation

MailerHandler extends AbstractProcessingHandler
in package

Base Handler class providing the Handler structure, including processors and formatters

Tags
author

Alexander Borisov boshurik@gmail.com

Table of Contents

$bubble  : bool
$formatter  : FormatterInterface|null
$level  : int
$processors  : array<string|int, callable>
$mailer  : mixed
$messageTemplate  : mixed
__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
{@inheritdoc}
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 Message to be sent.
getDefaultFormatter()  : FormatterInterface
Gets the default formatter.
getHighestRecord()  : array<string|int, mixed>
getSubjectFormatter()  : FormatterInterface
Gets the formatter for the Message subject.
processRecord()  : array<string|int, mixed>
Processes a record.
resetProcessors()  : void
send()  : mixed
Send a mail with the given content.
write()  : void
Writes the record down to the log of the implementing handler

Properties

$level

protected int $level = MonologLogger::DEBUG
Tags
phpstan-var

Level

$processors

protected array<string|int, callable> $processors = []
Tags
phpstan-var

array<ProcessorInterface|callable(Record): Record>

Methods

__construct()

public __construct(MailerInterface $mailer, callable|Email $messageTemplate[, string|int $level = Logger::DEBUG ][, bool $bubble = true ]) : mixed
Parameters
$mailer : MailerInterface
$messageTemplate : callable|Email
$level : string|int = Logger::DEBUG

The minimum logging level at which this handler will be triggered

$bubble : bool = true
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.

getLevel()

Gets minimum logging level at which this handler will be triggered.

public getLevel() : int
Tags
phpstan-return

Level

Return values
int

handle()

{@inheritDoc}

public handle(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>
Return values
bool

handleBatch()

{@inheritdoc}

public handleBatch(array<string|int, mixed> $records) : void
Parameters
$records : array<string|int, mixed>
Return values
void

isHandling()

{@inheritDoc}

public isHandling(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>
Return values
bool

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

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 Message 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

Return values
Email

getHighestRecord()

protected getHighestRecord(array<string|int, mixed> $records) : array<string|int, mixed>
Parameters
$records : array<string|int, mixed>
Return values
array<string|int, mixed>

processRecord()

Processes a record.

protected processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
$record : array<string|int, mixed>
Tags
phpstan-param

Record $record

phpstan-return

Record

Return values
array<string|int, mixed>

send()

Send a mail with the given content.

protected send(string $content, array<string|int, mixed> $records) : mixed
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
mixed

write()

Writes the record down to the log of the implementing handler

protected write(array<string|int, mixed> $record) : void
Parameters
$record : array<string|int, mixed>
Return values
void

Search results