system system.base system.caching system.caching.dependencies system.collections system.console system.db system.db.ar system.db.schema system.db.schema.mssql system.db.schema.mysql system.db.schema.oci system.db.schema.pgsql system.db.schema.sqlite system.i18n system.i18n.gettext system.logging system.utils system.validators system.web system.web.actions system.web.auth system.web.filters system.web.helpers system.web.renderers system.web.services system.web.widgets system.web.widgets.captcha system.web.widgets.pagers

CProfileLogRoute

system.logging
继承 class CProfileLogRoute » CWebLogRoute » CLogRoute » CComponent
可用自 1.0
版本 $Id$
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:
  • summary: list the execution time of every marked code block
  • callstack: list the mark code blocks in a hierarchical view reflecting their calling sequence.

公共属性

隐藏继承的属性

属性类型描述被定义在
categories string list of categories separated by comma or space. CLogRoute
enabled boolean whether to enable this log route. CLogRoute
filter mixed the additional filter (e. CLogRoute
groupByToken boolean whether to aggregate results according to profiling tokens. CProfileLogRoute
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

公共方法

隐藏继承的方法

方法描述被定义在
__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

受保护的方法

隐藏继承的方法

方法描述被定义在
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

属性详情

groupByToken 属性 (自版本 v1.0.6 可用)
public boolean $groupByToken;

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

report 属性
public string getReport()
public void setReport(string $value)

the type of the profiling report to display. Defaults to 'summary'.

方法详情

aggregateResult() 方法
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() 方法
protected void displayCallstack(array $logs)
$logs array list of logs

Displays the callstack of the profiling procedures for display.

displaySummary() 方法
protected void displaySummary(array $logs)
$logs array list of logs

Displays the summary report of the profiling result.

getReport() 方法
public string getReport()
{return} string the type of the profiling report to display. Defaults to 'summary'.

init() 方法
public void init()

Initializes the route. This method is invoked after the route is created by the route manager.

processLogs() 方法
public void processLogs(array $logs)
$logs array list of log messages

Displays the log messages.

setReport() 方法
public void setReport(string $value)
$value string the type of the profiling report to display. Valid values include 'summary' and 'callstack'.