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

OnSearchGetFileContent

Описание и параметры

mixed
функция-обработчик( string absolute_path,
string SEARCH_SESS_ID
);

Событие "OnSearchGetFileContent" вызывается во время переиндексации данных главного модуля CSearch::ReIndexFile.

Параметры

Параметр Описание
absolute_path Абсолютный путь к индексируемому файлу.
SEARCH_SESS_IDИдентификатор текущей сессии индексации. Может использоваться в обработчике события для добавления в поисковый индекс дополнительного контента с помощью метода CSearch::Index.

Возвращаемое значение

Функция-обработчик может вернуть массив описывающий содержимое файла. Массив должен иметь следующую структуру:

  • TITLE - заголовок (обязательное поле);
  • CONTENT - содержимое документа;
  • PROPERTIES - массив свойств документа (обязательное). Если свойств нет, то должен быть передан пустой массив. Содержимое элемента этого массива с именем указанным в настройках модуля как "Код свойства страницы в котором хранятся теги" будет занесен в теги;

Или может вернуть false, если не знает как файл должен быть обработан.

Пример функции-обработчика

<?
//init.php

// индексируем сжатые gzip файлы.
// регистрируем обработчик события "OnSearchGetFileContent" модуля "search"
AddEventHandler("search", "OnSearchGetFileContent", array("CMyClass", "OnSearchGetFileContent_gzip"));

class CMyClass
{
public static function OnSearchGetFileContent_gzip($absolute_path)
{

if(file_exists($absolute_path) && is_file($absolute_path) && substr($absolute_path, -3) == ".gz")
{
return array(
"TITLE" => basename($absolute_path),
"CONTENT" => implode("\n", gzfile($absolute_path)),
"PROPERTIES" => array(),
);
}
else
return false;
}
}

?>


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

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

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

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

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