GetList

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

CDBResult
CSearchTags::GetList(
	array arSelect = array(),
	array arFilter = array(),
	array arOrder = array(),
	int limit = 100
);

Получение списка тегов элементов поискового индекса. Метод статический.

Данный метод использует технологию управляемого кеширования в случае соответствующей настройки констант модуля поиска: CACHED_b_search_tags и CACHED_b_search_tags_len.

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

Параметр	Описание
arSelect	Массив, содержащий поля для выборки. Название поля может принимать значение: NAME - тег; CNT - частота тега, количество элементов поискового индекса содержащих этот тег; DATE_CHANGE - максимальная дата модификации (в полном формате) элементов поискового индекса содержащих этот тег; Не обязательный параметр. По умолчанию равен: array( "NAME", "CNT", )
arFilter	Массив, содержащий фильтр в виде наборов "название поля"=>"значение фильтра". Название поля может принимать значение: SITE_ID - массив идентификаторов сайтов; TAG - начало тега, будут возвращены все теги начинающиеся с этого значения; MODULE_ID - идентификатор модуля; PARAM1 - первый параметр элемента; PARAM2 - второй параметр элемента; Пример: array( "SITE_ID"=>array("s1"), "TAG"=>"We", "MODULE_ID"=>"iblock", )
arOrder	Массив, содержащий признак сортировки в виде наборов "название поля"=>"направление". Название поля может принимать значение: NAME - тег; CNT - частота тега, количество элементов поискового индекса содержащих этот тег; DATE_CHANGE - максимальная дата модификации (в полном формате) элементов поискового индекса содержащих этот тег; Направление сортировки может принимать значение: ASC - по возрастанию; DESC - по убыванию. Не обязательный параметр. По умолчанию равен: array( "NAME"=>"ASC", )
limit	Ограничение количества тегов в результатах.

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

Возвращается результат запроса типа CDBResult. При выборке из результата методами класса CDBResult становятся доступны поля перечисленные в параметре arSelect.

Смотрите также

Константы модуля поиска

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

Получение списка десяти самых популярных тегов модуля информационных блоков.

<?
//подключение модуля поиска
if(CModule::IncludeModule('search'))
{
	$rsTags = CSearchTags::GetList(
		array(),
		array(
			"MODULE_ID" => "iblock",
		),
		array(
			"CNT" => "DESC",
		),
		10
	);
	while($arTag = $rsTags->Fetch())
		print_r($arTag);
}
?>