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

GetList

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

CDBResult
CCountry::GetList(
	string &by = "s_name",
	string &order = "desc",
	array filter = array(),
	bool &is_filtered
)

Возвращает список стран, определённых в модуле "Статистика". Загрузка списка стран осуществляется при переиндексации базы IP адресов в настройках модуля "Статистика".

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

ПараметрОписание
byПоле для сортировки. Возможные значения:
  • s_id - двухсимвольный идентификатор страны;
  • s_short_name - трехсимвольный идентификатор страны;
  • s_name - наименование страны;
  • s_sessions - суммарное кол-во сессий по данной стране;
  • s_new_guests - суммарное кол-во новых посетителей по данной стране;
  • s_hits - суммарное кол-во хитов по данной стране;
  • s_events - суммарное кол-во событий по данной стране.
оrderПорядок сортировки. Возможные значения:
  • asc - по возрастанию;
  • desc - по убыванию.
filterМассив для фильтрации результирующего списка. В массиве допустимы следующие ключи:
  • ID* - двухсимвольный идентификатор страны;
  • ID_EXACT_MATCH - если значение равно "N", то при фильтрации по ID будет искаться вхождение;
  • SHORT_NAME* - трехсимвольный идентификатор страны;
  • SHORT_NAME_EXACT_MATCH - если значение равно "Y", то при фильтрации по SHORT_NAME будет искаться точное совпадение;
  • NAME* - наименование страны;
  • NAME_EXACT_MATCH - если значение равно "Y", то при фильтрации по NAME_EXACT_MATCH будет искаться точное совпадение;
  • SESSIONS1 - начальное значение интервала для поля "кол-во сессий";
  • SESSIONS2 - конечное значение интервала для поля "кол-во сессий";
  • NEW_GUESTS1 - начальное значение интервала для поля "кол-во новых посетителей";
  • NEW_GUESTS2 - конечное значение интервала для поля "кол-во новых посетителей";
  • HITS1 - начальное значение интервала для поля "кол-во хитов";
  • HITS2 - конечное значение интервала для поля "кол-во хитов";
  • EVENTS1 - начальное значение интервала для поля "кол-во событий";
  • EVENTS2 - конечное значение интервала для поля "кол-во событий".

    * - допускается сложная логика
is_filteredФлаг отфильтрованности списка UserAgent'ов. Если значение равно "true", то список был отфильтрован.

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

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

Array
(
	[ID] => двухсимвольный идентификатор страны
	[SHORT_NAME] => трехсимвольный идентификатор страны
	[NAME] => название страны
	[SESSIONS] => суммарное кол-во сессий
	[NEW_GUESTS] => суммарное кол-во новых посетителей
	[HITS] => суммарное кол-во хитов
	[C_EVENTS] => суммарное кол-во событий
	[REFERENCE_ID] => параметр REFERENCE_ID для использования в функции SelectBox или SelectBoxM
	[REFERENCE] => параметр REFERENCE для использования в функции SelectBox или SelectBoxM
)

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

<?
// выберем только те страны из которых было не менее 100 заходов на сайт
$arFilter = array(
	"SESSIONS1" => 100
);

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

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

<?
// выпадающий список с одиночным выбором
echo SelectBox("COUNTRY_ID", CCountry::GetList(), "", intval($COUNTRY_ID));

// список из 20 видимых элементов с возможностью множественного выбора
echo SelectBoxM("arCOUNTRY_ID[]", CCountry::GetList(), $arCOUNTRY_ID, "", false, 20);
?>


© «Битрикс», 2001-2024, «1С-Битрикс», 2024