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

DeleteIndex

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

void
CSearch::DeleteIndex(
	string MODULE_ID,
	string ITEM_ID = false,
	string PARAM1 = false,
	string PARAM2 = false,
	string SITE_ID = false
);

Метод удаляет из индекса поиска указанную информацию. Метод статический.

Параметры метода

Параметр Описание
MODULE_ID Код модуля, индексацию информации которого необходимо удалить .
ITEM_ID Код элемента, индексацию информации которого необходимо удалить. Если этот параметр равен false, то ограничение по коду элемента не устанавливается (удаляется индексация информации с любыми кодами). Не обязательный параметр, по умолчанию равен false.
PARAM1 Первый параметр элемента, ограничивающий набор проиндексированных элементов, индексацию информации которых необходимо удалить. Если этот параметр равен false, то ограничение по первому параметру элемента не устанавливается. Не обязательный параметр, по умолчанию равен false.
PARAM2 Второй параметр элемента, ограничивающий набор проиндексированных элементов, индексацию информации которых необходимо удалить. Если этот параметр равен false, то ограничение по второму параметру элемента не устанавливается. Не обязательный параметр, по умолчанию равен false.
SITE_ID Сайт проиндексированого элемента, ограничивающий набор элементов, индексацию информации которых необходимо удалить. Если этот параметр равен false, то ограничение по сайту элемента не устанавливается. Необязательный параметр, по умолчанию равен false.

До версии 4.0.6 параметр назывался LID.

Примеры использования

При удалении файла с диска необходимо удалить так же его индекс поиска, если он есть
<?
$path = "/ru/my_files/file.php";
if (unlink($_SERVER["DOCUMENT_ROOT"].$path))
{
	if (CModule::IncludeModule("search"))
		CSearch::DeleteIndex("main", $path);
}
?>


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

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

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

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

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