LogFilter
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\LogFilter » CLogFilter (opens new window) » CComponent (opens new window)
- Implements
ILogFilter- Since
- 2.3
LogFilter pre-processes the logged messages before they are handled by a log route.
LogFilter is meant to be used by a log route to pre-process the logged messages before they are handled by the route. The default implementation of LogFilter prepends additional context information to the logged messages. In particular, by setting {@link logVars}, predefined PHP variables such as $_SERVER, $_POST, etc. can be saved as a log message, which may help identify/debug issues encountered.
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $dumper (opens new window) | callable (opens new window) – Or function which will be used to dump context information. |
| $logUser (opens new window) | boolean (opens new window) – Whether to log the current user name and ID. |
| $logVars (opens new window) | array (opens new window) – List of the PHP predefined variables that should be logged. |
| $prefixSession (opens new window) | boolean (opens new window) – Whether to prefix each log message with the current user session ID. |
| $prefixUser (opens new window) | boolean (opens new window) – Whether to prefix each log message with the current user {@link CWebUser::name name} and {@link CWebUser::id ID}. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __construct() | |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| filter() (opens new window) | Filters the given log messages. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| raiseEvent() (opens new window) | Raises an event. |
# __construct()
Signature
public Craft\LogFilter __construct ( )
# Protected Methods
| Method | Description |
|---|---|
| format() (opens new window) | Formats the log messages. |
| getContext() (opens new window) | Generates the context information to be logged. |