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

GetList

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

CDBResult
CForumNew::GetList(
	array arOrder = Array("ID"=>"ASC"),
	array arFilter = Array(),
	array arAddParams = Array()
);

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

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

ПараметрОписаниеС версии
arOrder Массив вида Array(by1=>order1[, by2=>order2 [, ..]]), где

by - поле для сортировки, может принимать значения
    ID - ID форума;
    LID - язык форума;
    NAME - название форума;
    ACTIVE - активность;
    MODERATION - модерируемость форума;
    FORUM_GROUP_ID - ID группы форума;
    TOPICS - количество тем в форуме;
    POSTS - количество сообщений в форуме;
    LAST_POST_DATE - дата последнего сообщения;
    SORT - индекс сортировки;

order - порядок сортировки, может принимать значения
    ASC - по возрастанию;
    DESC - по убыванию;

Необязательный. По умолчанию равен Array("SORT"=>"ASC")
arFilter массив вида array("фильтруемое поле"=>"значения фильтра" [, ...])
"фильтруемое поле" может принимать значения
    LID - язык форума;
    ACTIVE - активность форума;
    ID - ID форума;
    FORUM_GROUP_ID - ID группы форума;
    TOPICS - количество тем в форуме;
    POSTS - количество сообщений в форуме;
    TEXT - подстрока в названии или описании форума;
    PERMS - права на доступ к форуму (массив из двух элементов, первый из которых - это список кодов групп, в которые входит пользователь, а второй - это код права на доступ);

фильтруемое поле может иметь содержать перед названием тип проверки фильтра
"!" - не равно
"<" - меньше
"<=" - меньше либо равно
">" - больше
">=" - больше либо равно

Необязательное. По умолчанию записи не фильтруются.
arAddParams Массив параметров. Необязательное. По умолчанию записи не фильтруются. 12.0.0

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

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

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

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

<?
// выведем список форумов, к которым текущий посетитель 
// имеет доступ по крайней мере на чтение, 
// отсортируем список сначала по индексу сортировки, а потом 
// по названию форума
$arFilter = array();
if (!$USER->IsAdmin())
{
	$arFilter["PERMS"] = array($USER->GetGroups(), 'A');
	$arFilter["ACTIVE"] = "Y";
}
$arOrder = array("SORT"=>"ASC", "NAME"=>"ASC");
$db_Forum = CForumNew::GetList($arOrder, $arFilter);
while ($ar_Forum = $db_Forum->Fetch())
{
	echo $ar_Forum["NAME"]."<br>";
}
?>


© «Битрикс», 2001-2024, «1С-Битрикс», 2024