Spec-Zone.ru › Yii 2.0

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

Все классы | Свойства | Методы | События
Наследование yii\debug\controllers\UserController » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\Object
Реализует yii\base\Configurable, yii\base\ViewContextInterface
Доступно с версии 2.0.10
Исходный код https://github.com/yiisoft/yii2-debug/blob/master/controllers/UserController.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\base\Controller
$module yii\base\Module Модуль, к которому принадлежит этот контроллер. yii\base\Controller
$modules yii\base\Module[] Все родительские модули, в которых расположен этот контроллер. yii\base\Controller
$route строка Маршрут (ID модуля, ID контроллера и ID действия) текущего запроса. yii\base\Controller
$uniqueId строка ID контроллера, префикс которого — 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
actionResetIdentity() Сбросить идентификатор, переключиться на основного пользователя yii\debug\controllers\UserController
actionSetIdentity() Установить новый идентификатор, переключиться на пользователя yii\debug\controllers\UserController
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\debug\controllers\UserController
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

События

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

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

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

Сбросить идентификатор, переключиться на основного пользователя

public yii\web\User actionResetIdentity ( )

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

Установить новый идентификатор, переключиться на пользователя

public yii\web\User actionSetIdentity ( )

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

Этот метод вызывается непосредственно перед выполнением действия.

Метод вызывает событие EVENT_BEFORE_ACTION. Значение возвращаемого методом результата определяет, должно ли действие продолжить выполнение.

В случае, если действие не должно выполняться, обработка запроса должна быть выполнена внутри кода beforeAction путём предоставления необходимого вывода или перенаправления запроса. В противном случае ответ будет пустым.

Если вы переопределяете этот метод, ваш код должен выглядеть следующим образом:

public function beforeAction($action)
{
    // your custom code here, if you want the code to run before action filters,
    // which are triggered on the [[EVENT_BEFORE_ACTION]] event, e.g. PageCache or AccessControl

    if (!parent::beforeAction($action)) {
        return false;
    }

    // other custom code here

    return true; // or false to not run the action
}
public boolean beforeAction ( $action )
$action yii\base\Action

Действие, подлежащее выполнению.

return boolean

Следует ли продолжать выполнение действия.

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

Spec-Zone.ru

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