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

GetList

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

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

Возвращает список хитов поисковых систем.

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

ПараметрОписание
byПоле для сортировки. Возможные значения:
оrderПорядок сортировки. Возможные значения:
  • asc - по возрастанию;
  • desc - по убыванию.
filterМассив для фильтрации результирующего списка. В массиве допустимы следующие ключи:
  • ID* - ID хита;
  • ID_EXACT_MATCH - если значение равно "N", то при фильтрации по ID будет искаться вхождение;
  • SEARCHER_ID* - ID поисковой системы;
  • SEARCHER_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по SEARCHER_ID будет искаться вхождение;
  • URL* - адрес проиндексированной страницы;
  • URL_404 - была ли 404 ошибка на проиндексированной странице:
    • Y - была;
    • N - не была.
  • SEARCHER* - название поисковой системы;
  • SEARCHER_EXACT_MATCH - если значение равно "Y", то при фильтрации по SEARCHER будет искаться точное совпадение;
  • DATE1 - начальное значение интервала для поля "дата хита";
  • DATE2 - конечное значение интервала для поля "дата хита";
  • IP* - IP адрес поисковой системы;
  • IP_EXACT_MATCH - если значение равно "Y", то при фильтрации по IP будет искаться точное совпадение;
  • USER_AGENT* - UserAgent поисковой системы;
  • USER_AGENT_EXACT_MATCH - если значение равно "Y", то при фильтрации по USER_AGENT будет искаться точное совпадение;
  • SITE_ID* - ID сайта;
  • SITE_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по SITE_ID будет искаться вхождение.
* - допускается сложная логика
is_filteredФлаг отфильтрованности результирующего списка. Если значение равно "true", то список был отфильтрован.

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

Array
(
    [ID] => ID хита
    [DATE_HIT] => дата хита
    [SEARCHER_ID] => ID поисковой системы
    [SEARCHER_NAME] => название поисковой системы
    [URL] => адрес проиндексированной страницы
    [URL_404] => [Y|N] флаг 404 ошибки на проиндексированной странице
    [IP] => IP адрес поисковой системы
    [USER_AGENT] => UserAgent поисковой системы
    [HIT_KEEP_DAYS] => индивидуально количество дней,
                       отводимое для хранения хитов поисковой системы
    [SITE_ID] => ID сайта
)

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

<?
// отфильтруем страницы проиндексированные 
// поисковой системой #20 и #21
$arFilter = array(
    "SEARCHER_ID" => "20 | 21"
    );

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

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


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

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

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

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

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