Класс yii\base\InlineAction
| Наследование | yii\base\InlineAction » yii\base\Action » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/base/InlineAction.php |
InlineAction представляет действие, определённое как метод контроллера.
Имя метода контроллера доступно через $actionMethod, которое устанавливается $controller, создающим это действие.
Более подробную информацию и сведения об использовании InlineAction см. в статье руководства об действиях.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $actionMethod | строка | Метод контроллера, с которым связано это действие. | yii\base\InlineAction |
| $behaviors | yii\base\Behavior[] | Список поведений, присоединённых к этому компоненту | yii\base\Component |
| $controller | yii\base\Controller|yii\web\Controller | Контроллер, который владеет этим действием | yii\base\Action |
| $id | строка | Идентификатор действия | yii\base\Action |
| $uniqueId | строка | Уникальный идентификатор этого действия в рамках всего приложения. | yii\base\Action |
Общедоступные методы
| Метод | Описание | Определён в |
|---|---|---|
| __call() | Вызывает метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | yii\base\InlineAction | |
| __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() | Возвращает уникальный идентификатор данного действия во всей приложении. | 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\InlineAction |
| trigger() | Вызывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| afterRun() | Этот метод вызывается сразу после выполнения run(). | yii\base\Action |
| beforeRun() | Этот метод вызывается непосредственно перед выполнением run(). | yii\base\Action |
Подробное описание свойств
$actionMethod общедоступное свойство
Метод контроллера, с которым связан этот встроенный action
public string $actionMethod = null
Подробное описание методов
__construct() общедоступный метод
| public void __construct ( $id, $controller, $actionMethod, $config = [] ) | ||
|---|---|---|
| $id | string |
ID этого action |
| $controller | yii\base\Controller |
Контроллер, которому принадлежит этот action |
| $actionMethod | string |
Метод контроллера, с которым связан этот встроенный action |
| $config | array |
Пара имя-значение, которые будут использованы для инициализации свойств объекта |
runWithParams() общедоступный метод
Выполняет этот action с указанными параметрами.
Этот метод в основном вызывается контроллером.
| public mixed runWithParams ( $params ) | ||
|---|---|---|
| $params | array |
Параметры action |
| return | mixed |
Результат действия |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-base-inlineaction.html
