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

GetList

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

CDBResult CBlogComment::GetList(
 array arOrder = Array("ID"=>"DESC"),
 array arFilter = Array(),
 bool  arGroupBy = false,
 bool  arNavStartParams = false,
 array arSelectFields = Array()
);

Возвращает список комментариев по фильтру arFilter, отсортированный в порядке arOrder. Метод нестатический.

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

ПараметрОписание
arOrder Массив для сортировки результата. Массив вида array("поле сортировки"=>"направление сортировки" [, ...]) Поле для сортировки может принимать значения:
  • ID - идентификатор комментария;
  • POST_ID - идентификатор сообщения;
  • BLOG_ID - идентификатор блога;
  • AUTHOR_ID - идентификатор автора комментария;
  • TITLE - заголовок комментария;
  • POST_TEXT - текст комментария;
  • DATE_CREATE - дата создания комментария;
  • PARENT_ID - идентификатор родителя комментария;
  • AUTHOR_NAME - имя автора анонимного комментария;
  • AUTHOR_EMAIL - Email автора анонимного комментария;
  • AUTHOR_IP - IP-адрес автора комментария;
  • AUTHOR_IP1 - IP-адрес автора комментария;
  • USER_LOGIN - логин автора неанонимного комментария;
  • USER_NAME - имя автора неанонимного комментария;
  • USER_LAST_NAME - фамилия автора неанонимного комментария;
  • USER_EMAIL - Email автора неанонимного комментария.
Необязательный. По умолчанию фильтруется по убыванию идентификатора комментария.
arFilter Массив вида array("фильтруемое поле"=>"значение фильтра" [, ...]). Фильтруемое поле может принимать значения:
  • ID - идентификатор комментария;
  • POST_ID - идентификатор сообщения;
  • BLOG_ID - идентификатор блога;
  • AUTHOR_ID - идентификатор автора комментария;
  • TITLE - заголовок комментария;
  • POST_TEXT - текст комментария;
  • DATE_CREATE - дата создания комментария;
  • PARENT_ID - идентификатор родителя комментария;
  • AUTHOR_NAME - имя автора анонимного комментария;
  • AUTHOR_EMAIL - Email автора анонимного комментария;
  • AUTHOR_IP - IP-адрес автора комментария;
  • AUTHOR_IP1 - IP-адрес автора комментария;
  • USER_LOGIN - логин автора неанонимного комментария;
  • USER_NAME - имя автора неанонимного комментария;
  • USER_LAST_NAME - фамилия автора неанонимного комментария;
  • USER_EMAIL - Email автора неанонимного комментария.
  • PUBLISH_STATUS - статус публикации сообщения;
Перед названием фильтруемого поля может указать тип фильтрации:
  • "!" - не равно
  • "<" - меньше
  • "<=" - меньше либо равно
  • ">" - больше
  • ">=" - больше либо равно

"значения фильтра" - одиночное значение или массив.

Необязательный. По умолчанию записи не фильтруются.
arGroupBy Массив полей, по которым группируются записи. Массив имеет вид:
array("название_поля1",
      "группирующая_функция2" => "название_поля2", ...)
В качестве "название_поляN" может стоять любое поле. В качестве группирующей функции могут стоять:
  • COUNT - подсчет количества;
  • AVG - вычисление среднего значения;
  • MIN - вычисление минимального значения;
  • MAX - вычисление максимального значения;
  • SUM - вычисление суммы.
Если массив пустой, то метод вернет число записей, удовлетворяющих фильтру.
Необязательный. По умолчанию - false - означает, что результат группироваться не будет.
arNavStartParams Массив параметров выборки. Может содержать следующие ключи:
  • "nTopCount" - количество возвращаемых методом записей будет ограничено сверху значением этого ключа
  • любой ключ, принимаемый методом CDBResult::NavQuery в качестве третьего параметра.
Необязательный. По умолчанию - false - означает, что параметров выборки нет.
arSelectFields Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение "*", то будут возвращены все доступные поля.

Необязательный. По умолчанию - пустой массив array() - означает, что будут возвращены все поля основной таблицы запроса.

Возвращаемое значение

Возвращается объект CDBResult.

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

<?
// выберем все комментарии к сообщению с идентификатором 1
$arOrder = Array(
        "ID" => "ASC",
        "DATE_CREATE" => "ASC"
    );
$arFilter = Array(
        "POST_ID"=>'1'
    );
$arSelectedFields = Array("ID", "BLOG_ID", "POST_ID", "PARENT_ID", "AUTHOR_ID", "AUTHOR_NAME", "AUTHOR_EMAIL", "AUTHOR_IP", "AUTHOR_IP1", "TITLE", "POST_TEXT", "DATE_CREATE");

$dbComment = CBlogComment::GetList($arOrder, $arFilter, false, false, $arSelectedFields);
while ($arComment = $dbComment->Fetch())
{
    print_r($arComment);
}
?>


© «Битрикс», 2001-2021, «1С-Битрикс», 2021
Наверх