CLogger
| Package | system.logging |
|---|---|
| Inheritance | class CLogger » CComponent |
| Since | 1.0 |
| Version | $Id: CLogger.php 433 2008-12-30 22:59:17Z qiang.xue $ |
CLogger implements the methods to retrieve the messages with various filter conditions, including log levels and log categories.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| executionTime | float | Returns the total time for serving the current request. | CLogger |
| logs | array | Retrieves log messages. | CLogger |
| memoryUsage | integer | Returns the memory usage of the current application. | CLogger |
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 |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getExecutionTime() | Returns the total time for serving the current request. | CLogger |
| getLogs() | Retrieves log messages. | CLogger |
| getMemoryUsage() | Returns the memory usage of the current application. | CLogger |
| 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 |
| log() | Logs a message. | CLogger |
| raiseEvent() | Raises an event. | CComponent |
Property Details
Returns the total time for serving the current request. This method calculates the difference between now and the timestamp defined by constant YII_BEGIN_TIME. To estimate the execution time more accurately, the constant should be defined as early as possible (best at the beginning of the entry script.)
Retrieves log messages.
Messages may be filtered by log levels and/or categories.
A level filter is specified by a list of levels separated by comma or space
(e.g. 'trace, error'). A category filter is similar to level filter
(e.g. 'system, system.web'). A difference is that in category filter
you can use pattern like 'system.*' to indicate all categories starting
with 'system'.
If you do not specify level filter, it will bring back logs at all levels.
The same applies to category filter.
Level filter and category filter are combinational, i.e., only messages
satisfying both filter conditions will be returned.
Returns the memory usage of the current application. This method relies on the PHP function memory_get_usage(). If it is not available, the method will attempt to use OS programs to determine the memory usage. A value 0 will be returned if the memory usage can still not be determined.
Method Details
|
public float getExecutionTime()
| ||
| {return} | float | the total time for serving the current request. |
Returns the total time for serving the current request. This method calculates the difference between now and the timestamp defined by constant YII_BEGIN_TIME. To estimate the execution time more accurately, the constant should be defined as early as possible (best at the beginning of the entry script.)
|
public array getLogs(string $levels='', string $categories='')
| ||
| $levels | string | level filter |
| $categories | string | category filter |
| {return} | array | list of messages. Each array elements represents one message with the following structure: array( [0] => message (string) [1] => level (string) [2] => category (string) [3] => timestamp (float, obtained by microtime(true)); |
Retrieves log messages.
Messages may be filtered by log levels and/or categories.
A level filter is specified by a list of levels separated by comma or space
(e.g. 'trace, error'). A category filter is similar to level filter
(e.g. 'system, system.web'). A difference is that in category filter
you can use pattern like 'system.*' to indicate all categories starting
with 'system'.
If you do not specify level filter, it will bring back logs at all levels.
The same applies to category filter.
Level filter and category filter are combinational, i.e., only messages
satisfying both filter conditions will be returned.
|
public integer getMemoryUsage()
| ||
| {return} | integer | memory usage of the application (in bytes). |
Returns the memory usage of the current application. This method relies on the PHP function memory_get_usage(). If it is not available, the method will attempt to use OS programs to determine the memory usage. A value 0 will be returned if the memory usage can still not be determined.
|
public void log(string $message, string $level='info', string $category='application')
| ||
| $message | string | message to be logged |
| $level | string | level of the message (e.g. 'Trace', 'Warning', 'Error'). It is case-insensitive. |
| $category | string | category of the message (e.g. 'system.web'). It is case-insensitive. |
Logs a message. Messages logged by this method may be retrieved back via getLogs.