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

Агрегатор


Описание webdav.aggregator
и mobile.webdav.aggregator

Компонент служит для быстрой навигации по библиотекам документов. Компонент является стандартным и входит в дистрибутив модуля.

В структуре визуального редактора компонент расположен по пути Контент > Агрегатор библиотек документов > Агрегатор.

Также в системе есть компонент Агрегатор для быстрой навигации по библиотекам документов корпоративного портала, настроенного на работу с мобильных устройств. Компонент является стандартным и входит в дистрибутив модуля.

В структуре визуального редактора компонент расположен по пути Контент > Агрегатор библиотек документов > Агрегатор и имеет идентичные обычному агрегатору опции настройки.



Параметры

Поле Параметр Описание
Основные параметры
Тип информационного блока IBLOCK_TYPE Указывается тип информационного блока библиотеки документов.
Информационные блоки с документами IBLOCK_OTHER_IDS Для выбранного типа инфоблоков указывается идентификаторы инфоблоков, в котором хранятся документы.
Информационный блок документов рабочих групп IBLOCK_GROUP_ID Указывается идентификатор инфорблока документов рабочих групп.
Информационный блок документов пользователей IBLOCK_USER_ID Указывается идентификатор инфорблока документов пользователя.
Отображение имени NAME_TEMPLATE Параметр определяет отображение имени пользователя:
  • #NOBR##LAST_NAME# #NAME##/NOBR# - фамилия, имя (Петров Иван);
  • #NOBR##LAST_NAME# #NAME##/NOBR# #SECOND_NAME# - фамилия, имя, отчество. (Петров Иван Васильевич);
  • #NAME# #SECOND_NAME# #LAST_NAME# - имя, отчество, фамилия. (Иван Васильевич Петров);
  • #NOBR##NAME# #LAST_NAME##/NOBR# - имя, фамилия. (Иван Петров).

По умолчанию - значение Формат сайта (т.е используются значение Формат имени, указанное в закладке Параметры страницы Редактирование сайта).

Управление адресами страниц
Включить поддержку ЧПУ SEF_MODE [Y|N] При отмеченной опции будет включена поддержка ЧПУ.

Если режим поддержки ЧПУ включен, то необходимо настроить следующие параметры:
Каталог ЧПУ (относительно корня сайта) SEF_FOLDER Каталог ЧПУ: путь до папки, с которой работает компонент. Этот путь может как совпадать с физическим путём, так и не совпадать.
Адреса страниц SEF_URL_TEMPLATES Указываются адреса следующих страниц:
  • USER_FILE_PATH - страница документов пользователя (страница должна вести на существующий профиль пользователя и содержать #USER_ID#);
  • GROUP_FILE_PATH - страница документов рабочих групп (страница должна вести на существующий группу пользователей и содержать #GROUP_ID#);
  • USER_VIEW - страница пользователя (страница должна вести на существующий профиль пользователя и содержать #USER_ID#).
SEF_FOLDER, SEF_URL_TEMPLATES.
Настройки кеширования
Тип кеширования CACHE_TYPE Указывается тип кеширования:
  • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
  • Y - Кешировать: для кеширования необходимо определить время кеширования;
  • N - Не кешировать: кеширования нет в любом случае.
Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.


Пример вызова
webdav.aggregator

<?$APPLICATION->IncludeComponent("bitrix:webdav.aggregator","",Array(
		"SEF_MODE" => "Y",
		"IBLOCK_TYPE" => "library",
		"IBLOCK_OTHER_IDS" => array("18","19","22"),
		"IBLOCK_GROUP_ID" => "18",
		"IBLOCK_USER_ID" => "19",
		"NAME_TEMPLATE" => "#NOBR##LAST_NAME# #NAME##/NOBR#",
		"CACHE_TYPE" => "A",
		"CACHE_TIME" => "3600",
		"SEF_FOLDER" => "/",
		"SEF_URL_TEMPLATES" => Array(
			"USER_FILE_PATH" => "company/personal/user/#USER_ID#/files/lib/#PATH#",
			"GROUP_FILE_PATH" => "workgroups/group/#GROUP_ID#/files/#PATH#",
			"USER_VIEW" => "/company/personal/user/#USER_ID#"
		),
		"VARIABLE_ALIASES" => Array(
			"USER_FILE_PATH" => Array(),
			"GROUP_FILE_PATH" => Array(),
			"USER_VIEW" => Array(),
		)
	)
);?>


Пример вызова
mobile.webdav.aggregator

<?$APPLICATION->IncludeComponent(
	"bitrix:mobile.webdav.aggregator",
	"",
	Array(
		"CACHE_TIME" => "3600",
		"CACHE_TYPE" => "A",
		"IBLOCK_GROUP_ID" => "23",
		"IBLOCK_OTHER_IDS" => array("23"),
		"IBLOCK_TYPE" => "news",
		"IBLOCK_USER_ID" => "23",
		"NAME_TEMPLATE" => "",
		"SEF_MODE" => "N"
	)
);?>


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