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

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

2022-03-25T09:04:06Z

DShtolin:

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

===Таблица в базе данных===
''aclwarrantagents'' - cправочник применения полномочий. Подробные правила работы с полномочиями описаны в разделе: [[Разработка:Управление_доступом | Управление доступом]].

====Подробный формат полей в таблице:====
* id - номер записи
* departmentid - id подразделения из таблицы [[Разработка:storages/departments | departments ]]
* personid - id персоны, к которому применяется полномочие в таблице [[Разработка:storages/persons | persons ]]
* baseptype - тип объекта к которому будет привязано полномочие (например назначение на должность - storages)
* basepcode - код объекта к которому будет привязано полномочие (например назначение на должность - appointments)
* basetype - говорит о типе связи. Тип связи "record" означает, что baseid сответствует номеру записи в baseptype/basepcode, по умолчанию record
* baseid - id объекта к которому будет привязано полномочие (например назначение на должность)
* aclwarrantid - id доверенности в таблице [[Разработка:storages/aclwarrants | aclwarrants ]]
* datecreate - дата создания применения доверенности (unixtime)
* begindate - дата начала действия полномочия (unixtime)
* duration - длительность действия полномочия (в секундах). Длительность действия полномочия вычисляется как begindate+duration. Длительность действия полномочия не должна превышать 1 января 2038 года (максимальное ограничение php). Если доверенность выдана бессрочно - то в поле duration значение "1 января 2038 - дата начала". Если дату начала действия доверенности (begindate) не удается определить - то устанавливается 0. Сумма begindate+duration не должна превышать 1 января 2038 года. Если begindate не указан то датой начала действия доверенности считается время указанное в поле datecreate.
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/aclwarrantagents | aclwarrantagents ]]
* isdelegatable - наследование выбранного полномочия выбранному пользователю. По умолчанию 0 (можно передоверять). Значение 1 означает, что пользователь сам обладает этим полномочием, но доверить его никому не может.

==== Стандартные доверенности ====
Эти доверенности создаются вместе с установкой плагина. Они не могут быть удалены, к ним не могут быть привязаны пользователи. Плагины, которые поддерживают права доступа должны привязывать свои права именно к этим доверенностям.
* Администратор (root) - Доверенность, обладающая всеми полномочиями.
* Учитель (teacher) - Доверенность, дающая доступ к преподаванию и просмотру учебных материалов, просмотру информации об успеваемости учеников
* Управляющий (manager) - Управление служебными данными: например изменение персональной информации учеников, регистрация новых учеников, и т. д.
* Ученик (student) - Доверенность, дающая доступ к просмотру информации о своем обучении.
* Методист (methodist) - Доверенность, дающая доступ к управлению учебным процессом (например изменение состава учебной программы)
* Законный представитель ученика (parent) - Доверенность, дающая право на просмотр информации об обучении ученика.

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

* '''get_default_roles()''' - получить список кодов стандартных доверенностей

=События=
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|workflow
|persons
|person_not_active
|intvar обрабатывается как personid - идентификатор персоны, для которой будет выполнена обработка
|архивирует назначение доверенности авторизованного пользователя для переданной персоны (которая была переведена в не активный статус)
|-
|storage
|persons
|insert
|intvar обрабатывается как personid - идентификатор персоны, для которой будет выполнена обработка
|назначает доверенность авторизованного пользователя для переданной персоны (которая была создана)
|-
|workflow
|persons
|person_active
|intvar обрабатывается как personid - идентификатор персоны, для которой будет выполнена обработка
|назначает или активирует доверенность авторизованного пользователя для переданной персоны (которая была переведена в активный статус)
|-
|storage
|persons
|update
|intvar обрабатывается как personid - идентификатор персоны, для которой будет выполнена обработка
|в случае, если во время обновления записи переданной персоны было изменено подразделение - будет переназначена доверенность авторизованного пользователя
|-
|workflow
|contracts
|changestatus
|intvar обрабатывается как contractid - идентификатор учебного договора, для которого будет выполнена обработка
|если контракт переведен в активный статус - производится назначение доверенности студента по указанному договору, а если в неактивный - архивация назначения доверенности студента по указанному договору
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не генерирует события''
|}

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|fix_user_warrantagent_departments
|идентификатор подразделения, в котором будет произведено исправление назначений доверенностей авторизованного пользователя персонам; пустое значение (empty) - все подразделения;
|Исправление некорректно назначенных доверенностей авторизованного пользователя для персон подразделения указанного подразделения; Исправляет ранее возможный случай (сделаны правки, которые должны исключить такие случаи в дальнейшем), когда доверенность назначалась в подразделении1, затем персона переносилась в подразделение2, новая доверенность не назначалась, а старая продолжала действовать; задание в таком случае обнаружит и заархивирует назначение доверенности авторизованного пользователя в подразделении1 и назначит новое в подразделении2;
|}

[[Категория:Управление доступом]]

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

2022-03-25T08:38:22Z

DShtolin:

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

2018-01-11T13:30:40Z

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

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

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

====Подробный формат полей в таблице:====
* ageid - учебный период в таблице [[Разработка:storages/ages | ages ]]
* programmitemid - дисциплина в таблице [[Разработка:storages/programmitems | programmitems ]]
* [больше не используется] teacherid - id преподавателя в таблице [[Разработка:storages/persons | persons ]]. После создания поля appointmentid стало ненужным. Все старые обращения к этому полю будут переделаны на обращения к appointmentid, при создании новых обращений они должны обращаться к appointmentid. После переработки старых методов данное поле удалиться.
* departmentid - подразделение, которому принадлежит учебный процесс в таблице [[Разработка:storages/departments | departments ]]
* appointmentid - id назначения на должность в таблице [[Разработка:storages/appointments | appointments ]].
* mdlgroup - id группы moodle, соответствующей учебному потоку
* eduweeks - количество учебных недель/циклов (каждая соответствует одному циклу в расписании) продолжительности курса, по-умолчанию берется из programmitems, если там не указано - из ages. Нужны для подсчета часов при составлении расписания.
* begindate - дата и время, когда учебный процесс был впервые переведен в состояние "идет обучение" по [http://ru.wikipedia.org/wiki/UTC UTC]
* enddate - дата и время окончания по [http://ru.wikipedia.org/wiki/UTC UTC], когда учебный процесс был в последний раз выведен из состояния "идет обучение"
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/cstreams | cstreams ]]
* hours - часов всего
* hoursweek - часов в неделю
* hoursweekinternally - часов в неделю очно
* name - имя предмето-потока
* hoursweekdistance - количество часов в неделю дистанционно
* explanatory - пояснительная записка
* lastgradesync - дата последней синхронизации оценок
* salfactor - поправочный зарплатный коэффициент
* substsalfactor - замещающий поправочный коэффициент для учебного процесса. По умолчанию 0.
* mdlcourse - идентификатор курса moodle. Заполняется и используется в режиме клонирования мастер-курса, утвержденного на уровне дисциплины. По умолчанию не указан, что означает использование курса, указанного непосредственно в дисциплине.

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

===='''insert($dataobject, $id = NULL, $quiet=false)'''====

Вставляет запись в таблицу плагина.

''Аргументы:''
* dataobject(object) - данные для записи в таблицу.
* $id = NULL
* quiet(bool) - генерировать или нет события, по умолчанию - нет(false).
''Возвращаемые значения:''
* (int) - id вставленной записи.
* (bool) - false, если операция не удалась.

===='''delete($id,$quiet=false)'''====

Удаляет запись из таблицы плагина с указанным id.

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

===='''update($dataobject, $id = NULL, $quiet=false)'''====

Обновляет запись в таблице плагина данными из объекта. Отсутствующие в объекте записи не изменяются. Если id передан, то обновляется запись с переданным id. Если id не передан обновляется запись с id, который передан в объекте.

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

===='''get_teacher_cstream($id, $status = "active")'''====

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

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

===='''get_department_cstream($id, $status = "active")'''====

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

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

===='''get_age_cstream($id, $status = "active")'''====

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

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

===='''get_programmitem_cstream($id, $status = "active")'''====

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

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

===='''get_agroup_cstream($id)'''====

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

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

===='''get_agroup_agenum_cstreams($agroupid, $ageid)'''====

Получить Список программ по академической группе, и периоду.

''Аргументы:''
* $agroupid(int) - id академической группы в таблице [[Разработка:storages/agroups | agroups ]].
* $ageid(int) - id учебного периода в таблице [[Разработка:storages/ages | ages ]].
''Возвращаемые значения:''
* (array) - массив записей из этой таблицы, если они есть.
* (bool) - false, если ничего не нашлось.

===='''get_agroup_status_cstreams($agroupid, $status)'''====
Получить Список программ по академической группе, и статусу.

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

===='''get_numberof_cstreams($select)'''====

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

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

===='''get_prog_age_cstreams($pitemid, $ageid, $status=null)'''====

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

''Аргументы:''
* $programmid(object) - id учебной программы в таблице [[Разработка:storages/programms | programms ]].
* $ageid(object) - id периода в таблице [[Разработка:storages/ages | ages ]].
* $status(string) - статус учебного потока.
''Возвращаемые значения:''
* (array) - массив записей из базы.
* (bool) - false, если произошла ошибка.

===='''get_programm_age_cstreams($programmid, $ageid = null, $agenum = null, $dpid = null)'''====

Получает все учебные потоки программы.

''Аргументы:''
* $programmid(int) - id учебной программы в таблице [[Разработка:storages/programms | programms ]].
* $ageid(int) - id периода в таблице [[Разработка:storages/ages | ages ]], по умолчанию нет.
* $agenum - номер паралели в таблице [[Разработка:storages/programmitems | programmitems ]], по умолчанию нет(null).
* $dpid - id подразделения в таблице [[Разработка:storages/departments | departments ]], по умолчанию - нет(null).
''Возвращаемые значения:''
* (array) - массив потоков.
* (bool) - false, если потоки не найдены.

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

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

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

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

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

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

===='''get_agroup_ageids($agroupid)'''====

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

''Аргументы:''
* @param int $agroupid - id академической группы в таблице [[Разработка:storages/agroups | agroups ]].
''Возвращаемые значения:''
* (array) - индексированный массив с уникальными значениями id периодов всех потоков.
* (bool) - false, если ничего не найдено.

===='''create_cstreams_for_agroup($agroupid, $ageid, $departmentid, $datebegin, $enddate=null)'''====

Создаёт учебные потоки для группы.

''Аргументы:''
* $agroupid(int) - id акадкмическуой группы (класса) в таблице [[Разработка:storages/agroups | agroups ]].
* $ageid(int) - id учебного периода в таблице [[Разработка:storages/ages | ages ]].
* $departmentid(int) - id учебного подразделения в таблице [[Разработка:storages/departments | departments ]].
* $datebegin(int) - дата начала обучения в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $enddate(int) - дата окончания обучения в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime], по умолчанию - нет(null).
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''create_cstreams_for_programm($programmid, $ageid, $agenum, $departmentid, $datebegin, $enddate=null)'''====

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

''Аргументы:''
* $programmid(int) - id учебной программы в таблице [[Разработка:storages/programms | programms ]].
* $ageid(int) - id учебного периода в таблице [[Разработка:storages/ages | ages ]].
* $agenum(int) - номер параллели, для которой создается подписка.
* $departmentid(int) - id учебного подразделения в таблице [[Разработка:storages/departments | departments ]].
* $datebegin(int) - дата начала обучения в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''enrol_agroup_on_cstreams($agroupid, $ageid)'''====

Подписывает группу на список потоков.

''Аргументы:''
* $agroupid(int) - id группы в таблице [[Разработка:storages/agroups | agroups ]].
* $ageid(int) - id учебного периода в таблице [[Разработка:storages/ages | ages ]].
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''set_status_complete($id)'''====

Переводит поток в статус "завершен".

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

===='''get_cstreams_on_parametres($programmitemid, $teacherid = 0, $mycstrems = false, $completecstrems = false)'''====

Возвращает список потоков по параметрам.

''Аргументы:''
* $programmitemid(int) - id дисциплины в таблице [[Разработка:storages/programmitems | programmitems ]].
* $teacherid(int) - id учителя в таблице [[Разработка:storages/persons | persons ]], по умолчанию - нет(0).
* $mycstrems(bool) - показать ли потоки текущего пользователя, по умолчанию - нет(false).
* $completecstrems(bool) - показать ли завершенные потоки, по умолчанию - нет(false).
''Возвращаемые значения:''
* (array).

===='''get_short_name($cstreamid)'''====

Возвращает короткое имя потока.

''Аргументы:''
* $cstreamid(int) - id потока в таблице плагина.
''Возвращаемые значения:''
* (string)
* (bool) - false, если возникли ошибки.

===='''enrol_students_on_cstream($cstream, $programmsbcids)'''====

Подписывает учеников на поток.

''Аргументы:''
* $cstream(object) - объект из таблицы плагина.
* $programmsbcids(object) - массив, состоящий из id подписок на программы в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''unenrol_students_from_cstream($cstream, $programmsbcids)'''====

Исключает учеников из потока

''Аргументы:''
* @param object $cstream - объект из таблицы плагина.
* @param array $programmsbcids - массив, состоящий из id подписок на программы в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''enrol_student_on_cstream($cstream, $programmsbcid)'''====

Подписывает одного ученика на поток.

''Аргументы:''
* $cstream(object) - объект из таблицы плагина.
* $programmsbcid(int) - id подписки ученика на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''unenrol_student_from_cstream($cstream, $programmsbcid)'''====

Исключает одного ученика из потока.

