nc_infoblock_path( int $infoblock_id, string $action = 'index', string $format = 'html', string $date = null, array $variables = null )
Появилось в версии: 5.4
возвращает путь к инфоблоку с указанным идентификатором
Параметры | Описание |
---|---|
$infoblock_id | идентификатор инфоблока |
$action | действие: index (список объектов), add (добавление объекта), search (поиск в инфоблоке), subscribe (подписка на инфоблок) |
$format | формат ответа: html, xml, rss |
$date | дата, которую следует добавить к пути (допустимые форматы даты: YYYY-mm-dd, YYYY-mm, YYYY) |
$variables | массив с дополнительными переменными |
Если модуль маршрутизации отключён, функция возвращает строку с путём к инфоблоку или false
, если инфоблок не существует.
При использовании модуля маршрутизации функция может вернуть false
при явной невозможности определить путь к ресурсу (в случае передачи функции некорректных аргументов), или объект класса nc_routing_path
, который может быть использован как обычная строка (объект имеет метод __toString()
). Промежуточный объект создаётся с целью оптимизации (в некоторых частях системы — например, в списке объектов — могут создаваться переменные, содержащие пути, но фактически они могут не использоваться в шаблонах; вычисление пути происходит только при первом приведении значения такой переменной к строке).