DOF - Вклад участника [ru]

Разработка:storages/schpresences

2018-09-13T09:53:41Z

Agadzhanyan: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = schpresences
| type = storages
}}

===Таблица в базе данных===
''schpresences'' - содержит сведения о присутствии или отсутствии учащихся на учебном событии.

====Подробный формат полей в таблице:====
* eventid - событие
* personid - ученик в таблице [[Разработка:storages/persons | persons ]]
* present - присутствие: 0/1
* orderid - id приказа в таблице [[Разработка:storages/orders | orders ]], в соответствии в котором был выставлен статус присутсвия
* mdlevent - Id события в moodle
* reasonid - ID причины отсутствия

===Дополнительные методы:===
===='''save_present_student($obj)'''====

Сохраняет статус присутствия/отсутствия ученика на занятии.

''Аргументы:''
* $obj(object) - запись в таблицу БД.
''Возвращаемые значения:''
* (int) id вставленной записи, если запись вставляется.
* (bool) true, если запись обновляется.
* (bool) false, если операции не удались.
''Структура работы:''
#находим запись в таблице БД по данным из обьекта:
#* если запись была найдена, мы ее обновляем и возвращаем результат.
#* если не найдена - запысываем в таблицу БД и возвращаем результат.

===='''save_present_students($obj)'''====

Сохраняет список статусов присутствия/отсутствия учеников на занятии.

''Аргументы:''
* $obj(object) - запись в таблицу БД (объект, в котором первое свойство(eventid) является id события, а второе(presents) - массив записей, где ключ - id персоны, значение - статус присутствия).
''Возвращаемые значения:''
* (bool) true, если все записи успешно обновились/вставились.
* (bool) false во всех остальных случаях.
''Структура работы:''
# обновляем/вставляем все записи в БД
#* перебираем исходный массив из данных объекта.
#* формируем объект для обновления/вставки в БД.
#* обновляем/вставляем объект в таблицу БД.
# возвращаем результат.

===='''get_present_status($stid, $evid)'''====

Получает статус присутствия ученика на занятии.

''Аргументы:''
* $stid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $evid(int) - id события.
''Возвращаемые значения:''
* (int) статус присутствия, если собитие существует.
* (bool) false если события нет.
''Структура работы:''

# находим запись в таблице БД.
#* если запись найдена, возвращаем статус присутствия.
#* если не найдена, возвращаем false.

===='''get_present_students($evid)'''====

Получает статусы присутствия учеников на занятии.

''Аргументы:''
* $evid(int) - id события
''Возвращаемые значения:''
* (array) массив, где ключ - id персоны, значение - статус присутствия
''Структура работы:''
# находим все записи связанные с данным собитием в таблице БД.
# формируем массив id ученика=>статус присутствия по каждому из событий.
# возвращаем результат.

===Планы:===
====Дополнительные методы:====
* Получить статистику посещения учеником занятий по id учебного процесса и id ученика: количество прошедших занятий, количество посещенных занятий, доля посещенных занятий (от 0 до 1), если установлен флаг - массив с посещаемостью всех прошедших занятий id_события => статус посещения.
* Получить статистику посещения учениками занятий по id учебного процесса (общие показатели по группе), если установлен флаг - массив с посещаемостью всех прошедших занятий id_события => =>id_студента =>статус посещения.

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|schpresences
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу schpresences.
|-
|storage
|schpresences
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице schpresences.
|-
|storage
|schpresences
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы schpresences.
|}

Разработка:storages/cpgrades

2018-09-13T09:51:11Z

Agadzhanyan: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = cpgrades
| type = storages
}}
===Таблица в базе данных===
''cpgrades'' - оценки по контрольным точкам внутри дисциплины. Контрольные точки могут быть как локальными (внутри учебной дисциплины), так и глобальными - на все учебное заведение (четверти в школе или промежуточные аттестации).

====Подробный формат полей в таблице:====
* cpassedid - подписка на дисциплину в таблице [[Разработка:storages/cpassed | cpassed ]] (связь с personid студента осуществляется через id подписки)
* planid - контрольная точка или тема в плане (таблица [[Разработка:storages/plans | plans ]]), за которую получена оценка
* grade - полученная оценка
* date - дата получения оценки
* notice - комментарий преподавателя к отметке (виден студенту и родителям)
* typesync - тип синхронизации (выставление вручную, синхронизация с moodle)
* mdlinstance - id задания в moodle, с которым выполнялась синхронизация
* orderid - id приказа в таблице [[Разработка:storages/orders | orders ]], в соответствии с которым была выставлена эта оценка
* teacherid - id сотрудника по справочнику [[Разработка:storages/persons | persons ]], вручную (если не синхронизация) выставившего отметку
* status - статус оценки (черновик (tmp), поставлена (put), удалена (delete) )
* estimatedin - источник, выставивший оценку в последний раз

====Комментарии====
* История оценок выставляется в эту же таблицу, старые оценки не удаляются, актуальной считается одна, самая последняя по дате

===Дополнительные методы:===

===='''save_grade_student($obj)'''====

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

''Аргументы:''
* $obj(object) - запись в таблицу БД.
''Возвращаемые значения:''
* (int) id вставленной записи, если запись вставляется.
* (bool) - true, если запись обновляется и false, если операции не удались.
''Структура работы:''
# находим запись в таблице БД по данным из обьекта:
#* если запись была найдена и ее статус при этом является черновым, мы ее обновляем и возвращаем результат.
#* если не найдена или статус не черновой - запысываем в таблицу БД и возвращаем результат.

===='''save_grade_students($obj)'''====

Cохраняет отметки всех студентов.

''Аргументы:''
* $obj(object) - запись в таблицу БД (объект, в котором имеются свойства date(дата), planid(id плана), teacherid(id учителя) и grades - массив записей, где ключ - id персоны, значения - оценка, подписка на учибный процесс и статус оценки).
''Возвращаемые значения:''
* (bool) true, если все записи успешно обновильсь/вставились, и false, во всех остальных случаях.
''Структура работы:''
# обновляем/вставляем все записи в БД.
#* перебираем исходный массив из данных объекта.
#* формируем объект для обновления/вставки в БД.
#* обновляем/вставляем объект в таблицу БД.
# возвращаем результат.

===='''get_grade_student_cpassed($cpid, $plid)'''====

Получает последнюю по дате оценку студента по id-подписки и id контрольной точки

''Аргументы:''
* $cpid(int) - id подписки в таблице [[Разработка:storages/cpassed | cpassed ]].
* $plid(int) - id контрольной точки в таблице [[Разработка:storages/plans | plans ]].
''Возвращаемые значения:''
* (object) запись из таблицы БД - последняя по дате оценка студента.
* (bool) - false, если ни одной оценки не найдено.
''Структура работы:''
# находим все оценки студента отсортированных по дате в порядке убывания.
# возвращаем первую стоящюю в списке оценку.

===='''get_grade_student($stid, $csid, $plid)'''====

Получает последнюю по дате оценку студента по id студента, id учебного потока и id контрольной точки.

''Аргументы:''
* $stid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $cpid(int) - id учебного потока в таблице [[Разработка:storages/cstreams | cstreams ]].
* $plid(int) - id контрольной точки в таблице [[Разработка:storages/plans | plans ]].
''Возвращаемые значения:''
* (object) запись из таблицы БД - последняя по дате оценка студента.
* (bool) - false, если ни одной оценки не найдено.
''Структура работы:''
# по id учебного потока и id студента находим подписку студента на учебный поток.
# по id подписка и id контрольной точки находим последнюю по дате оценку студента.
# возвращаем результат.

===='''get_all_grade_student($cpid)'''====

Получает все оценки одного студента по подписке на дисциплину вместе с информацией из плана.

''Аргументы:''
* $cpid(int) - id подписки на дисциплину в таблице [[Разработка:storages/cpassed | cpassed ]].
''Возвращаемые значения:''
* (array) - список оценок вместе c планом.
* (bool) - false, если ни одной оценки не найдено.
''Структура работы:''
# находим все оценки студента по подписке.
# создаем массив оценок вместе с информацией из плана.
#* создаем новый объек со свойствами:
#** grade - оценка студента
#** plan - контрольная точка (информация из учебного плана, таблица [[Разработка:storages/plans | plans ]])
#* записываем объект в массив
# возвращаем созданный массив

===Планы:===
====Дополнительные методы:====
* Получить историю изменения оценок по id подписки и id контрольной точки
===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|cpgrades
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу cpgrades.
|-
|storage
|cpgrades
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице cpgrades.
|-
|storage
|cpgrades
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы cpgrades.
|}

Разработка:storages/plans

2018-09-13T09:49:56Z

Agadzhanyan: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = plans
| type = storages
}}

===Таблица в базе данных===
''plans'' - темы в учебном плане и контрольные точки внутри учебной дисциплины/предмета, предусмотренные учебным планом курса.

====Подробный формат полей в таблице:====
* linkid - связь с учебным периодом, учебной программой, дисциплиной или учебным процессом
* linktype - тип связи ([[Разработка:storages/ages | ages ]], [[Разработка:storages/programmitems | programmitems ]], [[Разработка:storages/cstreams | cstreams ]], plan). Тип связи "plan" - означает что эта контрольная точка относится к индивидуальному тематическому планированию ученика. linkid в этом случае указывает на таблицу cstreams.
* parentid - id родительской контрольной точки, если она наследовалась от стандартной темы в плане (модификация или дубль), либо id основной контрольной точки, если оценка является "дополнительной" (статус "дополнительная" - при этом тема не отображается в плане отдельной строкой, а только в подробной информации про основную тему, если основная тема наследуется, то и все дополнительные наследуются), по умолчанию - 0
* name - название контрольной точки или темы занятия
* date - абсолютная дата контрольной точки или 0.
* reldate - относительная дата сдачи в секундах от начала учебного процесса, периода.
* reldldate - относительная дата последнего срока сдачи в секундах от начала учебного процесса, периода. Может совпадать с reldate.
* scale - диапазон или перечисленные через запятую возможные оценки, пустая строка если оценка не предусмотрена
* mingrade - минимальная оценка, при которой занятие считается успешно-завершенным
* type - тип события (очный урок/лекция(facetime), дистанционный урок/лекция(distance), семинар(seminar), лабораторная работа(laboratorywork), практическая работа(practicework), контрольная работа(testwork), промежуточная аттестация(intermediate))
* typesync - тип синхронизации (выставление вручную, синхронизация с moodle)
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/plans | plans ]]
* homework - домашнее задание
* homeworkhours - количество часов, отведенных на домашнее задание
* directmap - непосредственное отображение в журнале
* number - номер
* datetheme - дата темы
* plansectionsid - id из таблицы тематических разделов [[Разработка:storages/plansections | plansections ]]
* note - примечание
* estimated - является ли элемент оцениваемым
* gradessynctype - Тип синхронизации оценки (0 - Выключена/1 - Вручную/2 - Автоматически)
* gradespriority - Приоритет оценок (dof/moodle)"
* gradesoverride - Перезаписывать оценки в Moodle (0/1)

===Дополнительные методы:===

===='''get_checkpoints($id, $type, $status = 'active')'''====

Получает список контрольных точек напрямую связанных с одним объектом привязки. Сортируются по относительной дате. Данный метод возвращает только контрольные точки, напрямую привязанные к объекту, его не следует использовать для отображения полного учебно-тематического плана!

''Аргументы:''
* (int) $id - id элемента, к которому привязана контрольная точка.
* (str) $type - тип элемента, к которому привязана контрольная точка. ([[Разработка:storages/ages | ages ]], [[Разработка:storages/programmitems | programmitems ]], [[Разработка:storages/cstreams | cstreams ]]).
* (str) $status - статус контрольной точки, по умолчанию - действующая(active).
''Возвращаемые значения:''
* (array) массив объектов из таблицы.
* (bool) false если контрольные точки не найдены.
''Структура работы:''
* формируем SQL-запрос и возвращаем список КТ:
** если указывается статус - КТ с указанным статусом,
** если статус указывается null - КТ с любим статусом,
** если статус не указывается - КТ со статусом active.

===='''get_list_no_status($status = 'active')'''====

Получает список контрольных точек, со всеми статусами, кроме указанного

''Аргументы:''
* (str) $status - статус уоторый надо исключить, по умолчанию active
''Возвращаемые значения:''
* array|bool - массив записей из таблицы [[Разработка:storages/plans | plans ]] или false если ничего не найдено

===='''sort_checkpoints_and_events($id, $planstatuses=null, $eventstatuses=null)'''====

Получает список объединенных контрольных точек и событий отсортированных по дате события или контрольной точки.

