Разработка:im/agroups

Плагин
Название	agroups
Тип	im

im/agroups - Группы

Модуль редактирования параметров академической группы, (или класса в средней школе). Работает в паре с модулем storage/agroups. Позволяет создавать и редактировать различные атрибуты группы - название, код и т.п.

Список групп

На этой странице можно просмотреть список всех групп учебного заведения либо групп, отобранных по определенным критериям или их комбинации. Критериями отбора могут быть: отдел учебного заведения, программа обучения, статус группы. Просмотр отобранных групп возможен лишь при наличии соответствующих полномочий.

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

Кроме того на этой странице присутствует форма поиска группы. Искать можно по названию или по коду группы. В первом случае в поле поиска можно ввести только часть имени.

С этой страницы можно перейти на страницу создания группы или редактирования ее параметров.

На страницу могут передаваться в качестве входных параметров id учебной программы, id подразделения, код статуса группы в любой комбинации. Или не передаваться ничего. Если значения в бд найдены, то выводится соответствующий список. Если какой-то параметр неправильного типа - он не учитывается при формировании списка групп. Если он правильного типа, но такого значения нет в таблице, то выводится сообщение

   (Не найдено ни одной группы с такими параметрами)

Например, такое сообщение будет выведено, если во входных параметрах будет передан id программы 999999999999, или статус группы "букадырур". Если же переданный id программы будет иметь значение "дывларыда", а статус равен 9999, то они будут исключены из критериев отбора групп.

Страница группы

На этой странице выводится одна строка таблицы списка групп. Отсюда можно перейти на страницу редактирования параметров группы или на страницу списка групп.

Создание/изменение параметров группы

На этой странице отображается форма, в которой можно определить параметры группы. Это название группы, код группы, программа обучения группы, отдел, к которому приписана группа. Поле "статус" менять нельзя, потому что он меняется автоматически при наступлении определенных событий. Поле "номер периода" можно задать только при создании группы. Его дальнейшие изменения происходят автоматически.

При заполнении полей следует учитывать набор символов, который можно использовать:

• название группы - цифры, русские и латинские буквы в любом регистре, тире.
• код группы - цифры, русские и латинские буквы в нижнем регистре, тире. Если вы введете буквы в верхнем регистре, то они будут автоматически преобразованы к нижнему.

Код группы должен быть уникален среди всех групп.

Страница создания и редактирования группы содержит обязательный параметр agroupid.

• Если он передан - то редактируется группа с переданным id
• Если он не передан (или передана строка), то будет создана новая группа с указанными параметрами
• Если передан номер не существующей в БД записи - то будет выведено сообщение об ошибке

API

show($obj)

Возвращает html-код отображения информации об учебной группе в виде таблицы.

• Входные параметры:
  • $obj - объект, запись из таблицы agoups
• Возвращаемые значения:
  • html-код таблицы или
  • false в случае ошибки.

show_id($id)

Возвращает html-код отображения информации об учебной группе в виде таблицы

• Входные параметры:
  • $id - id записи из таблицы agroups;
• Возвращаемые значения:
  • html-код таблицы или
  • false в случае ошибки

showlist($list)

Возвращает html-код отображения информации о нескольких группах в виде таблицы.

• Входные параметры:
  • $list - массив объектов. Каждый объект - это запись из таблицы agroups.
• Возвращаемые значения:
  • html-код таблицы или
  • false в случае ошибки.

form($id=NULL)

Возвращает html-код формы создания новой или редактирования существующей группы.

• Входные переменные:
  • $id - id записи из таблицы agroups (по умолчанию NULL). Значения этой записи будут использованы для заполнения полей формы значениями по умолчанию. Если $id = NULL, то поля формы остаются пустыми.
• Возвращаемые значения:
  • html-код или
  • false в случае ошибки.

get_listing($limitfrom, $limitnum, $conds)

Возвращает список учебных групп, выбранных по заданным критериям.

• Входные переменные:
  • $limitfrom - порядковый номер записи в общем списке записей, удовлетворяющих критериям выборки. Эта запись будет первой в возвращаемом списке.
  • $limitnum - количество записей, которые нужно вернуть.
  • $conds - объект - список параметров для выборки записей. Название свойства объекта - это название поля в таблице agroups.
• Выходные значения:
  • массив записей из таблицы agroups или
  • false в случае ошибки.

get_select_listing($inputconds)

Возвращает фрагмент sql-запроса после слова WHERE.

• Входные переменные:
  • $inputconds - объект. Содержит критерии выборки для формирования запроса. Свойство объекта - название поля в таблице agroups.
• Возвращаемые значения:
  • фрагмент строки запроса, который будет вставлен в запрос после слова WHERE.

Список карточек:

• Инициализация плагина
• Редактирование страницы просмотра одного класса
• Редактирование страницы просмотра списка
  • добавляется фильтрация по программе и подразделению
• Редактирование интерфейса формы
• Редактирование обработчика формы
• Вставка на страницу списка классов меню поиска