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

Список учащихся


Описание school.students.list

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

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



Параметры

Поле Параметр Описание
Дополнительно
Страница отправки личного сообщения PM_URL Указывается путь к странице отправки личного сообщения.
Дополнительные поля для вывода 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 Выбирается один из созданных в системе типов информационного блока.
ID инфоблока классов IBLOCK_ID Для выбранного типа инфоблока указывается идентификатор информационного блока.
Класс CLASS_ID Выбирается класс, учащиеся которого будут показаны.
Выводить только синхронизируемых с 1С пользователей FILTER_1C_USERS [Y|N] При отмеченной опции будут выводиться только синхронизируемые с 1С пользователи.
Фильтр по подразделениям FILTER_SECTION_CURONLY Указывается тип фильтра по подразделениям:
  • прямой (Y);
  • рекурсивный (N).
Отображение имени NAME_TEMPLATE Указывается шаблон для отображения ФИО пользователя социальной сети. По умолчанию - значение Формат сайта (т.е используются значение Формат имени, указанное в закладке Параметры страницы Редактирование сайта). Указав пункт другое->, можно задать свой шаблон. Допустимы шаблоны: #NAME# - имя, #LAST_NAME# - фамилия, #SECOND_NAME# - отчество, #NAME_SHORT#, #LAST_NAME_SHORT#, #SECOND_NAME_SHORT# - сокращенные до одной буквы имя, фамилия и отчество.
Выводить уведомление при пустом списке SHOW_ERROR_ON_NULL [Y|N] При отмеченной опции выводится уведомление при пустом списке.
Количество пользователей на страницу USERS_PER_PAGE Указывается выводимое число пользователей на одной странице.
Подпись постраничной навигации NAV_TITLE Поле содержит подпись для постраничной навигации.
Показывать постраничную навигацию над списком SHOW_NAV_TOP [Y|N] При отмеченной опции постраничная навигация будет показываться над списком.
Показывать постраничную навигацию под списком SHOW_NAV_BOTTOM [Y|N] При отмеченной опции постраничная навигация будет показываться под списком.
Показывать список при пустом фильтре SHOW_UNFILTERED_LIST [Y|N] При отмеченной опции будет выведен весь список сотрудников. Если опция не отмечена, то будет показана только форма поиска.
Дополнительные настройки
Устанавливать заголовок страницы SET_TITLE [Y|N] При отмеченной опции в качестве заголовка страницы будет установлено имя текущего раздела.
Параметры фильтра
Имя фильтра FILTER_NAME Указывается имя фильтра.
Настройки кеширования
Тип кеширования CACHE_TYPE Тип кеширования:
  • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
  • Y - Кешировать: для кеширования необходимо определить время кеширования;
  • N - Не кешировать: кеширования нет в любом случае.
Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.


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

<?$APPLICATION->IncludeComponent(
"school:school.students.list",
	"",
	Array(
		"PM_URL" => "/personal/messages/form/#USER_ID#/",
		"USER_PROPERTY" => array("ID"),
		"AJAX_MODE" => "Y",
		"IBLOCK_TYPE" => "schedule",
		"IBLOCK_ID" => "11",
		"CLASS_ID" => "269",
		"FILTER_NAME" => "users",
		"FILTER_1C_USERS" => "Y",
		"FILTER_SECTION_CURONLY" => "N",
		"NAME_TEMPLATE" => "#NOBR##LAST_NAME# #NAME##/NOBR#",
		"SHOW_ERROR_ON_NULL" => "Y",
		"USERS_PER_PAGE" => "10",
		"NAV_TITLE" => "Сотрудники",
		"SHOW_NAV_TOP" => "Y",
		"SHOW_NAV_BOTTOM" => "Y",
		"SHOW_UNFILTERED_LIST" => "Y",
		"CACHE_TYPE" => "A",
		"CACHE_TIME" => "3600",
		"SET_TITLE" => "Y",
		"AJAX_OPTION_JUMP" => "N",
		"AJAX_OPTION_STYLE" => "Y",
		"AJAX_OPTION_HISTORY" => "N"
	)
);?>


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

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

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

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

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