Настроить действия Controller::configureActions

Модуль: main — подключать отдельно не нужно

Метод Controller::configureActions возвращает настройки действий. Наследник переопределяет метод, чтобы сменить фильтры действия или объявить действие отдельным классом. Конструктор читает настройки один раз.

Сигнатура метода в классе Bitrix\Main\Engine\Controller:

public function configureActions()

Возвращаемое значение

Метод возвращает массив имя действия => настройки. Базовый класс возвращает пустой массив.

Настройки действия принимают ключи из таблицы.

Ключ Описание
prefilters Префильтры действия. Заменяют фильтры по умолчанию. Пустой массив отключает все префильтры
+prefilters Префильтры, которые контроллер добавит к префильтрам действия. Без ключа prefilters — к фильтрам по умолчанию
-prefilters Классы префильтров, которые нужно убрать из префильтров действия. Без ключа prefilters — из фильтров по умолчанию
postfilters, +postfilters, -postfilters То же для постфильтров
class Класс действия — наследник Action, если действие описывает отдельный класс
callable Функция, которая выполняет действие
configure Настройки, которые получит метод configure класса действия

Особенности

  • По умолчанию действие получает три префильтра — Authentication, HttpMethod и Csrf. Они проверяют авторизацию, метод запроса GET или POST и CSRF-токен.
  • Если префильтры разрешают POST, а проверки CSRF среди них нет, контроллер сам добавит ее для POST-запроса.
  • Действие-метод xxxAction не нужно объявлять в настройках. Настройки нужны, только чтобы сменить его фильтры.

Примеры

Пример. Код открывает действие для гостей и проверяет, что оно выполнилось:

<?php
use Bitrix\Main\Engine\ActionFilter;
use Bitrix\Main\Engine\Controller;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

class UnitController extends Controller
{
    public function configureActions()
    {
        return [
            'list' => [
                'prefilters' => [],
            ],
            'save' => [
                '-prefilters' => [ActionFilter\Authentication::class],
            ],
        ];
    }

    public function listAction(): array
    {
        return ['kg', 'g'];
    }
}

$controller = new UnitController();
$result = $controller->run('list', [[]]);

echo implode(',', $result) . ' ' . implode(',', array_keys($controller->getConfigurationOfActions()));

Код выведет kg,g list,save. В примере код отключает фильтры действия list, чтобы запустить его из консоли.

Смотрите также