CProfileLogRoute
| Package | system.logging |
|---|---|
| Inheritance | class CProfileLogRoute » CWebLogRoute » CLogRoute » CComponent |
| Since | 1.0 |
| Version | $Id: CProfileLogRoute.php 433 2008-12-30 22:59:17Z qiang.xue $ |
CProfileLogRoute displays the profiling results in Web page.
The profiling is done by calling YiiBase::beginProfile() and YiiBase::endProfile(), which marks the begin and end of a code block.
CProfileLogRoute supports two types of report by setting the report property:
The profiling is done by calling YiiBase::beginProfile() and YiiBase::endProfile(), which marks the begin and end of a code block.
CProfileLogRoute supports two types of report by setting the report property:
- summary: list the execution time of every marked code block
- callstack: list the mark code blocks in a hierarchical view reflecting their calling sequence.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| categories | string | list of categories separated by comma or space. | CLogRoute |
| levels | string | list of levels separated by comma or space. | CLogRoute |
| report | string | the type of the profiling report to display. | CProfileLogRoute |
| showInFireBug | boolean | whether the log should be displayed in FireBug instead of browser window. | CWebLogRoute |
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 |
| collectLogs() | Retrieves filtered log messages from logger for further processing. | CLogRoute |
| 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 |
| getReport() | CProfileLogRoute | |
| 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 |
| init() | Initializes the route. | CProfileLogRoute |
| processLogs() | Displays the log messages. | CProfileLogRoute |
| raiseEvent() | Raises an event. | CComponent |
| setReport() | CProfileLogRoute |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| aggregateResult() | Aggregates the report result. | CProfileLogRoute |
| displayCallstack() | Displays the callstack of the profiling procedures for display. | CProfileLogRoute |
| displaySummary() | Displays the summary report of the profiling result. | CProfileLogRoute |
| formatLogMessage() | Formats a log message given different fields. | CLogRoute |
| render() | Renders the view. | CWebLogRoute |
Property Details
report
property
the type of the profiling report to display. Defaults to 'summary'.
Method Details
aggregateResult()
method
|
protected void aggregateResult(array $result, float $delta)
| ||
| $result | array | log result for this code block |
| $delta | float | time spent for this code block |
Aggregates the report result.
displayCallstack()
method
|
protected void displayCallstack(array $logs)
| ||
| $logs | array | list of logs |
Displays the callstack of the profiling procedures for display.
displaySummary()
method
|
protected void displaySummary(array $logs)
| ||
| $logs | array | list of logs |
Displays the summary report of the profiling result.
getReport()
method
|
public string getReport()
| ||
| {return} | string | the type of the profiling report to display. Defaults to 'summary'. |
init()
method
|
public void init()
|
Initializes the route. This method is invoked after the route is created by the route manager.
processLogs()
method
|
public void processLogs(array $logs)
| ||
| $logs | array | list of log messages |
Displays the log messages.
setReport()
method
|
public void setReport(string $value)
| ||
| $value | string | the type of the profiling report to display. Valid values include 'summary' and 'callstack'. |