Документация для разработчиков
Темная тема
Недоступно в редакциях: Малый бизнес, Стандарт, Старт

Учебный курс (комплексный компонент)

Комплексный компонент осуществляет полноценный вывод учебного курса. Компонент стандартный и входит в дистрибутив модуля.


Описание learning.course

В визуальном редакторе компонент находится в Компоненты > Сервисы > Обучение.

Компонент относится к модулю Обучение.



Параметры

Поле Параметр Описание
Основные параметры
Идентификатор курса COURSE_ID Указывается идентификатор курса.
Управление адресами страниц
Включить поддержку ЧПУ SEF_MODE [Y|N] При отмеченной опции будет включена поддержка ЧПУ.

Если режим поддержки ЧПУ включен, то необходимо настроить следующие параметры:
Каталог ЧПУ (относительно корня сайта) SEF_FOLDER Каталог ЧПУ: путь до папки, с которой работает компонент. Этот путь может как совпадать с физическим путём, так и не совпадать.
Адреса страниц SEF_URL_TEMPLATES Указываются адреса следующих страниц:
  • course.detail - главная страница;
  • lesson.detail - страница урока;
  • chapter.detail - страница главы;
  • test.self - страница теста для самопроверки;
  • test - страница теста;
  • test.list - страница списка тестов;
  • course.contents - страница со всеми материалами курса;
  • gradebook - страница журнала.
SEF_FOLDER, SEF_URL_TEMPLATES.

Если режим поддержки ЧПУ выключен, то необходимо настроить параметр VARIABLE_ALIASES
Имена переменных VARIABLE_ALIASES Имена переменных для управления страницами.

При выключенном режиме ЧПУ необходимо указать имена следующих переменных:
  • COURSE_ID - идентификатор курса;
  • INDEX - идентификатор индексной страницы;
  • LESSON_ID - идентификатор урока;
  • CHAPTER_ID - идентификатор главы;
  • SELF_TEST_ID - идентификатор теста для самопроверки;
  • TEST_ID - идентификатор теста;
  • TYPE - идентификатор всех материалов курса;
  • TEST_LIST - идентификатор списка тестов;
  • GRADEBOOK - идентификатор журнала;
  • FOR_TEST_ID - идентификатор теста в журнале.
.
Настройки кеширования
Тип кеширования CACHE_TYPE Тип кеширования:
  • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
  • Y - Кешировать: для кеширования необходимо определить время кеширования;
  • N - Не кешировать: кеширования нет в любом случае.
Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
Дополнительные настройки
Проверять право доступа CHECK_PERMISSIONS [Y|N] При отмеченной опции будет проверяться право на доступ к курсу.
URL, ведущий на страницу с профилем пользователя PATH_TO_USER_PROFILE Указывается шаблон пути со страницей профиля пользователя.
Устанавливать заголовок страницы SET_TITLE [Y|N] При отмеченной опции в качестве заголовка страницы будет установлено название курса.
Настройки теста
Количество вопросов в навигационной цепочке PAGE_WINDOW Указывается количество вопросов, отображаемых в навигационной цепочке.
Показывать счетчик ограничения времени SHOW_TIME_LIMIT [Y|N] При отмеченной опции будет отображаться счетчик времени.
Примечание: если в настройках теста ограничение по времени не установлено, то счетчик не будет отображаться в любом случае.
Идентификатор вопроса PAGE_NUMBER_VARIABLE Задается имя переменной для идентификатора вопроса теста.
Настройки списка тестов
Количество тестов на странице TESTS_PER_PAGE Указывается количество тестов, выводимых на одной странице. Остальные тесты будут выведены с помощью постраничной навигации.


Пример вызова

<$APPLICATION->IncludeComponent("bitrix:learning.course","",Array(
		"SEF_MODE" => "Y", 
		"COURSE_ID" => "$_REQUEST[\"COURSE_ID\"]", 
		"CHECK_PERMISSIONS" => "Y", 
		"PAGE_WINDOW" => "10", 
		"SHOW_TIME_LIMIT" => "Y", 
		"PAGE_NUMBER_VARIABLE" => "PAGE", 
		"TESTS_PER_PAGE" => "20", 
		"SET_TITLE" => "Y", 
		"CACHE_TYPE" => "A", 
		"CACHE_TIME" => "3600", 
		"SEF_FOLDER" => "/", 
		"SEF_URL_TEMPLATES" => Array(
			"course.detail" => "course#COURSE_ID#/index",
			"lesson.detail" => "course#COURSE_ID#/lesson#LESSON_ID#/",
			"chapter.detail" => "course#COURSE_ID#/chapter#CHAPTER_ID#/",
			"test.self" => "course#COURSE_ID#/selftest#SELF_TEST_ID#/",
			"test" => "course#COURSE_ID#/test#TEST_ID#/",
			"test.list" => "course#COURSE_ID#/examination/",
			"course.contents" => "course#COURSE_ID#/contents/",
			"gradebook" => "course#COURSE_ID#/gradebook/"
		),
		"VARIABLE_ALIASES" => Array(
			"course.detail" => Array(),
			"lesson.detail" => Array(),
			"chapter.detail" => Array(),
			"test.self" => Array(),
			"test" => Array(),
			"test.list" => Array(),
			"course.contents" => Array(),
			"gradebook" => Array(),
		)
	)
);?>


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

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

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

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

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