0 follower

CProfileLogRoute

Package	system.logging
Inheritance	class CProfileLogRoute » CWebLogRoute » CLogRoute » CComponent
Since	1.0
Source Code	framework/logging/CProfileLogRoute.php

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.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
categories	mixed	array of categories, or string list separated by comma or space.	CLogRoute
collapsedInFireBug	boolean	whether the log should be collapsed by default in Firebug.	CWebLogRoute
enabled	boolean	whether to enable this log route.	CLogRoute
except	mixed	array of categories, or string list separated by comma or space, to EXCLUDE from logs.	CLogRoute
filter	mixed	the additional filter (eg CLogFilter) that can be applied to the log messages.	CLogRoute
groupByToken	boolean	whether to aggregate results according to profiling tokens.	CProfileLogRoute
ignoreAjaxInFireBug	boolean	whether the log should be ignored in FireBug for ajax calls.	CWebLogRoute
ignoreFlashInFireBug	boolean	whether the log should be ignored in FireBug for Flash/Flex calls.	CWebLogRoute
levels	string	list of levels separated by comma or space.	CLogRoute
logs	array	the logs that are collected so far by this log route.	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

Hide inherited 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
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getReport()	Returns the type of the profiling report to display. Defaults to 'summary'.	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()	Sets the type of the profiling report to display. Valid values include 'summary' and 'callstack'.	CProfileLogRoute

Protected Methods

Hide inherited 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

groupByToken property

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 property

public string getReport()
public void setReport(string $value)

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

Method Details

aggregateResult() method

protected array aggregateResult(array $result, float $delta)
$result	array	log result for this code block
$delta	float	time spent for this code block
{return}	array

Source Code: framework/logging/CProfileLogRoute.php#205 (show)


protected function aggregateResult($result,$delta)
{
    list($token,$calls,$min,$max,$total)=$result;
    if($delta<$min)
        $min=$delta;
    elseif($delta>$max)
        $max=$delta;
    $calls++;
    $total+=$delta;
    return array($token,$calls,$min,$max,$total);
}

Aggregates the report result.

displayCallstack() method

protected void displayCallstack(array $logs)
$logs	array	list of logs

Source Code: framework/logging/CProfileLogRoute.php#94 (show)


protected function displayCallstack($logs)
{
    $stack=array();
    $results=array();
    $n=0;
    foreach($logs as $log)
    {
        if($log[1]!==CLogger::LEVEL_PROFILE)
            continue;
        $message=$log[0];
        if(!strncasecmp($message,'begin:',6))
        {
            $log[0]=substr($message,6);
            $log[4]=$n;
            $stack[]=$log;
            $n++;
        }
        elseif(!strncasecmp($message,'end:',4))
        {
            $token=substr($message,4);
            if(($last=array_pop($stack))!==null && $last[0]===$token)
            {
                $delta=$log[3]-$last[3];
                $results[$last[4]]=array($token,$delta,count($stack));
            }
            else
                throw new CException(Yii::t('yii','CProfileLogRoute found a mismatching code block "{token}". Make sure the calls to Yii::beginProfile() and Yii::endProfile() be properly nested.',
                    array('{token}'=>$token)));
        }
    }
    // remaining entries should be closed here
    $now=microtime(true);
    while(($last=array_pop($stack))!==null)
        $results[$last[4]]=array($last[0],$now-$last[3],count($stack));
    ksort($results);
    $this->render('profile-callstack',$results);
}

Displays the callstack of the profiling procedures for display.

displaySummary() method

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

Source Code: framework/logging/CProfileLogRoute.php#137 (show)


protected function displaySummary($logs)
{
    $stack=array();
    $results=array();
    foreach($logs as $log)
    {
        if($log[1]!==CLogger::LEVEL_PROFILE)
            continue;
        $message=$log[0];
        if(!strncasecmp($message,'begin:',6))
        {
            $log[0]=substr($message,6);
            $stack[]=$log;
        }
        elseif(!strncasecmp($message,'end:',4))
        {
            $token=substr($message,4);
            if(($last=array_pop($stack))!==null && $last[0]===$token)
            {
                $delta=$log[3]-$last[3];
                if(!$this->groupByToken)
                    $token=$log[2];
                if(isset($results[$token]))
                    $results[$token]=$this->aggregateResult($results[$token],$delta);
                else
                    $results[$token]=array($token,1,$delta,$delta,$delta);
            }
            else
                throw new CException(Yii::t('yii','CProfileLogRoute found a mismatching code block "{token}". Make sure the calls to Yii::beginProfile() and Yii::endProfile() be properly nested.',
                    array('{token}'=>$token)));
        }
    }

    $now=microtime(true);
    while(($last=array_pop($stack))!==null)
    {
        $delta=$now-$last[3];
        $token=$this->groupByToken ? $last[0] : $last[2];
        if(isset($results[$token]))
            $results[$token]=$this->aggregateResult($results[$token],$delta);
        else
            $results[$token]=array($token,1,$delta,$delta,$delta);
    }

    $entries=array_values($results);
    usort($entries, array($this, 'resultEntryCompare'));

    $this->render('profile-summary',$entries);
}

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

Source Code: framework/logging/CProfileLogRoute.php#55 (show)


public function getReport()
{
    return $this->_report;
}

init() method

public void init()

Source Code: framework/logging/CProfileLogRoute.php#47 (show)


public function init()
{
    $this->levels=CLogger::LEVEL_PROFILE;
}

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

Source Code: framework/logging/CProfileLogRoute.php#77 (show)


public function processLogs($logs)
{
    $app=Yii::app();
    if(!($app instanceof CWebApplication) || $app->getRequest()->getIsAjaxRequest())
        return;

    if($this->getReport()==='summary')
        $this->displaySummary($logs);
    else
        $this->displayCallstack($logs);
}

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

Source Code: framework/logging/CProfileLogRoute.php#64 (show)


public function setReport($value)
{
    if($value==='summary' || $value==='callstack')
        $this->_report=$value;
    else
        throw new CException(Yii::t('yii','CProfileLogRoute.report "{report}" is invalid. Valid values include "summary" and "callstack".',
            array('{report}'=>$value)));
}