Класс yii\base\Action
Action — базовый класс для всех классов действий контроллеров.
Action предоставляет способ повторного использования кода методов действий. Метод действия в классе Action может использоваться в нескольких контроллерах или в разных проектах.
Производные классы должны реализовать метод с именем run(). Этот метод будет вызываться контроллером при запросе действия. Метод run() может иметь параметры, которые будут автоматически заполнены значениями пользовательского ввода в соответствии с их именами. Например, если метод run() объявлен следующим образом:
public function run($id, $type = 'book') { ... }
И предоставленные параметры для действия — ['id' => 1]. Тогда метод run() будет вызван как run(1) автоматически.
Дополнительную информацию и инструкции по использованию Action см. в статье руководства по действиям.
Открытые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к данному компоненту | yii\base\Component |
| $controller | yii\base\Controller|yii\web\Controller | Контроллер, которому принадлежит это действие | yii\base\Action |
| $id | string | ID действия | yii\base\Action |
| $uniqueId | string | Уникальный ID этого действия во всей приложении. | yii\base\Action |
Открытые методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с указанным именем, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Action |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т. е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, по которым этот компонент должен вести себя. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| 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 |
| getUniqueId() | Возвращает уникальный ID этого действия во всей приложении. | yii\base\Action |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчики, прикрепленные к событию с заданным именем. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| off() | Открепляет существующего обработчика событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| runWithParams() | Выполняет это действие со специфицированными параметрами. | yii\base\Action |
| trigger() | Вызывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| afterRun() | Этот метод вызывается сразу после выполнения run(). | yii\base\Action |
| beforeRun() | Этот метод вызывается сразу перед выполнением run() . | yii\base\Action |
Подробное описание свойств
$controller открытое свойство
Контроллер, которому принадлежит это действие
public yii\base\Controller|yii\web\Controller $controller = null
$id открытое свойство
ID действия
public string $id = null
$uniqueId открытое только для чтения свойство
Уникальный ID этого действия во всей приложении.
public string getUniqueId ( )
Подробное описание методов
__construct() public method
Конструктор.
| public void __construct ( $id, $controller, $config = [] ) | ||
|---|---|---|
| $id | string |
Идентификатор этого действия. |
| $controller | yii\base\Controller |
Контроллер, которому принадлежит это действие. |
| $config | array |
Параметры в формате «ключ-значение» для инициализации свойств объекта. |
afterRun() protected method
Этот метод вызывается сразу после выполнения run().
Вы можете переопределить этот метод для выполнения пост-обработки для выполняемого действия.
| protected void afterRun ( ) |
|---|
beforeRun() protected method
Этот метод вызывается непосредственно перед выполнением run().
Вы можете переопределить этот метод, чтобы выполнить подготовительную работу для выполнения действия. Если метод вернёт false, действие будет отменено.
| protected boolean beforeRun ( ) | ||
|---|---|---|
| return | boolean |
Выполнять ли действие. |
getUniqueId() public method
Возвращает уникальный идентификатор этого действия во всём приложении.
| public string getUniqueId ( ) | ||
|---|---|---|
| return | string |
Уникальный идентификатор этого действия во всём приложении. |
runWithParams() public method
Выполняет это действие с указанными параметрами.
Этот метод в основном вызывается контроллером.
| public mixed runWithParams ( $params ) | ||
|---|---|---|
| $params | array |
Параметры, которые будут переданы в метод run() действия. |
| return | mixed |
Результат действия |
| throws | yii\base\InvalidConfigException |
если в классе действия нет метода run() |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-base-action.html