''Аргументы:''
* $cstream(object) - объект из таблицы плагина.
* $programmsbcid(int) - id подписки ученика на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''get_cstreamname($eventcode, $mixedvar, $cstream = false)'''====

В зависимости от произошедших событий (значение $eventcode) сохраняет информацию о новом (insert), и новом, и старом (update) либо только старом (delete) имени предмето-потока в БД.

''Аргументы:''
* $eventcode - произошедшее событие.
* $mixedvar(array) - id нового и старого потоков в таблице плагина.
* $cstream - данные пришли из таблицы плагина? , по умолчанию - нет(false).
''Возвращаемые значения:''
* (bool) - true, если запись прошла успешно, и false - в случае ошибок.

===='''get_old_sync_cstreams($limit)'''====

Возвращает id указанного количества активных самых давно-синхронизированных cstream`ов

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

===Планы:===
====Дополнительные методы:====
* Получить список учебных процессов для данного ученика с учетом персональной подписки и академических групп (второй параметр - статус, по умолчанию - "идет").

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

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|resync_programmitem_cstreams
|Обязателен. Указывается id дисциплины из таблицы [[Разработка:storages/programmitems | programmitems ]]
|Находит все активные учебные процессы в указанной дисциплине, после чего каждого из них приостанавливает и заново возобновляет. Необходимо для записи учащихся на курс Moodle, если курс Moodle был присвоен дисциплине во время учебного процесса.
|-
|programmitem_cpass_to_suspend
|Обязателен. Указывается id дисциплины из таблицы [[Разработка:storages/programmitems | programmitems ]]
|Находит все активные учебные процессы в указанной дисциплине, после чего каждого из них приостанавливает. Необходимо для отписывания учащихся с курса Moodle, если необходимо сменить курс Moodle в дисциплине. Работает в паре с '''programmitem_cpass_to_active'''.
|-
|programmitem_cpass_to_active
|Обязателен. Указывается id дисциплины из таблицы [[Разработка:storages/programmitems | programmitems ]]
|Находит все приостановленные учебные процессы в указанной дисциплине, после чего каждого из них активирует. Необходимо для записи учащихся на курс Moodle после смены курса Moodle в дисциплине. Работает в паре с '''programmitem_cpass_to_suspend'''.
|-
|resync_department_cstreams
|Обязателен. Указывается id подразделения из таблицы [[Разработка:storages/departments | departments ]]
|Находит все активные учебные процессы в указанном подразделении, после чего каждого из них приостанавливает и заново возобновляет. Необходимо для записи учащихся на курс Moodle, если курс Moodle был присвоен дисциплинам во время учебного процесса.
|}

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

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

2017-12-14T08:36:57Z

DShtolin: Новая страница: «{{Infobox_Plugin | name = taxitems | type = storages }} ===Таблица в базе данных=== ''taxitems'' - Хранилище элементов класс...»

{{Infobox_Plugin
| name = taxitems
| type = storages
}}
===Таблица в базе данных===
''taxitems'' - Хранилище элементов классификатора

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

* id - идентификатор элемента классификатора
* classificatorid - идентификатор классификатора
* code - Код элемента классификатора
* name - Название элемента классификатора
* description - Описание элемента классификатора
* parentitemid - Идентификатор родительского элемента классификатора
* availability - доступность выбора (можно ли выбирать этот элемент в списке в качестве результирующего элемента)
* canbedeleted - доступность удаления
* status - Статус

==API==

===='''save($data = null, $options = [])'''====

Сохранение

''Аргументы:''
* string|stdClass|array $data
* array $options
''Возвращаемые значения:''
* int | false
''Выбрасываемые исключения''
* dof_exception_dml

===='''normalize($data, $options = [])'''====

Нормализация данных

''Аргументы:''
* string|stdClass|array $data
* array $options
''Возвращаемые значения:''
* stdClass
''Выбрасываемые исключения''
* dof_exception_dml

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

2017-12-14T08:33:23Z

DShtolin:

{{Infobox_Plugin
| name = taxonomies
| type = storages
}}
===Таблица в базе данных===
''taxonomies'' - Хранилище классификаторов

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

* id - идентификатор классификатора
* code - Код классификатора
* name - Название классификатора
* description - Описание классификатора
* type - Тип классификатора
* canbedeleted - Доступность удаления
* status - Статус

==API==

===='''save($data = null, $options = [])'''====

Сохранение

''Аргументы:''
* string|stdClass|array $data
* array $options
''Возвращаемые значения:''
* int | false
''Выбрасываемые исключения''
* dof_exception_dml

===='''normalize($data, $options = [])'''====

Нормализация данных

''Аргументы:''
* string|stdClass|array $data
* array $options
''Возвращаемые значения:''
* stdClass
''Выбрасываемые исключения''
* dof_exception_dml

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

2017-12-14T08:32:36Z

DShtolin: Новая страница: «{{Infobox_Plugin | name = traxonomies | type = storages }} ===Таблица в базе данных=== ''taxonomies'' - Хранилище классификато...»

{{Infobox_Plugin
| name = traxonomies
| type = storages
}}
===Таблица в базе данных===
''taxonomies'' - Хранилище классификаторов

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

* id - идентификатор классификатора
* code - Код классификатора
* name - Название классификатора
* description - Описание классификатора
* type - Тип классификатора
* canbedeleted - Доступность удаления
* status - Статус

==API==

===='''save($data = null, $options = [])'''====

Сохранение

''Аргументы:''
* string|stdClass|array $data
* array $options
''Возвращаемые значения:''
* int | false
''Выбрасываемые исключения''
* dof_exception_dml

===='''normalize($data, $options = [])'''====

Нормализация данных

''Аргументы:''
* string|stdClass|array $data
* array $options
''Возвращаемые значения:''
* stdClass
''Выбрасываемые исключения''
* dof_exception_dml

Разработка:sync/messager

2017-12-14T08:16:36Z

DShtolin:

{{Infobox_Plugin
| name = messager
| type = sync
}}
Плагин отправки сообщений

== API ==

===='''notify_persons($personids, $notificationtext, $options=[])'''====
Системное уведомление пользователям

===='''notify_persons_with_acl($notificationtext, $plugintype, $plugincode, $aclcode, $departmentid = 0, $objectid = 0, $options=[])'''====
Системное уведомление пользователям, имеющим право в подразделении

==Перехватываемые события==
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Пояснение
|-
| im
| agroups
| send_message
| Событие отправки сообщения, результатом обработки которого является отправка сообщения
с текстом $mixedvar['message'] пользователю с идентификатором переданным в id
|}

Разработка:sync/mcourses

2017-12-14T07:47:56Z

DShtolin: /* API */

{{Infobox_Plugin
| name = mcourses
| type = sync
}}

Работа с курсами moodle

== API ==

===='''get_course($id)'''====
Получить объект курса moodle по его id

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

===='''get_course_link($id)'''====
Получить ссылку на курс moodle

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

===='''course_exists_quiet($id)'''====
Аккуратно проверить существование курса в moodle, не создавая ошибок print_error

''Аргументы:''
* int $id - id курса в moodle
''Возвращаемые значения:''
* bool - true, если курс существует; false, если курс не существует

===='''create_backup($courseid, $backupoptions = [], $fileoptions = [])'''====
Создание резервной копии курса

''Аргументы:''
* int $courseid - id курса в moodle
* array $backupoptions
* array $fileoptions
''Возвращаемые значения:''
* boolean

===='''restore_backup($courseid, $restoreoptions = [], $fileoptions = [], $courseoptions = [])'''====
Восстановление курса из резервной копии

''Аргументы:''
* int $courseid - id курса в moodle
* int $courseid
* array $restoreoptions
* array $fileoptions
* array $courseoptions
''Возвращаемые значения:''
* int

===='''backup_exists($courseid, $fileoptions = [])'''====
Проверка существования резервной копии курса

''Аргументы:''
* int $courseid - id курса в moodle
* array $fileoptions
''Возвращаемые значения:''
* boolean

===='''create_course(stdClass $courseobj)'''====
Создание курса мудл

''Аргументы:''
* stdClass $courseobj
''Возвращаемые значения:''
* int

=События=
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Идентификтаор
! Доп. данные
! Пояснение
|-
| storage
| programmitems
| coursedata_verification_requested
| идентификатор курса
| массив с данными:
* initiator - пользователь, запросивший согласование
* course - наименование курса
* discipline - наименование дисциплины
* notificationresult - массив с результатами отправки уведомлений
| Запрошено согласование мастер-курса
|-
| storage
| programmitems
| coursedata_accepted
| идентификатор курса
| массив с данными:
* course - наименование курса
* discipline - наименование дисциплины
* notificationresult - массив с результатами отправки уведомлений
| Мастер-курс одобрен
|-
| storage
| programmitems
| coursedata_declined
| идентификатор курса
| массив с данными:
* course - наименование курса
* discipline - наименование дисциплины
* notificationresult - массив с результатами отправки уведомлений
| Мастер-курс отклонен
|}

Разработка:sync/mcourses

2017-12-14T07:34:48Z

DShtolin:

{{Infobox_Plugin
| name = mcourses
| type = sync
}}

Работа с курсами moodle

== API ==

=== get_course ===
Получить объект курса moodle по его id

=== get_course_link ===
Получить ссылку на курс moodle

=== course_exists_quiet ===
Аккуратно проверить существование курса в moodle, не создавая ошибок print_error

=== create_backup ===
Создание резервной копии курса

=== restore_backup ===
Восстановление курса из резервной копии

=== backup_exists ===
Проверка существования резервной копии курса

=== create_course ===
Создание курса мудл

=События=
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Идентификтаор
! Доп. данные
! Пояснение
|-
| storage
| programmitems
| coursedata_verification_requested
| идентификатор курса
| массив с данными:
* initiator - пользователь, запросивший согласование
* course - наименование курса
* discipline - наименование дисциплины
* notificationresult - массив с результатами отправки уведомлений
| Запрошено согласование мастер-курса
|-
| storage
| programmitems
| coursedata_accepted
| идентификатор курса
| массив с данными:
* course - наименование курса
* discipline - наименование дисциплины
* notificationresult - массив с результатами отправки уведомлений
| Мастер-курс одобрен
|-
| storage
| programmitems
| coursedata_declined
| идентификатор курса
| массив с данными:
* course - наименование курса
* discipline - наименование дисциплины
* notificationresult - массив с результатами отправки уведомлений
| Мастер-курс отклонен
|}

Разработка:sync/minfo

2017-12-14T07:06:57Z

DShtolin:

{{Infobox_Plugin
| name = minfo
| type = sync
}}

Получение информации из moodle

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

В настоящее время пуст, так как методы, реализованные тут ранее, перенесены в специализированный плагин

Разработка:sync/mcourses

2017-12-14T07:06:04Z

DShtolin: Новая страница: «{{Infobox_Plugin | name = mcourses | type = sync }} Работа с курсами moodle == API == === get_course === Получить объект курса mo...»

Разработка:sync/minfo

2017-12-14T07:03:15Z

DShtolin:

{{Infobox_Plugin
| name = minfo
| type = sync
}}

Получение информации из moodle

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

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

2017-12-14T06:55:34Z

DShtolin:

{{Infobox_Plugin
| name = programmitems
| type = storages
}}
=Таблица в базе данных=
''programmitems'' - элементы учебной программы - учебные дисциплины/предметы.

====Подробный формат полей в таблице:====
* programmid - учебная программа в таблице [[Разработка:storages/programms | programms ]]
* agenum - номер учебного периода, от начала обучения по программе на который назначена дисциплина. Для необязательных дисциплин возможен 0, тогда студент может "взять" дисциплину в любом семестре.
* courseclsid - id по таблице coursecls (таблица пока не предусмотрена), предназначен для объединения однородных дисциплин. Однородность дисциплин может быть четырех уровней (записываются внутри таблицы coursecls):
** 1 - одинаковые дисциплины изучаемые в составе различных учебных программ,
** 2 - разные ступени изучения одной дисциплины,
** 3 - дисциплины, относящиеся к одной науке,
** 4 - категории (общественные, естественные, технические). Сама таблица coursecls пока не реализована, а поле зарезервировано на будущее.
* name - название дисциплины (текстовое поле)
* code - код дисциплины (текстовое поле, необязательное, при указании проверяется уникальность). Если код не указан - то вместо него подставляется id записи.
* mdlcourse - id курса в moodle
* type - тип предмета:
** ''required''- обязательный
** ''recommended'' - рекомендованный
** ''free'' - по выбору
* required - обязательный курс (0/1) На основании этого поля ориентируемся, нужно ли обязательно подписывать или нет, а предыдущий больше информационный. Например, даже обязательный курс, который планируется разделить на подгруппы может не требовать автоматической подписки.
* maxcredit - зачетные единицы трудоемкости (максимальное количество кредитов за курс, ЗЕТ)
* maxduration - максимальная продолжительность курса от начальной подписки (в секундах). Если не установлено - продолжительность неограничена. Учебные потоки всегда завершается автоматически с закрытием учебного периода, к которому они относятся.
* hours - часов всего
* hourstheory - часов лекций (Лек)
* hourspractice - часов практики (Пр)
* eduweeks - количество учебных недель/циклов (каждая соответствует одному циклу в расписании) продолжительности курса, если не указано, учебные процессы наследуют из ages.
* instrlevelid - id уровня компоненты -
** 1 - федеральная,
** 2 - региональная,
** 3 - учебного заведения,
** 4 - кафедры
* gradelevel - уровень оценки
** ''notused'' - оценка не идет в кондуит
** ''discipline'' - дисциплина
** ''coursework'' - курсовая работа
** ''practice'' - практика
** ''finalexam'' - междисциплинарный экзамен
** ''diplom'' - дипломная работа
* scale - диапазон или перечисленные через запятую возможной итоговой оценки, пустая строка если оценка не предусмотрена. Оценка может быть и дробной. Диапазон задается двумя числами через дефис: худшая_оценка_-_лучшая_оценка_. Например 5-1. 5 - самый плохой балл. 1 - самый лучший. Если задается не диапазон, а интервал, то оценки перечисляются через запятую: 5, 4.5, 4, 3.5, 3, 2.5, 2, 1.5, 1.
* mingrade - минимальная (для диапазона) или начальная слева-направа начиная с единицы (для перечисления) оценка, при которой курс считается завершенным. Если не указано, курс считается завершенным при выставлении любой оценки.
* sname - название в источнике/стандарте
* scode - код в источнике/стандарте
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/programmitems | programmitems ]]
* departmentid - структурное подразделение в таблице [[Разработка:storages/departments | departments ]], ответственное за реализацию дисциплины
* about - описание дисциплины
* notice - заметка о дисциплины для внутреннего пользования
* controltypeid - тип итогового контроля по данному курсу
* hoursweek - часов в неделю
* explanatory - пояснительная записка
* gradesyncenabled - разрешать синхронизацию оценок для данной дисциплины
* incjournwithoutgrade - при синхронизации оценок вносить в ведомость на момент ее заполнения студентов не имеющих оценки
* incjournwithunsatisfgrade - при синхронизации оценок вносить в ведомость на момент ее заполнения студентов имеющих неудовлетворительные оценки
* altgradeitem - id из grades_items (если не указано, то при синхронизации оценок берется оценка из итоговой оценки курса, который указан в mdlcourse)
* metasyncon - включена ли синхронизация с метадисциплиной
* metaprogrammitemid - id метадисциплины для синхронизации
* billingtext - цена дисциплины
* billingrules -
* salfactor - поправочный зарплатный коэффициент
* hourslab - часов лабораторных (Лаб)
* hoursind - часов самостоятельной работы слушателя (СРС)
* hourscontrol - часов контроля (Контроль)
* autohours (0/1) - "Автоматически расчитывать количества Часов всего" (галочка рядом с полем "Часов всего"). Если установлена, при сохранении, в поле hours записывается сумма: hourstheory+hourslab+hourspractice+hoursind+hourscontrol
* hoursclassroom - часов аудиторных - поле отображается, но не редактируется. При сохранении автоматически вычисляется как сумма: hourstheory+hourslab+hourspractice
* verificationrequested - запрошено согласование мастер-курса (ожидание проверки)
* coursetemplateversion - версия шаблона курса, соответствующая имени файла с резервной копией
* courselinktype - тип связи с курсом moodle (прямая подписка или клонирование)

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

===='''get_pitem_by_code($code)'''====

Ищет дисциплины по коду дисциплины.

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

===='''get_pitems_list($programmid, $agenum=false, $status = null)'''====

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

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

===='''get_maxagenum($programmid)'''====

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

''Аргументы:''
* $programmid - id учебной программы из таблицы [[Разработка:storages/programms|programms]].
''Возвращаемые значения:''
* false - если не нашлось не одной записи
* 0 - если нашлись только записи с agenum=0, то есть необязательные
* в остальных случаях возвращается целое число - максимальное кол-во дисциплин в данном периоде
''Структура работы:''
По sql-запросу производится поиск максимального значения agenum среди записей с выбранных programmid.

===='''get_gradelevels()'''====

Возвращает список всех возможных уровней оценки

''Возвращаемые значения:''
* array

===='''get_gradelevel_name($value)'''====

Возвращает название уровня оценки по его обозначению

''Аргументы:''
* (str) $value обозначение уровня оценки в БД
''Возвращаемые значения:''
* string

===='''get_types()'''====

Возвращает все возможные типы дисциплины

''Возвращаемые значения:''
* array

===='''get_type_name($value)'''====

Возвращает название типа по его идентификатору в базе

''Аргументы:''
* (str) $value
''Возвращаемые значения:''
* string

===='''is_positive_grade($programmitemid, $grade)'''====

Определяет является ли переданная оценка положительной(достаточной, для продолжения обучения)

''Аргументы:''
* (int) $programmitemid - id предмета, по которому выставляется итоговая оценка
* (str) $grade - выставляемая оценка
''Возвращаемые значения:''
* bool

===='''analyze_grade_scale($pitem, $grade)'''====

Определяет является ли переданная оценка допустимой для шкалы текущего предмета

''Аргументы:''
* (obj) $pitem - объект из таблицы [[Разработка:storages/programmitems | programmitems]]
* (str) $grade - выставляемая оценка
''Возвращаемые значения:''
* bool

===='''is_grade_valid($id, $grade, $scale=null)'''====

Определяет допустима ли переданная оценка для данной дисциплины

''Аргументы:''
* (int) $id - id предмета в таблице [[Разработка:storages/programmitems | programmitems]]
* (str) $grade - выставляемая оценка
* (str) $scale - шкала оценок, если она указывается вручную, по умолчанию null
''Возвращаемые значения:''
* bool

===='''set_status_deleted($id)'''====

Переводит дисциплину в статус "удален"

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

===='''get_hours_sum($programmitemids)'''====

Получить суммарное количество часов и ЗЕТ по нескольким предметам

''Аргументы:''
* (array) $programmitemids - массив id из таблицы programmitems
* (int) $id - id дисциплины
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (object) - или объект с полями:
** ->maxcredit
** ->hours
** ->hourstheory
** ->hourspractice
** ->hoursweek
** ->hourslab
** ->hoursind
** ->hourscontrol
** ->hoursclassroom

===Планы:===

=Права=
{| border="1"
|+ Таблица прав, объявленных данным плагином
! Код права
! Описание
|-
|view
|
|-
|edit
|
|-
|create
|
|-
|delete
|
|-
|use
|
|-
|edit:mdlcourse
|
|-
|view/meta
|
|-
|edit/meta
|
|-
|create/meta
|
|-
|delete/meta
|
|-
|use/meta
|
|-
|edit:verificationrequested
|Отправлять мастер-курсы на проверку
|-
|benotified:edit:coursetemplateversion
|Получать уведомления о результатах проверки мастер-курса
|-
|edit:coursetemplateversion
|Согласовывать (одобрять/отклонять) версию мастер-курса
|-
|benotified:edit:verificationrequested
|Получать уведомления о новых запросах на проверку мастер-курса
|-
|view:mastercourse
|Видеть ссылку на мастер-курс
|}
=События=
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}

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

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|change_mcourse_in_programmitem
|Обязателен. Указывается id дисциплины. В mixedvar необходим параметр mdlcourse.
|'''Только для внутреннего использования системой'''. Находит все активные подписки на дисциплины в указанной дисциплине, после чего каждую из них приостанавливает. Меняет курс Moodle в дисциплине. Возобновляет приостановленные подписки. Посылается из формы смены курса Moodle на странице просмотра дисциплины.
|}

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

=Периодические задания=
{| border="1"
|+ Таблица периодических заданий, которые выполняет этот плагин
! Метод, выполняющий периодическое задание
! Параметры
! Пояснение
! Режим нагрузки
|-
|check_deleted_courses
|Без параметров
|Поиск дисциплин с удаленным курсами, отвязка удаленных курсов от дисциплин
|loan=2
|}

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

2017-12-14T06:25:51Z

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

{{Infobox_Plugin
| name = programmitems
| type = storages
}}
=Таблица в базе данных=
''programmitems'' - элементы учебной программы - учебные дисциплины/предметы.

====Подробный формат полей в таблице:====
* programmid - учебная программа в таблице [[Разработка:storages/programms | programms ]]
* agenum - номер учебного периода, от начала обучения по программе на который назначена дисциплина. Для необязательных дисциплин возможен 0, тогда студент может "взять" дисциплину в любом семестре.
* courseclsid - id по таблице coursecls (таблица пока не предусмотрена), предназначен для объединения однородных дисциплин. Однородность дисциплин может быть четырех уровней (записываются внутри таблицы coursecls):
** 1 - одинаковые дисциплины изучаемые в составе различных учебных программ,
** 2 - разные ступени изучения одной дисциплины,
** 3 - дисциплины, относящиеся к одной науке,
** 4 - категории (общественные, естественные, технические). Сама таблица coursecls пока не реализована, а поле зарезервировано на будущее.
* name - название дисциплины (текстовое поле)
* code - код дисциплины (текстовое поле, необязательное, при указании проверяется уникальность). Если код не указан - то вместо него подставляется id записи.
* mdlcourse - id курса в moodle
* type - тип предмета:
** ''required''- обязательный
** ''recommended'' - рекомендованный
** ''free'' - по выбору
* required - обязательный курс (0/1) На основании этого поля ориентируемся, нужно ли обязательно подписывать или нет, а предыдущий больше информационный. Например, даже обязательный курс, который планируется разделить на подгруппы может не требовать автоматической подписки.
* maxcredit - зачетные единицы трудоемкости (максимальное количество кредитов за курс, ЗЕТ)
* maxduration - максимальная продолжительность курса от начальной подписки (в секундах). Если не установлено - продолжительность неограничена. Учебные потоки всегда завершается автоматически с закрытием учебного периода, к которому они относятся.
* hours - часов всего
* hourstheory - часов лекций (Лек)
* hourspractice - часов практики (Пр)
* eduweeks - количество учебных недель/циклов (каждая соответствует одному циклу в расписании) продолжительности курса, если не указано, учебные процессы наследуют из ages.
* instrlevelid - id уровня компоненты -
** 1 - федеральная,
** 2 - региональная,
** 3 - учебного заведения,
** 4 - кафедры
* gradelevel - уровень оценки
** ''notused'' - оценка не идет в кондуит
** ''discipline'' - дисциплина
** ''coursework'' - курсовая работа
** ''practice'' - практика
** ''finalexam'' - междисциплинарный экзамен
** ''diplom'' - дипломная работа
* scale - диапазон или перечисленные через запятую возможной итоговой оценки, пустая строка если оценка не предусмотрена. Оценка может быть и дробной. Диапазон задается двумя числами через дефис: худшая_оценка_-_лучшая_оценка_. Например 5-1. 5 - самый плохой балл. 1 - самый лучший. Если задается не диапазон, а интервал, то оценки перечисляются через запятую: 5, 4.5, 4, 3.5, 3, 2.5, 2, 1.5, 1.
* mingrade - минимальная (для диапазона) или начальная слева-направа начиная с единицы (для перечисления) оценка, при которой курс считается завершенным. Если не указано, курс считается завершенным при выставлении любой оценки.
* sname - название в источнике/стандарте
* scode - код в источнике/стандарте
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/programmitems | programmitems ]]
* departmentid - структурное подразделение в таблице [[Разработка:storages/departments | departments ]], ответственное за реализацию дисциплины
* about - описание дисциплины
* notice - заметка о дисциплины для внутреннего пользования
* controltypeid - тип итогового контроля по данному курсу
* hoursweek - часов в неделю
* explanatory - пояснительная записка
* gradesyncenabled - разрешать синхронизацию оценок для данной дисциплины
* incjournwithoutgrade - при синхронизации оценок вносить в ведомость на момент ее заполнения студентов не имеющих оценки
* incjournwithunsatisfgrade - при синхронизации оценок вносить в ведомость на момент ее заполнения студентов имеющих неудовлетворительные оценки
* altgradeitem - id из grades_items (если не указано, то при синхронизации оценок берется оценка из итоговой оценки курса, который указан в mdlcourse)
* metasyncon - включена ли синхронизация с метадисциплиной
* metaprogrammitemid - id метадисциплины для синхронизации
* billingtext - цена дисциплины
* billingrules -
* salfactor - поправочный зарплатный коэффициент
* hourslab - часов лабораторных (Лаб)
* hoursind - часов самостоятельной работы слушателя (СРС)
* hourscontrol - часов контроля (Контроль)
* autohours (0/1) - "Автоматически расчитывать количества Часов всего" (галочка рядом с полем "Часов всего"). Если установлена, при сохранении, в поле hours записывается сумма: hourstheory+hourslab+hourspractice+hoursind+hourscontrol
* hoursclassroom - часов аудиторных - поле отображается, но не редактируется. При сохранении автоматически вычисляется как сумма: hourstheory+hourslab+hourspractice
* verificationrequested - запрошено согласование мастер-курса (ожидание проверки)
* coursetemplateversion - версия шаблона курса, соответствующая имени файла с резервной копией
* courselinktype - тип связи с курсом moodle (прямая подписка или клонирование)

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

===='''get_pitem_by_code($code)'''====

Ищет дисциплины по коду дисциплины.

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

===='''get_pitems_list($programmid, $agenum=false, $status = null)'''====

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

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

===='''get_maxagenum($programmid)'''====

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

''Аргументы:''
* $programmid - id учебной программы из таблицы [[Разработка:storages/programms|programms]].
''Возвращаемые значения:''
* false - если не нашлось не одной записи
* 0 - если нашлись только записи с agenum=0, то есть необязательные
* в остальных случаях возвращается целое число - максимальное кол-во дисциплин в данном периоде
''Структура работы:''
По sql-запросу производится поиск максимального значения agenum среди записей с выбранных programmid.

===='''get_gradelevels()'''====

Возвращает список всех возможных уровней оценки

''Возвращаемые значения:''
* array

===='''get_gradelevel_name($value)'''====

Возвращает название уровня оценки по его обозначению

''Аргументы:''
* (str) $value обозначение уровня оценки в БД
''Возвращаемые значения:''
* string

===='''get_types()'''====

Возвращает все возможные типы дисциплины

''Возвращаемые значения:''
* array

===='''get_type_name($value)'''====

Возвращает название типа по его идентификатору в базе

''Аргументы:''
* (str) $value
''Возвращаемые значения:''
* string

===='''is_positive_grade($programmitemid, $grade)'''====

Определяет является ли переданная оценка положительной(достаточной, для продолжения обучения)

''Аргументы:''
* (int) $programmitemid - id предмета, по которому выставляется итоговая оценка
* (str) $grade - выставляемая оценка
''Возвращаемые значения:''
* bool

===='''analyze_grade_scale($pitem, $grade)'''====

Определяет является ли переданная оценка допустимой для шкалы текущего предмета

''Аргументы:''
* (obj) $pitem - объект из таблицы [[Разработка:storages/programmitems | programmitems]]
* (str) $grade - выставляемая оценка
''Возвращаемые значения:''
* bool

===='''is_grade_valid($id, $grade, $scale=null)'''====

Определяет допустима ли переданная оценка для данной дисциплины

''Аргументы:''
* (int) $id - id предмета в таблице [[Разработка:storages/programmitems | programmitems]]
* (str) $grade - выставляемая оценка
* (str) $scale - шкала оценок, если она указывается вручную, по умолчанию null
''Возвращаемые значения:''
* bool

===='''set_status_deleted($id)'''====

Переводит дисциплину в статус "удален"

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

===='''get_hours_sum($programmitemids)'''====

Получить суммарное количество часов и ЗЕТ по нескольким предметам

''Аргументы:''
* (array) $programmitemids - массив id из таблицы programmitems
* (int) $id - id дисциплины
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (object) - или объект с полями:
** ->maxcredit
** ->hours
** ->hourstheory
** ->hourspractice
** ->hoursweek
** ->hourslab
** ->hoursind
** ->hourscontrol
** ->hoursclassroom

===Планы:===

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

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|change_mcourse_in_programmitem
|Обязателен. Указывается id дисциплины. В mixedvar необходим параметр mdlcourse.
|'''Только для внутреннего использования системой'''. Находит все активные подписки на дисциплины в указанной дисциплине, после чего каждую из них приостанавливает. Меняет курс Moodle в дисциплине. Возобновляет приостановленные подписки. Посылается из формы смены курса Moodle на странице просмотра дисциплины.
|}

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

=Периодические задания=
{| border="1"
|+ Таблица периодических заданий, которые выполняет этот плагин
! Метод, выполняющий периодическое задание
! Параметры
! Пояснение
! Режим нагрузки
|-
|check_deleted_courses
|Без параметров
|Поиск дисциплин с удаленным курсами, отвязка удаленных курсов от дисциплин
|loan=2
|}

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

2017-12-14T06:15:08Z

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

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

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

====Подробный формат полей в таблице:====
* ageid - учебный период в таблице [[Разработка:storages/ages | ages ]]
* programmitemid - дисциплина в таблице [[Разработка:storages/programmitems | programmitems ]]
* [больше не используется] teacherid - id преподавателя в таблице [[Разработка:storages/persons | persons ]]. После создания поля appointmentid стало ненужным. Все старые обращения к этому полю будут переделаны на обращения к appointmentid, при создании новых обращений они должны обращаться к appointmentid. После переработки старых методов данное поле удалиться.
* departmentid - подразделение, которому принадлежит учебный процесс в таблице [[Разработка:storages/departments | departments ]]
* appointmentid - id назначения на должность в таблице [[Разработка:storages/appointments | appointments ]].
* mdlgroup - id группы moodle, соответствующей учебному потоку
* eduweeks - количество учебных недель/циклов (каждая соответствует одному циклу в расписании) продолжительности курса, по-умолчанию берется из programmitems, если там не указано - из ages. Нужны для подсчета часов при составлении расписания.
* begindate - дата и время, когда учебный процесс был впервые переведен в состояние "идет обучение" по [http://ru.wikipedia.org/wiki/UTC UTC]
* enddate - дата и время окончания по [http://ru.wikipedia.org/wiki/UTC UTC], когда учебный процесс был в последний раз выведен из состояния "идет обучение"
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/cstreams | cstreams ]]
* hours - часов всего
* hoursweek - часов в неделю
* hoursweekinternally - часов в неделю очно
* name - имя предмето-потока
* hoursweekdistance - количество часов в неделю дистанционно
* explanatory - пояснительная записка
* lastgradesync - дата последней синхронизации оценок
* salfactor - поправочный зарплатный коэффициент
* substsalfactor - замещающий поправочный коэффициент для учебного процесса. По умолчанию 0.
* mdlcourse - идентификатор курса moodle, используется в режиме клонирования мастер-курса, утвержденного на уровне дисциплины

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

===='''insert($dataobject, $id = NULL, $quiet=false)'''====

Вставляет запись в таблицу плагина.

''Аргументы:''
* dataobject(object) - данные для записи в таблицу.
* $id = NULL
* quiet(bool) - генерировать или нет события, по умолчанию - нет(false).
''Возвращаемые значения:''
* (int) - id вставленной записи.
* (bool) - false, если операция не удалась.

===='''delete($id,$quiet=false)'''====

Удаляет запись из таблицы плагина с указанным id.

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

===='''update($dataobject, $id = NULL, $quiet=false)'''====

Обновляет запись в таблице плагина данными из объекта. Отсутствующие в объекте записи не изменяются. Если id передан, то обновляется запись с переданным id. Если id не передан обновляется запись с id, который передан в объекте.

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

===='''get_teacher_cstream($id, $status = "active")'''====

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

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

===='''get_department_cstream($id, $status = "active")'''====

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

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

===='''get_age_cstream($id, $status = "active")'''====

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

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

===='''get_programmitem_cstream($id, $status = "active")'''====

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

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

===='''get_agroup_cstream($id)'''====

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

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

===='''get_agroup_agenum_cstreams($agroupid, $ageid)'''====

Получить Список программ по академической группе, и периоду.

''Аргументы:''
* $agroupid(int) - id академической группы в таблице [[Разработка:storages/agroups | agroups ]].
* $ageid(int) - id учебного периода в таблице [[Разработка:storages/ages | ages ]].
''Возвращаемые значения:''
* (array) - массив записей из этой таблицы, если они есть.
* (bool) - false, если ничего не нашлось.

===='''get_agroup_status_cstreams($agroupid, $status)'''====
Получить Список программ по академической группе, и статусу.

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

===='''get_numberof_cstreams($select)'''====

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

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

===='''get_prog_age_cstreams($pitemid, $ageid, $status=null)'''====

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

''Аргументы:''
* $programmid(object) - id учебной программы в таблице [[Разработка:storages/programms | programms ]].
* $ageid(object) - id периода в таблице [[Разработка:storages/ages | ages ]].
* $status(string) - статус учебного потока.
''Возвращаемые значения:''
* (array) - массив записей из базы.
* (bool) - false, если произошла ошибка.

===='''get_programm_age_cstreams($programmid, $ageid = null, $agenum = null, $dpid = null)'''====

Получает все учебные потоки программы.

''Аргументы:''
* $programmid(int) - id учебной программы в таблице [[Разработка:storages/programms | programms ]].
* $ageid(int) - id периода в таблице [[Разработка:storages/ages | ages ]], по умолчанию нет.
* $agenum - номер паралели в таблице [[Разработка:storages/programmitems | programmitems ]], по умолчанию нет(null).
* $dpid - id подразделения в таблице [[Разработка:storages/departments | departments ]], по умолчанию - нет(null).
''Возвращаемые значения:''
* (array) - массив потоков.
* (bool) - false, если потоки не найдены.

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

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

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

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

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

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

===='''get_agroup_ageids($agroupid)'''====

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

''Аргументы:''
* @param int $agroupid - id академической группы в таблице [[Разработка:storages/agroups | agroups ]].
''Возвращаемые значения:''
* (array) - индексированный массив с уникальными значениями id периодов всех потоков.
* (bool) - false, если ничего не найдено.

===='''create_cstreams_for_agroup($agroupid, $ageid, $departmentid, $datebegin, $enddate=null)'''====

Создаёт учебные потоки для группы.

''Аргументы:''
* $agroupid(int) - id акадкмическуой группы (класса) в таблице [[Разработка:storages/agroups | agroups ]].
* $ageid(int) - id учебного периода в таблице [[Разработка:storages/ages | ages ]].
* $departmentid(int) - id учебного подразделения в таблице [[Разработка:storages/departments | departments ]].
* $datebegin(int) - дата начала обучения в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $enddate(int) - дата окончания обучения в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime], по умолчанию - нет(null).
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''create_cstreams_for_programm($programmid, $ageid, $agenum, $departmentid, $datebegin, $enddate=null)'''====

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

