Panel.php 2.05 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\debug;

Qiang Xue committed
10
use Yii;
Qiang Xue committed
11 12 13
use yii\base\Component;

/**
Qiang Xue committed
14 15
 * Panel is a base class for debugger panel classes. It defines how data should be collected,
 * what should be displayed at debug toolbar and on debugger details view.
Alexander Makarov committed
16
 *
17 18 19 20
 * @property string $detail Content that is displayed in debugger detail view. This property is read-only.
 * @property string $name Name of the panel. This property is read-only.
 * @property string $summary Content that is displayed at debug toolbar. This property is read-only.
 * @property string $url URL pointing to panel detail view. This property is read-only.
21
 *
Qiang Xue committed
22 23 24 25 26
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class Panel extends Component
{
Qiang Xue committed
27 28
	public $id;
	public $tag;
Qiang Xue committed
29 30 31 32
	/**
	 * @var Module
	 */
	public $module;
Qiang Xue committed
33
	public $data;
34 35 36
	/**
	 * @var array array of actions to add to the debug modules default controller.
	 * This array will be merged with all other panels actions property.
Carsten Brandt committed
37
	 * See [[\yii\base\Controller::actions()]] for the format.
38 39
	 */
	public $actions = [];
Qiang Xue committed
40

Alexander Makarov committed
41 42 43
	/**
	 * @return string name of the panel
	 */
Qiang Xue committed
44 45 46 47 48
	public function getName()
	{
		return '';
	}

Alexander Makarov committed
49 50 51
	/**
	 * @return string content that is displayed at debug toolbar
	 */
Qiang Xue committed
52 53 54 55 56
	public function getSummary()
	{
		return '';
	}

Alexander Makarov committed
57 58 59
	/**
	 * @return string content that is displayed in debugger detail view
	 */
Qiang Xue committed
60 61 62 63 64
	public function getDetail()
	{
		return '';
	}

Alexander Makarov committed
65 66 67 68 69 70
	/**
	 * Saves data to be later used in debugger detail view.
	 * This method is called on every page where debugger is enabled.
	 *
	 * @return mixed data to be saved
	 */
Qiang Xue committed
71 72 73 74 75
	public function save()
	{
		return null;
	}

76 77 78 79 80
	/**
	 * Loads data into the panel
	 *
	 * @param mixed $data
	 */
Qiang Xue committed
81 82 83 84
	public function load($data)
	{
		$this->data = $data;
	}
Qiang Xue committed
85

Alexander Makarov committed
86 87 88
	/**
	 * @return string URL pointing to panel detail view
	 */
Qiang Xue committed
89 90
	public function getUrl()
	{
91
		return Yii::$app->getUrlManager()->createUrl([$this->module->id . '/default/view',
Qiang Xue committed
92 93
			'panel' => $this->id,
			'tag' => $this->tag,
Alexander Makarov committed
94
		]);
Qiang Xue committed
95
	}
Qiang Xue committed
96
}