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

GetList

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

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

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

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

ПараметрОписание
arOrder Массив для сортировки результата. Массив вида array("поле сортировки"=>"направление сортировки" [, ...])  
Поле для сортировки может принимать значения:
  • ID - идентификатор записи;
  • BLOG_ID - идентификатор блога;
  • USER_ID - идентификатор пользователя;
  • BLOG_USER_ID - идентификатор пользователя блога;
  • BLOG_USER_ALIAS - псевдоним пользователя блога;
  • USER_LOGIN - логин пользователя;
  • USER_NAME - имя пользователя;
  • USER_LAST_NAME - фамилия пользователя;
  • USER_EMAIL - Email пользователя.
Необязательный. По умолчанию фильтруется по убыванию идентификатора записи.
arFilter Массив вида array("фильтруемое поле"=>"значение фильтра" [, ...])
Фильтруемое поле может принимать значения:
  • ID - идентификатор записи;
  • BLOG_ID - идентификатор блога;
  • USER_ID - идентификатор пользователя;
  • BLOG_USER_ID - идентификатор пользователя блога;
  • BLOG_USER_ALIAS - псевдоним пользователя блога;
  • USER_LOGIN - логин пользователя;
  • USER_NAME - имя пользователя;
  • USER_LAST_NAME - фамилия пользователя;
  • USER_EMAIL - Email пользователя.
Перед названием фильтруемого поля может указать тип фильтрации:
  • "!" - не равно
  • "<" - меньше
  • "<=" - меньше либо равно
  • ">" - больше
  • ">=" - больше либо равно
"значения фильтра" - одиночное значение или массив.

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

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

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

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

Смотрите также

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

<?
// выберем список желающих вступить в друзья блога
//c идентификатором 1
$dbUsers = CBlogCandidate::GetList(
    array("USER_LAST_NAME" => "ASC", "USER_NAME" => "ASC"),
    array("BLOG_ID" => 1),
    false,
    false,
    array("ID", "USER_ID", "BLOG_USER_ALIAS", "USER_LOGIN", "USER_NAME", "USER_LAST_NAME")
);
while ($arUsers = $dbUsers->Fetch())
{
    print_r($arUsers);
}
?>


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