FileLogRoute
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\FileLogRoute » CFileLogRoute (opens new window) » CLogRoute (opens new window) » CComponent (opens new window)
- Since
- 1.0
Class FileLogRoute
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $categories (opens new window) | mixed – Array of categories, or string list separated by comma or space. |
| $enabled (opens new window) | boolean (opens new window) – Whether to enable this log route. |
| $except (opens new window) | mixed – Array of categories, or string list separated by comma or space, to EXCLUDE from logs. |
| $filter (opens new window) | mixed – The additional filter (eg {@link CLogFilter}) that can be applied to the log messages. |
| $levels (opens new window) | string (opens new window) – List of levels separated by comma or space. |
| $logs (opens new window) | array (opens new window) – The logs that are collected so far by this log route. |
| $rotateByCopy (opens new window) | boolean (opens new window) – Whether to rotate primary log by copy and truncate which is more compatible with log tailers. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __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. |
| collectLogs() (opens new window) | Retrieves filtered log messages from logger for further processing. |
| 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. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getLogFile() (opens new window) | |
| getLogPath() (opens new window) | |
| getMaxFileSize() (opens new window) | |
| getMaxLogFiles() (opens new window) | |
| 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. |
| init() | Initializes the log route. This method is invoked after the log route is created by the route manager. |
| raiseEvent() (opens new window) | Raises an event. |
| setLogFile() (opens new window) | |
| setLogPath() (opens new window) | |
| setMaxFileSize() (opens new window) | |
| setMaxLogFiles() (opens new window) |
# init()
Initializes the log route. This method is invoked after the log route is created by the route manager.
View source (opens new window)
Returns
Signature
public null init ( )
# Protected Methods
| Method | Description |
|---|---|
| formatLogMessage() (opens new window) | Formats a log message given different fields. |
| formatLogMessageWithForce() | Formats a log message given different fields. |
| processLogs() | Saves log messages in files. |
| rotateFiles() (opens new window) | Rotates log files. |
# formatLogMessageWithForce()
Formats a log message given different fields.
View source (opens new window)
Arguments
$message(string (opens new window)) – The message content.$level(integer (opens new window)) – The message level.$category(string (opens new window)) – The message category.$time(integer (opens new window)) – The message timestamp.$force(boolean (opens new window)) – Whether the message was forced or not.
Returns
string (opens new window) – The formatted message.
Signature
protected string formatLogMessageWithForce ( $message, $level, $category, $time, $force )
# processLogs()
Saves log messages in files.
View source (opens new window)
Arguments
$logs(array (opens new window)) – The list of log messages
Returns
Signature
protected null processLogs ( $logs )