UrlManager::createByComponentController() — параметры и описание

Сигнатура

public createByComponentController(Controller $controller, string $action[, array<string|int, mixed> $params = array() ][, bool $absolute = false ]) : Uri

Описание

Создаёт uri для контроллера в компоненте и его действия.

Параметры

$controller Controller

Контроллер.

$action string

Относительное имя действия.

$params array<string|int, mixed> = array()

Дополнительные параметры для действия.

$absolute bool = false

Генерировать абсолютный uri или нет.

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

Uri

Как применяется в UrlManager

UrlManager::createByComponentController() — метод класса \Bitrix\Main\Engine\UrlManager модуля «Главный модуль».

Метод объекта: сначала нужен экземпляр UrlManager.

use Bitrix\Main\Engine\UrlManager;

/** @var UrlManager $object */
$controller = null; // Controller
$action = '';
$result = $object->createByComponentController($controller, $action);
// $result: Uri

Другие методы UrlManager

create() Создаёт uri для действия.
createByBitrixComponent() Создаёт uri для битрикс-компонента, который реализует @see \Bitrix\Main\Engine\Contract\Controllerable, и его действия.
createByController() Создаёт uri для контроллера и его действия.
getEndPoint() Возвращает uri для эндпоинта.
getHostUrl() Возвращает url хоста с портом и схемой.
getInstance()