CChainedLogFilter
| Package | system.logging |
|---|---|
| Inheritance | class CChainedLogFilter » CComponent |
| Implements | ILogFilter |
| Since | 1.1.13 |
| Source Code | framework/logging/CChainedLogFilter.php |
CChainedLogFilter allows you to attach multiple log filters to a log route (See CLogRoute::$filter for details).
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| filters | array | list of filters to apply to the logs. | CChainedLogFilter |
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 |
| 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 |
| filter() | Filters the given log messages by applying all filters configured by filters. | CChainedLogFilter |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| 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 |
| raiseEvent() | Raises an event. | CComponent |
Property Details
filters property
public array $filters;
list of filters to apply to the logs. The value of each array element will be passed to Yii::createComponent to create a log filter object. As a result, this can be either a string representing the filter class name or an array representing the filter configuration. In general, the log filter classes should implement ILogFilter interface. Filters will be applied in the order they are defined.
Method Details
filter() method
public void filter(array &$logs) | ||
| $logs | array | the log messages |
Source Code: framework/logging/CChainedLogFilter.php#34 (show)
public function filter(&$logs)
{
foreach($this->filters as $filter)
Yii::createComponent($filter)->filter($logs);
}
Filters the given log messages by applying all filters configured by filters.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CChainedLogFilter