''Аргументы:''
* $programmid(int) - id учебной программы в таблице [[Разработка:storages/programms | programms ]].
* $ageid(int) - id учебного периода в таблице [[Разработка:storages/ages | ages ]].
* $agenum(int) - номер параллели, для которой создается подписка.
* $departmentid(int) - id учебного подразделения в таблице [[Разработка:storages/departments | departments ]].
* $datebegin(int) - дата начала обучения в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''enrol_agroup_on_cstreams($agroupid, $ageid)'''====

Подписывает группу на список потоков.

''Аргументы:''
* $agroupid(int) - id группы в таблице [[Разработка:storages/agroups | agroups ]].
* $ageid(int) - id учебного периода в таблице [[Разработка:storages/ages | ages ]].
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''set_status_complete($id)'''====

Переводит поток в статус "завершен".

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

===='''get_cstreams_on_parametres($programmitemid, $teacherid = 0, $mycstrems = false, $completecstrems = false)'''====

Возвращает список потоков по параметрам.

''Аргументы:''
* $programmitemid(int) - id дисциплины в таблице [[Разработка:storages/programmitems | programmitems ]].
* $teacherid(int) - id учителя в таблице [[Разработка:storages/persons | persons ]], по умолчанию - нет(0).
* $mycstrems(bool) - показать ли потоки текущего пользователя, по умолчанию - нет(false).
* $completecstrems(bool) - показать ли завершенные потоки, по умолчанию - нет(false).
''Возвращаемые значения:''
* (array).

