ILogFilter
| Package | system.logging |
|---|---|
| Inheritance | interface ILogFilter |
| Subclasses | CChainedLogFilter, CLogFilter |
| Since | 1.1.11 |
| Source Code | framework/base/interfaces.php |
ILogFilter is the interface that must be implemented by log filters.
A log filter preprocesses the logged messages before they are handled by a log route. You can attach classes that implement ILogFilter to CLogRoute::$filter.
A log filter preprocesses the logged messages before they are handled by a log route. You can attach classes that implement ILogFilter to CLogRoute::$filter.
Public Methods
| Method | Description | Defined By |
|---|---|---|
| filter() | This method should be implemented to perform actual filtering of log messages | ILogFilter |
Method Details
filter() method
abstract public void filter(array &$logs) | ||
| $logs | array | list of messages. Each array element represents one message with the following structure: array( [0] => message (string) [1] => level (string) [2] => category (string) [3] => timestamp (float, obtained by microtime(true)); |
This method should be implemented to perform actual filtering of log messages by working on the array given as the first parameter. Implementation might reformat, remove or add information to logged messages.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/ILogFilter