Spec-Zone.ru › Yii 2.0

Класс yii\debug\controllers\DefaultController

Все классы | Свойства | Методы | События
Наследование yii\debug\controllers\DefaultController » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\Object
Реализует yii\base\Configurable, yii\base\ViewContextInterface
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2-debug/blob/master/controllers/DefaultController.php

Контроллер отладчика

Общедоступные свойства

Свойство Тип Описание Определено в
$action yii\base\Action Действие, которое выполняется в данный момент. yii\base\Controller
$actionParams массив Параметры, привязанные к текущему действию. yii\web\Controller
$behaviors yii\base\Behavior[] Список поведений, прикрепленных к этому компоненту yii\base\Component
$defaultAction строка Идентификатор действия, используемого, когда идентификатор действия не указан в запросе. yii\base\Controller
$enableCsrfValidation булево Включить ли проверку CSRF для действий в этом контроллере. yii\web\Controller
$id строка Идентификатор этого контроллера. yii\base\Controller
$layout null|строка|false Имя макета, применяемого к представлениям этого контроллера. yii\debug\controllers\DefaultController
$module yii\debug\Module yii\debug\controllers\DefaultController
$modules yii\base\Module[] Все родительские модули, в которых расположен этот контроллер. yii\base\Controller
$route строка Маршрут (ID модуля, ID контроллера и ID действия) текущего запроса. yii\base\Controller
$summary массив Сводные данные (например, URL, время) yii\debug\controllers\DefaultController
$uniqueId строка Идентификатор контроллера, к которому прикреплен ID модуля (если есть). yii\base\Controller
$view yii\base\View|yii\web\View Объект представления, который можно использовать для рендеринга представлений или файлов представлений. yii\base\Controller
$viewPath строка Директория, содержащая файлы представлений для этого контроллера. yii\base\Controller

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

Метод Описание Определено в
__call() Вызывает метод с указанным именем, который не является методом класса. yii\base\Object
__clone() Этот метод вызывается после создания объекта путем клонирования существующего. yii\base\Component
__construct() yii\base\Controller
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, установлено ли свойство, т.е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в null. yii\base\Object
actionDownloadMail() yii\debug\controllers\DefaultController
actionIndex() yii\debug\controllers\DefaultController
actionToolbar() yii\debug\controllers\DefaultController
actionView() yii\debug\controllers\DefaultController
actions() Объявляет внешние действия для контроллера. yii\debug\controllers\DefaultController
afterAction() Этот метод вызывается сразу после выполнения действия. yii\base\Controller
asJson() Отправляет данные в формате JSON. yii\web\Controller
asXml() Отправляет данные в формате XML. yii\web\Controller
attachBehavior() Прикрепляет поведение к этому компоненту. yii\base\Component
attachBehaviors() Прикрепляет список поведений к компоненту. yii\base\Component
beforeAction() yii\debug\controllers\DefaultController
behaviors() Возвращает список поведений, по которым этот компонент должен вести себя. yii\base\Component
bindActionParams() Связывает параметры с действием. yii\web\Controller
canGetProperty() Возвращает значение, указывающее, можно ли прочитать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное квалифицированное имя этого класса. yii\base\Object
createAction() Создает действие на основе заданного идентификатора действия. yii\base\Controller
detachBehavior() Отсоединяет поведение от компонента. yii\base\Component
detachBehaviors() Отсоединяет все поведения от компонента. yii\base\Component
ensureBehaviors() Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. yii\base\Component
findLayoutFile() Ищет соответствующий файл макета. yii\base\Controller
getBehavior() Возвращает объект поведения с указанным именем. yii\base\Component
getBehaviors() Возвращает все прикрепленные к этому компоненту поведения. yii\base\Component
getModules() Возвращает все родительские модули этого контроллера. yii\base\Controller
getRoute() Возвращает маршрут текущего запроса. yii\base\Controller
getUniqueId() Возвращает уникальный идентификатор контроллера. yii\base\Controller
getView() Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представления. yii\base\Controller
getViewPath() Возвращает директорию, содержащую файлы представлений для этого контроллера. yii\base\Controller
goBack() Перенаправляет браузер на последнюю посещенную страницу. yii\web\Controller
goHome() Перенаправляет браузер на главную страницу. yii\web\Controller
hasEventHandlers() Возвращает значение, указывающее, есть ли обработчик, прикрепленный к указанному событию. yii\base\Component
hasMethod() Возвращает значение, указывающее, определен ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует объект. yii\base\Object
loadData() yii\debug\controllers\DefaultController
off() Отсоединяет существующий обработчик событий от этого компонента. yii\base\Component
on() Прикрепляет обработчик событий к событию. yii\base\Component
redirect() Перенаправляет браузер на указанный URL. yii\web\Controller
refresh() Обновляет текущую страницу. yii\web\Controller
render() Рендерит представление и применяет макет, если он доступен. yii\base\Controller
renderAjax() Рендерит представление в ответ на AJAX-запрос. yii\web\Controller
renderContent() Рендерит статическую строку, применяя макет. yii\base\Controller
renderFile() Рендерит файл представления. yii\base\Controller
renderPartial() Рендерит представление без применения макета. yii\base\Controller
run() Выполняет запрос, заданный в терминах маршрута. yii\base\Controller
runAction() Выполняет действие внутри данного контроллера с указанным идентификатором действия и параметрами. yii\base\Controller
setView() Устанавливает объект представления, который будет использоваться этим контроллером. yii\base\Controller
setViewPath() Устанавливает каталог, содержащий файлы представления. yii\base\Controller
trigger() Вызывает событие. yii\base\Component

Защищённые методы

Метод Описание Определено в
getManifest() yii\debug\controllers\DefaultController

События

Событие Тип Описание Определено в
EVENT_AFTER_ACTION yii\base\ActionEvent Событие, поднимаемое сразу после выполнения действия контроллера. yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent Событие, поднимаемое непосредственно перед выполнением действия контроллера. yii\base\Controller

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

$layout свойство public

Имя макета, который должен быть применён к представлениям этого контроллера. Это свойство в основном влияет на поведение render(). По умолчанию null, что означает, что фактическое значение макета должно наследовать значение макета от $module. Если false, макет не будет применён.

public null|string|false $layout = 'main'

$module свойство public

public yii\debug\Module $module = null

$summary свойство public

Данные сводки (например, URL, время)

public array $summary = null

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

actionDownloadMail() метод public

public void actionDownloadMail ( $file )
$file

actionIndex() метод public

public void actionIndex ( )

actionToolbar() метод public

public void actionToolbar ( $tag )
$tag

actionView() метод public

public void actionView ( $tag = null, $panel = null )
$tag
$panel

actions() метод public

Объявляет внешние действия для контроллера.

Этот метод предназначен для переопределения, чтобы объявить внешние действия для контроллера. Он должен возвращать массив, где ключи массива — идентификаторы действий, а значения массива — соответствующие имена классов действий или конфигурационные массивы действий. Например,

return [
    'action1' => 'app\components\Action1',
    'action2' => [
        'class' => 'app\components\Action2',
        'property1' => 'value1',
        'property2' => 'value2',
    ],
];

Yii::createObject() будет использоваться позже для создания запрошенного действия с помощью предоставленной здесь конфигурации.

public void actions ( )

beforeAction() метод public

public void beforeAction ( $action )
$action

getManifest() защищённый метод

protected void getManifest ( $forceReload = false )
$forceReload

loadData() метод public

public void loadData ( $tag, $maxRetry = 0 )
$tag
$maxRetry

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

Spec-Zone.ru

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