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

GetList

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

CDBResult
CReferer::GetList(
 string &by = "s_id",
 string &order = "desc",
 array filter = array(),
 bool &is_filtered,
 int &total,
 string &group_by,
 int &max
)

Возвращает список ссылающихся сайтов (страниц).

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

ПараметрОписание
byПоле для сортировки. В зависимости от группировки списка, набор доступных значений данной переменной может быть различным.
  • при группировке по ссылающейся странице (filter["GROUP"]="U"):
    • s_url_from - ссылающаяся страница;
    • s_quantity - количество заходов с ссылающейся страницы;
    • s_average_hits - среднее количество хитов, производимое посетителями заходящими с той или ссылающейся страницы.
  • при группировке по ссылающемуся домену (filter["GROUP"]="S"):
    • s_url_from - ссылающийся домен;
    • s_quantity - количество заходов с ссылающегося домена;
    • s_average_hits - среднее количество хитов, производимое посетителями.
  • когда группировка не установлена:
    • s_id - ID записи;
    • s_site_id - ID сайта, на который пришли;
    • s_url_from - ссылающаяся страница (с которой пришли);
    • s_url_to - страница на которую пришли;
    • s_date_hit - дата;
    • s_session_id - ID сессии.
оrderПорядок сортировки. Возможные значения:
  • asc - по возрастанию;
  • desc - по убыванию.
filterМассив для фильтрации результирующего списка. В массиве допустимы следующие ключи:
  • ID - ID записи;
  • ID_EXACT_MATCH - если значение равно "N", то при фильтрации по ID будет искаться вхождение;
  • SESSION_ID - ID сессии;
  • SESSION_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по SESSION_ID будет искаться вхождение;
  • DATE1 - начальное значение интервала для поля "дата";
  • DATE2 - конечное значение интервала для поля "дата";
  • FROM_PROTOCOL - протокол ссылающейся страницы;
  • FROM_PROTOCOL_EXACT_MATCH - если значение равно "Y", то при фильтрации по FROM_PROTOCOL будет искаться точное совпадение;
  • FROM_DOMAIN - домен ссылающейся страницы;
  • FROM_DOMAIN_EXACT_MATCH - если значение равно "Y", то при фильтрации по FROM_DOMAIN будет искаться точное совпадение;
  • FROM_PAGE - ссылающаяся страница;
  • FROM_PAGE_EXACT_MATCH - если значение равно "Y", то при фильтрации по FROM_PAGE будет искаться точное совпадение;
  • FROM - протокол + домен + ссылающаяся страница;
  • FROM_EXACT_MATCH - если значение равно "Y", то при фильтрации по FROM будет искаться точное совпадение;
  • TO* - страница на которую пришли;
  • TO_EXACT_MATCH - если значение равно "Y", то при фильтрации по TO будет искаться точное совпадение;
  • TO_404 - была ли 404 ошибка на странице, на которую пришли, возможные значения:
    • Y - была;
    • N - не была.
  • SITE_ID - ID сайта на который пришли;
  • GROUP - группировка результирующего списка; возможные значения:
    • S - группировка по ссылающемуся домену (сайту);
    • U - группировка по ссылающейся странице.
* - допускается сложная логика
is_filteredФлаг отфильтрованности результирующего списка. Если значение равно "true", то список был отфильтрован.
totalСуммарные количество заходов с ссылающихся страниц.
group_byГруппировка результирующего списка. Возможные значения:
  • U - группировка по ссылающейся странице;
  • S - группировка по ссылающемуся домену.
maxКоличество заходов с самой популярной ссылающейся страницы.

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

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

  • при группировке по ссылающейся странице (filter["GROUP"]="U"):
    Array
    (
        [URL_FROM] => ссылающаяся страница
        [QUANTITY] => сколько раз зашли с данной ссылающейся страницы
        [PERCENT] => процент заходов с данной ссылающейся страницы,
                     относительно всех заходов со всех ссылающихся сайтов
        [AVERAGE_HITS] => среднее количество хитов, производимое
                          посетителями, заходящими с данной
                          ссылающейся страницы
    )
  • при группировке по ссылающемуся домену (filter["GROUP"]="S"):
    Array
    (
        [URL_FROM] => ссылающийся домен
        [QUANTITY] => сколько раз зашли с данного ссылающегося домена
        [PERCENT] => процент заходов с данного ссылающегося домена,
                     относительно всех заходов со всех ссылающихся сайтов
        [AVERAGE_HITS] => среднее количество хитов, производимое
                          посетителями, заходящими с данного
                          ссылающегося домена
    )
  • когда группировка не установлена:
    Array
    (
        [ID] => ID записи
        [URL_FROM] => ссылающаяся страница
        [DATE_HIT] => дата
        [SESSION_ID] => ID сессии
        [URL_TO] => страница, на которую пришли
        [URL_TO_404] => [Y|N] флаг 404 ошибки на странице на которую пришли
        [SITE_ID] => ID сайта на который пришли
    )
    
    

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

<?
// отфильтруем только заходы с доменов "google"
// сгруппировав по ссылающемуся домену
$arFilter = array(
    "FROM_DOMAIN"  => "google",
    "GROUP"        => "S"
    );

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

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


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

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

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

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

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