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

Стандартная страница поиска

Компонент служит для создания страницы поиска. Компонент можно использовать как самостоятельно для создания страницы поиска, так и в сочетании с компонентом Форма поиска. Вне зависимости от настроек поиск в системе осуществляется в соответствии с правами пользователя.
В поставку продукта входят пять шаблонов компонента:

  • по умолчанию (.default);
  • с упрощенным оформлением страницы поиска (clear);
  • с графическим отображением содержимого результата поиска (icons);
  • с интерактивными подсказками (suggest);
  • со встроенной поддержкой облака тегов (tags).

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

Пример вызова компонента search.page

Секции настроек компонента:

  • Источник данных
  • Внешний вид
  • Управление режимом AJAX
  • Настройки кеширования
  • Дополнительные настройки
  • Настройки постраничной навигации
  • Описание параметров

    Поле Параметр Описание
    Источник данных
    Искать без учета морфологии (при отсутствии результата поиска) RESTART [Y|N] При отмеченной опции сначала будет выполнен поиск с учетом морфологии. Если ничего не найдено, то будет запущен поиск без учета морфологии.
    Отключить обработку слов как логических операторов NO_WORD_LOGIC [Y|N] При отмеченной опции слова (и, или, не) не будут использоваться как логические операторы.
    Искать только в активных по дате документах CHECK_DATES [Y|N] При отмеченной опции поиск будет осуществляться только в активных по дате элементах сайта.
    При ранжировании результата учитывать заголовки USE_TITLE_RANK [Y|N] По умолчанию выключена, т.к. создает дополнительную нагрузку. Если опция установлена, то при выводе результатов поиска будут учитываться заголовки новости/статьи/файла и т.п. (найденное будет отображаться сверху списка).
    Сортировка по умолчанию DEFAULT_SORT Указывается порядок сортировки результатов поиска по умолчанию: по релевантности (rank) или по дате (date).
    Дополнительный фильтр FILTER_NAME Задается имя переменной, в которой передается массив параметров из фильтра для фильтрации поискового индекса. Служит для определения выходящего из фильтра поискового индекса. Поле может быть оставлено пустым, тогда используется значение по умолчанию.
    Ограничение области поиска arrFILTER Параметр служит для ограничение области поиска: статическими файлами (main), форумами (forum), одним из типов инфоблоков (iblock), определенных в системе, блогами (blog), социальной сетью (socialnetwork) или информацией о сотрудниках компании (intranet). Можно также выбрать несколько из перечисленных источников информации либо выбрать пункт Не ограничивать.
    Если выбрать:
    • [main] Cтатические файлы - то появляется для заполнения поле Путь к файлу начинается с любого из перечисленных, в котором можно указать путь к разделу или файлу, где будет осуществлен поиск, например, /about/. Если поле пусто, то поиск осуществляется во всех статических файлах системы.
    • [forum] Форумы - то ниже отображается поле со всеми форумами, созданными на сайте. Среди них можно выбрать один или несколько форумов либо выбрать вариант (все), тогда поиск будет осуществлен во всех форумах системы.
    • [iblock_<имя>] - один из типов инфоблоков (например, [iblock_news] Новости), то при нажатии кнопки ОК станут доступны все инфоблоки, созданные внутри выбранного типа. Среди них можно выбрать один или несколько инфоблоков либо выбрать вариант (все), тогда поиск будет осуществлен во всех инфоблоках этого типа.
    • [blog] Блоги - то при данном ограничении поиск будет осуществлен только во всех блогах системы;
    • [socialnetwork] Социальная сеть - то при данном ограничении поиск будет осуществлен только в рамках социальной сети;
    • [intranet] Пользователи - то при данном ограничении поиск будет осуществлен только о сотрудниках компании;
    • [crm] CRM - то при данном ограничении поиск будет осуществлен только по CRM;
    • [disk] Файлы диска - то при данном ограничении поиск будет осуществлен только файлам диска.
    Внешний вид
    Показывать выпадающий список "Где искать" SHOW_WHERE [Y|N] При отмеченной опции в публичном разделе будет выведен выпадающий список
    Значения для выпадающего списка "Где искать" arrWHERE Указываются значения, которые должны быть включены в выпадающий список формы поиска "Где искать" (форум, блоги, инфоблоки и т.д.).
    с вариантами ограничения поиска, указанными в параметре arrWHERE.
    Показывать фильтр по датам SHOW_WHEN [Y|N] При отмеченной опции на странице поиска будет отображен дополнительный фильтр, позволяющий отсортировать результаты поиска по заданному интервалу времени.
    Количество результатов на странице PAGE_RESULT_COUNT Параметр определяет количество результатов поиска, которое будет выведено на одной странице. Все результаты будут выведены с помощью постраничной навигации.
    Управление режимом AJAX
    Включить режим AJAX AJAX_MODE [Y|N] При установленной опции для компонента будет включен режим AJAX.
    Включить затенение AJAX_OPTION_SHADOW [Y|N] Если параметр принимает значение "Y", то при выполнении AJAX-перехода будет затенена область, которая должна измениться.
    Включить прокрутку к началу компонента AJAX_OPTION_JUMP [Y|N] Если пользователь совершит AJAX-переход, то при установленой опции по окончании загрузки произойдет прокрутка к началу компонента.
    Включить подгрузку стилей AJAX_OPTION_STYLE [Y|N] Если параметр принимает значение "Y", то при совершении AJAX-переходов будет происходить подгрузка и обработка списка стилей, вызванных компонентом.
    Включить эмуляцию навигации браузера AJAX_OPTION_HISTORY [Y|N] Когда пользователь выполняет AJAX-переходы, то при включенной опции можно использовать кнопки браузера Назад и Вперед.
    Настройки кеширования
    Тип кеширования CACHE_TYPE Тип кеширования:
    • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
    • Y - Кешировать: для кеширования необходимо определить время кеширования;
    • N - Не кешировать: кеширования нет в любом случае.
    Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах. По умолчанию поле содержит 3600 сек.
    Дополнительные настройки
    Включить автоопределение раскладки клавиатуры USE_LANGUAGE_GUESS [Y|N] При отмеченной опции будет происходить автоматическое определение раскладки, в которой набран поисковый запрос.
    Показывать подсказку с поисковыми фразами USE_SUGGEST [Y|N] При отмеченной опции в строке поиска будет отображаться интерактивная подсказка с введенными ранее поисковыми фразами.
    Включить рейтингSHOW_RATINGУказывается включать ли вывод рейтинга:
    • пустое_значение - по умолчанию;
    • Y - да;
    • N - нет.


    Данный параметр недоступен для шаблона icons.
    Вид кнопок рейтингаRATING_TYPEУказывается тип кнопки рейтинга:
    • пустое_значение - по умолчанию;
    • like - Мне нравится (текстовый);
    • like_graphic - Мне нравится (графический);
    • standart_text - Нравится / Не нравится (текстовый);
    • standart - Нравится / Не нравится (графический).

    Данный параметр недоступен для шаблона icons.
    Шаблон пути к профилю пользователяPATH_TO_USER_PROFILE Указывается шаблон пути к профилю пользователя.

    Данный параметр недоступен для шаблона icons.
    Показывать теги документаSHOW_ITEM_TAGS [Y|N] При отмеченной опции для результатов поиска будут показаны теги документа.

    Данное поле доступно только для шаблонов icons и clear.
    Показывать дату изменения документаSHOW_ITEM_DATE_CHANGE [Y|N] При отмеченной опции для результатов поиска будет показана дата изменения документа.

    Данное поле доступно только для шаблонов icons и clear.
    Показывать сортировкуSHOW_ORDER_BY [Y|N] При отмеченной опции будет доступна сортировка результатов поиска.

    Данное поле доступно только для шаблонов icons и clear.
    Показывать облако теговSHOW_TAGS_CLOUD [Y|N] При отмеченной опции на странице поиска будет отображаться облако тегов. Кроме того, становятся доступными дополнительные поля
    Сужать область поиска*TAGS_INHERIT [Y|N] При отмеченной опции выбранные теги добавляются в фильтр поиска.
    Сортировка тегов*TAGS_SORT Указывается тип сортировки тегов: по имени (NAME) или по популярности (CNT).
    Количество тегов*TAGS_PAGE_ELEMENTS Параметр определяет количество выводимых тегов в облаке.
    Период выборки тегов (дней)*TAGS_PERIOD Параметр определяет период выборки тегов (дней).
    Путь к странице поиска (от корня сайта)*TAGS_URL_SEARCH Указывается путь к странице поиска (от корня сайта).
    Максимальный размер шрифта (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").
    , отмеченные *.

    Данное поле доступно только для шаблонов icons и clear.
    Настройки постраничной навигации
    Выводить над результатами DISPLAY_TOP_PAGER [Y|N] При отмеченной опции постраничная навигация будет выведена вверху страницы поиска.
    Выводить под результатами DISPLAY_BOTTOM_PAGER [Y|N] При отмеченной опции постраничная навигация будет выведена внизу страницы поиска.
    Название результатов поиска PAGER_TITLE Указывается название заголовка постраничной навигации.
    Выводить всегда PAGER_SHOW_ALWAYS [Y|N] При отмеченной опции навигация будет отображаться всегда, даже если результаты поиска помещаются на одной странице.
    Название шаблона PAGER_TEMPLATE Указывается название шаблона постраничной навигации.


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

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

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

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

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