Класс yii\debug\Module
| Наследование | yii\debug\Module » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\BootstrapInterface, yii\base\Configurable |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-debug/blob/master/Module.php |
Модуль Yii Debug предоставляет панель отладки и отладчик
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $aliases | массив | Список псевдонимов путей для определения. | yii\base\Module |
| $allowedHosts | массив | Список хостов, разрешенных для доступа к этому модулю. | yii\debug\Module |
| $allowedIPs | массив | Список IP-адресов, разрешенных для доступа к этому модулю. | yii\debug\Module |
| $basePath | строка | Корневой каталог модуля. | yii\base\Module |
| $behaviors | yii\base\Behavior[] | Список присоединенных к этому компоненту поведений | yii\base\Component |
| $components | массив | Список определений компонентов или загруженных экземпляров компонентов (ID => определение или экземпляр). | yii\di\ServiceLocator |
| $controllerMap | массив | Сопоставление идентификатора контроллера с конфигурациями контроллера. | yii\base\Module |
| $controllerNamespace | строка | Пространство имен, в котором находятся классы контроллеров. | yii\debug\Module |
| $controllerPath | строка | Директория, содержащая классы контроллеров. | yii\base\Module |
| $dataPath | строка | Директория, хранящая файлы данных отладчика. | yii\debug\Module |
| $debugHeaders | yii\base\Event | yii\debug\Module | |
| $defaultPanel | строка | Имя панели, которая должна быть видимой при открытии панели отладки. | yii\debug\Module |
| $defaultRoute | строка | Маршрут по умолчанию этого модуля. | yii\base\Module |
| $dirMode | целое число | Разрешения, которые нужно установить для вновь созданных каталогов. | yii\debug\Module |
| $enableDebugLogs | логическое значение | Включить ли ведение журнала сообщений для запросов об действиях модуля отладки. | yii\debug\Module |
| $fileMode | целое число | Разрешения, которые нужно установить для вновь созданных файлов данных отладчика. | yii\debug\Module |
| $historySize | целое число | Максимальное количество файлов данных отладки для сохранения. | yii\debug\Module |
| $id | строка | Идентификатор, который однозначно определяет этот модуль среди других модулей, имеющих того же родителя. | yii\base\Module |
| $layout | строка|логическое значение | Макет, который должен применяться для представлений в этом модуле. | yii\base\Module |
| $layoutPath | строка | Корневой каталог файлов макетов. | yii\base\Module |
| $logTarget | yii\debug\LogTarget | yii\debug\Module | |
| $module | yii\base\Module | Родительский модуль этого модуля. | yii\base\Module |
| $modules | массив | Модули (индексированные по их идентификаторам). | yii\base\Module |
| $panels | массив|yii\debug\Panel[] | Список панелей отладки. | yii\debug\Module |
| $params | массив | Пользовательские параметры модуля (имя => значение). | yii\base\Module |
| $toolbarHtml | yii\debug\Module | ||
| $traceLine | смешанный тип | Строка с заполнительми для подстановки или анонимная функция, которая возвращает строку строки трассировки. | yii\debug\Module |
| $uniqueId | строка | Уникальный идентификатор модуля. | yii\base\Module |
| $version | строка | Версия этого модуля. | yii\base\Module |
| $viewPath | строка | Корневой каталог файлов представлений. | yii\base\Module |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с указанным именем, который не является методом класса. | yii\base\Component |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Module |
| __get() | Возвращает значение свойства компонента. | yii\base\Component |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Component |
| __set() | Устанавливает значение свойства компонента. | yii\base\Component |
| __unset() | Устанавливает свойство компонента в null. | yii\base\Component |
| afterAction() | Этот метод вызывается сразу после выполнения действия в рамках данного модуля. | yii\base\Module |
| attachBehavior() | Присоединяет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| beforeAction() | Этот метод вызывается непосредственно перед выполнением действия в рамках этого модуля. | yii\debug\Module |
| behaviors() | Возвращает список поведений, по которым этот компонент должен вести себя. | yii\base\Component |
| bootstrap() | Метод инициализации, вызываемый во время этапа инициализации приложения. | yii\debug\Module |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Component |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| clear() | Удаляет компонент из локатора. | yii\di\ServiceLocator |
| createController() | Создаёт экземпляр контроллера на основе заданного маршрута. | yii\base\Module |
| createControllerByID() | Создаёт контроллер на основе заданного идентификатора контроллера. | yii\base\Module |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| get() | Возвращает экземпляр компонента с указанным идентификатором. | yii\di\ServiceLocator |
| getBasePath() | Возвращает корневой каталог модуля. | yii\base\Module |
| getBehavior() | Возвращает объект поведения с указанным именем. | yii\base\Component |
| getBehaviors() | Возвращает все присоединённые к этому компоненту поведения. | yii\base\Component |
| getComponents() | Возвращает список определений компонентов или загруженных экземпляров компонентов. | yii\di\ServiceLocator |
| getControllerPath() | Возвращает каталог, содержащий классы контроллеров в соответствии с $controllerNamespace. | yii\base\Module |
| getInstance() | Возвращает текущий запрашиваемый экземпляр этого класса модуля. | yii\base\Module |
| getLayoutPath() | Возвращает каталог, содержащий файлы шаблонов макета для данного модуля. | yii\base\Module |
| getModule() | Извлекает дочерний модуль с указанным идентификатором. | yii\base\Module |
| getModules() | Возвращает подмодули в этом модуле. | yii\base\Module |
| getToolbarHtml() | Получает HTML мини-панели инструментов. | yii\debug\Module |
| getUniqueId() | Возвращает идентификатор, уникально определяющий этот модуль среди всех модулей в текущем приложении. | yii\base\Module |
| getVersion() | Возвращает текущую версию модуля. | yii\base\Module |
| getViewPath() | Возвращает каталог, содержащий файлы представлений для данного модуля. | yii\base\Module |
| getYiiLogo() | Возвращает URL логотипа, используемого в <img src="
| yii\debug\Module |
| has() | Возвращает значение, указывающее, имеет ли локатор указанное определение компонента или инстанцировал ли компонент. | yii\di\ServiceLocator |
| hasEventHandlers() | Возвращает значение, указывающее, присоединён ли какой-либо обработчик к событию с указанным именем. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Component |
| hasModule() | Проверяет, существует ли дочерний модуль с указанным идентификатором. | yii\base\Module |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует модуль. | yii\debug\Module |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| renderToolbar() | Отображает мини-панель инструментов в конце тела страницы. | yii\debug\Module |
| runAction() | Выполняет действие контроллера, указанное маршрутом. | yii\base\Module |
| set() | Регистрирует определение компонента в этом локаторе. | yii\di\ServiceLocator |
| setAliases() | Определяет псевдонимы путей. | yii\base\Module |
| setBasePath() | Устанавливает корневой каталог модуля. | yii\base\Module |
| setComponents() | Регистрирует набор определений компонентов в этом локаторе. | yii\di\ServiceLocator |
| setDebugHeaders() | Установка заголовков для передачи отладочных данных в запросах AJAX без вмешательства в сам запрос. | yii\debug\Module |
| setInstance() | Устанавливает текущую запрашиваемую инстанцию этого класса модуля. | yii\base\Module |
| setLayoutPath() | Устанавливает каталог, содержащий файлы шаблонов. | yii\base\Module |
| setModule() | Добавляет подмодуль к этому модулю. | yii\base\Module |
| setModules() | Регистрирует подмодули в текущем модуле. | yii\base\Module |
| setVersion() | Устанавливает версию текущего модуля. | yii\base\Module |
| setViewPath() | Устанавливает каталог, содержащий файлы представлений. | yii\base\Module |
| setYiiLogo() | Устанавливает URL логотипа, который будет использоваться в <img src=" | yii\debug\Module |
| trigger() | Вызывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| checkAccess() | Проверяет, разрешен ли текущему пользователю доступ к модулю | yii\debug\Module |
| corePanels() | yii\debug\Module | |
| defaultVersion() | Возвращает версию модуля по умолчанию. | yii\debug\Module |
| initPanels() | Инициализирует панели. | yii\debug\Module |
| resetGlobalSettings() | Сбрасывает потенциально несовместимые глобальные настройки, выполненные в конфигурации приложения. | yii\debug\Module |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_ACTION | yii\base\ActionEvent | Событие, срабатывающее после выполнения действия контроллера. | yii\base\Module |
| EVENT_BEFORE_ACTION | yii\base\ActionEvent | Событие, срабатывающее перед выполнением действия контроллера. | yii\base\Module |
Константы
| Константа | Значение | Описание | Определено в |
|---|---|---|---|
| DEFAULT_IDE_TRACELINE | '{text}' | yii\debug\Module |
Подробное описание свойств
$allowedHosts общедоступное свойство
Список хостов, которым разрешен доступ к этому модулю. Каждый элемент массива — это имя хоста, которое будет разрешено в IP-адрес, сравниваемый с IP-адресом пользователя. Пример использования — динамический DNS (DDNS) для разрешения доступа. Значение по умолчанию — [].
public array $allowedHosts = []
$allowedIPs общедоступное свойство
Список IP-адресов, которым разрешен доступ к этому модулю. Каждый элемент массива представляет отдельный фильтр IP, который может быть либо IP-адресом, либо адресом с подстановкой (например, 192.168.0.*) для представления сетевого сегмента. Значение по умолчанию — ['127.0.0.1', '::1'], что означает, что доступ к модулю разрешен только с localhost.
public array $allowedIPs = ['127.0.0.1', '::1']
$controllerNamespace общедоступное свойство
Пространство имен, в котором находятся классы контроллеров. Это пространство имен будет использоваться для загрузки классов контроллеров путем добавления его к имени класса контроллера.
Если не задано, оно будет использовать подпространство controllers внутри пространства имен этого модуля. Например, если пространство имен этого модуля — foo\bar, то пространство имен контроллера по умолчанию будет foo\bar\controllers.
См. также раздел руководства по автозагрузке, чтобы узнать больше о определении пространств имен и о том, как загружаются классы.
public string $controllerNamespace = 'yii\debug\controllers'
$dataPath общедоступное свойство
Каталог, хранящий файлы данных отладчика. Это можно указать, используя псевдоним пути.
public string $dataPath = '@runtime/debug'
$debugHeaders общедоступное свойство (только для записи)
public void setDebugHeaders ( $event )
$defaultPanel общедоступное свойство (доступно начиная с версии 2.0.7)
Имя панели, которая должна быть видимой при открытии панели отладки. Значение по умолчанию — 'log'.
public string $defaultPanel = 'log'
$dirMode общедоступное свойство (доступно начиная с версии 2.0.6)
Разрешение, которое нужно установить для вновь созданных каталогов. Это значение будет использовано функцией PHP \yii\debug\chmod(). Umask не будет применен. Значение по умолчанию — 0775, что означает, что каталог может читаться и записываться владельцем и группой, но только читаться другими пользователями.
public integer $dirMode = 0775
$enableDebugLogs общедоступное свойство
Включает ли ведение журналов сообщений для запросов о действиях модуля отладки. Обычно вы не хотите сохранять эти логи, так как они могут отвлекать от журналов вашего приложения. Вы можете включить логи отладки, если хотите исследовать работу самого модуля отладки.
public boolean $enableDebugLogs = false
$fileMode общедоступное свойство (доступно начиная с версии 2.0.6)
Разрешение, которое нужно установить для вновь созданных файлов данных отладчика. Это значение будет использовано функцией PHP \yii\debug\chmod(). Umask не будет применен. Если не задано, разрешение будет определяться текущей средой.
public integer $fileMode = null
$historySize общедоступное свойство
Максимальное количество файлов данных отладки, которые нужно сохранить. Если генерируется больше файлов, самые старые будут удалены.
public integer $historySize = 50
$logTarget общедоступное свойство
public yii\debug\LogTarget $logTarget = null
$panels общедоступное свойство
Список панелей отладки. Ключи массива — идентификаторы панелей, а значения — соответствующие имена классов панелей или конфигурационные массивы. Это будет объединено с corePanels(). Вы можете переконфигурировать основную панель через это свойство, используя тот же идентификатор панели. Вы также можете отключить основную панель, установив для неё значение false в этом свойстве.
public array|yii\debug\Panel[] $panels = []
$toolbarHtml общедоступное свойство (только для чтения)
public void getToolbarHtml ( )
$traceLine общедоступное свойство (доступно начиная с версии 2.0.7)
Строка с заполнителями, которые должны быть заменены, или анонимная функция, возвращающая строку с отладочной строкой. Заполнителями являются {file}, {line} и {text}, и строка должна иметь следующий вид:
File: {file} - Line: {line} - Text: {text}
Подпись анонимной функции должна быть следующей:
function($trace, $panel) {
// compute line string
return $line;
}
public mixed $traceLine = self::DEFAULT_IDE_TRACELINE
Подробное описание методов
beforeAction() public method
Этот метод вызывается непосредственно перед выполнением действия в данном модуле.
Метод вызовет событие EVENT_BEFORE_ACTION. Возвращаемое значение метода определит, должно ли действие продолжить выполнение.
В случае, если действие не должно выполняться, обработка запроса должна быть выполнена внутри кода beforeAction, либо путем предоставления необходимого вывода, либо перенаправлением запроса. В противном случае ответ будет пустым.
Если вы переопределяете этот метод, ваш код должен выглядеть следующим образом:
public function beforeAction($action)
{
if (!parent::beforeAction($action)) {
return false;
}
// your custom code here
return true; // or false to not run the action
}
| public boolean beforeAction ( $action ) | ||
|---|---|---|
| $action | yii\base\Action |
Выполняемое действие. |
| return | boolean |
Должно ли действие продолжить выполнение. |
bootstrap() public method
Метод инициализации, вызываемый во время начальной загрузки приложения.
| public void bootstrap ( $app ) | ||
|---|---|---|
| $app | yii\base\Application |
Текущее работающее приложение |
checkAccess() protected method
Проверяет, разрешен ли текущему пользователю доступ к модулю
| protected boolean checkAccess ( ) | ||
|---|---|---|
| return | boolean |
Разрешен ли доступ |
corePanels() protected method
| protected array corePanels ( ) | ||
|---|---|---|
| return | array |
Набор панелей по умолчанию |
defaultVersion() protected method (available since version 2.0.7)
Возвращает версию модуля по умолчанию.
Подклассы могут переопределить этот метод для предоставления более специфического определения версии.
| protected string defaultVersion ( ) | ||
|---|---|---|
| return | string |
Версия этого модуля. |
getToolbarHtml() public method (available since version 2.0.7)
Получает HTML-код панели инструментов
| public void getToolbarHtml ( ) |
|---|
getYiiLogo() public static method
Возвращает URL логотипа, используемого в <img src="
| public static string getYiiLogo ( ) | ||
|---|---|---|
| return | string |
URL логотипа |
init() public method
Инициализирует модуль.
Этот метод вызывается после создания и инициализации модуля с заданными в конфигурации значениями свойств. Стандартная реализация инициализирует $controllerNamespace, если он не задан.
Если вы переопределяете этот метод, убедитесь, что вызываете родительскую реализацию.
| public void init ( ) |
|---|
initPanels() protected method
Инициализирует панели.
| protected void initPanels ( ) |
|---|
renderToolbar() public method
Отображает мини-панель инструментов в конце тела страницы.
| public void renderToolbar ( $event ) | ||
|---|---|---|
| $event | yii\base\Event | |
resetGlobalSettings() protected method
Сбрасывает потенциально несовместимые глобальные настройки, выполненные в конфигурации приложения.
| protected void resetGlobalSettings ( ) |
|---|
setDebugHeaders() public method (available since version 2.0.7)
Установка заголовков для передачи отладочных данных в запросах AJAX без вмешательства в сам запрос.
| public void setDebugHeaders ( $event ) | ||
|---|---|---|
| $event | yii\base\Event | |
setYiiLogo() public static method
Устанавливает URL логотипа, используемого в <img src="
| public static void setYiiLogo ( $logo ) | ||
|---|---|---|
| $logo | string |
URL логотипа |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-debug-module.html