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

GetList

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

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

Возвращает список групп в соответствии с фильтром. Метод статический.

Параметры

Параметр Описание С версии
arOrder Порядок сортировки возвращаемого списка, заданный в виде массива. Ключами в массиве являются поля для сортировки, а значениями - ASC/DESC - порядок сортировки. Допустимые ключи: ID, SITE_ID, NAME, DATE_CREATE, DATE_UPDATE, DATE_ACTIVITY, ACTIVE, VISIBLE, OPENED, CLOSED, SUBJECT_ID, OWNER_ID, NUMBER_OF_MEMBERS, INITIATE_PERMS, SPAM_PERMS, SUBJECT_NAME, OWNER_NAME, OWNER_LAST_NAME, OWNER_LOGIN.
arFilter Массив, задающий фильтр на возвращаемый список. Ключами в массиве являются названия полей, а значениями - их значения. Допустимые поля:ID, SITE_ID, NAME, DATE_CREATE, DATE_UPDATE, DATE_ACTIVITY, ACTIVE, VISIBLE, OPENED, CLOSED, SUBJECT_ID, OWNER_ID, NUMBER_OF_MEMBERS, INITIATE_PERMS, SPAM_PERMS, SUBJECT_NAME, OWNER_NAME, OWNER_LAST_NAME, OWNER_LOGIN, CHECK_PERMISSIONS.
arGroupBy Массив, задающий группировку результирующего списка. Если параметр содержит массив названий полей, то по этим полям будет произведена группировка. Если параметр содержит пустой массив, то метод вернет количество записей, удовлетворяющих фильтру. По умолчанию параметр равен false - не группировать.
arNavStartParams Массив, задающий условия выбора для организации постраничной навигации.
arSelectFields Массив, задающий выбираемые поля. Содержит список полей, которые должны быть возвращены методом. Если массив пустой, то выбираются поля ID, SITE_ID, NAME, DESCRIPTION, DATE_CREATE, DATE_UPDATE, DATE_ACTIVITY, ACTIVE, VISIBLE, OPENED, CLOSED, SUBJECT_ID, OWNER_ID, KEYWORDS, IMAGE_ID, NUMBER_OF_MEMBERS, INITIATE_PERMS, SPAM_PERMS, SUBJECT_NAME. В массиве допустимы любые поля из списка полей.

Метод поддерживает использование пользовательских полей наравне с остальными полями в параметрах arOrder, arFilter и arSelectFields. При этом в arSelectFields возможно использование значения "UF_*" для выборки значений всех пользовательских полей рабочих групп.

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

Метод возвращает объект типа CDBResult, содержащий записи, удовлетворяющие условию выборки.

Список полей

ID - идентификатор рабочей группы,
SITE_ID - код сайта,
NAME - название группы,
DESCRIPTION - описание группы,
DATE_CREATE - дата создания,
DATE_UPDATE - дата последнего изменения параметров группы,
ACTIVE - активность,
VISIBLE - видима ли группа в списках,
OPENED - открыта ли группа для свободного вступления,
CLOSED - является ли группа архивной,
SUBJECT_ID - код темы группы,
OWNER_ID - код пользователя-владельца группы,
KEYWORDS - ключевые слова,
IMAGE_ID - код иконки,
NUMBER_OF_MEMBERS - количество членов группы,
INITIATE_PERMS - кто имеет право на прием в группу новых членов,
SPAM_PERMS - кто имеет право на написание сообщений членам группы,
DATE_ACTIVITY - дата последней активности в группе,
SUBJECT_NAME - название темы группы,
OWNER_NAME - имя владельца группы,
OWNER_LAST_NAME - фамилия владельца группы,
OWNER_LOGIN - логин владельца группы,
CHECK_PERMISSIONS - ID того пользователя, чьи права надо учесть при выводе групп. В частном случае это текущий пользователь. Без проверки прав выведутся вообще все группы.

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



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

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

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

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

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