Class CProfileLogRoute

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 setReport 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.

CComponent

CLogRoute

CWebLogRoute

CProfileLogRoute

Package: system\logging
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/logging/CProfileLogRoute.php

Methods summary
`public`	# `init( )` Initializes the route. This method is invoked after the route is created by the route manager. Initializes the route. This method is invoked after the route is created by the route manager. Overrides `CLogRoute::init()`
`public string`	# `getReport( )` Returns `string` the type of the profiling report to display. Defaults to 'summary'.
`public`	# `setReport( string $value )` Parameters `$value` `string` $value the type of the profiling report to display. Valid values include 'summary' and 'callstack'. Throws `CException` if given value is not "summary" or "callstack"
`public`	# `processLogs( array $logs )` Displays the log messages. Displays the log messages. Parameters `$logs` `array` $logs list of log messages Overrides `CWebLogRoute::processLogs()`
`protected`	# `displayCallstack( array $logs )` Displays the callstack of the profiling procedures for display. Displays the callstack of the profiling procedures for display. Parameters `$logs` `array` $logs list of logs Throws `CException` if Yii::beginProfile() and Yii::endProfile() are not matching
`protected`	# `displaySummary( array $logs )` Displays the summary report of the profiling result. Displays the summary report of the profiling result. Parameters `$logs` `array` $logs list of logs Throws `CException` if Yii::beginProfile() and Yii::endProfile() are not matching
`protected array`	# `aggregateResult( array $result, float $delta )` Aggregates the report result. Aggregates the report result. Parameters `$result` `array` $result log result for this code block `$delta` `float` $delta time spent for this code block Returns `array`

Methods inherited from CWebLogRoute
`render()`

Methods inherited from CLogRoute
`collectLogs(), formatLogMessage()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public boolean`	`$groupByToken`	`true`	# whether to aggregate results according to profiling tokens. If false, the results will be aggregated by categories. Defaults to true. Note that this property only affects the summary report that is enabled when report is 'summary'. whether to aggregate results according to profiling tokens. If false, the results will be aggregated by categories. Defaults to true. Note that this property only affects the summary report that is enabled when report is 'summary'.

Properties inherited from CWebLogRoute
`$collapsedInFireBug, $ignoreAjaxInFireBug, $ignoreFlashInFireBug, $showInFireBug`

Properties inherited from CLogRoute
`$categories, $enabled, $except, $filter, $levels, $logs`

Magic properties summary
`public string`	`$report`	# The type of the profiling report to display. Defaults to 'summary'. The type of the profiling report to display. Defaults to 'summary'.

Packages

Classes

Interfaces

Class CProfileLogRoute

Overrides

Returns

Parameters

Throws

Parameters

Overrides

Parameters

Throws

Parameters

Throws

Parameters

Returns