===='''get_short_name($cstreamid)'''====

Возвращает короткое имя потока.

''Аргументы:''
* $cstreamid(int) - id потока в таблице плагина.
''Возвращаемые значения:''
* (string)
* (bool) - false, если возникли ошибки.

===='''enrol_students_on_cstream($cstream, $programmsbcids)'''====

Подписывает учеников на поток.

''Аргументы:''
* $cstream(object) - объект из таблицы плагина.
* $programmsbcids(object) - массив, состоящий из id подписок на программы в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''unenrol_students_from_cstream($cstream, $programmsbcids)'''====

Исключает учеников из потока

''Аргументы:''
* @param object $cstream - объект из таблицы плагина.
* @param array $programmsbcids - массив, состоящий из id подписок на программы в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''enrol_student_on_cstream($cstream, $programmsbcid)'''====

Подписывает одного ученика на поток.

''Аргументы:''
* $cstream(object) - объект из таблицы плагина.
* $programmsbcid(int) - id подписки ученика на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''unenrol_student_from_cstream($cstream, $programmsbcid)'''====

Исключает одного ученика из потока.

''Аргументы:''
* $cstream(object) - объект из таблицы плагина.
* $programmsbcid(int) - id подписки ученика на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
''Возвращаемые значения:''
* (bool) - true, если всё получилось, и false, если возникли ошибки.

===='''get_cstreamname($eventcode, $mixedvar, $cstream = false)'''====

В зависимости от произошедших событий (значение $eventcode) сохраняет информацию о новом (insert), и новом, и старом (update) либо только старом (delete) имени предмето-потока в БД.

''Аргументы:''
* $eventcode - произошедшее событие.
* $mixedvar(array) - id нового и старого потоков в таблице плагина.
* $cstream - данные пришли из таблицы плагина? , по умолчанию - нет(false).
''Возвращаемые значения:''
* (bool) - true, если запись прошла успешно, и false - в случае ошибок.

===='''get_old_sync_cstreams($limit)'''====

Возвращает id указанного количества активных самых давно-синхронизированных cstream`ов

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

===Планы:===
====Дополнительные методы:====
* Получить список учебных процессов для данного ученика с учетом персональной подписки и академических групп (второй параметр - статус, по умолчанию - "идет").

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

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|resync_programmitem_cstreams
|Обязателен. Указывается id дисциплины из таблицы [[Разработка:storages/programmitems | programmitems ]]
|Находит все активные учебные процессы в указанной дисциплине, после чего каждого из них приостанавливает и заново возобновляет. Необходимо для записи учащихся на курс Moodle, если курс Moodle был присвоен дисциплине во время учебного процесса.
|-
|programmitem_cpass_to_suspend
|Обязателен. Указывается id дисциплины из таблицы [[Разработка:storages/programmitems | programmitems ]]
|Находит все активные учебные процессы в указанной дисциплине, после чего каждого из них приостанавливает. Необходимо для отписывания учащихся с курса Moodle, если необходимо сменить курс Moodle в дисциплине. Работает в паре с '''programmitem_cpass_to_active'''.
|-
|programmitem_cpass_to_active
|Обязателен. Указывается id дисциплины из таблицы [[Разработка:storages/programmitems | programmitems ]]
|Находит все приостановленные учебные процессы в указанной дисциплине, после чего каждого из них активирует. Необходимо для записи учащихся на курс Moodle после смены курса Moodle в дисциплине. Работает в паре с '''programmitem_cpass_to_suspend'''.
|-
|resync_department_cstreams
|Обязателен. Указывается id подразделения из таблицы [[Разработка:storages/departments | departments ]]
|Находит все активные учебные процессы в указанном подразделении, после чего каждого из них приостанавливает и заново возобновляет. Необходимо для записи учащихся на курс Moodle, если курс Moodle был присвоен дисциплинам во время учебного процесса.
|}

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

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

2017-12-14T06:08:28Z

DShtolin: /* Дополнительные методы: */

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

===Таблица в базе данных===
''acl'' - справочник полномочий. Подробные правила работы с полномочиями описаны в разделе: [[Разработка:Управление_доступом | Управление доступом]].

====Подробный формат полей в таблице:====
* id - номер записи
* code - код полномочия (текстовое, необязательное, при указании кода проверяется уникальность)
* plugintype - тип плагина (im, storage, workflow, sync, modlib)
* plugincode - код плагина
* objectid - id объекта к которому дается доступ (или 0 если доступ дается ко всем объектам)
* aclwarrantid - id записи из таблица [[Разработка:storages/aclwarrants | aclwarrants ]]

==== Стандартные полномочия для хранилищ и рабочих процессов ====
В каждом плагине storage для определения уровня доступа к объекту следует использовать стандартные обозначения:

* view - право просматривать объект из таблицы
* edit - право редактировать объект из таблицы
* create - право создавать новый объект в таблице
* delete - право удалять объект из таблицы
* viewbase - право просматривать сокращенную информацию по объекту (например при просмотре списка записей)
* viewextended - право просматривать расширенную информацию по объекту (все поля)
* edit:имя_поля - право редактировать отдельное поле
* view:имя_поля - право просматривать отдельное поле
* changestatus - вообще изменять статус (с любого на любой)
* changestatus:from:статус - изменять статус с указанного
* changestatus:to:статус - изменять статус на указанный

Также при создании права можно указать отношение, которое указанный пользователь имеет к объекту, на который назначены права.
Отношение указывается через прямой слеш "/".

Примеры:
* 'edit/owner' - право редактировать объект для владельца.
* 'changestatus:all/owner' - право на любое изменение статуса для владельца объекта

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

===='''get_persons_acl_by_code($plugintype, $plugincode, $aclcode, $departmentid = 0, $objectid = 0)'''====

Получить список персон имеющих указанное полномочие

''Аргументы:''
* int $plugintype - тип плагина деканата
* int $plugincode - код плагина деканата
* int $aclcode - код права
* int $departmentid - id подразделения
* int $objectid - id объекта
''Возвращает значение:''
* array|false - массив записей из БД, содержащих идентификатор пользователя и подразделения или false в случае ошибки

[[Категория:Управление доступом]]

Категория:Плагины storages

2017-12-01T09:58:16Z

DShtolin:

[[Категория:Плагины]]
Плагины для работы с хранилищами (БД)
Помимо запросов в базу данных должны реализовывать логику.
В отдельных случаях, когда имеется сложная модель предметной области (например, журнал), задействующая много справочников, будет сложно сделать декомпозицию методов справочников, не сформировав слишком много перекрестных зависимостей. В таком случае бизнес-логика выносится в отдельный modlib

Категория:Плагины im

2017-12-01T09:45:16Z

DShtolin:

[[Категория:Плагины]]
Плагины интерфейсов. Плагины этого типа должны заниматься только отображением и первичной обработкой форм

Категория:Плагины modlibs

2017-12-01T09:27:39Z

DShtolin:

[[Категория:Плагины]]
Плагины modlib подразделяются на три типа:
* Библиотеки - считаются продолжением того плагина, который их вызывает (тот же ama к ним относится). Он не нарушает архитектуру того, что внешние синхронизации должны быть через sync, потому что просто линкуется к модулю sync, который его вызывает и не имеет собственных данных, настроек, не инициализирует сам никаких действий. Библиотеки виджетов имеют тот же принцип - они расширяют плагины im, а не действуют самостоятельно
* Системные сервисы. В FDO микроядерная архитектура, поэтому любые системные расширения включаются не в ядро, а в modlib: расширенные базовые классы, методы отправки уведомлений, методы логирования (если не в базу, а в файлы логов), методы сохранения сообщений об ошибках, методы отправки уведомлений пользователю.
* Контроллеры для модели MVC: если у нас сложная модель предметной области (например, журнал), задействующая много справочников, нам будет сложно сделать декомпозицию методов справочников, не сформировав слишком много перекрестных зависимостей, но и в im/journal мы не должны класть методы для работы с данными, im занимается только отображением и первичной обработкой форм, поэтому мы выносим контроллер в отдельный modlib/journal или вроде того.

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

2017-11-30T10:15:42Z

DShtolin: /* Рейтинг */

{{Infobox_Plugin
| name = achievements
| 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|Личный кабинет пользователя портфолио]]

== API ==

===== delete_achievement =====

Удаление шаблона вместе со всеми пользовательскими достижениями, связанными с этим шаблоном

''параметры:''
* $id - ID шаблона
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_achievementin =====

Удаление пользовательского достижения

''параметры:''
* $id - ID достижения
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления достижения

===== delete_achievementins_by_achievementid =====

Удаление пользовательских достижений по ID шаблона

''параметры:''
* $id - ID шаблона для удаления его пользовательских достижений
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* $errors - массив ошибок, полученных во время удаления достижений

===== delete_achievements_by_categoryid =====

Удаление шаблонов по ID раздела

''параметры:''
* $id - ID раздела для удаления его шаблонов
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_category =====

Удаление раздела вместе дочерними разделами, шаблонами, а также пользовательскими достижениями, связанными с этими шаблонами

''параметры:''
* $id - ID раздела для удаления
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления раздела

===== get_achievementcatstable =====

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

''параметры:''
* $options - массив параметров для переопределения значений
* ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementins =====

Получение пользовательских достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['departmentid'] - ID подразделения
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementinstable =====

Сформировать таблицу пользовательских достижений

''параметры:''
* $list - массив пользовательских достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки
** ['limitnum'] - Число достижений в таблице
** ['limitfrom'] - Смещение

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementstable =====

Получить таблицу управления шаблонами достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_clear_myachievementstable =====

Получить таблицу достижений пользователя

''параметры:''
* $personid - ID персоны
* $options - массив дополнительных параметров
** ['limitnum'] - Число выводимых записей

''возвращаемые значения:''
* HTML код таблицы

===== get_moderation_data =====

Получить список персон, у которых есть достижения, требующие модерации

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* массив с данными по пользователям. В качестве ключей передаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений

===== get_moderation_table =====

Получить таблицу достижений, требующих модерации

''параметры:''
* $personachievements - Данные пользователей. В качестве ключей ожидаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_my_rating_block =====

Получить блок рейтинга пользователя

''параметры:''
* $id - ID целевого пользователя или текущего, если NULL
* $addvars - Массив GET-параметров для ссылки

''возвращаемые значения:''
* HTML-код блока

===== get_ratingtable =====

Получить таблицу рейтинга

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров,
** ['page'] - Страница,
** ['limit'] - Число записей на странице

''возвращаемые значения:''
* HTML код таблицы

===== get_user_info =====

Получить информацию о пользователе

''параметры:''
* $personid - ID персоны
* $addvars - массив GET-параметров с идентификатором подразделения

''возвращаемые значения:''
* HTML код с информацией о пользователе

===== get_userrating_info =====

Получить информацию о рейтинге пользователя

''параметры:''
* $personid - опционально, ID персоны
* $achievementids - опционально, ID шаблонов достижения или массив шаблонов, по которым будет строиться рейтинг

''возвращаемые значения:''
* Объект с информацией о рейтинге пользователя

===== points_format =====

Форматирование значения рейтинга

''параметры:''
* $points - Значение рейтинга пользователя

''возвращаемые значения:''
* Отформатированное число

Разработка:sync/skills

2017-11-30T10:04:10Z

DShtolin:

{{Infobox_Plugin
| name = skills
| type = sync
}}

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

== API ==

=== get_path ===
Получение пути для достижения целевых компетенций

=== user_get_own_courses_id ===
Получение идентификаторов доступных пользователю курсов

=== user_get_target_courses_id ===
Получение идентификаторов целевых курсов пользователя

=== user_get_target_skills ===
Получение списка целевых компетенций пользователя

=== user_get_own_skills ===
Получение списка имеющихся у пользователя компетенций

=== user_target_skills_form ===
Отобразить блок назначения целевых компетенций пользователя

=== course_set_user_skills ===
Назначить компетенции курса пользователю

=== course_provide_skills_form ===
Отобразить блок назначения предоставляемых компетенций курса

=== course_depend_skills_form ===
Отобразить блок назначения требуемых компетенций курса

=== linkform ===
Отобразить блок назначения компетенций

Разработка:sync/skills

2017-11-30T09:41:14Z

DShtolin: Новая страница: «{{Infobox_Plugin | name = skills | type = sync }} == API == === get_path === Получение пути для достижения целевых компете...»

{{Infobox_Plugin
| name = skills
| type = sync
}}

== API ==

=== get_path ===
Получение пути для достижения целевых компетенций

=== user_get_own_courses_id ===
Получение идентификаторов доступных пользователю курсов

=== user_get_target_courses_id ===
Получение идентификаторов целевых курсов пользователя

=== user_get_target_skills ===
Получение списка целевых компетенций пользователя

=== user_get_own_skills ===
Получение списка имеющихся у пользователя компетенций

=== user_target_skills_form ===
Отобразить блок назначения целевых компетенций пользователя

=== course_set_user_skills ===
Назначить компетенции курса пользователю

=== course_provide_skills_form ===
Отобразить блок назначения предоставляемых компетенций курса

=== course_depend_skills_form ===
Отобразить блок назначения требуемых компетенций курса

=== linkform ===
Отобразить блок назначения компетенций

Разработка:sync/mreports

2017-11-30T09:15:09Z

DShtolin: Новая страница: «{{Infobox_Plugin | name = mreports | type = sync }} Сбор информации из Moodle для отчетов Отчеты, требующие получен...»

{{Infobox_Plugin
| name = mreports
| type = sync
}}

Сбор информации из Moodle для отчетов

Отчеты, требующие получения информации из Moodle оформляются согласно общим правилам формирования отчетов
[[Разработка:storages/reports]]

== Список отчетов, размещенных в плагине ==
=== studentfull ===
Полный отчет о деятельности ученика

=== studentshort ===
Краткий отчет о деятельности ученика

=== teacherfull ===
Полный отчет о деятельности учителя

=== teachershort ===
Краткий отчет о деятельности учителя

Разработка:sync/minfo

2017-11-30T08:26:02Z

DShtolin: Новая страница: «{{Infobox_Plugin | name = minfo | type = sync }} Получение информации из moodle == API == === get_course === Получить объект к...»

{{Infobox_Plugin
| name = minfo
| type = sync
}}

Получение информации из moodle

== API ==

=== get_course ===
Получить объект курса moodle по его id

=== get_course_link ===
Получить ссылку на курс moodle

=== course_exists_quiet ===
Аккуратно проверить существование курса в moodle, не создавая ошибок print_error

Разработка:sync/messager

2017-11-30T08:23:23Z

DShtolin: Новая страница: «{{Infobox_Plugin | name = messager | type = sync }} Плагин отправки сообщений ==Перехватываемые события== {| border="1" ...»

{{Infobox_Plugin
| name = messager
| type = sync
}}
Плагин отправки сообщений
==Перехватываемые события==
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Пояснение
|-
| im
| agroups
| send_message
| Событие отправки сообщения, результатом обработки которого является отправка сообщения
с текстом $mixedvar['message'] пользователю с идентификатором переданным в id
|}

Разработка:sync/import

2017-11-30T08:12:29Z

DShtolin: Новая страница: «{{Infobox_Plugin | name = import | type = sync }} Импорт данных в Электронный Деканат == API == === import_csv === Импорт д...»

{{Infobox_Plugin
| name = import
| type = sync
}}

Импорт данных в Электронный Деканат

== API ==

=== import_csv ===
Импорт данных в электронный деканат из csv-файла

=== import ===
Импорт данных в электронный деканат из файла
* Производит автоматическое определение формата и анализ полей в файле
* По результатам анализа передает управление индивидуальному методу обработки
* При критических ошибках выбрасывает исключение и возвращает falsе

=== clean_importfiles_directory ===
Процесс очистки устаревших файлов в папке импорта

=== save_importfile ===
Сохранить файл импорта

=== get_importfile_path ===
Получить путь до файла импорта

Разработка:sync/achievements

2017-11-30T08:03:13Z

DShtolin: Новая страница: «{{Infobox_Plugin | name = achievements | type = sync }} Синхронизация файлов достижений портфолио с плагинами пла...»

{{Infobox_Plugin
| name = achievements
| type = sync
}}

Синхронизация файлов достижений портфолио с плагинами плагиаризма

== API ==
=== get_plagiarism_plugins_code ===
получение кодов плагинов плагиаризма, доступных в текущем подразделении

=== get_plagiarism_plugin_name ===
получение локализованного имени плагина плагиаризма

=== plagiarism_add_to_index_file ===
добавление файла в индекс указанного плагина плагиаризма

=== add_text_to_apru_queue ===
создание файлов, содержащих текст задания и сохранение их очередь на отправку в Антиплагиат

=== process_add_to_apru_index ===
добавление задания в индекс антиплагиата

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

2017-04-21T11:56:02Z

DShtolin: /* Мое портфолио */

{{Infobox_Plugin
| name = achievements
| 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 - system_moderation_enabled.
В соответствии с фильтром (если доступен), в данном интерфейсе можно выбрать пользователей, у которых имеются достижения, требующие модерации. Список пользователей с указанием количества требующих модерации достижений, будет отображено в таблице с результатами фильтрации.
Для доступа к интерфейсу модерации у пользователя должно быть право im - achievements - moderate.
Для модерации самих достижений (процедура может быть осуществлена не только через этот интерфейс) у пользователя должно быть право im - achievements - achievementins/moderate.
[[Изображение:Selection 017.png||900px|center|]]
=== Мое портфолио ===
Данный интерфейс предназначен для наполнения пользовательского портфолио достижениями и просмотра достижений пользователя.
По умолчанию интерфейс отображает достижения пользователя, который в данный момент авторизован в системе, но он же может отобразить достижения другого пользователя, если передан параметр с идентификатором персоны деканата “personid”. Подобные ссылки на портфолио других пользователей доступны в рейтинге.
В интерфейсе будет отображена информация о пользователе, настроенная ранее в инструменте “Блок информации о пользователе”.
Чуть ниже - информация о рейтинге (количество баллов, место в рейтинге), сгруппированная по разделам достижений и ссылки на рейтинг.
Далее - форма добавления достижений и просмотр добавленных достижений с возможностью их фильтрации по разделу/шаблону, баллам и статусу.
Добавленные достижения, при наличии соответствующих прав, можно комментировать. Для комментирования необходимо в колонке "действия" рядом с достижением кликнуть по иконке "комментарии". На открывшейся странице будет доступна стандартная форма комментирования электронного деканата с возможностью добавления новых комментариев, редактирования и удаления своих собственных комментариев, просмотра чужих комментариев.
[[Изображение:Selection 018.png||900px|center|]]

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

== API ==

===== delete_achievement =====

Удаление шаблона вместе со всеми пользовательскими достижениями, связанными с этим шаблоном

''параметры:''
* $id - ID шаблона
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_achievementin =====

Удаление пользовательского достижения

''параметры:''
* $id - ID достижения
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления достижения

===== delete_achievementins_by_achievementid =====

Удаление пользовательских достижений по ID шаблона

''параметры:''
* $id - ID шаблона для удаления его пользовательских достижений
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* $errors - массив ошибок, полученных во время удаления достижений

===== delete_achievements_by_categoryid =====

Удаление шаблонов по ID раздела

''параметры:''
* $id - ID раздела для удаления его шаблонов
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_category =====

Удаление раздела вместе дочерними разделами, шаблонами, а также пользовательскими достижениями, связанными с этими шаблонами

''параметры:''
* $id - ID раздела для удаления
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления раздела

===== get_achievementcatstable =====

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

''параметры:''
* $options - массив параметров для переопределения значений
* ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementins =====

Получение пользовательских достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['departmentid'] - ID подразделения
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementinstable =====

Сформировать таблицу пользовательских достижений

''параметры:''
* $list - массив пользовательских достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки
** ['limitnum'] - Число достижений в таблице
** ['limitfrom'] - Смещение

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementstable =====

Получить таблицу управления шаблонами достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_clear_myachievementstable =====

Получить таблицу достижений пользователя

''параметры:''
* $personid - ID персоны
* $options - массив дополнительных параметров
** ['limitnum'] - Число выводимых записей

''возвращаемые значения:''
* HTML код таблицы

===== get_moderation_data =====

Получить список персон, у которых есть достижения, требующие модерации

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* массив с данными по пользователям. В качестве ключей передаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений

===== get_moderation_table =====

Получить таблицу достижений, требующих модерации

''параметры:''
* $personachievements - Данные пользователей. В качестве ключей ожидаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_my_rating_block =====

Получить блок рейтинга пользователя

''параметры:''
* $id - ID целевого пользователя или текущего, если NULL
* $addvars - Массив GET-параметров для ссылки

''возвращаемые значения:''
* HTML-код блока

===== get_ratingtable =====

Получить таблицу рейтинга

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров,
** ['page'] - Страница,
** ['limit'] - Число записей на странице

''возвращаемые значения:''
* HTML код таблицы

===== get_user_info =====

Получить информацию о пользователе

''параметры:''
* $personid - ID персоны
* $addvars - массив GET-параметров с идентификатором подразделения

''возвращаемые значения:''
* HTML код с информацией о пользователе

===== get_userrating_info =====

Получить информацию о рейтинге пользователя

''параметры:''
* $personid - опционально, ID персоны
* $achievementids - опционально, ID шаблонов достижения или массив шаблонов, по которым будет строиться рейтинг

''возвращаемые значения:''
* Объект с информацией о рейтинге пользователя

===== points_format =====

Форматирование значения рейтинга

''параметры:''
* $points - Значение рейтинга пользователя

''возвращаемые значения:''
* Отформатированное число

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

2017-04-10T10:42:22Z

DShtolin: /* Фильтрация пользователей */

{{Infobox_Plugin
| name = achievements
| 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 - system_moderation_enabled.
В соответствии с фильтром (если доступен), в данном интерфейсе можно выбрать пользователей, у которых имеются достижения, требующие модерации. Список пользователей с указанием количества требующих модерации достижений, будет отображено в таблице с результатами фильтрации.
Для доступа к интерфейсу модерации у пользователя должно быть право im - achievements - moderate.
Для модерации самих достижений (процедура может быть осуществлена не только через этот интерфейс) у пользователя должно быть право im - achievements - achievementins/moderate.
[[Изображение:Selection 017.png||900px|center|]]
=== Мое портфолио ===
Данный интерфейс предназначен для наполнения пользовательского портфолио достижениями и просмотра достижений пользователя.
По умолчанию интерфейс отображает достижения пользователя, который в данный момент авторизован в системе, но он же может отобразить достижения другого пользователя, если передан параметр с идентификатором персоны деканата “personid”. Подобные ссылки на портфолио других пользователей доступны в рейтинге.
В интерфейсе будет отображена информация о пользователе, настроенная ранее в инструменте “Блок информации о пользователе”.
Чуть ниже - информация о рейтинге (количество баллов, место в рейтинге) и ссылка на рейтинг.
Далее - форма добавления достижений и просмотр добавленных достижений с возможностью их фильтрации по разделу/шаблону, баллам и статусу.
Добавленные достижения, при наличии соответствующих прав, можно комментировать. Для комментирования необходимо в колонке "действия" рядом с достижением кликнуть по иконке "комментарии". На открывшейся странице будет доступна стандартная форма комментирования электронного деканата с возможностью добавления новых комментариев, редактирования и удаления своих собственных комментариев, просмотра чужих комментариев.
[[Изображение:Selection 018.png||900px|center|]]
=== Рейтинг ===
Страница рейтинга по умолчанию отображает рейтинг по разделу достижений, указанный в настройках подразделения, в котором расположено редактируемое портфолио. Требуемая настройка: storage - achievementcats - default_achievementcat. Если раздел, указанный в настройке не доступен, будет предложен выбор раздела.
В начале страницы отображается форма фильтрации пользователей, участвующих в рейтинге, по полям, настроенным в описанном выше инструменте “Фильтрация пользователей”.
Ниже отображается таблица пользователей с указанием места в рейтинге и набранных баллов.

== API ==

===== delete_achievement =====

Удаление шаблона вместе со всеми пользовательскими достижениями, связанными с этим шаблоном

''параметры:''
* $id - ID шаблона
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_achievementin =====

Удаление пользовательского достижения

''параметры:''
* $id - ID достижения
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления достижения

===== delete_achievementins_by_achievementid =====

Удаление пользовательских достижений по ID шаблона

''параметры:''
* $id - ID шаблона для удаления его пользовательских достижений
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* $errors - массив ошибок, полученных во время удаления достижений

===== delete_achievements_by_categoryid =====

Удаление шаблонов по ID раздела

''параметры:''
* $id - ID раздела для удаления его шаблонов
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_category =====

Удаление раздела вместе дочерними разделами, шаблонами, а также пользовательскими достижениями, связанными с этими шаблонами

''параметры:''
* $id - ID раздела для удаления
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления раздела

===== get_achievementcatstable =====

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

''параметры:''
* $options - массив параметров для переопределения значений
* ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementins =====

Получение пользовательских достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['departmentid'] - ID подразделения
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementinstable =====

Сформировать таблицу пользовательских достижений

''параметры:''
* $list - массив пользовательских достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки
** ['limitnum'] - Число достижений в таблице
** ['limitfrom'] - Смещение

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementstable =====

Получить таблицу управления шаблонами достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_clear_myachievementstable =====

Получить таблицу достижений пользователя

''параметры:''
* $personid - ID персоны
* $options - массив дополнительных параметров
** ['limitnum'] - Число выводимых записей

''возвращаемые значения:''
* HTML код таблицы

===== get_moderation_data =====

Получить список персон, у которых есть достижения, требующие модерации

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* массив с данными по пользователям. В качестве ключей передаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений

===== get_moderation_table =====

Получить таблицу достижений, требующих модерации

''параметры:''
* $personachievements - Данные пользователей. В качестве ключей ожидаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_my_rating_block =====

Получить блок рейтинга пользователя

''параметры:''
* $id - ID целевого пользователя или текущего, если NULL
* $addvars - Массив GET-параметров для ссылки

''возвращаемые значения:''
* HTML-код блока

===== get_ratingtable =====

Получить таблицу рейтинга

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров,
** ['page'] - Страница,
** ['limit'] - Число записей на странице

''возвращаемые значения:''
* HTML код таблицы

===== get_user_info =====

Получить информацию о пользователе

''параметры:''
* $personid - ID персоны
* $addvars - массив GET-параметров с идентификатором подразделения

''возвращаемые значения:''
* HTML код с информацией о пользователе

===== get_userrating_info =====

Получить информацию о рейтинге пользователя

''параметры:''
* $personid - опционально, ID персоны
* $achievementids - опционально, ID шаблонов достижения или массив шаблонов, по которым будет строиться рейтинг

''возвращаемые значения:''
* Объект с информацией о рейтинге пользователя

===== points_format =====

Форматирование значения рейтинга

''параметры:''
* $points - Значение рейтинга пользователя

''возвращаемые значения:''
* Отформатированное число

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

2017-01-30T10:27:56Z

DShtolin: /* Мое портфолио */

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

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

=== Панель управления достижениями ===
Через данный интерфейс производится администрирование шаблонов достижений.
Имеется возможность создавать разделы при помощи кнопки “добавить раздел”, выстраивая нужную иерархию. Среди настроек раздела доступны:
*Имя раздела
*Родительский раздел
*Доступность в рейтинге
Последняя настройка отвечает за отображение достижений в рейтинге, добавленных по шаблонам достижений, хранящимся в редактируемом разделе.
Добавленные разделы отображаются в виде таблицы, в первом столбце которой доступны операции по редактированию, удалению и блокировке раздела.
Перед самой таблицей имеется кнопка, включающая режим сортировки разделов. В режиме сортировки путем перетаскивания можно поменять порядок отображения разделов.

Находясь в разделе имеется возможность добавлять шаблоны достижений при помощи кнопки “Добавить шаблон достижения”.
Первым шагом добавления шаблона является настройка его основных характеристик таких как:
*Название шаблона
*Тип шаблона
*Раздел
*Баллы
Если включена подсистема модерации, то указанные баллы учитываются в рейтинге только после подтверждения достижения модератором.
После добавления шаблона достижения его необходимо активировать, кликнув по иконке с галочкой в таблице с шаблонами в первом столбце.
===== Тип шаблона “Результаты заданий” =====
Позволяет указать курс и задание, из которого автоматически будут создаваться достижения из ответов учащихся.
Имеется режим включающий назначение баллов пропорционально оценке. Количество баллов, указанных в достижении будет уменьшаться пропорционально набранному проценту оценки за задание.
Опционально, имеется возможность включить автоматическую отправку подтвержденных достижений в индекс антиплагиата.
===== Тип шаблона “Критерий” =====
Позволяет создать настраиваемый шаблон, предоставляющий пользователям возможность создавать достижения с ручным заполнением критериев.
В шаблон можно добавлять неограниченное количество поле следующих типов:
*текст - пользователю будет необходимо ввести текст при создании достижения
*дата - пользователю будет необходимо указать дату при создании достижения
*файл - пользователю будет необходимо прикрепить файл при создании достижения
*список - пользователю будет необходимо выбрать пункт из выпадающего списка при создании достижения
Все типы полей имеют возможность указания названия поля, выбора опции необходимости подтверждения поля модератором, коэффициента, на который будут умножены баллы достижения при заполнении поля. Выпадающий список имеет коэффициенты для каждого из пунктов.

=== Плагины портфолио ===
Интерфейс встречает пользователя ссылками на подсистемы портфолио.
===== Фильтрация пользователей =====
Подсистема фильтрации по умолчанию отключена и ее можно включить в настройках подразделения, в котором расположено редактируемое портфолио. Название требуемой настройки: im - achievements - display_filter.
Интерфейс позволяет настраивать поля, по которым будет возможно отфильтровать пользователей на странице просмотра рейтинга и на странице модерации.
Среди полей будут отображаться дополнительные поля профилей типа “Выбор из списка” и “Переключатель”, а также поля достижений “Раздел” и “Дата создания достижения”.
===== Блок информации о пользователе =====
На странице портфолио может быть отображена информация о пользователе из его профиля СДО. Настройка отображаемых полей производится в этом интерфейсе путем отмечания галочками нужных пунктов.

=== Панель модерации достижений пользователей ===
Подсистема модерации по умолчанию отключена и ее можно включить в настройках подразделения, в котором расположено редактируемое портфолио. Название требуемой настройки: im - achievements - system_moderation_enabled.
В соответствии с фильтром (если доступен), в данном интерфейсе можно выбрать пользователей, у которых имеются достижения, требующие модерации. Список пользователей с указанием количества требующих модерации достижений, будет отображено в таблице с результатами фильтрации.
Для доступа к интерфейсу модерации у пользователя должно быть право im - achievements - moderate.
Для модерации самих достижений (процедура может быть осуществлена не только через этот интерфейс) у пользователя должно быть право im - achievements - achievementins/moderate.

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

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

== API ==

===== delete_achievement =====

Удаление шаблона вместе со всеми пользовательскими достижениями, связанными с этим шаблоном

''параметры:''
* $id - ID шаблона
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_achievementin =====

Удаление пользовательского достижения

''параметры:''
* $id - ID достижения
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления достижения

===== delete_achievementins_by_achievementid =====

Удаление пользовательских достижений по ID шаблона

''параметры:''
* $id - ID шаблона для удаления его пользовательских достижений
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* $errors - массив ошибок, полученных во время удаления достижений

===== delete_achievements_by_categoryid =====

Удаление шаблонов по ID раздела

''параметры:''
* $id - ID раздела для удаления его шаблонов
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_category =====

Удаление раздела вместе дочерними разделами, шаблонами, а также пользовательскими достижениями, связанными с этими шаблонами

''параметры:''
* $id - ID раздела для удаления
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления раздела

===== get_achievementcatstable =====

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

''параметры:''
* $options - массив параметров для переопределения значений
* ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementins =====

Получение пользовательских достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['departmentid'] - ID подразделения
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementinstable =====

Сформировать таблицу пользовательских достижений

''параметры:''
* $list - массив пользовательских достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки
** ['limitnum'] - Число достижений в таблице
** ['limitfrom'] - Смещение

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementstable =====

Получить таблицу управления шаблонами достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_clear_myachievementstable =====

Получить таблицу достижений пользователя

''параметры:''
* $personid - ID персоны
* $options - массив дополнительных параметров
** ['limitnum'] - Число выводимых записей

''возвращаемые значения:''
* HTML код таблицы

===== get_moderation_data =====

Получить список персон, у которых есть достижения, требующие модерации

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* массив с данными по пользователям. В качестве ключей передаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений

===== get_moderation_table =====

Получить таблицу достижений, требующих модерации

''параметры:''
* $personachievements - Данные пользователей. В качестве ключей ожидаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_my_rating_block =====

Получить блок рейтинга пользователя

''параметры:''
* $id - ID целевого пользователя или текущего, если NULL
* $addvars - Массив GET-параметров для ссылки

''возвращаемые значения:''
* HTML-код блока

===== get_ratingtable =====

Получить таблицу рейтинга

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров,
** ['page'] - Страница,
** ['limit'] - Число записей на странице

''возвращаемые значения:''
* HTML код таблицы

===== get_user_info =====

Получить информацию о пользователе

''параметры:''
* $personid - ID персоны
* $addvars - массив GET-параметров с идентификатором подразделения

''возвращаемые значения:''
* HTML код с информацией о пользователе

===== get_userrating_info =====

Получить информацию о рейтинге пользователя

''параметры:''
* $personid - опционально, ID персоны
* $achievementids - опционально, ID шаблонов достижения или массив шаблонов, по которым будет строиться рейтинг

''возвращаемые значения:''
* Объект с информацией о рейтинге пользователя

===== points_format =====

Форматирование значения рейтинга

''параметры:''
* $points - Значение рейтинга пользователя

''возвращаемые значения:''
* Отформатированное число

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

2017-01-20T08:11:50Z

DShtolin: /* Панель управления достижениями */

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

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

=== Панель управления достижениями ===
Через данный интерфейс производится администрирование шаблонов достижений.
Имеется возможность создавать разделы при помощи кнопки “добавить раздел”, выстраивая нужную иерархию. Среди настроек раздела доступны:
*Имя раздела
*Родительский раздел
*Доступность в рейтинге
Последняя настройка отвечает за отображение достижений в рейтинге, добавленных по шаблонам достижений, хранящимся в редактируемом разделе.
Добавленные разделы отображаются в виде таблицы, в первом столбце которой доступны операции по редактированию, удалению и блокировке раздела.
Перед самой таблицей имеется кнопка, включающая режим сортировки разделов. В режиме сортировки путем перетаскивания можно поменять порядок отображения разделов.

Находясь в разделе имеется возможность добавлять шаблоны достижений при помощи кнопки “Добавить шаблон достижения”.
Первым шагом добавления шаблона является настройка его основных характеристик таких как:
*Название шаблона
*Тип шаблона
*Раздел
*Баллы
Если включена подсистема модерации, то указанные баллы учитываются в рейтинге только после подтверждения достижения модератором.
После добавления шаблона достижения его необходимо активировать, кликнув по иконке с галочкой в таблице с шаблонами в первом столбце.
===== Тип шаблона “Результаты заданий” =====
Позволяет указать курс и задание, из которого автоматически будут создаваться достижения из ответов учащихся.
Имеется режим включающий назначение баллов пропорционально оценке. Количество баллов, указанных в достижении будет уменьшаться пропорционально набранному проценту оценки за задание.
Опционально, имеется возможность включить автоматическую отправку подтвержденных достижений в индекс антиплагиата.
===== Тип шаблона “Критерий” =====
Позволяет создать настраиваемый шаблон, предоставляющий пользователям возможность создавать достижения с ручным заполнением критериев.
В шаблон можно добавлять неограниченное количество поле следующих типов:
*текст - пользователю будет необходимо ввести текст при создании достижения
*дата - пользователю будет необходимо указать дату при создании достижения
*файл - пользователю будет необходимо прикрепить файл при создании достижения
*список - пользователю будет необходимо выбрать пункт из выпадающего списка при создании достижения
Все типы полей имеют возможность указания названия поля, выбора опции необходимости подтверждения поля модератором, коэффициента, на который будут умножены баллы достижения при заполнении поля. Выпадающий список имеет коэффициенты для каждого из пунктов.

=== Плагины портфолио ===
Интерфейс встречает пользователя ссылками на подсистемы портфолио.
===== Фильтрация пользователей =====
Подсистема фильтрации по умолчанию отключена и ее можно включить в настройках подразделения, в котором расположено редактируемое портфолио. Название требуемой настройки: im - achievements - display_filter.
Интерфейс позволяет настраивать поля, по которым будет возможно отфильтровать пользователей на странице просмотра рейтинга и на странице модерации.
Среди полей будут отображаться дополнительные поля профилей типа “Выбор из списка” и “Переключатель”, а также поля достижений “Раздел” и “Дата создания достижения”.
===== Блок информации о пользователе =====
На странице портфолио может быть отображена информация о пользователе из его профиля СДО. Настройка отображаемых полей производится в этом интерфейсе путем отмечания галочками нужных пунктов.

=== Панель модерации достижений пользователей ===
Подсистема модерации по умолчанию отключена и ее можно включить в настройках подразделения, в котором расположено редактируемое портфолио. Название требуемой настройки: im - achievements - system_moderation_enabled.
В соответствии с фильтром (если доступен), в данном интерфейсе можно выбрать пользователей, у которых имеются достижения, требующие модерации. Список пользователей с указанием количества требующих модерации достижений, будет отображено в таблице с результатами фильтрации.
Для доступа к интерфейсу модерации у пользователя должно быть право im - achievements - moderate.
Для модерации самих достижений (процедура может быть осуществлена не только через этот интерфейс) у пользователя должно быть право im - achievements - achievementins/moderate.

=== Мое портфолио ===
Данный интерфейс предназначен для наполнения пользовательского портфолио достижениями и просмотра достижений пользователя.
По умолчанию интерфейс отображает достижения пользователя, который в данный момент авторизован в системе, но он же может отобразить достижения другого пользователя, если передан параметр с идентификатором персоны деканата “personid”. Подобные ссылки на портфолио других пользователей доступны в рейтинге.
В интерфейсе будет отображена информация о пользователе, настроенная ранее в инструменте “Блок информации о пользователе”.
Чуть ниже - информация о рейтинге (количество баллов, место в рейтинге) и ссылка на рейтинг.
Далее - форма добавления достижений и просмотр добавленных достижений с возможностью их фильтрации по разделу/шаблону, баллам и статусу.

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

== API ==

===== delete_achievement =====

Удаление шаблона вместе со всеми пользовательскими достижениями, связанными с этим шаблоном

''параметры:''
* $id - ID шаблона
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_achievementin =====

Удаление пользовательского достижения

''параметры:''
* $id - ID достижения
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления достижения

===== delete_achievementins_by_achievementid =====

Удаление пользовательских достижений по ID шаблона

''параметры:''
* $id - ID шаблона для удаления его пользовательских достижений
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* $errors - массив ошибок, полученных во время удаления достижений

===== delete_achievements_by_categoryid =====

Удаление шаблонов по ID раздела

''параметры:''
* $id - ID раздела для удаления его шаблонов
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_category =====

Удаление раздела вместе дочерними разделами, шаблонами, а также пользовательскими достижениями, связанными с этими шаблонами

''параметры:''
* $id - ID раздела для удаления
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления раздела

===== get_achievementcatstable =====

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

''параметры:''
* $options - массив параметров для переопределения значений
* ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementins =====

Получение пользовательских достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['departmentid'] - ID подразделения
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementinstable =====

Сформировать таблицу пользовательских достижений

''параметры:''
* $list - массив пользовательских достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки
** ['limitnum'] - Число достижений в таблице
** ['limitfrom'] - Смещение

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementstable =====

Получить таблицу управления шаблонами достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_clear_myachievementstable =====

Получить таблицу достижений пользователя

''параметры:''
* $personid - ID персоны
* $options - массив дополнительных параметров
** ['limitnum'] - Число выводимых записей

''возвращаемые значения:''
* HTML код таблицы

===== get_moderation_data =====

Получить список персон, у которых есть достижения, требующие модерации

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* массив с данными по пользователям. В качестве ключей передаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений

===== get_moderation_table =====

Получить таблицу достижений, требующих модерации

''параметры:''
* $personachievements - Данные пользователей. В качестве ключей ожидаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_my_rating_block =====

Получить блок рейтинга пользователя

''параметры:''
* $id - ID целевого пользователя или текущего, если NULL
* $addvars - Массив GET-параметров для ссылки

''возвращаемые значения:''
* HTML-код блока

===== get_ratingtable =====

Получить таблицу рейтинга

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров,
** ['page'] - Страница,
** ['limit'] - Число записей на странице

''возвращаемые значения:''
* HTML код таблицы

===== get_user_info =====

Получить информацию о пользователе

''параметры:''
* $personid - ID персоны
* $addvars - массив GET-параметров с идентификатором подразделения

''возвращаемые значения:''
* HTML код с информацией о пользователе

===== get_userrating_info =====

Получить информацию о рейтинге пользователя

''параметры:''
* $personid - опционально, ID персоны
* $achievementids - опционально, ID шаблонов достижения или массив шаблонов, по которым будет строиться рейтинг

''возвращаемые значения:''
* Объект с информацией о рейтинге пользователя

===== points_format =====

Форматирование значения рейтинга

''параметры:''
* $points - Значение рейтинга пользователя

''возвращаемые значения:''
* Отформатированное число

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

2017-01-20T06:28:02Z

DShtolin: /* Панель управления достижениями */

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

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

=== Панель управления достижениями ===
Через данный интерфейс производится администрирование шаблонов достижений.
Имеется возможность создавать разделы при помощи кнопки “добавить раздел”, выстраивая нужную иерархию. Среди настроек раздела доступны:
*Имя раздела
*Родительский раздел
*Доступность в рейтинге
Последняя настройка отвечает за отображение достижений в рейтинге, добавленных по шаблонам достижений, хранящимся в редактируемом разделе.
Добавленные разделы отображаются в виде таблицы, в первом столбце которой доступны операции по редактированию, удалению и блокировке раздела.
Перед самой таблицей имеется кнопка, включающая режим сортировки разделов. В режиме сортировки путем перетаскивания можно поменять порядок отображения разделов и достижений из него.

Находясь в разделе имеется возможность добавлять шаблоны достижений при помощи кнопки “Добавить шаблон достижения”.
Первым шагом добавления шаблона является настройка его основных характеристик таких как:
*Название шаблона
*Тип шаблона
*Раздел
*Баллы
Если включена подсистема модерации, то указанные баллы учитываются в рейтинге только после подтверждения достижения модератором.
После добавления шаблона достижения его необходимо активировать, кликнув по иконке с галочкой в таблице с шаблонами в первом столбце.
===== Тип шаблона “Результаты заданий” =====
Позволяет указать курс и задание, из которого автоматически будут создаваться достижения из ответов учащихся.
Имеется режим включающий назначение баллов пропорционально оценке. Количество баллов, указанных в достижении будет уменьшаться пропорционально набранному проценту оценки за задание.
Опционально, имеется возможность включить автоматическую отправку подтвержденных достижений в индекс антиплагиата.
===== Тип шаблона “Критерий” =====
Позволяет создать настраиваемый шаблон, предоставляющий пользователям возможность создавать достижения с ручным заполнением критериев.
В шаблон можно добавлять неограниченное количество поле следующих типов:
*текст - пользователю будет необходимо ввести текст при создании достижения
*дата - пользователю будет необходимо указать дату при создании достижения
*файл - пользователю будет необходимо прикрепить файл при создании достижения
*список - пользователю будет необходимо выбрать пункт из выпадающего списка при создании достижения
Все типы полей имеют возможность указания названия поля, выбора опции необходимости подтверждения поля модератором, коэффициента, на который будут умножены баллы достижения при заполнении поля. Выпадающий список имеет коэффициенты для каждого из пунктов.

=== Плагины портфолио ===
Интерфейс встречает пользователя ссылками на подсистемы портфолио.
===== Фильтрация пользователей =====
Подсистема фильтрации по умолчанию отключена и ее можно включить в настройках подразделения, в котором расположено редактируемое портфолио. Название требуемой настройки: im - achievements - display_filter.
Интерфейс позволяет настраивать поля, по которым будет возможно отфильтровать пользователей на странице просмотра рейтинга и на странице модерации.
Среди полей будут отображаться дополнительные поля профилей типа “Выбор из списка” и “Переключатель”, а также поля достижений “Раздел” и “Дата создания достижения”.
===== Блок информации о пользователе =====
На странице портфолио может быть отображена информация о пользователе из его профиля СДО. Настройка отображаемых полей производится в этом интерфейсе путем отмечания галочками нужных пунктов.

=== Панель модерации достижений пользователей ===
Подсистема модерации по умолчанию отключена и ее можно включить в настройках подразделения, в котором расположено редактируемое портфолио. Название требуемой настройки: im - achievements - system_moderation_enabled.
В соответствии с фильтром (если доступен), в данном интерфейсе можно выбрать пользователей, у которых имеются достижения, требующие модерации. Список пользователей с указанием количества требующих модерации достижений, будет отображено в таблице с результатами фильтрации.
Для доступа к интерфейсу модерации у пользователя должно быть право im - achievements - moderate.
Для модерации самих достижений (процедура может быть осуществлена не только через этот интерфейс) у пользователя должно быть право im - achievements - achievementins/moderate.

=== Мое портфолио ===
Данный интерфейс предназначен для наполнения пользовательского портфолио достижениями и просмотра достижений пользователя.
По умолчанию интерфейс отображает достижения пользователя, который в данный момент авторизован в системе, но он же может отобразить достижения другого пользователя, если передан параметр с идентификатором персоны деканата “personid”. Подобные ссылки на портфолио других пользователей доступны в рейтинге.
В интерфейсе будет отображена информация о пользователе, настроенная ранее в инструменте “Блок информации о пользователе”.
Чуть ниже - информация о рейтинге (количество баллов, место в рейтинге) и ссылка на рейтинг.
Далее - форма добавления достижений и просмотр добавленных достижений с возможностью их фильтрации по разделу/шаблону, баллам и статусу.

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

== API ==

===== delete_achievement =====

Удаление шаблона вместе со всеми пользовательскими достижениями, связанными с этим шаблоном

''параметры:''
* $id - ID шаблона
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_achievementin =====

Удаление пользовательского достижения

''параметры:''
* $id - ID достижения
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления достижения

===== delete_achievementins_by_achievementid =====

Удаление пользовательских достижений по ID шаблона

''параметры:''
* $id - ID шаблона для удаления его пользовательских достижений
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* $errors - массив ошибок, полученных во время удаления достижений

===== delete_achievements_by_categoryid =====

Удаление шаблонов по ID раздела

''параметры:''
* $id - ID раздела для удаления его шаблонов
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_category =====

Удаление раздела вместе дочерними разделами, шаблонами, а также пользовательскими достижениями, связанными с этими шаблонами

''параметры:''
* $id - ID раздела для удаления
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления раздела

===== get_achievementcatstable =====

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

''параметры:''
* $options - массив параметров для переопределения значений
* ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementins =====

Получение пользовательских достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['departmentid'] - ID подразделения
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementinstable =====

Сформировать таблицу пользовательских достижений

''параметры:''
* $list - массив пользовательских достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки
** ['limitnum'] - Число достижений в таблице
** ['limitfrom'] - Смещение

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementstable =====

Получить таблицу управления шаблонами достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_clear_myachievementstable =====

Получить таблицу достижений пользователя

''параметры:''
* $personid - ID персоны
* $options - массив дополнительных параметров
** ['limitnum'] - Число выводимых записей

''возвращаемые значения:''
* HTML код таблицы

===== get_moderation_data =====

Получить список персон, у которых есть достижения, требующие модерации

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* массив с данными по пользователям. В качестве ключей передаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений

===== get_moderation_table =====

Получить таблицу достижений, требующих модерации

''параметры:''
* $personachievements - Данные пользователей. В качестве ключей ожидаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_my_rating_block =====

Получить блок рейтинга пользователя

''параметры:''
* $id - ID целевого пользователя или текущего, если NULL
* $addvars - Массив GET-параметров для ссылки

''возвращаемые значения:''
* HTML-код блока

===== get_ratingtable =====

Получить таблицу рейтинга

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров,
** ['page'] - Страница,
** ['limit'] - Число записей на странице

''возвращаемые значения:''
* HTML код таблицы

===== get_user_info =====

Получить информацию о пользователе

''параметры:''
* $personid - ID персоны
* $addvars - массив GET-параметров с идентификатором подразделения

''возвращаемые значения:''
* HTML код с информацией о пользователе

===== get_userrating_info =====

Получить информацию о рейтинге пользователя

''параметры:''
* $personid - опционально, ID персоны
* $achievementids - опционально, ID шаблонов достижения или массив шаблонов, по которым будет строиться рейтинг

''возвращаемые значения:''
* Объект с информацией о рейтинге пользователя

===== points_format =====

Форматирование значения рейтинга

''параметры:''
* $points - Значение рейтинга пользователя

''возвращаемые значения:''
* Отформатированное число

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

2017-01-16T08:31:50Z

DShtolin: /* Журнал занятий */

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

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

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

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

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

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

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

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

== Журнал группы ==
Страница принимает обязательный параметр 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#Отчеты о фактической нагрузке | Подробнее ]]

=== Отчеты по замененным урокам ===

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

==== Структура приказа о закрытии зарплатного периода ====
Данные приказа:
* 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 в случае ошибки
''Структура работы:''
# получаем все программы, за которые отвечает подразделение
# для каждой программы получаем все ее журналы

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

2017-01-16T07:57:13Z

DShtolin: /* API */

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

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

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

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

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

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

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

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

== Журнал группы ==
Страница принимает обязательный параметр 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#Отчеты о фактической нагрузке | Подробнее ]]

=== Отчеты по замененным урокам ===

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

==== Структура приказа о закрытии зарплатного периода ====
Данные приказа:
* 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 - идентификатор подразделения
''Возвращаемые значения:'' нет

== Подробное описание работы функций ==
В этом разделе описывается подробная работа всех публичных и внутренних методов для классов журнала. Если вам требуется только краткая справка по 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 в случае ошибки
''Структура работы:''
# получаем все программы, за которые отвечает подразделение
# для каждой программы получаем все ее журналы

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

2017-01-09T06:57:38Z

DShtolin: /* Классный журнал */

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

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

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

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

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

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

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

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

== Журнал группы ==
Страница принимает обязательный параметр 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#Отчеты о фактической нагрузке | Подробнее ]]

=== Отчеты по замененным урокам ===

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

==== Структура приказа о закрытии зарплатного периода ====
Данные приказа:
* 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 в случае ошибки

== Подробное описание работы функций ==
В этом разделе описывается подробная работа всех публичных и внутренних методов для классов журнала. Если вам требуется только краткая справка по 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 в случае ошибки
''Структура работы:''
# получаем все программы, за которые отвечает подразделение
# для каждой программы получаем все ее журналы

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

2016-12-22T13:07:05Z

DShtolin: Новая страница: «{{Infobox_Plugin | name = achievements | type = im }} == Портфолио достижений == Плагин предназначен для управления...»

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

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

=== Панель управления достижениями ===
Через данный интерфейс производится администрирование шаблонов достижений.
Имеется возможность создавать разделы при помощи кнопки “добавить раздел”, выстраивая нужную иерархию. Среди настроек раздела доступны:
*Имя раздела
*Родительский раздел
*Доступность в рейтинге
Последняя настройка отвечает за отображение достижений в рейтинге, добавленных по шаблонам достижений, хранящимся в редактируемом разделе.
Добавленные разделы отображаются в виде таблицы, в первом столбце которой доступны операции по редактированию, удалению и блокировке раздела.

Находясь в разделе имеется возможность добавлять шаблоны достижений при помощи кнопки “Добавить шаблон достижения”.
Первым шагом добавления шаблона является настройка его основных характеристик таких как:
*Название шаблона
*Тип шаблона
*Раздел
*Баллы
Если включена подсистема модерации, то указанные баллы учитываются в рейтинге только после подтверждения достижения модератором.
После добавления шаблона достижения его необходимо активировать, кликнув по иконке с галочкой в таблице с шаблонами в первом столбце.
===== Тип шаблона “Результаты заданий” =====
Позволяет указать курс и задание, из которого автоматически будут создаваться достижения из ответов учащихся.
Имеется режим включающий назначение баллов пропорционально оценке. Количество баллов, указанных в достижении будет уменьшаться пропорционально набранному проценту оценки за задание.
Опционально, имеется возможность включить автоматическую отправку подтвержденных достижений в индекс антиплагиата.
===== Тип шаблона “Критерий” =====
Позволяет создать настраиваемый шаблон, предоставляющий пользователям возможность создавать достижения с ручным заполнением критериев.
В шаблон можно добавлять неограниченное количество поле следующих типов:
*текст - пользователю будет необходимо ввести текст при создании достижения
*дата - пользователю будет необходимо указать дату при создании достижения
*файл - пользователю будет необходимо прикрепить файл при создании достижения
*список - пользователю будет необходимо выбрать пункт из выпадающего списка при создании достижения
Все типы полей имеют возможность указания названия поля, выбора опции необходимости подтверждения поля модератором, коэффициента, на который будут умножены баллы достижения при заполнении поля. Выпадающий список имеет коэффициенты для каждого из пунктов.

=== Плагины портфолио ===
Интерфейс встречает пользователя ссылками на подсистемы портфолио.
===== Фильтрация пользователей =====
Подсистема фильтрации по умолчанию отключена и ее можно включить в настройках подразделения, в котором расположено редактируемое портфолио. Название требуемой настройки: im - achievements - display_filter.
Интерфейс позволяет настраивать поля, по которым будет возможно отфильтровать пользователей на странице просмотра рейтинга и на странице модерации.
Среди полей будут отображаться дополнительные поля профилей типа “Выбор из списка” и “Переключатель”, а также поля достижений “Раздел” и “Дата создания достижения”.
===== Блок информации о пользователе =====
На странице портфолио может быть отображена информация о пользователе из его профиля СДО. Настройка отображаемых полей производится в этом интерфейсе путем отмечания галочками нужных пунктов.

=== Панель модерации достижений пользователей ===
Подсистема модерации по умолчанию отключена и ее можно включить в настройках подразделения, в котором расположено редактируемое портфолио. Название требуемой настройки: im - achievements - system_moderation_enabled.
В соответствии с фильтром (если доступен), в данном интерфейсе можно выбрать пользователей, у которых имеются достижения, требующие модерации. Список пользователей с указанием количества требующих модерации достижений, будет отображено в таблице с результатами фильтрации.
Для доступа к интерфейсу модерации у пользователя должно быть право im - achievements - moderate.
Для модерации самих достижений (процедура может быть осуществлена не только через этот интерфейс) у пользователя должно быть право im - achievements - achievementins/moderate.

=== Мое портфолио ===
Данный интерфейс предназначен для наполнения пользовательского портфолио достижениями и просмотра достижений пользователя.
По умолчанию интерфейс отображает достижения пользователя, который в данный момент авторизован в системе, но он же может отобразить достижения другого пользователя, если передан параметр с идентификатором персоны деканата “personid”. Подобные ссылки на портфолио других пользователей доступны в рейтинге.
В интерфейсе будет отображена информация о пользователе, настроенная ранее в инструменте “Блок информации о пользователе”.
Чуть ниже - информация о рейтинге (количество баллов, место в рейтинге) и ссылка на рейтинг.
Далее - форма добавления достижений и просмотр добавленных достижений с возможностью их фильтрации по разделу/шаблону, баллам и статусу.

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

== API ==

===== delete_achievement =====

Удаление шаблона вместе со всеми пользовательскими достижениями, связанными с этим шаблоном

''параметры:''
* $id - ID шаблона
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_achievementin =====

Удаление пользовательского достижения

''параметры:''
* $id - ID достижения
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* массив ошибок, полученных во время удаления достижения

===== delete_achievementins_by_achievementid =====

Удаление пользовательских достижений по ID шаблона

''параметры:''
* $id - ID шаблона для удаления его пользовательских достижений
* $options - массив дополнительных опций удаления, не используется

''возвращаемые значения:''
* $errors - массив ошибок, полученных во время удаления достижений

===== delete_achievements_by_categoryid =====

Удаление шаблонов по ID раздела

''параметры:''
* $id - ID раздела для удаления его шаблонов
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления шаблонов

===== delete_category =====

Удаление раздела вместе дочерними разделами, шаблонами, а также пользовательскими достижениями, связанными с этими шаблонами

''параметры:''
* $id - ID раздела для удаления
* $options - массив параметров удаления

''возвращаемые значения:''
* массив ошибок, полученных во время удаления раздела

===== get_achievementcatstable =====

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

''параметры:''
* $options - массив параметров для переопределения значений
* ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementins =====

Получение пользовательских достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['departmentid'] - ID подразделения
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementinstable =====

Сформировать таблицу пользовательских достижений

''параметры:''
* $list - массив пользовательских достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров
** ['personid'] - ID персоны, для которой производится построение таблицы
** ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
*** 'points' - По баллу
*** 'status' - По статусу
** ['dir'] - Направление сортировки
** ['limitnum'] - Число достижений в таблице
** ['limitfrom'] - Смещение

''возвращаемые значения:''
* HTML код таблицы

===== get_achievementstable =====

Получить таблицу управления шаблонами достижений

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_clear_myachievementstable =====

Получить таблицу достижений пользователя

''параметры:''
* $personid - ID персоны
* $options - массив дополнительных параметров
** ['limitnum'] - Число выводимых записей

''возвращаемые значения:''
* HTML код таблицы

===== get_moderation_data =====

Получить список персон, у которых есть достижения, требующие модерации

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* массив с данными по пользователям. В качестве ключей передаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений

===== get_moderation_table =====

Получить таблицу достижений, требующих модерации

''параметры:''
* $personachievements - Данные пользователей. В качестве ключей ожидаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров

''возвращаемые значения:''
* HTML код таблицы

===== get_my_rating_block =====

Получить блок рейтинга пользователя

''параметры:''
* $id - ID целевого пользователя или текущего, если NULL
* $addvars - Массив GET-параметров для ссылки

''возвращаемые значения:''
* HTML-код блока

===== get_ratingtable =====

Получить таблицу рейтинга

''параметры:''
* $options - массив параметров для переопределения значений
** ['addvars'] - Массив GET-параметров,
** ['page'] - Страница,
** ['limit'] - Число записей на странице

''возвращаемые значения:''
* HTML код таблицы

===== get_user_info =====

Получить информацию о пользователе

''параметры:''
* $personid - ID персоны
* $addvars - массив GET-параметров с идентификатором подразделения

''возвращаемые значения:''
* HTML код с информацией о пользователе

===== get_userrating_info =====

Получить информацию о рейтинге пользователя

''параметры:''
* $personid - опционально, ID персоны
* $achievementids - опционально, ID шаблонов достижения или массив шаблонов, по которым будет строиться рейтинг

''возвращаемые значения:''
* Объект с информацией о рейтинге пользователя

===== points_format =====

Форматирование значения рейтинга

''параметры:''
* $points - Значение рейтинга пользователя

''возвращаемые значения:''
* Отформатированное число