Spec-Zone.ru › Yii 2.0

Класс yii\debug\Panel

Все классы | Свойства | Методы
Наследование yii\debug\Panel » yii\base\Component » yii\base\Object
Реализует yii\base\Configurable
Подклассы yii\debug\panels\AssetPanel, yii\debug\panels\ConfigPanel, yii\debug\panels\DbPanel, yii\debug\panels\LogPanel, yii\debug\panels\MailPanel, yii\debug\panels\ProfilingPanel, yii\debug\panels\RequestPanel, yii\debug\panels\RouterPanel, yii\debug\panels\TimelinePanel, yii\debug\panels\UserPanel, yii\elasticsearch\DebugPanel, yii\httpclient\debug\HttpClientPanel, yii\mongodb\debug\MongoDbPanel
Доступна с версии 2.0
Исходный код https://github.com/yiisoft/yii2-debug/blob/master/Panel.php

Panel — базовый класс для классов панелей отладчика. Он определяет, как должны собираться данные, что должно отображаться в панели отладки и на странице подробностей отладчика.

Публичные свойства

Свойство Тип Описание Определено в
$actions массив Массив действий, которые нужно добавить к контроллеру модуля отладки по умолчанию. yii\debug\Panel
$behaviors yii\base\Behavior[] Список поведений, присоединенных к этому компоненту yii\base\Component
$data смешанный Данные, связанные с панелью yii\debug\Panel
$detail строка Содержание, отображаемое в представлении подробностей отладчика yii\debug\Panel
$id строка Уникальный идентификатор панели. yii\debug\Panel
$module yii\debug\Module yii\debug\Panel
$name строка Имя панели yii\debug\Panel
$summary строка Содержание, отображаемое в панели инструментов отладки yii\debug\Panel
$tag строка Идентификатор набора данных запроса. yii\debug\Panel
$url строка URL, указывающий на представление подробностей панели yii\debug\Panel

Общедоступные методы

Метод Описание Определено в
__call() Вызывает метод с указанным именем, который не является методом класса. yii\base\Component
__clone() Этот метод вызывается после создания объекта путем клонирования существующего. yii\base\Component
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства компонента. yii\base\Component
__isset() Проверяет, установлено ли свойство, т. е. определено и не равно null. yii\base\Component
__set() Устанавливает значение свойства компонента. yii\base\Component
__unset() Устанавливает свойство компонента в значение null. yii\base\Component
attachBehavior() Присоединяет поведение к компоненту. yii\base\Component
attachBehaviors() Присоединяет список поведений к компоненту. yii\base\Component
behaviors() Возвращает список поведений, по которым должен вести себя этот компонент. yii\base\Component
canGetProperty() Возвращает значение, указывающее, можно ли прочитать свойство. yii\base\Component
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Component
className() Возвращает полное имя этого класса. yii\base\Object
detachBehavior() Отсоединяет поведение от компонента. yii\base\Component
detachBehaviors() Отсоединяет все поведения от компонента. yii\base\Component
ensureBehaviors() Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. yii\base\Component
getBehavior() Возвращает объект поведения с заданным именем. yii\base\Component
getBehaviors() Возвращает все поведения, присоединенные к этому компоненту. yii\base\Component
getDetail() yii\debug\Panel
getName() yii\debug\Panel
getSummary() yii\debug\Panel
getTraceLine() Возвращает строку трассировки yii\debug\Panel
getUrl() yii\debug\Panel
hasEventHandlers() Возвращает значение, указывающее, есть ли обработчики событий, прикрепленные к событию с указанным именем. yii\base\Component
hasMethod() Возвращает значение, указывающее, определен ли метод. yii\base\Component
hasProperty() Возвращает значение, указывающее, определено ли свойство для данного компонента. yii\base\Component
init() Инициализирует объект. yii\base\Object
load() Загружает данные в панель yii\debug\Panel
off() Отсоединяет существующий обработчик событий от данного компонента. yii\base\Component
on() Присоединяет обработчик события к событию. yii\base\Component
save() Сохраняет данные для последующего использования в представлении подробностей отладчика. yii\debug\Panel
trigger() Вызывает событие. yii\base\Component

Подробности свойств

$actions общедоступное свойство

Массив действий, которые нужно добавить к контроллеру по умолчанию модулей отладки. Этот массив будет объединён со всеми другими свойствами действий панелей. Смотрите yii\base\Controller::actions() для формата.

public array $actions = []

$data свойство public

Данные, связанные с панелью

public mixed $data = null

$detail свойство public только для чтения

Содержание, отображаемое в представлении подробностей отладчика

public string getDetail ( )

$id свойство public

Уникальный идентификатор панели. Он устанавливается автоматически модулем контейнера.

public string $id = null

$module свойство public

public yii\debug\Module $module = null

$name свойство public только для чтения

Название панели

public string getName ( )

$summary свойство public только для чтения

Содержание, отображаемое в панели инструментов отладки

public string getSummary ( )

$tag свойство public

Идентификатор набора данных запроса.

public string $tag = null

$url свойство public только для чтения

URL, указывающий на представление подробностей панели

public string getUrl ( $additionalParams = null )

Подробное описание методов

getDetail() метод public

public string getDetail ( )
return string

Содержание, отображаемое в представлении подробностей отладчика

getName() метод public

public string getName ( )
return string

Название панели

getSummary() метод public

public string getSummary ( )
return string

Содержание, отображаемое в панели инструментов отладки

getTraceLine() метод public (доступен начиная с версии 2.0.7)

Возвращает строку трассировки

public string getTraceLine ( $options )
$options array

Массив с трассировкой

return string

Строка трассировки

getUrl() метод public

public string getUrl ( $additionalParams = null )
$additionalParams null|array

Дополнительные параметры для добавления к маршруту

return string

URL, указывающий на представление подробностей панели

load() метод public

Загружает данные в панель

public void load ( $data )
$data mixed

save() метод public

Сохраняет данные для последующего использования в представлении подробностей отладчика.

Этот метод вызывается на каждой странице, где включена отладка.

public mixed save ( )
return mixed

Сохраняемые данные

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-debug-panel.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API