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

Облако тегов


Описание search.tags.cloud

Компонент предназначен для вывода облака тегов - механизм поиска по тегам в статистических страницах, элементах информационных блоков, в блогах, форумах. Компонент имеет настройки различных шрифтов и цветов для тегов различной даты и различной популярности использования. Компонент является стандартным и входит в дистрибутив модуля.

Компонент относится к модулю Поиск.



Параметры

Поле Параметр Описание
Основные параметры
Сортировка тегов SORT Указывается тип сортировки тегов: по имени (NAME) или по популярности (CNT).
Количество тегов PAGE_ELEMENTS Параметр определяет количество выводимых тегов в облаке.
Период выборки тегов (дней) PERIOD Параметр определяет период выборки тегов (дней).
Путь к странице поиска (от корня сайта) URL_SEARCH Указывается путь к странице поиска (от корня сайта).
Сужать область поиска TAGS_INHERIT [Y|N] При отмеченной опции выбранные теги добавляются в фильтр поиска.
Источник данных
Искать только в активных по дате документах CHECK_DATES [Y|N] При отмеченной опции поиск будет осуществляться только в активных по дате документах.
Дополнительный фильтр FILTER_NAME Указывается название дополнительного фильтра (для разработчиков).
Ограничение области поиска arrFILTER Параметр служит для ограничение области поиска: статическими файлами (main), форумами (forum), одним из типов инфоблоков (iblock), определенных в системе, блогами (blog) или социальной сетью (socialnetwork). Можно также выбрать несколько из перечисленных источников информации либо выбрать пункт Не ограничивать.
Если выбрать:
  • [main] Cтатические файлы - то появляется для заполнения поле Путь к файлу начинается с любого из перечисленных, в котором можно указать путь к разделу или файлу, где будет осуществлен поиск, например, /about/. Если поле пусто, то поиск осуществляется во всех статических файлах системы.
  • [forum] Форумы - то ниже отображается поле со всеми форумами, созданными на сайте. Среди них можно выбрать один или несколько форумов либо выбрать вариант (все), тогда поиск будет осуществлен во всех форумах системы.
  • [iblock_<имя>] - один из типов инфоблоков (например, [iblock_news] Новости), то при нажатии кнопки ОК станут доступны все инфоблоки, созданные внутри выбранного типа. Среди них можно выбрать один или несколько инфоблоков либо выбрать вариант (все), тогда поиск будет осуществлен во всех инфоблоках этого типа.
  • [blog] Блоги - то при данном ограничении поиск будет осуществлен только во всех блогах системы;
  • [socialnetwork] Социальная сеть - то при данном ограничении поиск будет осуществлен только в рамках социальной сети;
  • [crm] CRM - то при данном ограничении поиск будет осуществлен только по CRM;
  • [disk] Файлы диска - то при данном ограничении поиск будет осуществлен только файлам диска.
Настройки кеширования
Тип кеширования CACHE_TYPE Тип кеширования:
  • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
  • Y - Кешировать: для кеширования необходимо определить время кеширования;
  • N - Не кешировать: кеширования нет в любом случае.
Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах. По умолчанию поле содержит 3600 сек.
Дополнительные настройки
Максимальный размер шрифта (px) FONT_MAX Указывается максимальный размер шрифта отображения тегов (в пикселах).
Минимальный размер шрифта (px) FONT_MIN Указывается минимальный размер шрифта отображения тегов (в пикселах).
Цвет более позднего тега (пример: "C0C0C0") COLOR_NEW Указывается код цвета тегов, дата создания которых наиболее поздняя (пример: "C0C0C0").
Цвет более раннего тега (пример: "FEFEFE") COLOR_OLD Указывается код цвета тегов, дата создания которых наиболее ранняя (пример: "FEFEFE").
Период, в течение которого считать тег новым (дней) PERIOD_NEW_TAGS Указывается период, в течение которого тег считается новым (дней).
Показывать цепочку навигации SHOW_CHAIN [Y|N] При отмеченной опции будет показана цепочка навигации. Параметр работает, если параметр TAGS_INHERIT принимает значение Y.
Плавное изменение цвета COLOR_TYPE [Y|N] При отмеченной опции переход между цветами COLOR_NEW и COLOR_OLD будет плавным.
Ширина облака тегов (пример: "100%" или "100px", "100pt", "100in") WIDTH Указывается ширина облака тегов (пример: "100%" или "100px", "100pt", "100in").


Пример вызова

<?$APPLICATION->IncludeComponent("bitrix:search.tags.cloud","",Array(
		"FONT_MAX" => "50", 
		"FONT_MIN" => "10", 
		"COLOR_NEW" => "3E74E6", 
		"COLOR_OLD" => "C0C0C0", 
		"PERIOD_NEW_TAGS" => "", 
		"SHOW_CHAIN" => "Y", 
		"COLOR_TYPE" => "Y", 
		"WIDTH" => "100%", 
		"SORT" => "NAME", 
		"PAGE_ELEMENTS" => "150", 
		"PERIOD" => "", 
		"URL_SEARCH" => "/search/index.php", 
		"TAGS_INHERIT" => "Y", 
		"CHECK_DATES" => "Y",
		"FILTER_NAME"=> "",
		"arrFILTER" => Array("no"),
		"CACHE_TYPE" => "A", 
		"CACHE_TIME" => "3600" 
	)
);?>


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2020, «1С-Битрикс», 2020
Наверх