Перед использованием модуля Поиск необходимо проверить установлен ли он и подключить его при помощи конструкции:
<?
if(CModule::IncludeModule("search"))
{
//здесь можно использовать функции модуля
}
?>
Работа модуля поиска сводится к предварительному индексированию и последующей выдаче информации сайте по запросу пользователя. Индексирование заключается в сохранении времени изменения, модуля-владельца, кода элемента, языка, web-адреса, заголовка, текста и двух произвольных параметров индексируемого элемента, а так же списка кодов групп пользователей, которые имеют доступ на чтение (как минимум) к данному элементу. Поиск заключается в выдаче списка результатов, удовлетворяющих введенной строке запроса (обрабатывается с учётом языка запросов), а так же набору установленных ограничений (модуль-владелец, код элемента, сайт, два произвольных параметра).
Алгоритм работы модуля поиска таков, что он не имеет никакой информации по характеру и структуре данных других модулей. При индексации модули по запросу сами отдают модулю поиска ту информацию, которую необходимо проиндексировать. Передача осуществляется в виде массива заданной структуры. Связь между модулем поиска и другими модулями системы осуществляется через систему сообщений.
Специальные константы.
Публичные функции и возвращаемые значения
| Функция | Описание |
|---|---|
| stemming | Возвращает массив неизменных основ слов. |
| stemming_default | Функция морфологического анализа текста применяемая по умолчанию. |
| stemming_stop_default | Функция определения стоп слова применяемая по умолчанию. |
| stemming_letter_default | Функция возвращает алфавит по умолчанию. |
| tags_prepare | Возвращает массив тегов. |
| InputTags | Возвращает код html для ввода тегов с поддержкой автодополнения. |
Классы модуля поиска
| Класс | Описание |
|---|---|
| CSearch | Класс для индексирования сайта и осуществления поиска по индексу. |
| CSearchCustomRank | Класс поддержки правил сортировки. |
| CSiteMap | Класс поддержки Google Sitemap. |
| CSearchTags | Класс поддержки тегов. |
События модуля поиска
| Событие | Описание |
|---|---|
| BeforeIndex | Вызывается перед индексацией элемента. |
| OnSearch | Вызывается перед выполнением поисковых запросов. |
| OnReIndex | Вызывается при построении поискового индекса. |
| OnSearchGetFileContent | Вызывается по время переиндексации данных главного модуля. |
| OnSearchGetURL | Вызывается при форматировании элемента в результатах поиска. |
| OnBeforeFullReindexClear | Вызывается в начале первого шага полной переиндексации, непосредственно перед удалением всех данных поискового индекса. |
| OnBeforeIndexDelete | Вызывается перед удалением части поискового индекса. |
| OnBeforeIndexUpdate | Вызывается перед обновлением поискового индекса. |
| OnAfterIndexAdd | Вызывается после добавления новых данных в поисковый индекс. |
| OnSearchCheckPermissions | Вызывается при построении поискового запроса. |
Модуль включает в себя следующие Компоненты 2.0:
| Компоненты модуля | ||
|---|---|---|
| Название | Имя в пространстве имен bitrix | Описание |
| Форма поиска | search.form | Служит для вывода формы поиска. |
| Стандартная страница поиска | search.page | Служит для создания страницы поиска. |
| Облако тегов | search.tags.cloud | Предназначен для вывода облака тегов. |
| Форма ввода тегов | search.tags.input | Предназначен для вывода формы ввода тегов. |
Смотрите также:
Пользовательские комментарии
Пользовательские комментарии не являются официальной документацией. Ответственность за их использование несет сам пользователь.Добавлять комментарии могут только зарегистрированные пользователи. Сообщения для просмотра появляются после модерации.

