Задать источники параметров Controller::setSourceParametersList

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

Метод Controller::setSourceParametersList задает источники параметров действия. Метод run вызывает его сам со своим аргументом. Метод нужен, когда действие создают и выполняют без run, например в тестах объекта Action.

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

final public function setSourceParametersList($sourceParametersList)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
sourceParametersList* array[] Задает список источников, например [['id' => 5]]

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

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

Метод возвращает тот же объект Controller.

Примеры

Пример. Код задает параметры и выполняет действие без run:

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

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

class UnitController extends Controller
{
    public function viewAction(int $id): int
    {
        return $id * 10;
    }
}

$controller = (new UnitController())->setSourceParametersList([['id' => 5]]);
$action = new InlineAction('view', $controller, []);

echo $action->runWithSourceParametersList();

Код выведет 50. Без run фильтры и события контроллера не работают.

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