Spec-Zone.ru › Yii 2.0

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

Все классы | Свойства | Методы | События
Наследование yii\gii\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-gii/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
$generator yii\gii\Generator yii\gii\controllers\DefaultController
$id строка Идентификатор этого контроллера. yii\base\Controller
$layout yii\gii\controllers\DefaultController
$module yii\gii\Module yii\gii\controllers\DefaultController
$modules yii\base\Module[] Все родительские модули, в которых находится этот контроллер. yii\base\Controller
$route строка Маршрут (ID модуля, ID контроллера и ID действия) текущего запроса. yii\base\Controller
$uniqueId строка Идентификатор контроллера, который предваряется идентификатором модуля (если таковой имеется). 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
actionAction() Выполняет действие, определённое в генераторе. yii\gii\controllers\DefaultController
actionDiff() yii\gii\controllers\DefaultController
actionIndex() yii\gii\controllers\DefaultController
actionPreview() yii\gii\controllers\DefaultController
actionView() yii\gii\controllers\DefaultController
actions() Объявляет внешние действия для контроллера. yii\base\Controller
afterAction() Этот метод вызывается сразу после выполнения действия. yii\base\Controller
asJson() Отправляет данные в формате JSON. yii\web\Controller
asXml() Отправляет данные в формате XML. yii\web\Controller
attachBehavior() Прикрепляет поведение к этому компоненту. yii\base\Component
attachBehaviors() Прикрепляет список поведений к компоненту. yii\base\Component
beforeAction() Этот метод вызывается непосредственно перед выполнением действия. yii\web\Controller
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
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

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

Метод Описание Определено в
loadGenerator() Загружает генератор с указанным идентификатором. yii\gii\controllers\DefaultController

События

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

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

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

public yii\gii\Generator $generator = null

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

public  $layout = 'generator'

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

public yii\gii\Module $module = null

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

actionAction() общедоступный метод

Выполняет действие, определённое в генераторе.

Для действия с именем «xyz» вызывается метод «actionXyz()» в генераторе. Если такого метода нет, будет брошено исключение 400 HTTP.

общедоступный mixed actionAction ( $id, $name )
$id string

Идентификатор генератора

$name string

Имя действия

return mixed

Результат действия.

throws yii\web\NotFoundHttpException

если метод действия не существует.

actionDiff() общедоступный метод

общедоступный void actionDiff ( $id, $file )
$id
$file

actionIndex() общедоступный метод

общедоступный void actionIndex ( )

actionPreview() общедоступный метод

общедоступный void actionPreview ( $id, $file )
$id
$file

actionView() общедоступный метод

общедоступный void actionView ( $id )
$id

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

Загружает генератор с указанным идентификатором.

защищённый yii\gii\Generator loadGenerator ( $id )
$id string

Идентификатор загружаемого генератора.

return yii\gii\Generator

Загруженный генератор

throws yii\web\NotFoundHttpException

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

Spec-Zone.ru

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