Класс yii\debug\panels\MailPanel
| Наследование | yii\debug\panels\MailPanel » yii\debug\Panel » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-debug/blob/master/panels/MailPanel.php |
Панель отладчика, которая собирает и отображает сгенерированные письма.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $actions | массив | Массив действий, которые нужно добавить к контроллеру модуля отладки по умолчанию. | yii\debug\Panel |
| $behaviors | yii\base\Behavior[] | Список поведенческих модулей, присоединённых к этому компоненту | yii\base\Component |
| $data | смешанный | Данные, связанные с панелью | yii\debug\Panel |
| $detail | строка | Содержимое, отображаемое в детальном представлении отладчика | yii\debug\panels\MailPanel |
| $id | строка | Уникальный идентификатор панели. | yii\debug\Panel |
| $mailPath | строка | Путь, где будут сохранены все письма. | yii\debug\panels\MailPanel |
| $messages | массив | Сообщения | yii\debug\panels\MailPanel |
| $module | yii\debug\Module | yii\debug\Panel | |
| $name | строка | Имя панели | yii\debug\panels\MailPanel |
| $summary | строка | Содержимое, отображаемое в строке отладки | yii\debug\panels\MailPanel |
| $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\panels\MailPanel | |
| getMessages() | Возвращает информацию о сообщениях текущего запроса. Каждый элемент — массив, содержащий информацию о сообщении, например: время, ответ, bc, cc, от, до и другое. | yii\debug\panels\MailPanel |
| getName() | yii\debug\panels\MailPanel | |
| getSummary() | yii\debug\panels\MailPanel | |
| getTraceLine() | Возвращает строку трассировки | yii\debug\Panel |
| getUrl() | yii\debug\Panel | |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикреплённый к событию с заданным именем. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует объект. | yii\debug\panels\MailPanel |
| load() | Загружает данные в панель | yii\debug\Panel |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| save() | Сохраняет данные для последующего использования в детальном представлении отладчика. | yii\debug\panels\MailPanel |
| trigger() | Срабатывает событие. | yii\base\Component |
Подробности свойств
$detail public только для чтения свойство
Содержание, отображаемое в детальном представлении отладчика
public string getDetail ( )
$mailPath public свойство
Путь, по которому будут сохраняться все электронные письма. Должен быть псевдонимом.
public string $mailPath = '@runtime/debug/mail'
$messages public только для чтения свойство
Сообщения
public array getMessages ( )
$name public только для чтения свойство
Имя панели
public string getName ( )
$summary public только для чтения свойство
Содержание, отображаемое в панели инструментов отладки
public string getSummary ( )
Подробное описание методов
getDetail() public метод
| public string getDetail ( ) | ||
|---|---|---|
| return | string |
Содержание, отображаемое в детальном представлении отладчика |
getMessages() public метод
Возвращает информацию о сообщениях текущего запроса. Каждый элемент представляет собой массив, содержащий информацию о сообщении, такую как: время, ответ, bc, cc, от, до и другие.
| public array getMessages ( ) | ||
|---|---|---|
| return | array |
Сообщения |
getName() public метод
| public string getName ( ) | ||
|---|---|---|
| return | string |
Имя панели |
getSummary() public метод
| public string getSummary ( ) | ||
|---|---|---|
| return | string |
Содержание, отображаемое в панели инструментов отладки |
init() public метод
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.
| public void init ( ) |
|---|
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-panels-mailpanel.html
