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

GetSimpleList

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

CDBResult
CStatEventType::GetSimpleList(
	string &by = "s_event1",
	string &order = "desc",
	array filter = array(),
	bool &is_filtered
)

Возвращает список типов событий в упрощённом виде.

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

ПараметрОписание
byПоле для сортировки. Возможные значения:
  • s_id - ID типа события;
  • s_event1 - идентификатор event1 типа события;
  • s_event2 - идентификатор event2 типа события;
  • s_name - название типа события;
  • s_description - описание типа события.
оrderПорядок сортировки. Возможные значения:
  • asc - по возрастанию;
  • desc - по убыванию.
filterМассив для фильтрации результирующего списка. В массиве допустимы следующие ключи:
  • ID* - ID типа события;
  • ID_EXACT_MATCH - если значение равно "N", то при фильтрации по ID будет искаться вхождение;
  • EVENT1* - идентификатор event1 типа события;
  • EVENT1_EXACT_MATCH - если значение равно "Y", то при фильтрации по EVENT1 будет искаться точное совпадение;
  • EVENT2* - идентификатор event2 типа события;
  • EVENT2_EXACT_MATCH - если значение равно "Y", то при фильтрации по EVENT2 будет искаться точное совпадение;
  • NAME* - название типа события;
  • NAME_EXACT_MATCH - если значение равно "Y", то при фильтрации по NAME будет искаться точное совпадение;
  • DESCRIPTION* - описание типа события;
  • DESCRIPTION_EXACT_MATCH - если значение равно "Y", то при фильтрации по DESCRIPTION будет искаться точное совпадение;
  • KEYWORDS - event1, event2, название и описание типа события;
  • KEYWORDS_EXACT_MATCH - если значение равно "Y", то при фильтрации по KEYWORDS будет искаться точное совпадение.
* - допускается сложная логика
is_filteredФлаг отфильтрованности результирующего списка. Если значение равно "true", то список был отфильтрован.

Структура возвращаемой записи

Array
(
	[ID] => ID типа события
	[EVENT1] => идентификатор event1 типа события
	[EVENT2] => идентификатор event2 типа события
	[NAME] => название типа события
	[EVENT] => event1 / event2, либо название типа события если оно указано
	[DESCRIPTION] => описание типа события
)

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

<?
// выберем только те типы событий у которых в event1 входит "download"
$arFilter = array(
	"EVENT1" => "download"
);

// получим список записей
$rs = CStatEventType::GetSimpleList(
	($by="s_event2"), 
	($order="desc"), 
	$arFilter, 
	$is_filtered
);

// выведем все записи
while ($ar = $rs->Fetch())
{
	echo "<pre>"; print_r($ar); echo "</pre>";    
}
?>


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

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

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

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

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