Настроить действия Controllerable::configureActions
Модуль: main — подключать отдельно не нужно
Метод Controllerable::configureActions возвращает настройки фильтров для действий. Контроллер читает настройки при создании своего объекта. Действие, которого нет в настройках, получает фильтры по умолчанию.
Сигнатура метода в интерфейсе Bitrix\Main\Engine\Contract\Controllerable:
public function configureActions();
Возвращаемое значение
Метод возвращает массив. Ключ — имя действия без суффикса Action, значение — массив настроек действия. Контроллер сравнивает имя действия с ключами массива без учета регистра.
|
Ключ |
Описание |
|
prefilters |
Заменяет префильтры по умолчанию. Фильтры выполняются до действия |
|
postfilters |
Заменяет постфильтры по умолчанию. Фильтры выполняются после действия |
|
+prefilters |
Добавляет фильтры к префильтрам действия. Без ключа |
|
-prefilters |
Убирает префильтры действия. Элементы — имена классов фильтров |
|
+postfilters |
Добавляет фильтры к постфильтрам действия. Без ключа |
|
-postfilters |
Убирает постфильтры действия. Элементы — имена классов фильтров |
Элемент списков prefilters и postfilters — объект наследника ActionFilter\Base или замыкание. Если метод вернул null или пустой массив, все действия получают фильтры по умолчанию.
Исключения
| Исключение | Когда возникает |
|---|---|
Bitrix\Main\Engine\Exception\ActionConfigurationException |
Ключ массива не строка, значение не массив, элемент prefilters или postfilters не фильтр. Также если у метода-действия есть атрибуты фильтров и одновременно ключ в configureActions |
Контроллер выбрасывает исключение в своем конструкторе, когда читает настройки.
Особенности
Контроллер сначала убирает фильтры из списков -prefilters и -postfilters, затем добавляет фильтры из +prefilters и +postfilters. Поэтому фильтр, добавленный через +, вычитание не убирает.
Контроллер сравнивает фильтры с именами классов через is_a, поэтому -prefilters убирает и наследников указанного класса. Ключ -prefilters с классом Csrf убирает и фильтр Csrf, который контроллер добавил сам для POST-запроса.
Примеры
Пример. Компонент объявляет действие list без префильтров. Код запускает действие через ComponentController так же, как роутер AJAX-запросов, и выводит результат:
<?php
use Bitrix\Main\Engine\Component\ComponentController;
use Bitrix\Main\Engine\Contract\Controllerable;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
class DemoUnitListComponent extends CBitrixComponent implements Controllerable
{
public function configureActions()
{
return [
'list' => [
'prefilters' => [],
],
];
}
public function listAction()
{
return ['kg', 'm'];
}
}
$controller = new ComponentController(new DemoUnitListComponent());
print_r($controller->run('list', []));
Код выведет массив из двух элементов kg и m.