Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Class used for writing log messages to email via Zend_Mail.
Allows for emailing log messages at and above a certain level via a Zend_Mail object. Note that this class only sends the email upon completion, so any log entries accumulated are sent in a single email.

array
$_eventsToMail= 'array()'
Array of formatted events to include in message body.
array()
Details
array
$_layoutEventsToMail= 'array()'
Array of formatted lines for use in an HTML email body; these events are formatted with an optional formatter if the caller is using Zend_Layout.
array()
Details
\Zend_Log_Formatter_Interface
$_layoutFormatter= ''
Optional formatter for use when rendering with Zend_Layout.

array
$_methodMapHeaders= 'array(
'from' => 'setFrom''
MethodMap for Zend_Mail's headers
array(
'from' => 'setFrom'
Details
array
$_numEntriesPerPriority= 'array()'
Array keeping track of the number of entries per priority level.
array()
Details
__construct(
\Zend_Mail $mail, \Zend_Layout $layout
=
null
)
:
void
Class constructor.
Constructs the mail writer; requires a Zend_Mail instance, and takes an optional Zend_Layout instance. If Zend_Layout is being used, $this->_layout->events will be set for use in the layout template.
Name | Type | Description |
---|---|---|
\Zend_Mail | Mail instance |
|
$layout | \Zend_Layout | Layout instance; optional |

_constructLayoutFromConfig(
array $config
)
:
\Zend_Layout
Construct a Zend_Layout instance based on a configuration array
Name | Type | Description |
---|---|---|
$config | array |
Type | Description |
---|---|
\Zend_Layout |
Exception | Description |
---|---|
\Zend_Log_Exception |

_constructMailFromConfig(
array $config
)
:
\Zend_Mail
Construct a Zend_Mail instance based on a configuration array
Name | Type | Description |
---|---|---|
$config | array |
Type | Description |
---|---|
\Zend_Mail |
Exception | Description |
---|---|
\Zend_Log_Exception |

_getFormattedNumEntriesPerPriority(
)
:
string
Gets a string of number of entries per-priority level that occurred, or an emptry string if none occurred.
Type | Description |
---|---|
string |

_write(
array $event
)
:
void
Places event line into array of lines to be used as message body.
Handles the formatting of both plaintext entries, as well as those rendered with Zend_Layout.
Name | Type | Description |
---|---|---|
$event | array | Event data |

factory(
array|\Zend_Config $config
)
:
\Zend_Log_Writer_Mail
Create a new instance of Zend_Log_Writer_Mail
Name | Type | Description |
---|---|---|
$config | array|\Zend_Config |
Type | Description |
---|---|
\Zend_Log_Writer_Mail |

getLayoutFormatter(
)
:
\Zend_Log_Formatter_Interface|null
Gets instance of Zend_Log_Formatter_Instance used for formatting a message using Zend_Layout, if applicable.
Type | Description |
---|---|
\Zend_Log_Formatter_Interface|null | The formatter, or null. |

setLayout(
\Zend_Layout|array $layout
)
:
\Zend_Log_Writer_Mail
Set the layout
Name | Type | Description |
---|---|---|
$layout | \Zend_Layout|array |
Type | Description |
---|---|
\Zend_Log_Writer_Mail |
Exception | Description |
---|---|
\Zend_Log_Exception |

setLayoutFormatter(
\Zend_Log_Formatter_Interface $formatter
)
:
\Zend_Log_Writer_Mail
Sets a specific formatter for use with Zend_Layout events.
Allows use of a second formatter on lines that will be rendered with Zend_Layout. In the event that Zend_Layout is not being used, this formatter cannot be set, so an exception will be thrown.
Name | Type | Description |
---|---|---|
$formatter | \Zend_Log_Formatter_Interface |
Type | Description |
---|---|
\Zend_Log_Writer_Mail |
Exception | Description |
---|---|
\Zend_Log_Exception |

setSubjectPrependText(
string $subject
)
:
\Zend_Log_Writer_Mail
Allows caller to have the mail subject dynamically set to contain the entry counts per-priority level.
Sets the text for use in the subject, with entry counts per-priority level appended to the end. Since a Zend_Mail subject can only be set once, this method cannot be used if the Zend_Mail object already has a subject set.
Name | Type | Description |
---|---|---|
$subject | string | Subject prepend text. |
Type | Description |
---|---|
\Zend_Log_Writer_Mail |
Exception | Description |
---|---|
\Zend_Log_Exception |