\Pop\Log\WriterMail

Mail log writer class

Summary

Methods
Properties
Constants
setLogLimit()
getLogLimit()
hasLogLimit()
isWithinLogLimit()
writeLog()
getContext()
__construct()
No public properties found
No constants found
No protected methods found
$limit
$mailer
$emails
$options
N/A
No private methods found
No private properties found
N/A

Properties

$limit

$limit : integer

Log limit

Type

integer

$emails

$emails : array

Emails to which to send the log messages

Type

array

$options

$options : array

Array of mail-specific options, i.e. subject, headers, etc.

Type

array

Methods

setLogLimit()

setLogLimit(integer  $level) : \Pop\Log\Writer\AbstractWriter

Set log limit

Parameters

integer $level

Returns

\Pop\Log\Writer\AbstractWriter

getLogLimit()

getLogLimit() : integer

Get log limit

Returns

integer

hasLogLimit()

hasLogLimit() : boolean

Has log limit

Returns

boolean

isWithinLogLimit()

isWithinLogLimit(integer  $level) : boolean

Check if a log level is within the set log level limit

Parameters

integer $level

Returns

boolean

writeLog()

writeLog(mixed  $level, string  $message, array  $context = array()) : \Pop\Log\Writer\Mail

Write to the log

Parameters

mixed $level
string $message
array $context

Returns

\Pop\Log\Writer\Mail

getContext()

getContext(array  $context = array()) : string

Get context for log

Parameters

array $context

Returns

string

__construct()

__construct(\Pop\Mail\Mailer  $mailer, mixed  $emails, array  $options = array()) 

Constructor

Instantiate the Mail writer object

Parameters

\Pop\Mail\Mailer $mailer
mixed $emails
array $options