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

GetList

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

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

Возвращает список поисковых систем и количество хитов (проиндексированных страниц) каждой из них за все время ведения статистики, за последние 3 дня, либо за указанный интервал времени.

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

ПараметрОписание
byПоле для сортировки. Возможные значения:
  • s_id - ID поисковой системы;
  • s_date_last - дата последнего хита;
  • s_today_hits - количество хитов за сегодня;
  • s_yesterday_hits - количество хитов за вчера;
  • s_b_yesterday_hits - количество хитов за позавчера;
  • s_total_hits - суммарное количество хитов;
  • s_period_hits - количество хитов за установленный период времени (filter["DATE1"], filter["DATE2"]);
  • s_name - название поисковой системы;
  • s_user_agent - UserAgent поисковой системы.
оrderПорядок сортировки. Возможные значения:
  • asc - по возрастанию;
  • desc - по убыванию.
filterМассив для фильтрации результирующего списка. В массиве допустимы следующие ключи:
  • ID* - ID поисковой системы;
  • ID_EXACT_MATCH - если значение равно "N", то при фильтрации по ID будет искаться вхождение
  • ACTIVE - флаг активности, возможные значения:
    • Y - активна;
    • N - не активна.
  • SAVE_STATISTIC - флаг "сохранять хиты поисковой системы", возможные значения:
    • Y - да;
    • N - нет.
  • DIAGRAM_DEFAULT - флаг "включать в круговую диаграмму и график по умолчанию", возможные значения:
    • Y - да;
    • N - нет.
  • HITS1 - начальное значение интервала для поля "количество хитов";
  • HITS2 - конечное значение интервала для поля "количество хитов";
  • DATE1_PERIOD - начальное значение значение для произвольного периода;
  • DATE2_PERIOD - конечное значение значение для произвольного периода;
  • DATE1 - начальное значение интервала для поля "дата последнего хита поисковой системы";
  • DATE2 - конечное значение интервала для поля "дата последнего хита поисковой системы";
  • NAME* - наименование поисковой системы;
  • NAME_EXACT_MATCH - если значение равно "Y", то при фильтрации по NAME будет искаться точное совпадение;
  • USER_AGENT* - UserAgent поисковой системы;
  • USER_AGENT_EXACT_MATCH - если значение равно "Y", то при фильтрации по USER_AGENT будет искаться точное совпадение.
* - допускается сложная логика
is_filteredФлаг отфильтрованности списка поисковых систем. Если значение равно "true", то список был отфильтрован.
limitМаксимальное количество поисковых систем которые будут выбраны в списке. Если значение равно false, то кол-во РК будет ограничено в соответствии со значением параметра "Максимальное кол-во показываемых записей в таблицах" из настроек модуля "Статистика".

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

Array
(
    [ID] => ID поисковой системы
    [NAME] => название
    [USER_AGENT] => UserAgent
    [DIAGRAM_DEFAULT] => [Y|N] флаг "включать в круговую диаграмму и график по умолчанию"
    [DATE_LAST] => дата последнего хита
    [TOTAL_HITS] => суммарное количество хитов
    [TODAY_HITS] => количество хитов за сегодня
    [YESTERDAY_HITS] => количество хитов за вчера
    [B_YESTERDAY_HITS] => количество хитов за позавчера
    [PERIOD_HITS] => количество хитов за установленный период времени (filter["DATE1_PERIOD"], filter["DATE2_PERIOD"])
)

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

<?
// отфильтруем данные только для поисковой системы #20 и #21
// а также получим дополнительные данные на декабрь 2005 года
$arFilter = array(
    "ID"           => "20 | 21",
    "DATE1_PERIOD" => "01.12.2005",
    "DATE2_PERIOD" => "31.12.2005",
    );

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

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


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

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

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

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

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