''Аргументы:''
* (int) $id - id учебного процесса в таблице [[Разработка:storages/cstreams | cstreams ]]
* array $planstatuses - список статусов с которыми получаются контрольные точки из таблицы [[Разработка:storages/plans | plans ]], по умолчанию - с любым статусом(null)
* array $eventstatuses - список статусов с которыми нужно получить события из таблицы [[Разработка:storages/schevents | schevents ]], по умолчанию - с любым статусом(null)
''Возвращаемые значения:''
* array массив объектов - контрольных точек из таблицы [[Разработка:storages/plans | plans ]]. Если для КТ есть событие - то оно записывается в поле "event"
''Структура работы:''
# находим необходимые контрольные точки.
# получаем масив состыкованных КТ и событий.
# формируем новый массив состыкованных КТ и событий, в котором индексы заменены на метки времени.
#* получаем метку времени при помощи get_date().
#* если метку времени не получили, переходим к следующему элементу,
#* если метка времени не уникальна, делаем ее уникальной.
#* записываем получившуюся метку времени, как ключ массива.
# соритуем массив по ключам в порядке возрастания.
# возвращаем результат.

===='''get_date($pe)'''====

Получает метку времени КT или соответствующего события.

''Аргументы:''
* (object) $pe - объект контрольной точки
''Возвращаемые значения:''
* string - дата начало события,
* string - если нет даты события, дата начала КТ,
* string - если нет даты начала КТ, дата начала учебного потока + смещение.
* bool - false, если возникли ошибки

===='''get_checkpoints_for_cstreams($csid, $statuses=null)'''====

Получает список контрольных точек актуальных для данного учебного процесса (включая контрольные точки дисциплины и периода, с которыми связан данный учебный процесс). Сортируются по абсолютной дате, которая вычисляется как дата старта учебного процесса + относительная дата точек, привязанных к учебному процессу или точек, привязанных к дисциплине, или как дата начала учебного периода + относительная дата точек, привязанных к учебному периоду.

''Аргументы:''
* (int) $csid - id учебного процесса в таблице [[Разработка:storages/cstreams | cstreams ]].
* (str) $statuses - статусы контрольных точек в таблице [[Разработка:storages/plans | plans ]]
''Возвращаемые значения:''
* array - массив объектов из таблицы.
* bool - false если контрольные точки не найдены.
''Структура работы:''
* формируем SQL-запрос:
** по данному id находим учебный процесс.
** формируем условие выборки.
** по id периода из учебного находим учебный период.
*** если период существует, добавляем его в условие выборки и формируем дополнительную колонку содержащюю абсолютную дату для каждой КТ,
*** если периода нет, формируем дополнительную колонку без учета периода.
* возвращаем список КТ по SQL-запросу.

===='''get_numberof_points($select)'''====

Возвращает количество КТ, удовлетворяющих указанным критериям.

''Аргументы:''
* (str) $select - критерии отбора записей
''Возвращаемые значения:''
* int - количество найденных записей

===='''cancel_checkpoint($id, $all = false)'''====

Отменяет контрольную точку с событием.

''Аргументы:''
* (int) $id - id контрольной точки
* (bool) $all - удалять ли все события: true - да, false - нет, по умолчанию false
''Возвращаемые значения:''
* bool true - КТ отменено, false - возникли ошибки

===='''get_grades_scale($scale)'''====

Разбивает шкалу оценок на массив оценок.

''Аргументы:''
* (string) $scale - шкала оценок
''Возвращаемые значения:''
* array - массив оценок

===='''get_theme_plan($linktype, $linkid, $statuses=null, $viewplan = false)'''====

Возвращает список тематических разделов.

''Аргументы:''
* (string)$linktype - тип связи (plans, cstreams, programmitems, ages)
* (int)$linkid - id связи
* (string)$statuses - список статусов (по умолчанию null)
* (string) $viewplan - (по умолчанию false)
''Возвращаемые значения:''
* array|false - список тематических разделов или false

===='''succession_pitem_plan($cstream)'''====

Наследует учебный темплан из планирования по предмету.

''Аргументы:''
* (object)|(int) $cstream - объект учебного потока или id из таблицы cstreams
''Возвращаемые значения:''
* bool

===='''widgets_save_field($querytype, $objectid, $data)'''====

Сохрание данных одного поля при ajax-редактировании.

''Аргументы:''
* (string) $querytype - уникальное имя запроса сохранения внутри плагина. Как правило имя
сохраняемого поля
* (int) $objectid - id объекта, данные которого редактируются
* (object) $data - данные для сохранения (обычно - новое значение поля)
''Возвращаемые значения:''
* string - новое значение элемента или строка с html-кодом ошибки

===='''widgets_field_variants_list($querytype='standart', $obj)'''====

Метод, который возвращает список для автозаполнения.

''Аргументы:''
* (string) $querytype - тип запроса (по-умолчанию стандарт)
* (object) $obj - объект с параметрами для выборки
''Возвращаемые значения:''
* array | false - запись, если есть или false, если нет

===='''widgets_load_field($fieldname, $objectid, $data=null)'''====

Подгрузить значение поля перед inline-редактированием.

''Аргументы:''
* (string) $fieldname - название поля объекта, которое будет подгружено
* (int) $objectid - id редактируемого объекта
* (mixed) $data[optional] - дополнительные данные для запроса
''Возвращаемые значения:''
* string

===Планы:===
===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|plans
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу plans.
|-
|storage
|plans
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице plans.
|-
|storage
|plans
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы plans.
|}

Разработка:storages/schevents

2018-09-13T09:46:28Z

Agadzhanyan: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = schevents
| type = storages
}}

=Таблица в базе данных=
''schevents'' - учебные события, отображенные на реальные даны. Содержит информацию о реальной дате и времени учебного события, его статусе (проведено/не проведено), собитии-замене, исходном шаблоне, подразделении, расписанию которого принадлежит события и другие.

====Подробный формат полей в таблице:====
* templateid - шаблон расписания в таблице [[Разработка:storages/schtemplates | schtemplates]]
* dayid - день расписания, по которому было создано событие. Все запланированные(plan) и отложенные (postponed) события должны быть привязаны к существующим дням (то есть дняв с статусе active). Если в поле dayid стоит null - это нормальная ситуация. Она означает, что событие было создано вручную завучем, и не связано с шаблонами расписания.
* planid - тема урока в плане
* type - тип события: обычный урок, совместный урок(например, учитель ведет свой обычный урок и параллельно ведет урок по совмещению от заболевшего учителя), бесплатный урок (например, учитель химии ведет урок химии, который связан и с биологией, при этом в журнале "биологии" отмечается бесплатный урок, который учитель биологии не вел, но тема пройдена), интегрированный урок (например, учитель географии приглашает на свой урок учителя информатики для занятия в ГИС, при этом урок записывается и в журнал информатики и преподаватель информатики получает за него деньги; при этом "итегрированным" считается только урок информатики, а географии - обычный).
* joinid - id обычного урока, к которому присоединяется "бесплатный" , "совместный" или "интегрированный" либо 0
* cstreamid - учебный поток в таблице [[Разработка:storages/cstreams | cstreams ]]
* teacherid - '''БОЛЬШЕ НЕ ИСПОЛЬЗУЕТСЯ''' id преподавателя в таблице [[Разработка:storages/persons | persons ]]
* date - дата и время начала события по UTC
* duration - продолжительность события в секундах
* place - место проведения события (текстовое поле)
* replaceid - id события, которое заменяется данным событием
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/schevents |schevents ]]
* form - форма урока (очно/дистанционно)
* appointmentid - назначение на должность, в рамках которого проходит урок (таблица[[Разработка:storages/persons | appointments ]])
* ahours - продолжительность урока в академических часах
* rhours - продолжительность в условных часах, рассчитанная по формуле(ahours * programmitem.salfactor * programmsbcs.salfactor * schtemplates.salfactor * конфиг.поправаподразделения * конфиг.поправкапоколичествуучеников * cstreams.salfactor + ahours * cstreams.substsalfactor)
* salfactor - применяемый итоговый коэффициент (вычисляется как один час, к которому применены все действующие для данного урока поправочные коэффициенты или один замещающий)
* salfactorparts - сериализованный объект с полями: $obj->vars-> значения всех действующих на момент расчета коэффициентов, $obj->formula - формула расчета
* url - ссылка на занятие (текстовое поле формата url)

=Дополнительные методы:=

===='''replace_events($eventid, $date)'''====

Формирует замену для события событием.

''Аргументы:''
* $eventid(int) - id события, для которого формируется замена.
* $data(int) - дата, на которую переносится событие
''Возвращаемые значения:''
* (bool) true в случае успеха или false если обновление не удалось.
''Структура работы:''

В поле replaceid заменяемого события записываем id события, которое будет его заменять и обновляем запись в таблице БД.

===='''delete_events($date=null)'''====

Удаляет все события дня.

''Аргументы:''
* $date - день, для которого надо удалить все события, по умолчанию - текущий день (null).
''Возвращаемые значения:''
* (bool) true если все записи удалились и false в остальных случаях
''Структура работы:''
# если метка времени не указана, устанавливаем текущую метку времени.
# формируем метку времени начала дня.
# получаем все существующие события.
# для каждого события проверяем, если метка времени события попадает в промежуток даты начала дня и даты конца дня, то удаляем событие.
# возвращаем результат.

===='''get_cstream_events(csid, $status=null, $begin=null, $end=null)'''====

Получает список событий для учебного потока.

''Аргументы:''
* $csid(int) - id учебного потока в таблице [[Разработка:storages/cstreams | cstreams ]].
* $status(string) - статус учебного процесса, по умолчанию - все (null).
* $begin(int) - дата начала события, по умолчанию - все (null).
* $end(int) - дата окончания события, по умолчанию - все (null).
''Возвращаемые значения:''
* (array) события для учебного потока.
* (bool) false если события не найдены.
''Структура работы:''
* формируем SQL-запрос и возвращаем список событий:
** если указываются даты начала и окончания - события в указанный промежуток,
** если даты начала и окончания не указываются или указываются как null- события в любой день.
** если указывается статус - группы с указанным статусом,
** если статус не указывается или указывается как null - события с любым статусом.

===='''get_teacher_events($tcid, $status=null, $begin=null, $end=null)'''====

Получает список событий для преподавателя.

''Аргументы:''
* $tcid(int) - id преподавателя в таблице [[Разработка:storages/persons | persons ]].
* $status(string) - статус учебного процесса, по умолчанию - все (null).
* $begin(int) - дата начала события, по умолчанию - все (null).
* $end(int) - дата окончания события, по умолчанию - все (null).
''Возвращаемые значения:''
* (array) события для учебного потока.
* (bool) false если события не найдены.
''Структура работы:''
# находим все учебные потоки для преподавателя.
# для каждого учебного потока находим его события и заносим в массив.
# возвращаем резальтат.

===='''get_department_events($dpid, $status=null, $begin=null, $end=null)'''====

Получает список событий, принадлежащих структурному подразделению.

''Аргументы:''
* $dpid(int) - id структурного подразделения в таблице [[Разработка:storages/departments | departments ]].
* $status(string) - статус учебного процесса, по умолчанию - все (null).
* $begin(int) - дата начала события, по умолчанию - все (null).
* $end(int) - дата окончания события, по умолчанию - все (null).
''Возвращаемые значения:''
* (array) события для учебного потока.
* (bool) false если события не найдены.
''Структура работы:''
# находим все учебные потоки для подразделения.
# для каждого учебного потока находим его события и заносим в массив.
# возвращаем резальтат.

===='''get_pevent($point, $event)'''====

Состыковывает контрольную точку с событием.

''Аргументы:''
* $point(obj) - контрольная точка
* $event(obj) - событие
''Возвращаемые значения:''
* (obj) - cостыкованную запись

===='''get_pointevents($point, $cstreamid = null, $cancel_event = false)'''====

Получает массив состыкованных записей контрольной точки с ее событиями.

''Аргументы:''
* $point(obj) - контрольная точка
* $cstreamid - учебный поток в таблице [[Разработка:storages/cstreams | cstreams ]]
* $cancel_event(bool) - нужно ли отображать отмененные уроки, по умолчанию false
''Возвращаемые значения:''
* (array) - список состыкованных записей

===='''get_points_and_events($plans, $cstreamid, $cancel_event = false )'''====

Получает массив состыкованных записей контрольных точек с их событиями.

''Аргументы:''
* $plans(array) - массив записей контрольных точек
* $cstreamid(int) - учебный поток в таблице [[Разработка:storages/cstreams | cstreams ]]
* $cancel_event(bool) - нужно ли отображать отмененные уроки, по умолчанию false
''Возвращаемые значения:''
* (array) - список состыкованных записей

===='''canceled_event($eventid, $cancel_all = false)'''====

Отменяет урок.

