Документация для разработчиков
Темная тема

UrlManager

Класс выполняет две задачи:

  • имеет набор именованных методов для генерации ссылок;
  • определяет по адресу страницы, какой компонент и с какими параметрами надо подключить.

С помощью опций можно переопределить адреса страниц.

Методы

Метод Описание С версии
public function setUserId(int $userId): UrlManager Позволяет установить идентификатор пользователя $userId для которого будут определяться адреса, зависящие от пользователя.
public function getUserId(): int Возвращает идентификатор пользователя.
public function setRoot(string $root): UrlManager Устанавливает корневую папку, от которой будут строиться ссылки.
public function getRoot(): string Возвращает корневую папку.
public function setSefMode(bool $isSefMode): UrlManager Включает / выключает "ЧПУ" режим работы.
public function isSefMode(): bool Возвращает текущий статус "ЧПУ" режима работы.
public function setSiteId(string $siteId): UrlManager Устанавливает идентификатор сайта, в рамках которого будут строиться адреса.
public function getSiteId(): ?string Возвращает идентификатор сайта.
public function getDefaultUrlTemplates(): array Возвращает массив шаблонов ссылок по умолчанию, где имя - название компонента, а значение - адрес.
public function saveCustomUrlTemplates(array $templates): void Позволяет сохранить свой набор шаблонов ссылок.
public function getCustomUrlTemplates(): array Возвращает массив переопределенных шаблонов ссылок.
public function getPreparedTemplates(): array Возвращает набор подготовленных шаблонов ссылок, с учетом корня и корня сайта.
public function parseRequest(HttpRequest $httpRequest = null): ParseResult Определяет необходимые параметры из запроса $httpRequest. Если он не передан, берется текущий.

Возвращает объект Bitrix\Rpa\UrlManager\ParseResult

public function getPanelUrl(): ?Uri Возвращает ссылку на корневой раздел публичной части модуля.
public function getKanbanUrl(int $typeId): ?Uri Возвращает ссылку на канбан процесса $typeId.
public function getAutomationUrl(int $typeId = null): ?Uri Возвращает ссылку на настройки роботов процесса $typeId.
public function getAutomationEditRobotUrl(int $typeId = null): ?Uri Возвращает ссылку на страницу настроек робота процесса $typeId.
public function getTypeDetailUrl(int $typeId = null): ?Uri Возвращает ссылку на страницу настроек процесса $typeId.

Если $typeId не передена, то это будет ссылка на страницу создания процесса

public function getStageDetailUrl(int $stageId = null): ?Uri Возвращает ссылку на страницу настроек стадии $stageId.

Не используется.

public function getItemDetailUrl(int $typeId, int $itemId = null, int $stageId = null): ?Uri Возвращает ссылку на карточку элемента $itemId процесса $typeId.

Если $itemId не передан, то это будет ссылка на страницу добавления элемента

public function getTasksUrl(): ?Uri Возвращает ссылку на список заданий.
public function getTaskUrl(int $typeId, int $elementId): ?Uri Возвращает ссылку на страницу задания элемента $elementId процесса $typeId.
public function getItemsListUrl(int $typeId): ?Uri Возвращает ссылку на страницу грида элементов процесса $typeId.
public function getStageListUrl(int $typeId): Uri Возвращает ссылку на страницу настроек стадий процесса $typeId.
public function getUserPersonalUrl(int $userId): Uri Возвращает ссылку на профиль пользователя $userId.
public function getFieldsListTemplateUrl(): ?string Возвращает шаблон ссылки страницы списка настроек пользовательских полей.
public function getFieldsDetailTemplateUrl(): ?string Возвращает шаблон ссылки страницы настроек пользовательского поля.
public function getTypeFieldsListUrl(int $typeId): ?Uri Возвращает ссылку на страницу списка настроек пользовательских полей процесса $typeId.
public function getFieldDetailUrl(int $typeId, int $fieldId): ?Uri Возвращает ссылку на страницу настроек пользовательского поля $fieldId процесса $typeId.
public function getUserItemsUrl(int $typeId): ?Uri Возвращает ссылку на список элементов процесса $typeId того вида (список или канбан), который пользователь посещал последним.
public function getUserItemListView(int $typeId): ?string Возвращает идентификатор представления списка элементов процесса $typeId пользователя.
public function setUserItemListView(int $typeId, string $view): UrlManager Устанавливает идентификатор представления $view списка элементов процесса $typeId пользователя.

Возвращает $this

public function getUserTypesUrl(): ?Uri Возвращает ссылку на список процессов того вида (список или плитка), который пользователь посещал последним.
public function getUserTypeListView(): ?string Возвращает идентификатор представления списка процессов пользователя.
public function setUserTypeListView(string $view): UrlManager Устанавливает идентификатор представления $view списка процессов пользователя

Возвращает $this.

public function getUserItemsUrlWithTasks(int $typeId): ?Uri Возвращает ссылку на список элементов процесса $typeId пользователя с установленным фильтром по элементам, на которых есть задания пользователя.
public function getUserTypesUrlWithTasks(): ?Uri< Возвращает ссылку на список процессов пользователя с установленным фильтром по процессам, на которых есть задания пользователя.


© «Битрикс», 2001-2024, «1С-Битрикс», 2024