Class yii\debug\panels\LogPanel

All Classes | Properties | Methods

Inheritance	yii\debug\panels\LogPanel » yii\debug\Panel » yii\base\Component
Available since extension's version	2.0
Source Code	https://github.com/yiisoft/yii2-debug/blob/master/src/panels/LogPanel.php

Debugger panel that collects and displays logs.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$actions	array	Array of actions to add to the debug modules default controller.	yii\debug\Panel
$data	mixed	Data associated with panel	yii\debug\Panel
$detail	string	Content that is displayed in debugger detail view.	yii\debug\Panel
$error	yii\debug\FlattenException\|null	Error while saving the panel	yii\debug\Panel
$id	string	Panel unique identifier.	yii\debug\Panel
$module	yii\debug\Module		yii\debug\Panel
$name	string	Name of the panel.	yii\debug\Panel
$summary	string	Content that is displayed at debug toolbar.	yii\debug\Panel
$tag	string	Request data set identifier.	yii\debug\Panel
$url	string	URL pointing to panel detail view.	yii\debug\Panel

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By

Public Methods

Hide inherited methods

Method	Description	Defined By
getDetail()		yii\debug\panels\LogPanel
getError()		yii\debug\Panel
getName()		yii\debug\panels\LogPanel
getSummary()		yii\debug\panels\LogPanel
getTraceLine()	Returns a trace line	yii\debug\Panel
getUrl()		yii\debug\Panel
hasError()		yii\debug\Panel
isEnabled()	Checks whether this panel is enabled.	yii\debug\Panel
load()	Loads data into the panel	yii\debug\Panel
save()	Saves data to be later used in debugger detail view.	yii\debug\panels\LogPanel
setError()		yii\debug\Panel

Protected Methods

Hide inherited methods

Method	Description	Defined By
getModels()	Returns an array of models that represents logs of the current request.	yii\debug\panels\LogPanel

Method Details

Hide inherited methods

getDetail() public method

public string getDetail ( )
return	string	Content that is displayed in debugger detail view

Source code

                public function getDetail()
{
    $searchModel = new Log();
    $dataProvider = $searchModel->search(Yii::$app->request->getQueryParams(), $this->getModels());
    return Yii::$app->view->render('panels/log/detail', [
        'dataProvider' => $dataProvider,
        'panel' => $this,
        'searchModel' => $searchModel,
    ]);
}

getError() public method (available since version 2.0.10)

Defined in: yii\debug\Panel::getError()

public yii\debug\FlattenException\|null getError ( )

Source code

                public function getError()
{
    return $this->error;
}

getModels() protected method

Returns an array of models that represents logs of the current request.

Can be used with data providers, such as \yii\data\ArrayDataProvider.

protected array getModels ( $refresh = false )
$refresh	boolean	If need to build models from log messages and refresh them.
return	array	Models

Source code

                protected function getModels($refresh = false)
{
    if ($this->_models === null || $refresh) {
        $this->_models = [];
        foreach ($this->data['messages'] as $message) {
            $this->_models[] = [
                'message' => $message[0],
                'level' => $message[1],
                'category' => $message[2],
                'time' => $message[3] * 1000, // time in milliseconds
                'trace' => isset($message[4]) ? $message[4] : [],
            ];
        }
    }
    return $this->_models;
}

getName() public method

public string getName ( )
return	string	Name of the panel

Source code

                public function getName()
{
    return 'Logs';
}

getSummary() public method

public string getSummary ( )
return	string	Content that is displayed at debug toolbar

Source code

                public function getSummary()
{
    return Yii::$app->view->render('panels/log/summary', ['data' => $this->data, 'panel' => $this]);
}

getTraceLine() public method (available since version 2.0.7)

Defined in: yii\debug\Panel::getTraceLine()

Returns a trace line

public string getTraceLine ( $options )
$options	array	The array with trace
return	string	The trace line

Source code

                public function getTraceLine($options)
{
    if (!isset($options['text'])) {
        $options['text'] = "{$options['file']}:{$options['line']}";
    }
    $traceLine = $this->module->traceLine;
    if ($traceLine === false) {
        return $options['text'];
    }
    $options['file'] = str_replace('\\', '/', $options['file']);
    $rawLink = $traceLine instanceof \Closure ? $traceLine($options, $this) : $traceLine;
    return strtr($rawLink, ['{file}' => $options['file'], '{line}' => $options['line'], '{text}' => $options['text']]);
}

getUrl() public method

Defined in: yii\debug\Panel::getUrl()

public string getUrl ( $additionalParams = null )
$additionalParams	null\|array	Optional additional parameters to add to the route
return	string	URL pointing to panel detail view

Source code

                public function getUrl($additionalParams = null)
{
    $route = [
        '/' . $this->module->id . '/default/view',
        'panel' => $this->id,
        'tag' => $this->tag,
    ];
    if (is_array($additionalParams)){
        $route = ArrayHelper::merge($route, $additionalParams);
    }
    return Url::toRoute($route);
}

hasError() public method (available since version 2.0.10)

Defined in: yii\debug\Panel::hasError()

public boolean hasError ( )

Source code

                public function hasError()
{
    return $this->error !== null;
}

isEnabled() public method (available since version 2.0.10)

Defined in: yii\debug\Panel::isEnabled()

Checks whether this panel is enabled.

public boolean isEnabled ( )
return	boolean	Whether this panel is enabled.

Source code

                public function isEnabled()
{
    return true;
}

load() public method

Defined in: yii\debug\Panel::load()

Loads data into the panel

public void load ( $data )
$data	mixed

Source code

                public function load($data)
{
    $this->data = $data;
}

save() public method

Saves data to be later used in debugger detail view.

This method is called on every page where debugger is enabled.

public mixed save ( )
return	mixed	Data to be saved

Source code

                public function save()
{
    $target = $this->module->logTarget;
    $except = [];
    if (isset($this->module->panels['router'])) {
        $except = $this->module->panels['router']->getCategories();
    }
    
    $messages = $target->filterMessages($target->messages, Logger::LEVEL_ERROR | Logger::LEVEL_INFO | Logger::LEVEL_WARNING | Logger::LEVEL_TRACE, [], $except);
    foreach ($messages as &$message) {
        if (!is_string($message[0])) {
            // exceptions may not be serializable if in the call stack somewhere is a Closure
            if ($message[0] instanceof \Throwable || $message[0] instanceof \Exception) {
                $message[0] = (string) $message[0];
            } else {
                $message[0] = VarDumper::export($message[0]);
            }
        }
    }
    return ['messages' => $messages];
}

setError() public method (available since version 2.0.10)

Defined in: yii\debug\Panel::setError()

public void setError ( yii\debug\FlattenException $error )
$error	yii\debug\FlattenException

Source code

                public function setError(FlattenException $error)
{
    $this->error = $error;
}