CEmailLogRoute
| Package | system.logging |
|---|---|
| Inheritance | class CEmailLogRoute » CLogRoute » CComponent |
| Since | 1.0 |
| Version | $Id: CEmailLogRoute.php 2213 2010-06-18 13:17:30Z qiang.xue $ |
CEmailLogRoute sends selected log messages to email addresses.
The target email addresses may be specified via emails property. Optionally, you may set the email subject and the sentFrom address.
The target email addresses may be specified via emails property. Optionally, you may set the email subject and the sentFrom address.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| categories | string | list of categories separated by comma or space. | CLogRoute |
| emails | array | list of destination email addresses | CEmailLogRoute |
| enabled | boolean | whether to enable this log route. | CLogRoute |
| filter | mixed | the additional filter (e. | CLogRoute |
| levels | string | list of levels separated by comma or space. | CLogRoute |
| logs | array | the logs that are collected so far by this log route. | CLogRoute |
| sentFrom | string | send from address of the email | CEmailLogRoute |
| subject | string | email subject. | CEmailLogRoute |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| collectLogs() | Retrieves filtered log messages from logger for further processing. | CLogRoute |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getEmails() | CEmailLogRoute | |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getSentFrom() | CEmailLogRoute | |
| getSubject() | CEmailLogRoute | |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| init() | Initializes the route. | CLogRoute |
| raiseEvent() | Raises an event. | CComponent |
| setEmails() | CEmailLogRoute | |
| setSentFrom() | CEmailLogRoute | |
| setSubject() | CEmailLogRoute |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| formatLogMessage() | Formats a log message given different fields. | CLogRoute |
| processLogs() | Sends log messages to specified email addresses. | CEmailLogRoute |
| sendEmail() | Sends an email. | CEmailLogRoute |
Property Details
emails
property
list of destination email addresses
sentFrom
property
send from address of the email
subject
property
email subject. Defaults to CEmailLogRoute::DEFAULT_SUBJECT
Method Details
getEmails()
method
|
public array getEmails()
| ||
| {return} | array | list of destination email addresses |
getSentFrom()
method
|
public string getSentFrom()
| ||
| {return} | string | send from address of the email |
getSubject()
method
|
public string getSubject()
| ||
| {return} | string | email subject. Defaults to CEmailLogRoute::DEFAULT_SUBJECT |
processLogs()
method
|
protected void processLogs(array $logs)
| ||
| $logs | array | list of log messages |
Sends log messages to specified email addresses.
sendEmail()
method
|
protected void sendEmail(string $email, string $subject, string $message)
| ||
| string | single email address | |
| $subject | string | email subject |
| $message | string | email content |
Sends an email.
setEmails()
method
|
public array|string setEmails($value)
| ||
| $value | ||
| {return} | array|string | list of destination email addresses. If the value is a string, it is assumed to be comma-separated email addresses. |
setSentFrom()
method
|
public void setSentFrom(string $value)
| ||
| $value | string | send from address of the email |
setSubject()
method
|
public void setSubject(string $value)
| ||
| $value | string | email subject. |