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

GetList

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

CDBResult
CLesson::GetList(
	array arOrder = Array("TIMESTAMP_X"=>"DESC"),
	array arFilter = Array()
);

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

Примечание: начиная с версии 12.0.0, метод считается устаревшим. Вместо него для работы с главами/уроками следует использовать метод CLearnLesson::GetList.

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

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

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

Необязательный. По умолчанию записи не фильтруются.

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

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

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

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

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

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

?>
<?

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

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

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

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

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

?>
<?

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

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

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

?>


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