Описание и параметры
CDBResult
CHit::GetList(
string &by = "s_id",
string &order = "desc",
array filter = array(),
bool &is_filtered
)
Возвращает список хитов посетителей. Число выводимых строк определяется в поле Максимальное кол-во показываемых записей в таблицах в настройках модуля Веб-аналитика.
Параметры метода
Параметр | Описание |
by | Поле для сортировки. Возможные значения:
- s_id - ID хита;
- s_site_id - ID сайта;
- s_session_id - ID сессии;
- s_date_hit - время хита;
- s_user_id - ID пользователя под которым был авторизован посетитель (в момент хита или до того);
- s_guest_id - ID посетителя;
- s_ip - IP адрес посетителя;
- s_url - страница хита;
- s_country_id - ID страны посетителя.
|
оrder | Порядок сортировки. Возможные значения:
- asc - по возрастанию;
- desc - по убыванию.
|
filter | Массив для фильтрации результирующего списка. В массиве допустимы следующие ключи:
- ID* - ID хита;
- ID_EXACT_MATCH - если значение равно "N", то при фильтрации по ID будет искаться вхождение;
- GUEST_ID* - ID посетителя;
- GUEST_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по GUEST_ID будет искаться вхождение;
- NEW_GUEST - флаг "новый посетитель", возможные значения:
- Y - посетитель впервые на портале;
- N - посетитель уже посещал ранее портал.
- SESSION_ID* - ID сессии;
- SESSION_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по SESSION_ID будет искаться вхождение;
- STOP_LIST_ID* - ID записи стоп-листа под которую попал посетитель (если это имело место быть);
- STOP_LIST_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по STOP_LIST_ID будет искаться вхождение;
- URL* - страница хита;
- URL_EXACT_MATCH - если значение равно "Y", то при фильтрации по URL будет искаться точное совпадение;
- URL_404 - была ли 404 ошибка на странице хита
- USER* - ID, логин, имя, фамилия пользователя под которым был авторизован посетитель в момент хита или до него;
- USER_EXACT_MATCH - если значение равно "Y", то при фильтрации по USER будет искаться точное совпадение;
- REGISTERED - флаг "был ли авторизован посетитель в момент хита или до этого", возможные значения:
- DATE_1 - начальное значение интервала даты хита;
- DATE_2 - конечное значение интервала даты хита;
- IP* - IP адрес посетителя в момент хита;
- IP_EXACT_MATCH - если значение равно "Y", то при фильтрации по IP будет искаться точное совпадение;
- USER_AGENT* - UserAgent посетителя в момент хита;
- USER_AGENT_EXACT_MATCH - если значение равно "Y", то при фильтрации по USER_AGENT будет искаться точное совпадение;
- COUNTRY_ID* - ID страны посетителя в момент хита;
- COUNTRY_ID_EXACT_MATCH - если значение равно "Y", то при фильтрации по COUNTRY_ID будет искаться точное совпадение;
- COUNTRY* - название страны;
- COUNTRY_EXACT_MATCH - если значение равно "Y", то при фильтрации по COUNTRY будет искаться точное совпадение;
- COOKIE* - содержимое Cookie в момент хита;
- COOKIE_EXACT_MATCH - если значение равно "Y", то при фильтрации по COOKIE будет искаться точное совпадение;
- STOP -
- SITE_ID* - ID сайта;
- SITE_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по SITE_ID будет искаться вхождение.
* - допускается сложная логика |
is_filtered | Флаг отфильтрованности списка хитов. Если значение равно "true", то список был отфильтрован. |
Структура возвращаемой записи
Array
(
[ID] => ID хита
[SESSION_ID] => ID сессии
[DATE_HIT] => время хита
[GUEST_ID] => ID посетителя
[NEW_GUEST] => [Y|N] флаг "был ли это новый посетитель на сайте" (Y)
[USER_ID] => ID пользователя под которым посетитель был авторизован (в момент хита или до этого)
[USER_AUTH] => флаг "был ли посетитель авторизован в момент хита"
[URL] => страница хита
[URL_404] => была ли 404 ошибка на странице хита
[URL_FROM] => страница откуда пришел посетитель
[IP] => IP адрес посетитель в момент хита
[METHOD] => HTTP метод отсылки данных
[COOKIES] => содержимое Cookie посетителя в момент хита
[USER_AGENT] => UserAgent посетителя в момент хита
[STOP_LIST_ID] => ID записи стоп-листа под которую попал посетитель (если это имело место быть)
[COUNTRY_ID] => ID страны (двухсимвольный идентификатор) посетителя сайта в момент хита (определяется по IP адресу)
[COUNTRY_NAME] => название страны посетителя сайта в момент хита (определяется по IP адресу)
[SITE_ID] => ID сайта (двухсимвольный идентификатор)
[LOGIN] => логин пользователя под которым посетитель был авторизован (в момент хита или до этого)
[USER_NAME] => имя и фамилия пользователя под которым посетитель был авторизован (в момент хита или до этого)
)
Примеры использования
<?
// выберем хиты сессии #1056
$arFilter = array(
"SESSION_ID" => 1056
);
// получим список записей
$rs = CHit::GetList(
($by = "s_id"),
($order = "desc"),
$arFilter,
$is_filtered
);
// выведем все записи
while ($ar = $rs->Fetch())
{
echo "<pre>"; print_r($ar); echo "</pre>";
}
?>