Log/Writer/Mail.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Log
subpackage: Writer
version: $Id: Mail.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Log_Writer_Mail

Description

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.

Zend_Log_Writer_Mail
jump to top

Extends from: Zend_Log_Writer_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Log
subpackage: Writer
version: $Id: Mail.php 20096 2010-01-06 02:05:09Z bkarwin $
Properties: $_eventsToMail; $_layoutEventsToMail; $_mail; $_layout; $_layoutFormatter; $_numEntriesPerPriority; $_subjectPrependText
Methods: __construct; factory; _write; getLayoutFormatter; setLayoutFormatter; setSubjectPrependText; shutdown; _getFormattedNumEntriesPerPriority

Description

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.

Properties

$_eventsToMail
jump to class

array $_eventsToMail = 'array'

Array of formatted events to include in message body.

Details

$_eventsToMail: array
visibility: protected
default: array
final: false
static: false

$_layout
jump to class

Zend_Layout $_layout = ''

Zend_Layout instance to use; optional.

Details

$_layout: Zend_Layout
visibility: protected
default
final: false
static: false

$_layoutEventsToMail
jump to class

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.

Details

$_layoutEventsToMail: array
visibility: protected
default: array
final: false
static: false

$_layoutFormatter
jump to class

Zend_Log_Formatter_Interface $_layoutFormatter = ''

Optional formatter for use when rendering with Zend_Layout.

Details

$_layoutFormatter: Zend_Log_Formatter_Interface
visibility: protected
default
final: false
static: false

$_mail
jump to class

Zend_Mail $_mail = ''

Zend_Mail instance to use

Details

$_mail: Zend_Mail
visibility: protected
default
final: false
static: false

$_numEntriesPerPriority
jump to class

array $_numEntriesPerPriority = 'array'

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

Details

$_numEntriesPerPriority: array
visibility: protected
default: array
final: false
static: false

$_subjectPrependText
jump to class

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

$_subjectPrependText: string|null
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

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

Arguments

$mail: Zend_Mail
Mail instance
$layout: Zend_Layout
Layout instance; optional

Details

visibility: public
final: false
static: false

_getFormattedNumEntriesPerPriority
jump to class

_getFormattedNumEntriesPerPriority(
          
          )
        
        :
        string

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

Output

string

Details

visibility: protected
final: false
static: false

_write
jump to class

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

Arguments

$event: array
Event data

Details

visibility: protected
final: false
static: false

factory
jump to class

factory(
          array|Zend_Config $config
          )
        
        :
        Zend_Log_Writer_Mail

Create a new instance of Zend_Log_Writer_Mail

Arguments

$config: arrayZend_Config

Output

Zend_Log_Writer_Mail

Details

visibility: public
final: false
static: true
throws

getLayoutFormatter
jump to class

getLayoutFormatter(
          
          )
        
        :
        Zend_Log_Formatter_Interface|null

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

Output

Zend_Log_Formatter_Interface|null: The formatter, or null.

Details

visibility: public
final: false
static: false

setLayoutFormatter
jump to class

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.

Arguments

$formatter: Zend_Log_Formatter_Interface

Output

Zend_Log_Writer_Mail

Details

visibility: public
final: false
static: false
throws

setSubjectPrependText
jump to class

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.

Arguments

$subject: string
Subject prepend text.

Output

Zend_Log_Writer_Mail

Details

visibility: public
final: false
static: false

shutdown
jump to class

shutdown(
          
          )
        
        :
        void

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

Details

visibility: public
final: false
static: false

API Documentation

Log/Writer/Mail.php

Description

Zend_Log_Writer_Mailjump to top

Description

Properties

$_eventsToMailjump to class

Details

$_layoutjump to class

Details

$_layoutEventsToMailjump to class

Details

$_layoutFormatterjump to class

Details

$_mailjump to class

Details

$_numEntriesPerPriorityjump to class

Details

$_subjectPrependTextjump to class

Details

Methods

__constructjump to class

Arguments

Details

_getFormattedNumEntriesPerPriorityjump to class

Output

Details

_writejump to class

Arguments

Details

factoryjump to class

Arguments

Output

Details

getLayoutFormatterjump to class

Output

Details

setLayoutFormatterjump to class

Arguments

Output

Details

setSubjectPrependTextjump to class

Arguments

Output

Details

shutdownjump to class

Details

Zend_Log_Writer_Mail
jump to top

$_eventsToMail
jump to class

$_layout
jump to class

$_layoutEventsToMail
jump to class

$_layoutFormatter
jump to class

$_mail
jump to class

$_numEntriesPerPriority
jump to class

$_subjectPrependText
jump to class

__construct
jump to class

_getFormattedNumEntriesPerPriority
jump to class

_write
jump to class

factory
jump to class

getLayoutFormatter
jump to class

setLayoutFormatter
jump to class

setSubjectPrependText
jump to class

shutdown
jump to class