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

Список учащихся (комплексный компонент)


Описание school.students

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

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



Параметры

Поле Параметр Описание
Дополнительно
Пользовательские поля для вывода USER_PROPERTY С помощью клавиши Ctrl выбираются поля для вывода.
Управление режимом AJAX
Включить режим AJAX AJAX_MODE [Y|N] При установленной опции для компонента будет включен режим AJAX.
Включить прокрутку к началу компонента AJAX_OPTION_JUMP [Y|N] Если пользователь совершит AJAX-переход, то при установленой опции по окончании загрузки произойдет прокрутка к началу компонента.
Включить подгрузку стилей AJAX_OPTION_STYLE [Y|N] Если параметр принимает значение "Y", то при совершении AJAX-переходов будет происходить подгрузка и обработка списка стилей, вызванных компонентом.
Включить эмуляцию навигации браузера AJAX_OPTION_HISTORY [Y|N] Когда пользователь выполняет AJAX-переходы, то при включенной опции можно использовать кнопки браузера "Назад" и "Вперед".
Основные параметры
Тип инфоблока классов IBLOCK_TYPE Выбирается один из созданных в системе типов информационного блока.
Код информационного блока IBLOCK_ID Для выбранного типа инфоблока указывается идентификатор информационного блока.
Идентификатор класса CLASS_ID Выбирается идентификатор класса, учащиеся которого будут показаны.
Дополнительные настройки
Устанавливать заголовок страницы SET_TITLE [Y|N] При отмеченной опции в качестве заголовка страницы будет установлено имя текущего раздела.
Устанавливать статус 404, если не найден класс SET_STATUS_404 [Y|N] Если система не находит в каталоге элемент или раздел, то при отмеченной опции вместо HTTP статуса 200 будет сообщаться HTTP статус 404.
Настройки кеширования
Тип кеширования CACHE_TYPE Тип кеширования:
  • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
  • Y - Кешировать: для кеширования необходимо определить время кеширования;
  • N - Не кешировать: кеширования нет в любом случае.
Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
Управление адресами страниц
Включить поддержку ЧПУ SEF_MODE [Y|N] При отмеченной опции будет включена поддержка ЧПУ.

Если режим поддержки ЧПУ включен, то необходимо настроить следующие параметры:
Каталог ЧПУ (относительно корня сайта) SEF_FOLDER Каталог ЧПУ: путь до папки, с которой работает компонент. Этот путь может как совпадать с физическим путём, так и не совпадать.
Адреса страниц SEF_URL_TEMPLATES Указываются адреса следующих страниц:
  • classes - страница списка классов;
  • students - страница списка учащихся в классе.
SEF_FOLDER, SEF_URL_TEMPLATES.
Имена переменных VARIABLE_ALIASES Имена переменных для управления страницами.


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

<?$APPLICATION->IncludeComponent(
"school:school.students",
	"",
	Array(
		"USER_PROPERTY" => array(),
		"SEF_MODE" => "Y",
		"AJAX_MODE" => "Y",
		"SET_TITLE" => "Y",
		"SET_STATUS_404" => "Y",
		"IBLOCK_TYPE" => "schedule",
		"IBLOCK_ID" => "11",
		"CLASS_ID" => "272",
		"CACHE_TYPE" => "A",
		"CACHE_TIME" => "36000000",
		"SEF_FOLDER" => "/school_life/sports/",
		"SEF_URL_TEMPLATES" => Array(
			"classes" => "777",
			"students" => "#CLASS_ID#/"
		),
		"AJAX_OPTION_JUMP" => "N",
		"AJAX_OPTION_STYLE" => "Y",
		"AJAX_OPTION_HISTORY" => "N",
		"VARIABLE_ALIASES" => Array(
			"students" => Array(),
			"classes" => Array(),
		)
	)
);?>


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