''Аргументы:''
* $eventid(int) - id урока
* $cancel_all(bool) - отменить все события: true - все, включая замененные, по умолчанию false
''Возвращаемые значения:''
* (bool) true - если удалось отменить, false - иначе

===='''get_replace_event($eventid)'''====

Находит последнюю замену для события.

''Аргументы:''
* $eventid(int) - id события для которого ищем замену
''Возвращаемые значения:''
* int|bool - id замененного события или false

===='''get_plansid_anchored_day($date = null)'''====

Возвращает массив id КТ уроков для указанного дня.

''Аргументы:''
* $date(int) - день, по котором надо сделать выборку, если не указано, то текущий день, по умолчанию null
''Возвращаемые значения:''
* array|bool - массив id или false - если ничего не найдено

===='''get_listing($limitfrom = null, $limitnum = null, $conds=null, $countonly=false)'''====

Возвращает список событий по заданным критериям

''Аргументы:''
* $limitfrom(int) - начиная с какой записи просматривается фрагмент списка записей, по умолчанию null
* $limitnum(int) - сколько записей нужно извлечь из базы, по умолчанию null
* $conds(obj) - объект со списком свойств, по которым будет происходить поиск, по умолчанию null
* $countonly(obj) - только вернуть количество записей по указанным условиям, по умолчанию false
''Возвращаемые значения:''
* array массив записей из базы, или false в случае ошибки

===='''get_select_listing($inputconds)'''====

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

''Аргументы:''
* $inputconds(obj) - список полей с условиями запроса в формате "поле_БД->значение"
''Возвращаемые значения:''
* string

===Планы:===
====Дополнительные методы:====
* Создать событие на день по объекту шаблона расписания
* Получить статистику событий по структурному подразделению
* Получить статитстику событий по преподавателю
* Получить статистику событий по учебному процессу
* Получить статистику событий с участием студента

=События=
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|schevents
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу schevents.
|-
|storage
|schevents
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице schevents.
|-
|storage
|schevents
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы schevents.
|}

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|delete_broken_events
|Необязателен. Указывается дата, с которой ищутся занятия, если не указан по-умолчанию выбираются все.
|Находит все запланированные и отложенные занятия привязанные к дням начиная с указанной даты. Отменяет те события, чьи дни были удалены или отсутствуют в БД.
|}

[[Категория:Плагины обработки todo | storages/schevents]]

Разработка:modlibs/transmit

2018-03-02T09:17:39Z

Agadzhanyan:

=== Справочник дополнительных параметров: ===
{{Infobox_Plugin
| name = transmit
| type = modlibs
}}

= Принцип работы =
Библиотека обмена данными между электронным деканатом и внешней системой.
Логика работы заключается в обработке входного/выходного массива данных пуллом обработчиков, который привязывается к выбранной стратегии импорта/экспорта.

== Обработчики ==
Обработчика делятся на четыре группы:
* Валидаторы - валидируют входные данные
* Конвертеры - конвертируют свалидированные данные на бизнес-язык ЭД
* Импортеры - импортируют данные в систему
* Экспортеры - экспортируют данные

=== Валидаторы ===
-

=== Конвертеры ===
{| border="1"
|+ Таблица конвертеров с описанием
! Код конвертера
! Входные слоты
! Выходные слоты
! Статические слоты
! Доп. данные
! Описание
|-
| person_email
|
* (string)email
|
* (int)personid
|
* (bool)trycreatefrommoodle
|
|
Обработчик получает по email идентификатор персоны в деканате и выкидывает его в пулл в случае успешного нахождения.
Если персоны не существует в электронном деканате и при этом статичный слот trycreatefrommoodle равен true, то обработчик пытается получить пользователя Moodle.
После успешного получения пользователя Moodle, происходит поиск персоны в ЭД, которая привязаны к найденому пользователю Moodle.
Если персона в ЭД не найдена, то происходит регистрация персоны и привязка к пользователю Moodle, затем идентификатор созданной персоны выкидывается в пулл.
|}

=== Импортеры ===
-

=== Экспортеры ===
-

Разработка:modlibs/transmit

2018-03-02T09:01:41Z

Agadzhanyan: /* Конвертеры */

2018-03-02T07:11:43Z

Agadzhanyan: /* API */

{{Infobox_Plugin
| name = departments
| type = im
}}

== Подразделения ==
Интерфейс позволяет производить действия с подразделениями системы. Подразделения - отдельные элементы Деканата, которые позволяют разграничить работу с контингентом, установить собственные настройки плагинов и права пользователей. Под подразделениями можно понимать такие элементы, как Институты и их Филиалы, Факультеты и Отделы.

=== Список подразделений ===
Подразделения выводятся списком, каждая строчка в котором отображает информацию о структурном подразделении. В левом верхнем углу экрана содержится ссылка на создание подразделения.
В зависимости от уровня прав, которыми располагает пользователь, становятся доступны функции создания, удаления и редактирования.
Интерфейс позволяет увидеть только подразделения текущего местонахождения пользователя( само подразделение и его прямые потомки ).

=== Форма сохранения подразделения ===

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

'''Назначение полей:'''
* ''Название'' - Название подразделения. Обязательное поле.
* ''Код подразделения'' - Обязательное поле. Уникальное поле. Автоматически генерируется для новых подразделений, если не указано вручную(транслитерация первых 10 символов названия и добавление случайного номера).
* ''Руководитель'' - Необязательное поле. Руководитель структурного подразделения. По-умолчанию не указан. Выбирается из списка существующих персон и несет исключительно информационную цель. Пользователь не получает никаких прав, став Руководителем.
* ''Вышестоящий отдел'' - Обязательное поле. Какому подразделению подчиняется данное подразделение. По умолчанию стоит подразделение текущего местоположения пользователя. Выбирается из списка существующих подразделений.
* ''Часовой пояс'' - Обязательное поле. Временная зона подразделения. Необходимо для правильного расчета времени при составлении расписания и др. действий в системе. Выбирается по шкале универсального координированного времени, UTC. По умолчанию время сервера.

=== Карточка отдела ===

Выводит всю информацию о структурном подразделении. Также выводит список всех дочерних подразделения данного подразделения в древовидной структуре.

== API ==

Методы интерфейса подразделений

===== get_listing() =====

''Параметры:''
* $limitfrom - с какой записи начинать вывод
* $limitnum - сколько записей выводить на одной странице
* $conds - Обьект, содержащий данные с условиями выборки, в формате ''поле_БД->значение'' по умолчанию пустой массив

''Возвращаемые значения:''
* (array) массив записей из базы, или false в случае ошибки

=====showlist($list, $addvars, $options = [])=====
Возвращает HTML-код таблицы подразделений

''Параметры:''
* (array) $list - Массив подразделений из справочника [[Разработка:storages/departments|departments]].
* (array) $addvars - Массив GET-параметров для передачи по ссылкам.
* (array) $options - Массив дополнительных параметров отображения

''Возвращаемые значения:''
* (string) - HTML-код таблицы подразделений

===== show_id() =====
Возвращает HTML-код отображения информации об одном подразделении

''Параметры:''
* $id - id записи в таблице [[Разработка:storages/departments|departments]]

''Возвращаемые значения:''
* (string) - HTML-код или false в случае ошибки

===== get_html_link($id, $withcode = false) =====
Возвращает HTML-код отображения информации об одном подразделении

''Параметры:''
* (int)$id - ID записи в таблице [[Разработка:storages/departments|departments]]
* (bool)$withcode - Требуется код подразделения в названии ссылки

''Возвращаемые значения:''
* (string) - HTML-строка со ссылкой на подразделение или пустая строка в случае ошибки

===== get_departments_select_options($parentdep = 0, $options = []) =====
Возвращает список доступных подразделений для отображения в селекте.
Метод является рекурсивным и кеширует список подразделений.
Кеш сбрасывается при любом CrUD действии для актуализации данных.

''Параметры:''
* (int)$parentdep - Подразделение, от которого начинается сбор массива
* (array)$options - Массив опций сбора данных
['delimiter'] - Разделитель для уровней иерархии. По - умолчанию '-'
['statuses'] - Массив статусов в виде ['status1', 'status2']. По-умолчанию - actual метастатус
['access_callback'] - Функция дополнительной проверки прав доступа к подразделению

''Возвращаемые значения:''
* (array) - Массив для добавления в select список

== Events ==
Список отлавливаемых событий

=== Получение ссылки на объект ===
'plugintype' => 'im',
'plugincode' => 'obj'
'eventcode' => 'get_object_url'

* Возвращается ссылка на объект

=== Добавление подразделения ===
'plugintype' => 'storage',
'plugincode' => 'departments'
'eventcode' => 'insert'

* Сбрасывается кеш списка подразделений

=== Добавление подразделения ===
'plugintype' => 'storage',
'plugincode' => 'departments'
'eventcode' => 'update'

* Сбрасывается кеш списка подразделений

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

{{Infobox_Plugin
| name = schedule
| type = im
}}
'''Расписание.'''

Плагин предназначин для ввода и отображения информации по расписанию учебных занятий.

== Портфолио достижений ==
Плагин предназначен для управления разделами, шаблонами достижений, их отображением и модерированием. При помощи этого же плагина осуществляется доступ к наполнению портфолио и доступ к рейтингу.

=== Интерфейс достижений ===
Портфолио достижений встречает пользователей списком ссылок на доступные в соответствии с их правами инструменты. В этом списке могут быть представлены ссылки на:
*Панель управления достижениями
*Плагины портфолио
*Панель модерации достижений пользователей
*Мое портфолио
[[Изображение:Selection_011.png‎||350px|center|]]
=== Панель управления достижениями ===
Через данный интерфейс производится администрирование шаблонов достижений.
Имеется возможность создавать разделы при помощи кнопки “добавить раздел”, выстраивая нужную иерархию. Среди настроек раздела доступны:
*Имя раздела
*Родительский раздел
*Доступность в рейтинге
Последняя настройка отвечает за отображение достижений в рейтинге, добавленных по шаблонам достижений, хранящимся в редактируемом разделе.
Добавленные разделы отображаются в виде таблицы, в первом столбце которой доступны операции по редактированию, удалению и блокировке раздела.
Перед самой таблицей имеется кнопка, включающая режим сортировки разделов. В режиме сортировки путем перетаскивания можно поменять порядок отображения разделов.
[[Изображение:Selection 012.png||900px|center|]]
Находясь в разделе имеется возможность добавлять шаблоны достижений при помощи кнопки “Добавить шаблон достижения”.
Первым шагом добавления шаблона является настройка его основных характеристик таких как:
*Название шаблона
*Тип шаблона
*Раздел
*Баллы
Если включена подсистема модерации, то указанные баллы учитываются в рейтинге только после подтверждения достижения модератором.
После добавления шаблона достижения его необходимо активировать, кликнув по иконке с галочкой в таблице с шаблонами в первом столбце.
===== Тип шаблона “Результаты заданий” =====
Позволяет указать курс и задание, из которого автоматически будут создаваться достижения из ответов учащихся.
Имеется режим включающий назначение баллов пропорционально оценке. Количество баллов, указанных в достижении будет уменьшаться пропорционально набранному проценту оценки за задание.
Опционально, имеется возможность включить автоматическую отправку подтвержденных достижений в индекс антиплагиата.
===== Тип шаблона “Критерий” =====
Позволяет создать настраиваемый шаблон, предоставляющий пользователям возможность создавать достижения с ручным заполнением критериев.
В шаблон можно добавлять неограниченное количество поле следующих типов:
*текст - пользователю будет необходимо ввести текст при создании достижения
*дата - пользователю будет необходимо указать дату при создании достижения
*файл - пользователю будет необходимо прикрепить файл при создании достижения
*список - пользователю будет необходимо выбрать пункт из выпадающего списка при создании достижения
Все типы полей имеют возможность указания названия поля, выбора опции необходимости подтверждения поля модератором, коэффициента, на который будут умножены баллы достижения при заполнении поля. Выпадающий список имеет коэффициенты для каждого из пунктов.
[[Изображение:Selection 115.png||900px|center|]]
=== Плагины портфолио ===
Интерфейс встречает пользователя ссылками на подсистемы портфолио.
===== Фильтрация пользователей =====
Подсистема фильтрации по умолчанию отключена и ее можно включить в настройках подразделения, в котором расположено редактируемое портфолио. Название требуемой настройки: im - achievements - display_filter.
Интерфейс позволяет настраивать поля, по которым будет возможно отфильтровать пользователей на странице просмотра рейтинга и на странице модерации.
Среди полей будут отображаться дополнительные поля профилей типа “Выбор из списка” и “Переключатель”, а также поля достижений “Раздел” и “Дата создания достижения”.
Кроме того, в новой версии теперь доступна возможность фильтрации пользователей по ФИО.
[[Изображение:Selection 014.png||900px|center|]]

