API Documentation

Zend/Log/Writer/Mail.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Log  
Subpackage
Writer  
Version
$Id: Mail.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Log_Writer_Mail

Package: Zend\Log\Writer

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.

Parent(s)
\Zend_Log_Writer_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Version
$Id: Mail.php 24594 2012-01-05 21:27:01Z matthew $  

Properties

Propertyprotectedarray  $_eventsToMail= 'array()'

Array of formatted events to include in message body.

Default valuearray()Details
Type
array
Propertyprotected\Zend_Layout  $_layout= ''

Zend_Layout instance to use; optional.

Details
Type
\Zend_Layout
Propertyprotectedarray  $_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.

Default valuearray()Details
Type
array
Propertyprotected\Zend_Log_Formatter_Interface  $_layoutFormatter= ''

Optional formatter for use when rendering with Zend_Layout.

Propertyprotected\Zend_Mail  $_mail= ''

Zend_Mail instance to use

Details
Type
\Zend_Mail
Propertyprotectedarray  $_methodMapHeaders= 'array( 'from' => 'setFrom''
static

MethodMap for Zend_Mail's headers

Default valuearray( 'from' => 'setFrom'Details
Type
array
Propertyprotectedarray  $_numEntriesPerPriority= 'array()'

Array keeping track of the number of entries per priority level.

Default valuearray()Details
Type
array
Propertyprotectedstring|null  $_subjectPrependText= ''

Subject prepend text.

Can only be used of the Zend_Mail object has not already had its subject line set. Using this will cause the subject to have the entry counts per-priority level appended to it.

Details
Type
stringnull

Methods

methodpublic__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.

Parameters
Name Type Description
$mail \Zend_Mail

Mail instance

$layout \Zend_Layout

Layout instance; optional

methodprotected_constructLayoutFromConfig( array $config ) : \Zend_Layout

Construct a Zend_Layout instance based on a configuration array

Parameters
Name Type Description
$config array
Returns
Type Description
\Zend_Layout
Throws
Exception Description
\Zend_Log_Exception
methodprotected_constructMailFromConfig( array $config ) : \Zend_Mail
static

Construct a Zend_Mail instance based on a configuration array

Parameters
Name Type Description
$config array
Returns
Type Description
\Zend_Mail
Throws
Exception Description
\Zend_Log_Exception
methodprotected_getFormattedNumEntriesPerPriority( ) : string

Gets a string of number of entries per-priority level that occurred, or an emptry string if none occurred.

Returns
Type Description
string
methodprotected_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.

Parameters
Name Type Description
$event array

Event data

methodpublicfactory( array|\Zend_Config $config ) : \Zend_Log_Writer_Mail
static

Create a new instance of Zend_Log_Writer_Mail

Parameters
Name Type Description
$config array|\Zend_Config
Returns
Type Description
\Zend_Log_Writer_Mail
methodpublicgetLayoutFormatter( ) : \Zend_Log_Formatter_Interface|null

Gets instance of Zend_Log_Formatter_Instance used for formatting a message using Zend_Layout, if applicable.

Returns
Type Description
\Zend_Log_Formatter_Interface|null The formatter, or null.
methodpublicsetLayout( \Zend_Layout|array $layout ) : \Zend_Log_Writer_Mail

Set the layout

Parameters
Name Type Description
$layout \Zend_Layout|array
Returns
Type Description
\Zend_Log_Writer_Mail
Throws
Exception Description
\Zend_Log_Exception
methodpublicsetLayoutFormatter( \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.

Parameters
Name Type Description
$formatter \Zend_Log_Formatter_Interface
Returns
Type Description
\Zend_Log_Writer_Mail
Throws
Exception Description
\Zend_Log_Exception
methodpublicsetSubjectPrependText( 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.

Parameters
Name Type Description
$subject string

Subject prepend text.

Returns
Type Description
\Zend_Log_Writer_Mail
Throws
Exception Description
\Zend_Log_Exception
methodpublicshutdown( ) : void

Sends mail to recipient(s) if log entries are present. Note that both plaintext and HTML portions of email are handled here.

Documentation was generated by DocBlox 0.15.1.