Action — действие контроллера
Пространство имен: Bitrix\Main\Engine
Модуль: main — подключать отдельно не нужно
Когда использовать
Класс Action — базовый класс действия контроллера. Наследуйте от него класс действия, чтобы вынести логику действия из контроллера и подключать ее к разным контроллерам.
Контроллер создает действие по описанию из метода configureActions. Ключ class в описании задает класс действия. Затем контроллер вызывает runWithSourceParametersList. Метод передает в run параметры запроса по именам аргументов, как в методе действия контроллера.
Действие-метод контроллера вида viewAction тоже работает через наследника Action — класс InlineAction. Создавать его не нужно.
Подробнее о действиях — в статье Контроллеры.
Что реализовать в наследнике
Наследник обязан объявить публичный метод run. Контроллер заполняет аргументы run из параметров запроса и автоматически подставляемых объектов. Значение, которое вернул run, становится результатом действия.
Наследник может переопределить защищенные методы:
init()— конструктор вызывает метод в конце работы.onBeforeRun()— действие вызывает метод передrun. Если метод вернул ложное значение, действие не выполняетrunи возвращаетnull.onAfterRun()— действие вызывает метод послеrun.
Защищенные методы addError(Error $error) и addErrors(array $errors) добавляют ошибки действия. После выполнения действия контроллер переносит их в свой список.
Методы класса
| Метод | Описание | С версии |
|---|---|---|
| __construct | Создает действие для контроллера | |
| configure | Принимает дополнительные настройки действия | |
| getName | Возвращает имя действия | |
| getController | Возвращает контроллер действия | |
| getConfig | Возвращает описание действия из контроллера | |
| getArguments | Возвращает аргументы метода run |
|
| setArguments | Заменяет аргументы метода run |
|
| getBinder | Возвращает объект, который подбирает аргументы | |
| runWithSourceParametersList | Выполняет действие | |
| getCurrentUser | Возвращает текущего пользователя контроллера | |
| convertKeysToCamelCase | Переводит ключи массива в camelCase | |
| className | Возвращает полное имя класса | |
| getErrors | Возвращает ошибки действия | |
| getErrorByCode | Возвращает ошибку по коду |
Наследование
Класс реализует интерфейс Bitrix\Main\Errorable.
Реализации
Контроллер сам создает объекты следующих наследников.
| Класс | Назначение |
|---|---|
Bitrix\Main\Engine\InlineAction |
Действие-метод контроллера, например viewAction |
Bitrix\Main\Engine\ClosureAction |
Действие из ключа callable в configureActions |
Bitrix\Main\Engine\FallbackAction |
Действие для неизвестного имени у контроллера с интерфейсом FallbackActionInterface. Имя такого действия всегда fallback |
Bitrix\Main\Engine\Component\InlineAction |
Действие-метод компонента с интерфейсом Controllerable |