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

GetList

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

CDBResult
CFormStatus::GetList(
 int form_id,
 string &by = "s_sort",
 string &order = "asc",
 array filter = array(),
 bool &is_filtered
)

Возвращает список статусов в виде объекта класса CDBResult. Метод нестатический.

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

Параметр Описание
form_id ID веб-формы.
by Ссылка на переменную с полем для сортировки результирующего списка, может принимать значения:
  • s_id - ID статуса;
  • s_sort - индекс сортировки;
  • s_timestamp - время последнего изменения статуса;
  • s_active - флаг активности;
  • s_default - флаг установки по умолчанию;
  • s_title - заголовок;
  • s_description - описание;
  • s_results - количество результатов находящихся в данном статусе.
оrder Ссылка на переменную с порядком сортировки, может принимать значения:
  • asc - по возрастанию;
  • desc - по убыванию.
filter Массив для фильтрации. Необязательный параметр. В массиве допустимы следующие ключи:
  • ID* - ID статуса (по умолчанию будет искаться точное совпадение);
  • ID_EXACT_MATCH - если значение равно "N", при фильтрации по ID будет искаться вхождение;
  • ACTIVE - флаг активности, допустимые следующие значения:
  • TITLE* - заголовок статуса (по умолчанию будет искаться вхождение);
  • TITLE_EXACT_MATCH - если значение равно "Y", то при фильтрации по TITLE будет искаться точное совпадение;
  • DESCRIPTION* - описание статуса (по умолчанию будет искаться вхождение);
  • DESCRIPTION_EXACT_MATCH - если значение равно "Y", то при фильтрации по DESCRIPTION будет искаться точное совпадение.
* - допускается сложная логика
is_filtered Ссылка на переменную хранящую флаг отфильтрованности результирующего списка. Если значение равно "true", то список был отфильтрован.

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

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

<?
$FORM_ID = 4; // ID веб-формы

// сформируем массив фильтра
$arFilter = Array(
    "ID"                       => "1 | 4",       // ID статуса равен 1 или 4
    "ID_EXACT_MATCH"           => "Y",           // точное совпадение для ID
    "ACTIVE"                   => "Y",           // флаг активности
    "TITLE"                    => "опубликован", // заголовок
    "TITLE_EXACT_MATCH"        => "N",           // точное совпадение для TITLE
    "DESCRIPTION"              => "конечный",    // описание
    "DESCRIPTION_EXACT_MATCH"  => "N",           // точное совпадение для DESCRIPTION
);

// получим список всех статусов формы, соответствующих фильтру
$rsStatuses = CFormStatus::GetList(
    $FORM_ID, 
    $by="s_id", 
    $order="desc", 
    $arFilter, 
    $is_filtered
    );
while ($arStatus = $rsStatuses->Fetch())
{
    echo "<pre>"; print_r($arStatus); echo "</pre>";
}
?>


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

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

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

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

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