Документация для разработчиков
Документация для разработчиков Документация по D7 Документация по REST Пользовательская документация
Темная тема

GetList

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

CDBResult
CChapter::GetList(
	array arOrder = Array("TIMESTAMP_X"=>"DESC"),
	array arFilter = Array(),
	bool bIncCnt = false
);

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

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

ПараметрОписание
arOrder Массив для сортировки результата. Массив вида array("поле сортировки"=>"направление сортировки" [, ...]).
Поле для сортировки может принимать значения:
  • ID - идентификатор главы;
  • NAME - название главы;
  • ACTIVE - активность главы;
  • SORT - индекс сортировки;
  • TIMESTAMP_X - дата изменения главы.
Направление сортировки может принимать значения:
  • asc - по возрастанию;
  • desc - по убыванию;
Необязательный. По умолчанию сортируется по убыванию даты изменения главы.
arFilter Массив вида array("фильтруемое поле"=>"значение фильтра" [, ...]). Фильтруемое поле может принимать значения:
  • ID - идентификатор главы;
  • NAME - название главы (можно искать по шаблону [%_]);
  • SORT - индекс сортировки;
  • CODE - символьное имя главы (можно искать по шаблону [%_]);
  • ACTIVE - фильтр по активности (Y|N);
  • TIMESTAMP_X - дата изменения главы;
  • CHAPTER_ID - идентификатор главы. Для получения списка родительских глав установите это поле в значение пусто;
  • COURSE_ID - идентификатор курса;
  • DETAIL_TEXT - детальное описание (можно искать по шаблону [%_]);
  • PREVIEW_TEXT - предварительное описание (можно искать по шаблону [%_]);
  • MIN_PERMISSION - минимальный уровень доcтупа. По умолчанию "R". Список прав доступа см. в CCourse::SetPermission.
  • CHECK_PERMISSIONS - проверять уровень доступа. Если установлено значение "N" - права доступа не проверяются;
  • CNT_ACTIVE - считать количество только активных уроков. Работает, если bIncCnt установлено в значение true.
Перед названием фильтруемого поля может быть указан тип фильтрации:
  • "!" - не равно
  • "<" - меньше
  • "<=" - меньше либо равно
  • ">" - больше
  • ">=" - больше либо равно

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

Необязательный. По умолчанию записи не фильтруются.
bIncCnt Возвращать ли количество уроков главы в поле ELEMENT_CNT. Не обязательный параметр, по умолчанию равен false.

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

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

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

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

<?
if (CModule::IncludeModule("learning"))
{
	$COURSE_ID = 97;
	$res = CChapter::GetList(
		Array("SORT"=>"ASC"), 
		Array("ACTIVE" => "Y", "COURSE_ID" => $COURSE_ID, "CNT_ACTIVE" => "Y"),
		true
	);

	while ($arChapter = $res->GetNext())
	{
		echo "Chapter name: ".$arChapter["NAME"]."<br>";
		echo "Active lessons: ".$arChapter["ELEMENT_CNT"]."<br><br>";
	}
}

?>
<?

if (CModule::IncludeModule("learning"))
{
	$res = CChapter::GetList(
		Array("SORT"=>"ASC"), 
		Array("?NAME" => "Site")
	);

	while ($arChapter = $res->GetNext())
	{
		echo "Chapter name: ".$arChapter["NAME"]."<br>";
	}
}
?>
<?

if (CModule::IncludeModule("learning"))
{
	$COURSE_ID = 97;

	$res = CChapter::GetList(
		Array("NAME" => "ASC", "SORT"=>"ASC"), 
		Array("COURSE_ID" => $COURSE_ID)
	);

	while ($arChapter = $res->GetNext())
	{
		echo "Chapter name: ".$arChapter["NAME"]."<br>";
	}
}

?>
<?

if (CModule::IncludeModule("learning"))
{
	$COURSE_ID = 97;

	$res = CChapter::GetList(
		Array("TIMESTAMP_X" => "ASC", "SORT"=>"ASC"), 
		Array("CHECK_PERMISSIONS" => "N", "CHAPTER_ID" => "", "COURSE_ID" => $COURSE_ID)
	);

	while ($arChapter = $res->GetNext())
	{
		echo "Chapter name: ".$arChapter["NAME"]."<br>";
	}
}

?>


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