===== Блок информации о пользователе =====
На странице портфолио может быть отображена информация о пользователе из его профиля СДО. Настройка отображаемых полей производится в этом интерфейсе путем отмечания галочками нужных пунктов.
[[Изображение:Selection 016.png||700px|center|]]
=== Панель управления достижениями портфолио ===
Подсистема позволяет просматривать количество подтвержденных и неподтвержденных достижений пользователей СДО с возможностью сортировки по ФИО, дате создания достижения и по разделу достижений.
Если у пользователя отсутствует право модерации достижений, то колонка с неподтвержденными достижениями автоматически скрывается и пользователь видит только количество подтрвежденных достижений.

За доступ к модерации и к отображению колонки неподтвержденных достижений отвечает право im - achievements - moderate.
[[Изображение:Selection 172.png||900px|center|Панель управления пользователями портфолио]]

Также система позволяет фильтровать достижения для точечного поиска пользователей.

[[Изображение:Selection 173.png||900px|center|Панель управления пользователями портфолио]]

=== Мое портфолио ===
Данный интерфейс предназначен для наполнения пользовательского портфолио достижениями и просмотра достижений пользователя.
По умолчанию интерфейс отображает достижения пользователя, который в данный момент авторизован в системе, но он же может отобразить достижения другого пользователя, если передан параметр с идентификатором персоны деканата “personid”. Подобные ссылки на портфолио других пользователей доступны в рейтинге.
В интерфейсе будет отображена информация о пользователе, настроенная ранее в инструменте “Блок информации о пользователе”.
Чуть ниже - информация о рейтинге (количество баллов, место в рейтинге), сгруппированная по разделам достижений и ссылки на рейтинг.
Далее - форма добавления достижений и просмотр добавленных достижений с возможностью их фильтрации по разделу/шаблону, баллам и статусу.
Добавленные достижения, при наличии соответствующих прав, можно комментировать. Для комментирования необходимо в колонке "действия" рядом с достижением кликнуть по иконке "комментарии". На открывшейся странице будет доступна стандартная форма комментирования электронного деканата с возможностью добавления новых комментариев, редактирования и удаления своих собственных комментариев, просмотра чужих комментариев.
[[Изображение:Selection 018.png||900px|center|]]

=== Рейтинг ===
Страница рейтинга по умолчанию отображает рейтинг по разделу достижений, указанный в настройках подразделения, в котором расположено редактируемое портфолио. Требуемая настройка: storage - achievementcats - default_achievementcat. Если раздел, указанный в настройке не доступен, будет предложен выбор раздела.
В начале страницы отображается форма фильтрации пользователей, участвующих в рейтинге, по полям, настроенным в описанном выше инструменте “Фильтрация пользователей”.
Ниже отображается таблица пользователей с указанием места в рейтинге и набранных баллов.
При наличии права im-achievements-rating_export под фильтром также отображается кнопка, позволяющая экспортировать рейтинг портфолио в файл и скачать его.

Также система позволяет студенту выбор в участии в общем рейтинге. Если студент подтверждает участие, то он будет учитываться при формировании общего рейтинга, в ином случае он будет отсутствовать в общем рейтинге.

[[Изображение:Selection 174.png||900px|center|Личный кабинет пользователя портфолио]]

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

2018-02-05T08:18:44Z

Agadzhanyan:

{{Infobox_Plugin
| name = schedule
| type = im
}}
'''Расписание.'''

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

