Онлайн-руководство разработчика 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

API

$nc_search->show_form([string $params [, array $template [, array $areas]]])

выводит форму поиска

Параметр Описание
$params (опционально) строка с дополнительными параметрами формы, соединёнными через амперсанд (например, "inputsize=30&suggest=0"). Если значения содержат символы &, =, пробел, они должны быть указаны как %26, %3D, + соответственно.
$template (опционально) массив с альтернативным шаблоном формы поиска
$areas (опционально) массив с областями поиска, где ключ — описание области (см. раздел «Области поиска на сайте»), а значение — текстовое описание, которое будет выведено в форме.

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

  • submitname — текст кнопки отправки запроса.
  • inputsize — размер поля ввода. По умолчанию — 20.
  • suggest — если значение равно 1 или on, будет использоваться автозаполнение (должно быть разрешено в настройках модуля). По умолчанию — 1.
  • areastype — индекс элемента массива с шаблоном формы, отвечающего за вывод списка областей поиска:
    • empty — не выводить области поиска.
    • select — вывести список областей поиска в виде выпадающего списка.
    • radio — вывести список областей поиска в виде переключателей (radiobutton).
    • checkbox — вывести список областей с «галочками» (checkbox). Удобно для использования вместе с областью поиска thissub (поиск в только текущем разделе).
    • links — вывести области поиска в виде ссылок. Нажатие на ссылку с областью поиска перезагружает страницу поиска с поисковым запросом, заданным при загрузке страницы. Удобно для использования на странице поиска.
    • hidden - области поиска будут скрытыми

Значение по умолчанию: если параметр $areas задан — select, иначе — empty.

  • showavdancedlink — выводить ли ссылку на форму расширенного поиска (если её использование разрешено в настройках модуля). По умолчанию — 0 (не выводить ссылку).
  • inputvalue — значение в поле ввода, по умолчанию равен GET-параметру query.
  • selectedarea — выбранная область; может быть перечислено несколько областей через запятую. По умолчанию равен GET-параметру area.
  • actionurl – путь до раздела поиска; по умолчанию определяется автоматически.

Массив с альтернативным шаблоном формы поиска $template может содержать элементы prefix (начало формы — код до вывода областей поиска), suffix (окончание формы — код после вывода областей поиска), элементы для вывода областей поиска: unactive (невыбранная область поиска), active (выбранная область поиска), divider (разделитель между областями поиска). В массиве $template могут быть заданы не все элементы, а только их часть; недостающие элементы будут взяты из описания формы поиска по умолчанию в настройках модуля.

В шаблонах вывода областей поиска можно использовать псевдопеременные %AREANUM (порядковый номер области поиска), %AREA (область поиска), %NAME (текстовое описание области поиска), %URL (ссылка на страницу поиска с поисковым запросом, но без параметра area). Во всех элементах шаблона можно использовать параметры-переменные из первого аргумента метода, например, $inputsize или $areastype.

Структура формы поиска по умолчанию определяется в панели управления модулем на вкладке «Настройки» — «Отображение».

Как правило, изменение шаблона не требуется, поскольку внешний вид формы можно изменить при помощи CSS.

Массив с областями поиска $areas можно записать в таком виде:

array("thissub" => "только в этом разделе")

или

array("" => "на всём сайте",
	"/catalogue/*" => "в каталоге товаров",
	"sub30*" => "в новостях")
Описание проекта