Class yii\debug\panels\AssetPanel

All Classes | Properties | Methods

Inheritance	yii\debug\panels\AssetPanel » 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/AssetPanel.php

Debugger panel that collects and displays asset bundles data.

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\AssetPanel
getError()		yii\debug\Panel
getName()		yii\debug\panels\AssetPanel
getSummary()		yii\debug\panels\AssetPanel
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\panels\AssetPanel
load()	Loads data into the panel	yii\debug\Panel
save()	Saves data to be later used in debugger detail view.	yii\debug\panels\AssetPanel
setError()		yii\debug\Panel

Protected Methods

Hide inherited methods

Method	Description	Defined By
format()	Additional formatting for view.	yii\debug\panels\AssetPanel
formatOptions()	Format associative array of params to simple value.	yii\debug\panels\AssetPanel

Method Details

Hide inherited methods

format() protected method

Additional formatting for view.

protected \yii\web\AssetBundle[] format ( array $bundles )
$bundles	\yii\web\AssetBundle[]	Array of bundles to formatting.

Source code

                protected function format(array $bundles)
{
    // @todo remove
    foreach ($bundles as $bundle) {
        array_walk($bundle->css, function(&$file, $key, $userdata) {
            $file = Html::a($file, $userdata->baseUrl . '/' . $file, ['target' => '_blank']);
        }, $bundle);
        array_walk($bundle->js, function(&$file, $key, $userdata) {
            $file = Html::a($file, $userdata->baseUrl . '/' . $file, ['target' => '_blank']);
        }, $bundle);
        array_walk($bundle->depends, function(&$depend) {
            $depend = Html::a($depend, '#' . $depend);
        });
        $this->formatOptions($bundle->publishOptions);
        $this->formatOptions($bundle->jsOptions);
        $this->formatOptions($bundle->cssOptions);
    }
    return $bundles;
}

formatOptions() protected method

Format associative array of params to simple value.

protected array formatOptions ( array &$params )
$params	array

Source code

                protected function formatOptions(array &$params)
{
    if (!is_array($params)) {
        return $params;
    }
    foreach ($params as $param => $value) {
        $params[$param] = Html::tag('strong', '\'' . $param . '\' => ') . (string) $value;
    }
    return $params;
}

getDetail() public method

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

Source code

                public function getDetail()
{
    return Yii::$app->view->render('panels/assets/detail', ['panel' => $this]);
}

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;
}

getName() public method

public string getName ( )
return	string	Name of the panel

Source code

                public function getName()
{
    return 'Asset Bundles';
}

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/assets/summary', ['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)

Checks whether this panel is enabled.

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

Source code

                public function isEnabled()
{
    try {
        Yii::$app->view->assetManager;
    } catch (InvalidConfigException $exception) {
        return false;
    }
    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()
{
    $bundles = Yii::$app->view->assetManager->bundles;
    if (empty($bundles)) { // bundles can be false
        return [];
    }
    $data = [];
    foreach ($bundles as $name => $bundle) {
        if ($bundle instanceof AssetBundle) {
            $bundleData = (array) $bundle;
            if (isset($bundleData['publishOptions']['beforeCopy']) && $bundleData['publishOptions']['beforeCopy'] instanceof \Closure) {
                $bundleData['publishOptions']['beforeCopy'] = '\Closure';
            }
            if (isset($bundleData['publishOptions']['afterCopy']) && $bundleData['publishOptions']['afterCopy'] instanceof \Closure) {
                $bundleData['publishOptions']['afterCopy'] = '\Closure';
            }
            $data[$name] = $bundleData;
        }
    }
    return $data;
}

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;
}