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

GetList

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

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

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

Параметры функции

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

ПараметрОписание
arOrder Массив для сортировки результата. Массив вида array("поле сортировки"=>"направление сортировки" [, ...]) Поле для сортировки может принимать значения:
  • ID - идентификатор изображения;
  • FILE_ID - идентификатор файла;
  • BLOG_ID - идентификатор блога;
  • POST_ID - идентификатор сообщения блога;
  • USER_ID - идентификатор пользователя;
  • TIMESTAMP_X - время создания сообщения;
  • TITLE - заголовок изображения;
  • IMAGE_SIZE - размер изображения в байтах;
  • IS_COMMENT - флаг, прикреплено ли изображение к комментарию;
  • COMMENT_ID - идентификатор комментария, к которому прикреплено изображение.
Необязательный параметр. По умолчанию фильтруется по убыванию идентификатора изображения.
arFilter Массив вида array("фильтруемое поле"=>"значение фильтра" [, ...]). Фильтруемое поле может принимать значения:
  • ID - идентификатор изображения;
  • FILE_ID - идентификатор файла;
  • BLOG_ID - идентификатор блога;
  • POST_ID - идентификатор сообщения блога;
  • USER_ID - идентификатор пользователя;
  • TIMESTAMP_X - время создания сообщения;
  • TITLE - заголовок изображения;
  • IMAGE_SIZE - размер изображения в байтах;
  • IS_COMMENT - флаг, прикреплено ли изображение к комментарию;
  • COMMENT_ID - идентификатор комментария, к которому прикреплено изображение.
Перед названием фильтруемого поля может указать тип фильтрации:
  • "!" - не равно
  • "<" - меньше
  • "<=" - меньше либо равно
  • ">" - больше
  • ">=" - больше либо равно

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

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

Необязательный. По умолчанию - false - означает, что результат группироваться не будет.
arNavStartParams Массив параметров выборки. Может содержать следующие ключи:
  • "nTopCount" - количество возвращаемых методом записей будет ограничено сверху значением этого ключа
  • любой ключ, принимаемый методом CDBResult::NavQuery в качестве третьего параметра.
Необязательный. По умолчанию - false - означает, что параметров выборки нет.
arSelectFields Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение "*", то будут возвращены все доступные поля.

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

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

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

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

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

Для изображений, прикреплённых к комментариям в сообщение с идентификатором 2, вывод идентификатора изображений и идентификатора файла:

$res = CBlogImage::GetList(
	$arOrder = Array("POST_ID" => "DESC"), 
	$arFilter = Array("POST_ID" => "2", "IS_COMMENT" => "Y"), 
	$arGroupBy = false, 
	$arNavStartParams = false, 
	$arSelectFields = array("ID", "FILE_ID",)
);

while($image = $res->Fetch())
	print_r($image);


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

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

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

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

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