Онлайн-руководство разработчика NetCat
Модуль «Поиск по сайту» 12.2.1Начало работы с модулем 12.2.2Язык запросов 12.2.3Способы хранения индекса 12.2.4Интерфейс модуля в панели управления сайтом 12.2.5Области индексирования 12.2.6Области HTML-страниц 12.2.7Области поиска на сайте 12.2.8Индексирование по расписанию, запуск индексирования в фоновом режиме 12.2.9Правила индексирования 12.2.10Постановка задачи переиндексирования в очередь 12.2.11Интеграция модуля в макеты дизайна сайта 12.2.12Простая форма поиска 12.2.13Расширенная форма поиска 12.2.14Вывод результатов поиска 12.2.15Стилизация списка подсказок 12.2.16Расширенные настройки 12.2.17Разработка расширений модуля 12.2.18Обзор архитектуры модуля 12.2.19Обработчики документов различных типов 12.2.20Текстовые фильтры 12.2.21Анализаторы текста 12.2.22Корректировщики запросов 12.2.23Подключение других поисковых систем 12.2.24Решение проблем с поиском 12.2.25Решение проблем с индексированием 12.2.26Справочник API

Вывод результатов поиска

Вывод результатов поиска осуществляется при помощи служебного компонента «Поиск по сайту», расположенного в одноимённой группе компонентов.

Для получения результатов в системных настройках компонента используется метод:


$nc_search->get_results(string $query_string[, string|array $area[, string $params]])

Параметр Описание
$query_string поисковый запрос
$area (опционально) область поиска в виде строки или массива с областями поиска
$params (опционально) дополнительные параметры в виде строки через амперсанд

В свою очередь у параметра $params есть свой перечень возможных передаваемых параметров:

  • field — название поля, в котором производится поиск. Игнорируется, если в настройках модуля отключен поиск по полю.
  • interval — должен содержать непустое значение для срабатывания фильтрации результатов по дате последнего изменения.
  • intervalunit — тип интервала, по которому производится фильтрация результатов. Допустимые значения: hour, day, week, month.
  • intervalvalue — значение интервала (число).
  • sortby — поле, по которому производится сортировка. Если значение не задано, результаты сортируются по релевантности. Игнорируется, если в настройках модуля отключен поиск по полю. Допустимые значения: last_modified, а также имена дополнительных полей, по которым возможна сортировка доступных для поиска.
  • sortdirection — направление сортировки. Допустимые значения: desc (сортировка по убыванию), asc (сортировка по возрастанию). Значение по умолчанию — desc.
  • language — язык запроса. По умолчанию определяется автоматически (по языку раздела, в котором расположен компонент поиска).
  • curPos — номер первого результата (для перехода по страницам результатов).
  • recNum — количество результатов на странице, по умолчанию 10 (берется из настроек компонента в разделе).
  • correct — если значение равно 1, модуль поиска будет пробовать исправлять запросы, не давшие результатов (по умолчанию равно значению соответствующей настройки модуля). Игнорируется, если в настройках модуля отключено исправление запросов.

Оформление результатов поиска можно изменить в полях раздела «Шаблон отображения списка объектов», однако, как правило, этого не требуется: оформлением можно управлять при помощи CSS-стилей.

Результаты выполнения поискового запроса сохраняются в объекте класса nc_search_result (переменная $results), у которого доступны следующие методы:


$results->get_error_message()

метод получения сообщения об ошибках, если они возникли при выполнении запроса.


$results->get_correction_suggestion() 

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


$results->get_search_time()

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

В поле «Объект в списке» можно использовать следующие свойства документа:

  • $f_url — адрес страницы
  • $f_title — заголовок страницы
  • $f_context — фрагменты текста, совпавшие с поисковым запросом. Поле недоступно, если в настройках модуля (вкладка «Настройки» — «Отображение») отключена опция «показывать фрагмент текста в списке найденных страниц». Длина фрагмента определяется настройкой «Максимальное количество слов в фрагменте текста» на вышеупомянутой вкладке.
  • $f_lastmodified — время последнего изменения (в виде строки в формате «ГГГГ-ММ-ДД ЧЧ:ММ:СС»)
  • $f_content — проиндексированный текст документа
  • $f_language — код языка документа
  • $f_contenttype — MIME-тип документа (например, "text/html")
  • $f_site_id — идентификатор сайта, на котором расположен документ
  • $f_meta — массив с дополнительными полями (см. раздел «Сохранение частей страниц для использования в результатах поиска»)
Описание проекта