GetList

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

CDBResult
CStatEventType::GetList(
	string &by = "s_today_counter",
	string &order = "desc",
	array filter = array(),
	bool &is_filtered,
	mixed limit = false
)

Возвращает список типов событий.

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

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

• CStatEventType::GetDynamicList
• CStatEventType::GetSimpleList
• Термин "Тип события"

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

В зависимости от установленной группировки, структура возвращаемой записи различная.

• при группировке по event1 (filter["GROUP"]="event1"):

  Array
  (
  	[EVENT1] => идентификатор event1 типа события
  	[DATE_ENTER] => дата первого события, тип которого имеет данный идентификатор event1
  	[DATE_LAST] => дата последнего события, тип которого имеет данный идентификатор event1
  	[TOTAL_COUNTER] => суммарное количество событий
  	[TODAY_COUNTER] => количество событий за сегодня
  	[YESTERDAY_COUNTER] => количество событий за вчера
  	[B_YESTERDAY_COUNTER] => количество событий за позавчера
  	[PERIOD_COUNTER] => количество событий за период времени, указанный в фильтре (filter[DATE1_PERIOD], filter[DATE2_PERIOD])
  	[TOTAL_MONEY] => суммарная денежная сумма
  	[TODAY_MONEY] => денежная сумма за сегодня
  	[YESTERDAY_MONEY] => денежная сумма за вчера
  	[B_YESTERDAY_MONEY] => денежная сумма за позавчера
  	[PERIOD_MONEY] => денежная сумма за период времени, указанный в фильтре (filter[DATE1_PERIOD], filter[DATE2_PERIOD])
  	[CURRENCY] => трехсимвольный идентификатор валюты
  )

• при группировке по event2 (filter["GROUP"]="event2"):

  Array
  (
  	[EVENT2] => идентификатор event2 типа события
  	[DATE_ENTER] => дата первого события, тип которого имеет данный идентификатор event2
  	[DATE_LAST] => дата последнего события, тип которого имеет данный идентификатор event2
  	[TOTAL_COUNTER] => суммарное количество событий
  	[TODAY_COUNTER] => количество событий за сегодня
  	[YESTERDAY_COUNTER] => количество событий за вчера
  	[B_YESTERDAY_COUNTER] => количество событий за позавчера
  	[PERIOD_COUNTER] => количество событий за период времени, указанный в фильтре (filter[DATE1_PERIOD], filter[DATE2_PERIOD])
  	[TOTAL_MONEY] => суммарная денежная сумма
  	[TODAY_MONEY] => денежная сумма за сегодня
  	[YESTERDAY_MONEY] => денежная сумма за вчера
  	[B_YESTERDAY_MONEY] => денежная сумма за позавчера
  	[PERIOD_MONEY] => денежная сумма за период времени, указанный в фильтре (filter[DATE1_PERIOD], filter[DATE2_PERIOD])
  	[CURRENCY] => трехсимвольный идентификатор валюты
  )

• когда группировка не установлена:

  Array
  (
  	[ID] => ID типа события
  	[EVENT1] => идентификатор event1 типа события
  	[EVENT2] => идентификатор event2 типа события
  	[DIAGRAM_DEFAULT] => [Y|N] флаг: включать ли данный тип события в круговую диаграмму и график по умолчанию
  	[NAME] => название типа события
  	[EVENT] => event1 / event2, либо название типа события (если оно указано)
  	[DESCRIPTION] => описание типа события
  	[TOTAL_COUNTER] => суммарное количество событий данного типа
  	[TODAY_COUNTER] => количество событий данного типа за сегодня
  	[YESTERDAY_COUNTER] => количество событий данного типа за вчера
  	[B_YESTERDAY_COUNTER] => количество событий данного типа за позавчера
  	[PERIOD_COUNTER] => количество событий данного типа за период времени, указанный в фильтре (filter[DATE1_PERIOD], filter[DATE2_PERIOD])
  	[TOTAL_MONEY] => суммарная денежная сумма по данному типу события
  	[TODAY_MONEY] => денежная сумма по данному типу события за сегодня
  	[YESTERDAY_MONEY] => денежная сумма по данному типу события за вчера
  	[B_YESTERDAY_MONEY] => денежная сумма по данному типу события за позавчера
  	[PERIOD_MONEY] => денежная сумма по данному типу события за период времени, указанный в фильтре (filter[DATE1_PERIOD], filter[DATE2_PERIOD])
  	[CURRENCY] => трехсимвольный идентификатор валюты
  )

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

<?
// получим данные только по тем типам событий 
// у которых event1 = "download"
// а также получим дополнительные данные на декабрь 2007 года
$arFilter = array(
	"DATE1_PERIOD" => "01.12.2007",
	"DATE2_PERIOD" => "31.12.2007",
	"EVENT1"       => "download"
);

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

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