* Экран просмотра общего шаблона расписания по структурному подразделению (структурное подразделение задается через id в ссылке) и учебному периоду. Расписание организовано по дням учебной недели/учебного цикла плюс вкладка "управление". Внутри каждой вкладки доступны подвкладки с вариантами учебной недели (общая, четная, нечетная) и вкладка "операции". Внутри подвкладок с вариантом недели - список шаблонов уроков, заданных на этот день и ссылка для добавления нового урока на этот день. Уроки отсортированы по времени начала. Отображаются колонки "время начала, продолжительность, дисциплина (берется из учебного потока), преподаватель (берутся из учебного потока), академические группы (берутся из привязки к учебному потоку), кабинет. Напротив каждой ссылки "удалить" и "редактировать".
[[Изображение:Экран_просмотра_общего_шаблона_расписания.png|thumb|500px|center|Шаблон экрана "Просмотр общего шаблона расписания по структурному подразделению"]]
* Экран импорта/экспорта шаблона учебного расписания по структурному подразделению и учебному периоду в формат CSV. [[Изображение:Экран_импорта_экспорта_шаблона_рассписания.png|thumb|500px|center|Шаблон экрана "Импорт/экспорт шаблона учебного расписания по структурному подразделению и учебному периоду в формат CSV"]]
* Экран редактирования записи в шаблоне расписания. Позволяет изменить день, вариант недели, время, продолжительность урока, тип события, место проведения (текстовое поле), статус, учебный поток (выпадающее меню - при смене учебного потока автоматически сменится преподаватель, группа и дисциплина, поскольку они задаются именно учебным потоком). Виджеты "занятость преподавателя на день", "занятость группы/ученика на день", "недельная нагрузка учебного потока" [[Изображение:Экран_редактирования_записи_в_шаблоне_рассписания.png|thumb|500px|center|Шаблон экрана "Редактирование записи в шаблоне расписания"]]
* Экран просмотра шаблона расписания по учебному потоку (во всех подразделениях). Аналогичен части экрана просмотра общего шаблона расписания на вариант дня недели, но отображаются только события, относящиеся к выбранному учебному потоку (id передается через ссылку), за всю учебную неделю в одну колонку, разделенную номерами/названиями дней недели. Строчка каждого события так же содержит вариант учебной недели, к которой оно относится. [[Изображение:Экран_просмотра_шаблона_рассписания_по_учебному_потоку.png|thumb|500px|center|Шаблон экрана "Просмотр шаблона расписания по учебному потоку"]]
* Экран просмотра шаблона расписания по преподавателю и учебному периоду (во всех подразделениях). Аналогичен части экрана просмотра общего шаблона расписания на вариант дня недели, но отображаются только события, относящиеся к данному преподавателю (id передается через ссылку). [[Изображение:Экран_просмотра_шаблона_рассписания_по_преподавателю_и_учебному_периоду.png|thumb|500px|center|Шаблон экрана "Просмотр шаблона расписания по преподавателю и учебному периоду"]]
* Экран просмотра шаблона расписания по ученику и учебному периоду (во всех подразделения). Аналогичен экрану просмотра шаблона расписания по преподавателю. [[Изображение:Экран_просмотра_шаблона_расписания_по_ученику_и_учебному_периоду.png |thumb|500px|center|Шаблон экрана "Просмотр шаблона расписания по ученику и учебному периоду"]]
* Экран создания расписания на неделю. Размещается во вкладке "управление" экрана просмотра общего шаблона расписания. Позволяет выбрать начальную дату и вариант (кроме "нулевого"), начиная с которой будут созданы события по шаблону недели. [[Изображение:Экран_создания_расписания_на_неделю.png|thumb|500px|center|Шаблон экрана "Создание расписания на неделю"]]
* Экран создания расписания на день. Размещается во вкладке "опции" экрана просмотра общего шаблона расписания. Позволяет выбрать дату и вариант (кроме "нулевого"), на которую будут созданы события по шаблону дня. [[Изображение:Экран_создания_расписания_на_день.png|thumb|500px|center|Шаблон экрана "Создание расписания на день"]]
* Экран "реестр учебных дней". Отображает список созданных учебных дней в рамках подразделения и учебного периода. Рядом с каждым учебным днем отображаются параметры, с которыми он был создан.[[Изображение:Экран_Реестр_учебных_дней.png |thumb|500px|center|Шаблон экрана "Реестр учебных дней"]]
* Экран "экспорт учебных событий". Позволяет получить в виде файла CSV все учебные события по структурному подразделению за учебный день, диапазон дней, или учебный период. [[Изображение:Экран_Экспорт_учебных_событий.png|thumb|500px|center|Шаблон экрана "Экспорт учебных событий"]]
* Экран просмотра учебных событий на учебный день без группировки, отсортированных по времени. [[Изображение:Экран_просмотра_учебных_событий_без_группировки.png |thumb|500px|center|Шаблон экрана "Просмотр учебных событий на учебный день без группировки, отсортированных по времени"]]
* Экран просмотра учебных событий на учебный день по подразделению, сгруппированных по преподавателю. [[Изображение:Экран_просмотра_учебных_событий_по_преподавателю.png |thumb|500px|center|Шаблон экрана "Просмотр учебных событий на учебный день по подразделению, сгруппированных по преподавателю"]]
* Экран просмотра учебных событий на учебный день по подразделению, сгруппированных по академическим группам (для учебных потоков, привязанных к академическим группам). [[Изображение:Экран_просмотра_учебных_событий_по_академическим_группам.png |thumb|500px|center|Шаблон экрана "Просмотр учебных событий на учебный день по подразделению, сгруппированных по академическим группам"]]
* Экран просмотра учебных событий на учебный день по подразделению, сгруппированных по ученикам. Возможность отфильтровать события, привязанные к учебным потокам, привязанным к академическим группам. [[Изображение:Экран_просмортра_учебных_событий_по_ученикам.png |thumb|500px|center|Шаблон экрана "Просмотр учебных событий на учебный день по подразделению, сгруппированных по ученикам"]]
* Экран просмотра учебных событий на учебный день для ученика (по id ученика, доступен ученику, законному представителю и тем, у кого есть доступ), не зависимо от подразделений. [[Изображение:Экран_просмотра_учебных_событий_для_ученика.png |thumb|500px|center|Шаблон экрана "Просмотр учебных событий на учебный день для ученика"]]
* Экран просмотра учебных событий на учебный день для преподавателя (по id преподавателя, виден самому преподавателю и у кого есть доступ, изначально доступ есть у админов и руководителей структурного подразделения, которому принадлежит событие). События разделены по трем спискам: сегодняшние события, события, проведение которых не отмечено вовремя, отложенные события, точное время восполнения которых еще не назначено. С экрана есть ссылки на "Экран просмотра учебных событий на календарную дату по подразделению, сгруппированных по преподавателю" и "экран просмотра расписания по преподавателю". Напротив наступающих и неотмеченных событий есть ссылка. [[Изображение:Экран_просмотра_учебных_событий_для_преподавателя.png |thumb|500px|center|Шаблон экрана "Просмотр учебных событий на учебный день для преподавателя"]]
* Экран отметки о проведении события. Позволяет установить статус занятия. Преподаватель может сменить статус "запланировано" на "состоялось" или "отложено". Если разрешено политиками отдела (пока не реализовано), может изменить статус "отложено" на статус "заменено", указав новую дату события (других параметров при этом поменять не может. Администратор может изменить статус "запланировано" и "отложено" на "состоялось" и "отложено". [[Изображение:Экран_отметки_о_проведении_события.png|thumb|500px|center|Шаблон экрана "Отметки о проведении события"]]
* Виджеты: генерируются с помощью специальных функций, вставляя на страницу, с которой были вызваны, дополнительную информацию:
** Занятость преподавателя на день в шаблоне расписания с указанным вариантом (во всех структурных подразделениях): нагрузка в академических и список занятий с указанием кода группы и дисциплины. [[Изображение:Виджет_Занятость_преподавателя.png|thumb|500px|center|Шаблон виджета "Занятость преподавателя на день"]]
** Занятость группы/ученика на день в шаблоне расписания с указанным вариантом (во всех учебных программах, во всех структурных подразделениях): нагрузка в академических часах и список занятий с указанием дисциплины. [[Изображение:Виджет_Занатость_группы,_ученика.png|thumb|500px|center|Шаблон виджета "Занятость группы/ученика на день"]]
** Недельная нагрузка учебного потока (предмето-класса при указанном вариенте учебной недели) в шаблоне расписания: количество академических часов и список занятий в рамках данного учебного потока, приписанных к данной учебной недели. [[Изображение:Виджет_Недельная_нагрузка_учебного_потока.png |thumb|300px|center|Шаблон виджета "Недельная нагрузка учебного потока"]]
** Календарь учебных дней по структурному подразделению. Отображает календарь, в котором созданные учебные дни подсвечиваются в виде ссылок на "экран просмотра учебных событий на учебный день без группировки" либо другой экран, ссылка на который была передана (к переданной ссылке добавляется id дня из реестра дней). [[Изображение:Виджет_Календарь_учебных_дней.png |thumb|500px|center|Шаблон виджета "Календарь учебных дней"]]

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

2017-12-29T12:59:12Z

Agadzhanyan: /* Отчеты */

{{Infobox_Plugin
| name = journal
| type = im
}}
= Классный журнал =
В журнале можно выставлять оценки и вводить отчет о проведенном уроке.
== Список занятий ==
Включает в себя три страницы: информацию о текущем дне, список занятий в целом и поиск занятий по конкретной персоне.
Каждая страница содержит соответствующую ей навигацию.
====Список занятий за текущий день====
При заходе с главной страницы при нажатии на ссылку "Журнал" пользователь попадает именно на эту страницу, с нее начинается работа со списком занятий.

В начале страницы отображается секция навигации, с помощью которой пользователь может перейти на просмотр списка занятий в целом, поиск занятий по персоне или просмотреть отчет по фактической нагрузке.

Далее отображаются все уроки пользователя за сегодняшний день. Если уроков нет секция остается пустой.

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

После навигации пользователь видит два календарика, где он может выбрать как один определенный день, так и целый период, за который он хочет просмотреть список занятий.

Далее отображается список занятий за указанный день или период.

====Поиск занятий по персоне====

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

== Журнал группы ==
Страница принимает обязательный параметр id учебного процесса.

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

Ниже отображаются две таблицы - таблица оценок и, справа от нее, таблица уроков. Обе таблицы сделаны максимально похожими на соответствующие таблицы в бумажном "Классном журнале". Таблицы связаны друг с другом, содержат в себе темы с directmap=1

Таблица уроков содержит в себе темы и события связанные с указанным учебным процессом, кроме удаленных. Если же тема не связана с событием или событие не связано с темой они также отображаются в таблице, но без соответствующей информации.

Таблица оценок события и темы отображаются также как и в таблице уроков, кроме замененных событий и событий без тем. Дата в таблице оценок отображаются только в том случае, если для созданной темы создано событие, если у темы события нет, отображается полностью его название.

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

=== Таблица оценок. ===

Если таблица уроков пуста, то в таблице оценок нет ни одной колонки с датой.

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

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

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

В выборе оценок из списка, отображаются те оценки, что прописаны в шкале оценок указанной темы. Если в теме шкала отсутствует, то шкала берется из связанного с темой предмета, если же и там шкалы нет, то задается стандартная от 1 до 5.

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

Замыкает тройку галочка "н/о", которая показывает обучался ли учащийся на этом уроке или нет. В отличие от галочки "н", которая помечает присутствие или отсутствие учащегося на уроке, галочка "н/о" или "не обучался", что ученик в данный момент времени вообще не обучался на данном уроке по какой-либо причине(начал обучатся не со всеми, закончил обучатся раньше, взял академический отпуск, находится на лечении в санатории или больнице и т.д). Появляется эта галочка только в том случае, если присутствие или отсутствие у учащегося не проставлено.

При переключении в режим формы под таблицей появляется надпись "Внимание! До нажатия кнопки "сохранить" оценки не сохраняются...", под которой также появится галочка о подтверждения проведения урока и три кнопки - "Сохранить", "Сохранить и продолжить", "Восстановить".
Нажатие на первую кнопку сохраняет изменения, сделанные в форме и перезагружает страницу в режим просмотра. Вторая - сохраняет сделанные изменения, но страница остается в режиме формы - можно продолжать ввод. Третья кнопка отменяет сделанные изменения. Все введенные, но несохраненные данные удаляются из формы. Форма перегружается с отображением последних сохраненных изменений.

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

Что происходит в процессе сохранения.
После того как нажата одна из кнопок, сохраняющая внесенные изменения происходит

* формирование приказа регистрации присутствия учеников на уроке. В него сохраняются данные о всех учениках потока, их статусы присутствия, id события, статус присутствия на котором выставляется. Также вместе с приказом идет отметка о проведении урока.
* применение приказа и сохранение статусов учеников в соответствующих таблицах.

Если были выставлены оценки. То в дополнение к вышеописанным действиям происходят следующие действия:
* формирование приказа регистрации выставления оценок только тем ученикам, которые их получили на уроке. В приказе сохраняются: точное время выставления оценки, id КТ, за которую выставлена оценка, id преподавателя (из /storage/persons), который выставил оценку, ученики, которые получили оценку, и соответствующие им оценки, статус оценки, id подписки ученика на поток.
* применение приказа и сохранение оценок в соответствующих таблицах.

Примечание: Если у учащегося была проставлена галочка "н/о", то данные по этому ученику в приказ не сохраняются

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

=== Таблица уроков. ===
Представляет собой таблицу из семи столбцов.
# Порядковый номер урока.
# Дата проведения урока в формате дд.мм.гг
# Тема урока. Если отображается событие без темы, данная ячейка пустая.
# Домашнее задание. Если отображается событие без темы или пользователь ничего не вводил в поле домашнего задания, данная ячейка пустая.
# Время на домашнее задание. Аналогично со столбцом "Домашнее задание"
# Примечание. Аналогично со столбцом "Домашнее задание". На данный момент не используется, ввиду сокращения размеров таблицы
# Статус урока. Если отображается тема без события, данная ячейка пустая. Если событие зафиксировано как состоявшееся, ниже пишется персона проводившая событие.

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

=== Страница редактирования урока. ===
Вверху страницы, под строкой навигации, выводится надпись "Журнал группы".
Ниже выводится форма ввода информации об уроке.

Первой отображается секция создания события. Здесь можно выбрать создавать событие или нет (если создается тема без события), если да, то можно выбрать форму проведения урока (очно/дистанционно) и дату проведения. Если событие редактируется, то эти поля изменить нельзя. Если у пользователя нет прав для создания события, то данная секция не отображается.

Следом идет секция для создания темы урока. Сначала мы выбираем как мы создаем тему:
* Не создавать новую тему - если событие создается без темы
* Выбрать тему из планирования - если к событию мы привязываем существующую уже созданную тему.
* Создать собственную тему - создает новую тему на планирование по учебному процессу
В третьем варианте, при создании новой темы пользователь может либо выбрать родительские темы, откуда он будет наследовать название своей темы (поле "Что пройдено на уроке", необязательно к заполнению, но пользователь может ввести что-то свое), либо заполнить поле Что пройдено на уроке". Далее пользователь заполняет все оставшееся поля по мере необходимости.

В самом низу расположены две кнопки - "Сохранить" и "Отмена". При нажатии на вторую происходит возврат на главную страницу журнала без сохранения внесенных изменений. После нажатия на кнопку "Сохранить" происходит сохранение введенных данных в соответствующих таблицах. О результатах операции сохранения информирует надпись, выводимая под кнопками. Еще ниже появляется ссылка "назад" для возврата на главную страницу журнала. В случае возврата после сохранения данных, таблица оценок загружается в режиме редактирования данных на дату только что сохраненного урока.

Правее формы редактирования урока расположено окно с полосами прокрутки, в котором можно просмотреть темы уже проведенных уроков.
Они выводятся в видет таблицы из трех столбцов, в которых указываются соответственно дата, тема урока и домашнее задание.

В зависимости от заполненности полей ввода возможны разные варианты обработки введенных данных.

{|border=1
|id темы
|id события
|создание события
|создание темы
|как обрабатывается
|-
|0
|0
|не выбрано
|выбрано: Не создавать новую тему
|ничего не создается
|-
|0
|0
|не выбрано
|выбрано: Выбрать тему из планирования
|ничего не создается. Форма подгружает выбранную тему для редактирования
|-
|0
|0
|не выбрано
|выбрано: Создать собственную тему
|создается новая темы с указанными пользователем данными без события
|-
|0
|0
|выбрано
|выбрано: Не создавать новую тему
|создается новое событие с указанными пользователем данными без темы
|-
|0
|0
|выбрано
|выбрано: Выбрать тему из планирования
|создается новое событие с указанными пользователем данными и привязкой к выбранной теме
|-
|0
|0
|выбрано
|выбрано: Создать собственную тему
|создается новая темы и новая темы с указанными пользователем данными связанные друг с другом
|-
|существующая
|0
|нет выбора
|выбрано: Не создавать новую тему
|ничего не создается и не редактируется
|-
|существующая
|0
|нет выбора
|выбрано: Выбрать тему из планирования
|Выбранная тема привязывается к указанному событию
|-
|существующая
|0
|нет выбора
|выбрано: Создать собственную тему
|создается новая темы с указанными пользователем данными и привязывается к указанному событию
|-
|0
|существующая
|не выбрано
|нет выбора
|редактируется указанная тема
|-
|0
|существующая
|выбрано
|нет выбора
|создается новое событие с указанными пользователем данными, к которому привязывается указанная тема. Тему можно отредактировать
|-
|существующая
|существующая
|нет выбора
|нет выбора
|редактируется указанная тема, событие не редактируется
|}

=== Ведомость итоговых оценок ===
На данной странице можно выставить итоговые оценки учащимся и завершить обучение потока. Страница принимает обязательный параметр id - id идущего или завершенного потока.

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

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

Перейти на эту страницу можно со страницы Журнала группы.

== Отчеты ==
=== Отчеты о фактической нагрузке ===

Позволяют просмотреть статистику о нагрузке учителей за определенный период. [[ Разработка:im/reports#Отчеты о фактической нагрузке | Подробнее ]]

Для просмотра отчета по любой персоне необходимо право im/journal view:salfactors.

Для просмотра своего отчета необходимо право im/journal view:salfactors/own.

Для просмотра истории по отчетам (данные сроком более 2 месяцев) необходимо право view:salfactors_history.

=== Отчеты по замененным занятиям ===

Отчет отображает информацию по замененным занятиям с указанием суммарного количество часов и зарплатных часов и с возможностью выбора нескольких учебных периодов.

Интерфейс заказа отчета выглядит следующим образом:

[[Изображение:replaced_events-1.png||400px|center|]]

Интерфейс собранного отчета выглядит следующим образом:

[[Изображение:replaced_events-2.png||900px|center|]]

Отчет представляет собой информацию по замененным занятиям, также имеется возможно перехода в режим отображения отчета по преподавателям.
Отчет по преподавателям выглядит следующим образом:

[[Изображение:replaced_events-4.png||900px|center|]]

Отчет можно фильтровать по типам замен:
*По замене другим временем
*По замене другим преподавателем

=== Сводная ведомость текущих оценок и пропущенных уроков по параллели ===

Отчет отображает информацию о процессе обучения студентов. Включает в себя следующую информацию:
* Всего уроков по расписанию за период - количество занятий ученика по раписанию по всем его предметам
* Пропущенных уроков за период (кол-во) - отмеченные в журнале символом «Н»
* Текущие оценки - текущие оценки ученика по предмету (оценку идут подряд 451332)
* Средний балл учащегося по предмету за период - средний балл студента за предмет (если оценки 4532, средняя -3,25)
* Средний балл по предмету в параллели за период - средний бал всех оценок всех учеников за предмет (если у одного ученика оценки 45, у второго 53, средняя (4+5+5+3)/4 = 4,25)
* Качество знаний по предмету в параллели за период - отношений учеников, у которых в текущих оценках только 4 и 5 к общему числу учеников, изучающих предмет (если ученик не изучал предмет, он будет закрашен серым цветом и не будет учитываться в подсчете)

[[Изображение:Selection 02011.png||400px|center|]]

== Приказы ==
=== Приказ о закрытии зарплатного периода ===

==== Структура приказа о закрытии зарплатного периода ====
Данные приказа:
* reportid - id сформированного [[ Разработка:im/reports#Отчеты о фактической нагрузке | отчета по фактической нагркзке ]]

==== Формирование приказа о переводе ====
При формировании приказа также формируется отчет по фактической нагрузке с тем же указанным промежутком и в тоже указанное время исполнение, что и в приказе.

==== Подписание приказа о переводе ====
Подписание приказа происходит сразу же после его формирование.

=== Исполнение приказа о переводе ===
По крону. Возможно позже будет реализовано вручную.

Генерирует приказ по фактической нагрузке. После этого фиксирует все дни подразделения и его дочерних подразделений.

== События ==
* itog_grade_was_set - генерируется во время выставления итоговой оценки не зависимо от того, происходит первичное выставление оценки или повторное через ведомость пересдачи

== Уведомления ==

==== Уведомление учащегося об оценке ====

Отправка уведомлений после выставления оценки в электронном деканате осуществляется в случае, если включена настройка в подразделении.

Для отправки уведомлений об оценке полученной впервые по дисциплине, необходимо установить настройку send_grade_notification в значение 1. В качестве темы письма будет использоваться текст из настройки grade_notification_subject, в качестве основного текста письма будет использована настройка grade_notification_text.

Для отправки уведомления об оценке полученной через ведомость пересдачи, необходимо установить настройку send_reoffset_notification в значение 1. В качестве темы письма будет использоваться текст из настройки reoffset_notification_subject, в качестве основного текста письма будет использована настройка reoffset_notification_text.

В теме и тексте письма можно использовать следующие подстановки:
* [PERSONFULLNAME] - ФИО учащегося
* [DISCIPLINE] - Наименование дисциплины
* [GRADE] - полученная оценка

=Права=

* '''datamanage''' - глобальное право (администратор)
* '''view_journal''' - право на просмотр журнала учебного процесса (учитель курса или завуч)
* '''view_all_journals''' - право на просмотр всех журналов (может просматривать общую информацию и личные данные)
* '''view_all_journals_department''' - право на просмотр всех журналов подразделения (может просматривать общую информацию и личные данные)
* '''can_complete_lesson''' - право отметить проведение урока (учитель урока или завуч)
* '''create_schevent''' - право на создание события (завуч и учитель на потоке, если есть переменная в конфиге)
* '''control_journal''' - право на проверку журнала (завуч)
* '''give_grade''' - право на выставление оценки (учитель на потоке или завуч)
* '''give_itog_grades''' - право выставить итоговые оценки (поток завершён и пользователь - учитель на потоке)
* '''view_events''' - право просматривать свое расписание (учитель)
* '''give_attendance''' - право на отметку посещаемости (учитель урока или завуч)
* '''give_theme_event''' - право указать тему для события (только событие в статусе "запланирован" или "отложено на неопределенный срок", а пользователь - завуч или учитель потока)
* '''edit_plans''' - право редактировать КТ (КТ не "зафиксирована" и ((КТ завершена или событие состоялось), а пользователь - завуч) или пользователь может выставлять оценки)
* '''replace_schevent''' - право формирование замены события (учитель на потоке или завуч)

= API =
В этом разделе описаны функции для работы со страницами "журнал группы" и "список журналов". Здесь содержится только краткое описание функций и их параметров. Если вас интересует их внутренняя логика, то обратитесь к разделу [[Разработка:im/journal#Подробное описание работы функций|Подробное описание]]. Аргументы всех функций перечислены именно в том порядке, в котором их следует передавать.
=== Журнал группы ===
В этом разделе собраны все функции, которые относятся к странице "журнал группы"
==== Класс dof_im_journal_tablegrades ====
Класс отрисовки школьного журнала
===== print_texttable() =====
Вывести страницу журнала - просмотр оценок, или редактирование

''Аргументы:''
* $editid - id редактируемого учебного плана в таблице [[Разработка:storages/plans|plans]]
* $eventid - id учебного события, которое будет редактировано (таблица [[Разработка:storages/schevents|schevents]])

''Возвращаемые значения:''
* null
===== check_permissions() =====
Проверяет разрешения на редактирование оценок для текущего пользователя

''Аргументы:'' нет

''Возвращаемые значения:''
* true/false - есть или нет разрешения на редактирование оценок
==== Класс dof_im_journal_templans_table ====
Класс для отрисовки таблицы тематического планирования в классном журнале
===== __construct() =====
''Аргументы:''
* $dof - объект класса [[Разработка:lib/dof.php|dof_control]]
* $csid - id учебного потока

''Возвращаемые значения:'' нет
===== print_table() =====
Выводит таблицу тематического планирования на экран

''Аргументы:'' нет

''Возвращаемые значения:''
* true если операция вывода прошла успешно, или false если при выводе возникли ошибки
==== Класс dof_im_journal_edittopic ====
Класс для создания или редактирования одной темы на странице планирования уроков
===== __construct() =====
''Аргументы:''
* $dof - объект класса [[Разработка:lib/dof.php|dof_control]]
* $planid - id элемента учебного плана в таблице [[Разработка:storages/plans|plans]]
* $csid - id учебного потока
* $eventid - id учебного события (таблица [[Разработка:storages/schevents|schevents]])

''Возвращаемые значения:'' нет
===== get_topic() =====
Возвращает объект с полями, необходимыми для заполнения формы

''Аргументы:'' нет

''Возвращаемые значения:''
* object - объект с полями для вставки в форму, или false в случае ошибки
===== create_topic() =====
Создает новый элемент тематического планирования

''Аргументы:''
* $checkpoint - контрольная точка из таблицы [[Разработка:storages/plans|plans]]
* $event - заранее заготовленный объект для таблицы [[Разработка:storages/schevents|schevents]]
''Возвращаемые значения:''
* (int) - id новой записи из таблицы schevents или false в случае ошибки
===== save_topic() =====
Обновляет существующий или создает новый элемент тематического планирования

''Аргументы:''
* $checkpoint (object) - объект для обновления или создания записи в таблице [[Разработка:storages/plans|plans]]
* $event (object) - объект для обновления или создания записи в таблице [[Разработка:storages/schevents|schevents]]

''Возвращаемые значения:''
* true, если все записи успешно обновлены
* (int), id новой записи, если она была добавлена
* false в случае ошибки
===== print_table() =====
Формирует таблицу тематического планирования в правой части страницы журнала

''Аргументы:'' нет

''Возвращаемые значения:''
* true если операция вывода прошла успешно, или false если при выводе возникли ошибки
===== get_anchor_id() =====
Возвращает метку времени, которая будет создана для нового урока, чтобы осуществить корректное перенаправление на страницу журнала
''Аргументы:''
* $time - (int) время создания нового события: метка времени в формате unixtime
''Возвращаемые значения:''
* (int) - метка времени для перенаправления

==== Класс dof_im_journal_rawdata ====
Класс для подготовки сырых исходных данных для формирования школьного журнала и ему подобных документов
===== __construct() =====
Конструктор - определяет с каким учебным потоком будет вестись работа

''Аргументы:''
* $dof - объект класса [[Разработка:lib/dof.php|dof_control]]
* $csid - id учебного потока
''Возвращаемые значения:'' нет

==== Класс dof_im_journal_process_gradesform ====
Класс для проверки и обработки оценок из формы
===== __construct() =====
Конструктор класса. Осуществляет все проверки и записывает данные во внутреннее поле.

''Аргументы:''
* $dof - объект класса [[Разработка:lib/dof.php|dof_control]]
* $gradedata (array) - массив $_POST из формы
''Возвращаемые значения:'' нет
===== process_form() =====
Обработать все данные, пришедшие из формы: установить посещаемость, выставить оценки и сформировать приказы

''Аргументы:'' нет

''Возвращаемые значения:''
* false в случае неудачи. В случае успеха производит редирект на страницу журнала
==== Класс dof_im_journal_presence ====
Класс для обработки информации о посещаемости
===== __construct() =====
''Аргументы:''
* $dof - объект класса [[Разработка:lib/dof.php|dof_control]]
* $csid - id учебного потока
''Возвращаемые значения:'' нет
===== presence_students() =====
Формирует массив присутствия учеников

''Аргументы:'' нет

''Возвращаемые значения:''
* массив вида [id_ученика]=>статус_присутствия
===== absence_students() =====
Формирует массив отсутствующих студентов

''Аргументы:''
* $away - массив id отсутствующих учеников
''Возвращаемые значения:''
* массив вида [id_ученика]=>статус_присутствия
==== Дополнительные функции ====
===== dof_im_journal_format_date() =====

''Аргументы:''
* $date (int) - метка времення для преобразования.
* $format (string) - формат выводимой даты. По умолчанию 'dmy'.
* $url (string) - Указывается, если необходимо получить дату как ссылку. По умолчанию NULL
''Возвращаемые значения:''
* (string) строка с отформатированной датой
===== dof_im_journal_date_edit() =====
Возвращает отформатироанную дату и значок редактирования как ссылку
''Аргументы:''
* $date (int) - метка времени
* $format (string) - формат выводимой даты. По умолчанию 'dmy'
* $durl (string) - путь ссылки для даты, если не указана - дата выводится как просто строка. По умолчанию null.
* $eurl (string) - путь ссылки для значка, если не указана значок не показывается По умолчанию null.
* $imgsubdate (bool) - вывести значок под датой или рядом по умолчанию true (выводит значок под датой)
''Возвращаемые значения:''
* (string) - строка с отформатированной датой
=== Список журналов ===
==== Класс dof_im_journal_listjournals ====
Этот класс содержит функции для работы со страницей списка журналов
===== __construct() =====
''Аргументы:''
* $dof - объект класса [[Разработка:lib/dof.php|dof_control]]
''Возвращаемые значения:'' нет

===== set_data() =====
Заполняет начальной информацией внутренние поля объекта

''Аргументы:''
* $departmentid (int) - id подразделения (таблица [[Разработка:storages/departments|departments]]). По умолчанию 0.
''Возвращаемые значения:''
* (bool) true если все нормально или false в случае ошибки
===== get_data() =====
Возвращает собранные данные

''Аргументы:'' нет

''Возвращаемые значения:''
* (array) - массив структурных подразделений
===== get_journals() =====
Получить все журнлы занесенных подразделений

''Аргументы:'' нет

''Возвращаемые значения:''
* (bool) true если все нормально или false в случае ошибки

=== Журнал занятий ===
==== Класс dof_im_journal_show_events ====
Этот класс содержит функции для работы с журналом занятий
===== __construct() =====
''Аргументы:''
* $dof - объект класса [[Разработка:lib/dof.php|dof_control]]
* $depid - идентификатор подразделения
''Возвращаемые значения:'' нет

===== set_data =====
Заполняет параметры класса начальной информацией

''Аргументы:''
* $date - массив, состоящий из даты начала и даты окончания:
** [date_from] - дата начала
** [date_to] - дата окончания
* $teacherid - идентификатор преподавателя
* $studentid - идентификатор студента
''Возвращаемые значения:''
* true если операция прошла успешно

===== get_string_event =====
Получение строки для вывода одного занятия.
При проверке статуса события, выполняется проверка статуса на момент проведения самого события

''Аргументы:''
* $event - объект события
* $show_all - вывод подробной таблицы
''Возвращаемые значения:''
* array - массив для строчки события

===== get_table_events =====
Возвращает события одного дня

''Аргументы:''
* $display - ражим отображения(по времени, по учителям, по ученикам)
** [time] - по времени
** [students] - по ученикам
** [teachers] - по учителям
* $show_all - вывод подробной таблицы
* $implied - вывод мнимых событий
''Возвращаемые значения:''
* array - набор журналов или bool - false

===== get_table_unmarked_events =====
Возвращает события одного дня

''Аргументы:''
* $display - ражим отображения(по времени, по учителям, по ученикам)
** [time] - по времени
** [students] - по ученикам
** [teachers] - по учителям
''Возвращаемые значения:''
* array - набор журналов или bool - false

===== get_string_appointment =====
Получение строки для вывода одного предмето-класса

''Аргументы:''
* $cstream - объект учебного процесса (предмето-класса)
''Возвращаемые значения:''
* array - массив для строчки события

===== get_table_teaching_load =====
Возвращает учебную нагрузку учителя

''Аргументы:'' нет
''Возвращаемые значения:'' array - набор журналов или bool - false

===== get_data_for_export =====
Сбор данных для экспорта в csv

''Аргументы:'' нет
''Возвращаемые значения:''
* array - данные для экспорта

===== get_string_for_export =====
Создание массива данных об учениках

''Аргументы:''
* $event - объект урока
''Возвращаемые значения:''
* array - массив с данными

== Подробное описание работы функций ==
В этом разделе описывается подробная работа всех публичных и внутренних методов для классов журнала. Если вам требуется только краткая справка по API, то обратитесь к разделу [[Разработка:im/journal#API|API]].
=== Для журнала группы ===
==== Класс dof_im_journal_tablegrades ====

===== Описание print_texttable() =====
[[#print_texttable()|Описание API]].

Итоговая функция, выводящая всю собранную информацию на экран.

''Структура работы:''
# собирает всю информацию при помощи функции [[Разработка:im/journal#Описание get_all_form()|get_all_form()]]
# обращается к плагину templater для представления информации в html-формате
# функцией print выводит результат работы templater'а на экран.
===== Описание check_permissions() =====
[[#check_permissions()|Описание API]].

''Структура работы:''
# получаем учебный поток. Если поток не найден - возвращаем false.
# проверяем статус учебного потока. Если он не равен значению "go", то возвращаем false.
# проверяем, имеет ли текущий пользователь права редактирования. Если нет, то возвращаем false.
# если все проверки пройдены успешно, то возвращаем true.
===== Описание get_all_form() =====
Возвращает объект формы для вставки в templater. Таблица в шаблоне формируется по столбцам, т. е. сначала выводится контрольная точка в тем. планировании, а затем оценки всех учеников за это событие (как при заполнении обычного школьного журнала).

''Аргументы:''
* $editid (int) - id редактируемого учебного плана в таблице [[Разработка:storages/plans|plans]]
* $eventid (int) - id редактируемого учебного события в таблице [[Разработка:storages/schevents|schevents]]
''Возвращаемые значения:''
* (object) объект нужной структуры для построения шаблона

''Структура работы:''
# собираем в объект все стандартные надписи для таблицы
# собираем все запланированные активные контрольные точки учебного потока
# создадим массивы для названий месяцев и дат
# собираем в массив информацию по ученикам. Если параметр $editid не равен нулю, то в столбце оценок для редактируемой даты вместо оценки выводим форму.
# собираем в результурующий массив названия месяцев и дат
# если нужно распечатать форму - устанавливаем стандартные html-теги начала и конца формы
# возвращаем результат

===== Описание get_cell_form() =====
Возвращает редактируемую ячейку таблицы журнала.

''Аргументы:''
* $studentid (int) - id ученика в таблице persons.
* $cpassedid (int) - id учебной программы
* $oldgrade (int) - старая оценка (если есть). По умолчанию null.
* $gradeid (int) - id оценки в таблице cpgrades . По умолчанию 0
* $eventid (int) - id учебного события в таблице [[Разработка:storages/schevents|schevents]].
* $scale (string) - шкала всех возможных оценок через запятую. По умолчанию null.
''Возвращаемые значения:''
* (string) - строка с html-кодом формы редактирования оценки.
''Структура работы:''

Вся форма редактирования оценки представляет собой маленькую таблицу. С левой стороны находится форма выбора оценки, а справа галочка для отметки отсутствующего ученика (верхняя ячейка) и пояснение к ней (нижняя ячейка).
# получаем все допустимые варианты оценок для данного задания из параметра scale.
# из этих вариантов оценки составляем html-элемент формы типа SELECT.
# если за задание уже есть ранее выставленная, старая оценка, то делаем ее оценкой по умолчанию
# узнаем статус присутствия ученика на занятии, и в зависимсости от этого проставляем галочку над буквой "н". Форма с возможностью отмечания отсутствующих учеников отображается только для контрольных точек для которых есть события.
# возвращаем результат одной строкой.
===== Описание get_cell_string() =====
Получить текстовое содержимое ячейки оценки.

''Аргументы:''
* $studentid (int) - id ученика в таблице persons
* $plan (object) - объект содержащий данные об элементе тематического планирования (таблица [[Разработка:storages/plans|plans]])
* $gradedata (object) - данные об оценке По умолчанию null.
''Возвращаемые значения:''
* (string) html-код оценки, либо специальный знак пробела, чтобы в таблице было видно пустую ячейку
''Структура работы:''

# узнаем данные о посещаемости: получаем id события, если оно есть
#* если событие есть, узнаем, был ли ученик на занятии
# находим оценку
#* если ученик был на занятии и получил оценку - выводим оценку
#* если ученик был на занятии и не получил оценку - выводим символ пробела
#* если ученик отсутствовал на занятии и нет оценки, то выводим букву "н"
#* если ученик отсутствовал на занятии и получил оценку - выводим оценку, и букву "н" рядом с ней

===== Описание get_one_cell() =====
Возвращает данные в одной клетке журнала. Определяет какой тип ячейки выводить: для редактирования или текстовую.

''Аргументы:''
* $studentid (int) - id ученика в таблице persons
* $plan (object) - объект содержащий контрольную точку с событием из тем. планирования (таблица [[Разработка:storages/plans|plans]])
* $gradedata (object) - объект содержащий данные об оценке (таблица cpgrades)
* $cpassedid (int) - id подписки (таблица cpassed)
* $editid (int) - id редактируемого в текущий момент элемента из тем. планирования
* $eventid (int) - id редактируемого в текущий момент события (таблица [[Разработка:storages/schevents|schevents]])
* $scale (string) = По умолчанию null.
''Возвращаемые значения:''
* (string) строка с html-кодом формы редактирования оценки, либо сама оценка, либо статус "отсутствовал"
''Структура работы:''
# сравниваем, совпадают ли id выводимой и редактируемой в данной момент контрольной точки
#* если id совпадают - то выводим форму редактирования оценки
#** если за это задание оценка уже была ранее выставлена, то выводим форму с установленной ранее оценкой
#** если за задание еще нет оценки - то выводим форму без предустановленных значений
#* если id не совпадают то выводим оценку текстом (либо статус "отсутствовал", либо пустую клетку, в зависимости от того был ли ученик на уроке, и получил ли он оценку)
===== Описание get_line_for_student() =====
Возвращает строку таблицы журнала для одного ученика.

''Аргументы:''
* $i (int) - порядковый номер ученика в группе
* $student (object) - объект с данными об ученике из таблицы persons
* $cpasseds (array) - массив объектов, содержащий все подписки учеников этого потока
* $plans (array) - массив объектов, содержащий все контрольные точки текущего курса (из таблицы [[Разработка:storages/plans|plans]])
* $editid (int) - id редактируемой в данный момент контрольной точки
* $eventid (int) - id редактируемого в данный момент события (или 0, если события нет) Таблица [[Разработка:storages/schevents|schevents]]
''Возвращаемые значения:''
* (object) - информация об ученике: его ФИО, и оценки по всем контрольным точкам, а также сведения о посещаемости
''Структура работы:''
# создаем объект для итоговых данных
# записываем в соответствующие поля итогового объекта порядковый номер ученика, и его ФИО
# перебираем все переданные подписки ищем ту, которая относится к переданному ученику
# записываем в итоговый объект id его подписки
# создаем массив для оценок и собираем оценки ученика:
#* перебираем все контрольные переданные точки ($plans)
#* для каждой контрольной точки создаем объект оценки
#* получаем значение оценки за просматриваемую контрольную точку
#* при помощи функции [[Разработка:im/journal#Описание get_one_cell()|get_one_cell()]] получаем оформленный html-код оценки
#* записываем полученный объект в массив оценок
# добавляем массив оценок в итоговый объект
# возвращаем итоговый объект
===== Описание get_lines_for_students() =====
Возвращает массив строк с ФИО и оценками для всех учеников

''Аргументы:''
* $plans (array) - массив всех контрольных точек учебного потока из таблицы plans
* $editid (int) - id редактируемой в данный момент контрольной точки (из таблицы [[Разработка:storages/plans|plans]])
* $eventid (int) - id редактируемого в данный момент события (таблица [[Разработка:storages/schevents|schevents]])
''Возвращаемые значения:''
* (array) информация о всех учениках учебного потока или false, если ни одного ученика нет
''Структура работы:''
# получаем все подписки учебного потока, чтобы потом установить связи с оценками
# получаем учеников учебного потока
# присваиваем каждому ученику порядковый номер,
# получаем информацию по каждому ученику функцией [[#Описание get_line_for_student()|get_line_for_student()]] и заносим объект с информацией о нем в массив
# возвращаем получившийся массив
===== Описание create_datesstring() =====
Создает верхнюю строку журнала с названиями месяцев и списком дат в пригодном для обработки плагином templater виде.

''Аргументы:''
* $plans - список всех контрольных точек учебного потока из таблицы [[Разработка:storages/plans|plans]].
''Возвращаемые значения:''
* (object) - объект, содержащий массив с данными для шаблонизатора
''Структура работы:''

Даты в электронном журнале должны будут проставляться как и в обычном классном журнале: верхняя строка - месяцы обучения, нижняя строка - даты проведенных или запланированных уроков, а также четвертные или годовые оценки.
Для того чтобы организовать такой внешний вид для электронного журнала мы должны воспользоваться параметром colspan для html-таблицы журнала, и расположить тем самым месяцы точно над датами проведенных уроков. Для этой задачи в этой функции мы создаем объект следующей структуры:
* ''(возвращаемый объект)''
** ''monthtitle'' - массив объектов, каждый из которых имеет свойства ''mtitle'' - название месяца, и ''mcolspan'' - количество ячеек с датами проведенных уроков в этом месяце
** ''monthdate'' - строка с датой проведенного урока, либо название контрольной точки.

# получаем строку форматированных дат уроков при помощи функции [[#Описание generate_all_dates()|generate_all_dates()]]
# перебираем все события и собираем массивы дат и названий месяцев
#* если просматриваемая дата не находится в том же месяце, что и предыдущая, то дополняем массив месяцев
# прибавляем счетчик дат в месяце
# записываем новую дату в итоговый массив
# возвращаем итоговый массив
===== Описание generate_all_dates() =====
Вызывается из [[#Описание create_datesstring()|create_datesstring()]]. Получить отформатированные даты для журнала

''Аргументы:''
* $plans - массив всех контрольных точек учебного потока (из таблицы [[Разработка:storages/plans|plans]])
''Возвращаемые значения:''
* (array) - отформатированные даты для вывода в журнал
''Структура работы:''
# получим событие из таблицы schevents, которое относится к данной теме тематического планирования
# если событие есть - то покажем дату
# если события нет - только название контрольной точки

===== Описание generate_single_date() =====
Вызывается из [[#Описание generate_all_dates|generate_all_dates]] Создает один объект даты для журнала.

''Аргументы:''
* $plan (object) - объект из таблицы [[Разработка:storages/plans|plans]]
* $date (string) - метка времени для события или контрольной точки
* $event (object) - Объект из таблицы [[Разработка:storages/schevents|schevents]]. По умолчанию null.
''Возвращаемые значения:''
* (object) дата в нужном для templater'a формате
''Структура работы:''
# устанавливаем путь (html-якорь) к теме в планирования на странице
# Определяем, id события которое будет редактировано. Если события нет, то передаем 0.
# записываем якорь с ссылкой в объект
# возвращаем объект

==== Класс dof_im_journal_templans_table ====
===== Описание get_topics() =====
Возвращает массив объектов c необходимыми свойствами для вставки в таблицу schevents

''Аргументы:'' нет

''Возвращаемые значения:''
* (array) массив тем входящих в планирование
''Структура работы:''
# получаем все контрольные точки учебного потока
# формируем объект с нужными полями для каждой контрольной точки
# возвращаем получившийся массив объектов
===== Описание get_empty_topic() =====
Возвращает "пустой" объект отчета об уроке

''Аргументы:'' нет

''Возвращаемые значения:''
* (object) - объект для вставки в таблицу [[Разработка:storages/schevents|schevents]]
''Структура работы:''
* создаем объект с необходимым списком пустых полей и возвращаем его
===== Описание table_data() =====
Возвращает массив строк данных отформатированных для вывода с помощью moodle-функции print_table()

''Аргументы:'' нет

''Возвращаемые значения:''
* (array) массив с данными для распечатки таблицы, либо false в случае ошибки
''Структура работы:''
# проверяем, есть ли для переданного потока элементы тематического планирования.
#* если их нет - то возвращаем false
# формируем массив строк таблицы
# проставляем html-якоря для каждой контрольной точки на странице оценок
# добавляем ссылки на редактирования элементов учебного плана
# возвращаем получившийся массив
==== Класс dof_im_journal_edittopic ====
===== Описание get_topic() =====
[[#get_topic()|Описание API]]

''Структура работы:''
* Проверяем, указан ли id контрольной точки.
** Если не указан - возврящаем пустую тему.
** Если указан - пробуем извлечь контрольную точку по такому id
*** Если контрольную точку извлечь не удалось - то возвращаем false
*** Если удалось - то возвращаем заполненный отчет об уроке
===== Описание save_topic() =====
[[#save_topic()|Описание API]]

''Структура работы:''
# проверяем есть ли у нас данные в переменной $event для обновления или создания события. Если нет - то возвращаем false.
# определяем тип действия, которое надо совершить
#* если указан planid для события - то создаем новое событие для существующей контрольной точки
#* если нет id для контрольной точки - создаем новое событие и новую контрольную точку
#* в остальных случаях - обновляем контрольную точку и событие: вычисляем новую относительную дату, и обновляем записи в таблицах [[Разработка:storages/schevents|schevents]] и [[Разработка:storages/plans|plans]]
===== Описание create_topic() =====
[[#create_topic()|Описание API]]

''Структура работы:''
# создаем новый элемент тематического планирования в таблице plans (если это не удалось - то возвращаем false)
# добавляем в переданное событие id контрольной точки
# создаем событие из переданного объекта $event (если событие не создано - удаляем ранее созданный элемент тематического планирования)
# возвращаем id события
===== Описание create_checkpoint() =====
Создает и сохраняет запись в таблице plans

''Аргументы:''
* $point (object) - данные для сохранения в таблицу [[Разработка:storages/plans|plans]]
''Возвращаемые значения:''
* (int) - id новой записи или false в случае ошибки
''Структура работы:''
# проверяем, есть ли у нас все необходимые для создания записи
# получаем id учебного потока
# получаем дату начала обучения
# создаем заготовку для объекта контрольной точки
# вычисляем относительную дату контрольной точки
# заносим данные в базу
===== Описание create_event() =====
Создает объект события и сохраняет его в schevents

''Аргументы:''
* $event (object) - данные для сохранения
''Возвращаемые значения:''
* (int) - id новой записи в таблице событий или false.
''Структура работы:''
# проверяем, есть ли у нас все необходимые для создания записи
# получаем id учебного потока
# получаем id преподавателя в таблице persons
# создаем объект нужного формата и заносим туда все данные
# записываем данные в базу
==== Класс dof_im_journal_rawdata ====
''Поля:''
* dof - объект класса [[Разработка:lib/dof.php|dof_control]]
* csid - id учебного потока в таблице сstreams
===== Описание get_checkpoints() =====
Получить все контрольные точки одного учебного потока

''Аргументы:'' нет

''Возвращаемые значения:''
* (array) - массив объектов из таблицы plans или false
''Структура работы:''
# получаем id учебного потока из таблицы cstreams
# выбираем из таблицы plans все записи, у которых поле cstreamid равно id учебного потока, и тип связи "cstreams"
# сортируем их в хронологическом порядке
# возвращаем получившийся массив

===== Описание get_students() =====
Получить всех учеников указанного учебного потока

''Аргументы:'' нет

''Возвращаемые значения:''
* (array) массив записей из таблицы persons или false
''Структура работы:''
# получаем список пройденных дисциплин
# перебираем все подписки и запоминаем id ученика для каждой из них
# извлекаем из таблицы persons учеников, чьи id были извлечены из подписок

===== Описание get_teacherid() =====
Получить id преподавателя учебного потока

''Аргументы:'' нет

''Возвращаемые значения:''
* (int) - id преподавателя или false в случае неудачи
''Структура работы:''
* id преподавателя всегда берется только из записи учебного потока из таблицы cstreams
==== Класс dof_im_journal_process_gradesform ====
''Поля:''
* gradedata - (object) все оценки и сопутствующая им информация
* mypost - (array) непроверенные данные пришедшие из массива $_POST. Используются только для составления повторного запроса на сохранение данных.
===== Описание __construct =====
[[#Класс dof_im_journal_rawdata|Описание API]]

''Структура работы:''
# создаем объект, в который мы будем складывать все проверенные данные, пришедшие из формы
# проверяем скалярные данные: все числовые идентификаторы, и отдельные строки, и после проверки записываем их в итоговый объект
# теперь, зная cstreamid из проверенных скалярных данных вызываем родительский конструктор
# проверяем массивы, пришедшие из формы:
#* данные об отсутствующих учениках
#* массив оценок
#* массив идентификаторов подписок (таблица cpassed)
#* узнаем id оценок для изменения их статуса
# записываем все проверенные данные в итоговый массив
# определяем тип действия, которое надо совершить:
#* сохранить данные
#* сохранить данные и продолжить редактирование
#* восстановить исходные значения
# записываем исходный массив (непроверенный) в поле объекта, если потом понадобится еще раз отправить данные после подтверждения
===== Описание process_form() =====
[[#process_form()|Описание API]]

''Структура работы:''
# в самом начале проверяем тип действия, которое надо совершить. Если этим действием является "отменить изменения", то не переходим к сохранению оценок и сразуже выполняем перенаправление на страницу журнала. В остальных случаях идем дальше:
# проверяем, установлено ли у кого-нибудь из учеников одновременно "н" и оценка. Если это так - то перенаправим пользователя на страницу с сообщением об этом, и попросим его подтвердить такой выбор.
#* если пользователь согласен с изменениями, которые он сделал, то все выставленые им оценки и сведения о посещаемости сохраняются
#* если же нет - то происходит отмена всех изменений
# в случае, когда никаких предупреждений нет - сначала формируем приказ для оценок
# затем приказ о посещаемости
# если все действия произведены успешно - производим редирект. Если же возникли ошибки - сообщаем об этом

===== Описание generate_order_grades() =====
Сформировать приказ об изменении состояния учебного потока

''Аргументы:'' нет

''Возвращаемые значения:''
* true если приказ успешно сформирован, и false в случае ошибки
''Структура работы:''
# получаем id подразделения в таблице departments
# определяем тип действия, которое нужно совершить с оценкой
# обращаемся к функциям выставления, либо удаления оценки
===== Описание order_set_grade() =====
Формирует приказ - установить оценку.

''Аргументы:''
* $departmentid (int) - id подразделения в таблице [[Разработка:storages/departments|departments]]
''Возвращаемые значения:''
* (bool) true в случае успеха и false в случае неудачи
''Структура работы:''
# подключаем методы работы с приказом
# создаем объект для записи
# сохраняем автора приказа, подразделение, к которому он относится, дату создания приказа
# добавляем данные, которые определяют назначение приказа
# сохраняем приказ в БД, в таблицу orders
# подписываем приказ
# исполняем приказ
Методы order_delete_grade и order_update_grade работают по такому же принципу.
===== Описание get_grades_fororder() =====

''Аргументы:''
* $type - тип действия, которое необходимо будет произвести над оценкой. Возможные значения: ''set_grade'' и ''delete_grade''.
''Возвращаемые значения:''
* (object) - объект, содержащий список оценок и все идентификаторы для формирования приказа.
''Структура работы:''
# создаем объект для итоговых данных
# записываем в него дату, id учителя (в таблице persons) и id контрольной точки (в таблице plans
# перебираем все оценки из внутреннего массива с проверенными данными
# определяем тип действия, которое над ней нужно совершить
# в зависимости от типа действия (установление или удаление оценки) записываем в объект оценки нужные идентификаторы
# упаковываем оценки в итоговый массив и возвращаем его
=== Для списка журналов ===
==== Класс dof_im_journal_listjournals ====
Этот класс служит для сбора и вывода информации по всем структурным подразделениям. Информация выводится древовидно: самый верхний уровень - подразделение, затем учебные программы, затем учебные периоды, элементы учебной программы, и в самом конце - журналы учебного потока.
''Поля:''
* dof - - объект класса [[Разработка:lib/dof.php|dof_control]]
* $departments массив структуры
array(
[departmentid] => obj -> departmentname = 'department_name'
obj -> programms = array(
[programmid] => obj1 -> programmname = 'programm_name'
obj1 -> ages = array(
[agenum] => obj2 -> agename = 'age_name'
obj2 -> items = array(
[itemid] => obj3 -> itemname = 'item_name'
obj3 -> cstreams = array(
[cstreamid] => obj4 -> cstreamname = 'cstream_name'
)''// конец массива cstreams''
)''// конец массива items''
)''// конец массива ages''
)''// конец массива programms''
)''// конец общего массива''
содержит данные для вставку в темплатер после добавления еще одного уровня:
$fortemplater->departments = $this->departments;
В общем виде сбор данных выглядит так:
# сначала собирается информация по структурному подразделению (одному или нескольким), и информация по ним записывается в итоговый объект
# затем получаются все программы учебного подразделения, информация по ним записывается в итоговый массив
# извлекается и записывается в итоговый объект список учебных периодов
# для каждого учебного периода получаются элементы учебной программы, которые изучаются в нем
# для каждого элемента учебной программы получаются учебные потоки
# для каждого учебного потока получается его журнал
===== Описание set_data() =====
[[#set_data()|Описание API]]

''Структура работы:''
* получаем id структурного подразделения из таблицы departments.
** если оно есть - то получаем информацию только по нему
** если получили 0 вместо id подразделения - то выводим информацию по всем подразделениям

===== Описание get_journals_department() =====
Возвращает журналы одного подразделения

''Аргументы:''
* $departmentid - id подразделения в таблице [[Разработка:storages/departments|departments]]
''Возвращаемые значения:''
* (array) - набор журналов
* (bool) - false в случае ошибки
''Структура работы:''
# получаем все программы, за которые отвечает подразделение
# для каждой программы получаем все ее журналы

Файл:Selection 02011.png

2017-12-29T12:59:02Z

Agadzhanyan:

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

2017-12-12T14:23:57Z

Agadzhanyan:

{{Infobox_Plugin
| name = recordbook
| type = im
}}
== Зачетная книжка ==

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

=== Главный экран ===
Отображается список договор на обучение, которые пользователь может просматривать (информация о себе, информация об учениках, для которых пользователь выступает законным представителем). Под каждым контрактом выводится ссылка с названием учебной программы, ссылка на расписание уроков, и ссылка на зачетную книжку, где отображается информация о дисциплинах по текущей учебной программе. Информацию о том, ко какому ученику отображать информацию плагин берет из текущей переменной $USER, при помощи плагина [[Разработка:storages/persons|storage/persons]]. Название учебной программы выведен на экран информации об учебной программы. Ссылка "расписание уроков" ведет на страницу расписания текущей недели. Ссылка на зачетную книжку ведет на страницу со списком дисциплин по текущей учебной программе.
[[Изображение:Главный_экран_recordbook.png‎|thumb|500px|center|Шаблон экрана "Главный экран"]]

=== Экран "Расписание уроков" ===
В данном разделе отображается календарь где можно выбрать неделю, относительно которой нужно показать в таблице ниже уроки по учебным процессам в текущей учебной программе. Далее идет таблица с событиями по учебным процессам относящимся к этой учебной программе в рамках текущей календарной недели (по умолчанию отображаются уроки по текущей недели). Таблица оформлена в виде школьного дневника, расположенного в одну колонку: состоит из семи разделов, по одному на каждый день недели, где каждая строчка соответствует учебным событиям, расположенным в порядке их наступления. Строчка события содержит:
* Время
* Название урока
* Кабинет
* Тема
* Задание на следующий урок
* Время на д/з
* Форма занятия
* Оценка
[[Изображение:Selection 140.png|thumb|800px|center|Страница дневника учащегося]]

=== Экран "Зачетная книжка" ===
На этом экране отображается сводная информация об ученике по всем дисциплинам в рамках текущей учебной программы. Содержит в следующий вкладки:
* Информация о персоне
* Список дисциплин
* Запланированные дисциплины
* Перезачтенные дисциплины
* Академическая разница
[[Изображение:Сводная_информация_recordbook.png|thumb|500px|center|Шаблон экрана "Зачетная книжка"]]

=== Личный рейтинг студента по программе ===
Рейтинг собирается на основе кешированного рейтинга по учебным процессам.
Рейтинг схож с рейтингом по академической группе (можно почитать в im/agroups).
Если студент на текущей параллели изучал учебный процесс два раза, то в рейтинге учтется с тем, у которой средний балл выше.

Пример рейтинга:

[[Изображение:Selection 016 im recordbook.png|thumb|500px|center|Личный рейтинг студента по программе]]

==== Вкладка "Информация о персоне" ====
Содержит в себе следующую информацию:
* Название - ''название учебной программы''
* Ответственное подразделение - ''подразделение, к которому относится учебная программа''
* Учащийся - ''ФИО учащегося''
[[Изображение:Selection_004.png|thumb |600px |center|Вкладка "Информация о персоне"]]

==== Вкладка "Список дисциплин" ====
Эта вкладка содержит себе информацию по дисциплинам по всем параллелям в текущей учебной программе. Дисциплины делятся на две таблицы активные/завершенные.
Сожержит следующую информацию:
* Название параллели
* Две таблицы (Активные/Завершенные), которые содержат в себе название дисциплины, тип итогового контроля, итоговая оценка, часов по плану.
[[Изображение:Selection_005.png|thumb |600px |center|Вкладка "Список дисциплин"]]

==== Вкладка "Запланированные дисциплины" ====
Эта вкладка содержит себе информацию по запланированных дисциплинах.
Отображается в виде таблицы и содержит следующую информацию:
* Дисциплина
* Тип итогового контроля
* Часов по плану
[[Изображение:Selection_007.png|thumb |600px |center|Вкладка "Список дисциплин"]]

==== Вкладка "Перезачтённые дисциплины" ====
Эта вкладка содержит себе информацию по перезачтенными дисциплина в текущей учебной программе.
Отображается в виде таблицы со следующей информацией:
* Название дисциплины
* Итоговая оценка
* Часов по плану
[[Изображение:Selection_006.png|thumb |600px |center|Вкладка "Перезачтённые дисциплины"]]

==== Вкладка "Академическая разница" (В планах) ====

== API ==
Здесь описаны функции для работы со списком учебных программ.
===== get_section() =====

''Параметры:''
* $name - название секции
* $id - ID текста в наборе

''Возвращаемые значения:''
* (array) html-код содержимого секции секции

===== private get_learning_data() =====
Возвращает html форму для отображение договоров и подписок клиента
Вызывается через метод get_section() с параметром $name = 'list_learning_data'

''Параметры:''
* $options - id = id студента, template = название шаблона для отображения

''Возвращаемые значения:''
* (string) html код формы