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

GetListEx

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

CDBResult
CForumSubscribe::GetListEx(
 array arOrder = array("ID"=>"ASC"),
 array arFilter = array()
);

Возвращает записи из таблицы подписки на сообщения форума удовлетворяющие фильтру arFilter и упорядоченные в соответствии с сортировкой arOrder. С каждой записью идет email пользователя, которому принадлежит эта запись (т.е. email подписчика). Метод статический.

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

Параметр Описание
arOrder

Порядок сортировки записей; представляет собой ассоциативный массив, в котором ключами являются названия параметров записей, а значениями - направления сортировки.

Допустимые параметры записи для сортировки:
   ID - код записи
   FORUM_ID - код форума, на сообщения которого осуществлена подписка
   USER_ID - код пользователя-подписчика
   TOPIC_ID - код темы, на сообщения которой осуществлена подписка
   START_DATE - дата начала подписки

arFilter

Фильтр на возвращаемые записи; представляет собой ассоциативный массив, в котором ключами являются названия параметров записи, а значениями - условия на эти параметры.

Допустимые параметры записи для фильтрации:
   ID - код подписки
   USER_ID - код пользователя-подписчика
   FORUM_ID - код форума, на сообщения которого осуществлена подписка
   TOPIC_ID - код темы, на сообщения которой осуществлена подписка
   TOPIC_ID_OR_NULL - код темы, на сообщения которой осуществлена подписка, включая пустые значения
   NEW_TOPIC_ONLY - флаг, определяющий подписку только на новые темы (допустимые значения Y/N)
   LAST_SEND - код последнего отправленного по данной подписке сообщения
   LAST_SEND_OR_NULL - код последнего отправленного по данной подписке сообщения, включая пустые значения
   PERMISSION - минимальное право на доступ к форуму, на сообщения которого осуществлена подписка

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

Возвращяется объект класса CDBResult, каждая запись которого представляет собой массив с ключами

Ключ Значение
ID Код подписки.
USER_ID Код пользователя-подписчика.
FORUM_ID Код форума, на сообщения которого осуществлена подписка.
TOPIC_ID Код темы, на сообщения которой осуществлена подписка.
LAST_SEND Код последнего отправленного по подписке сообщения.
NEW_TOPIC_ONLY Флаг, означающий подписку только на новые темы (значения Y/N)
SITE_ID Код сайта, на котором осуществлена подписка.
START_DATE Дата подписки.
EMAIL Email адрес пользователя-подписчика.

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

  • CDBResult
  • Поля подписки


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

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

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

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

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