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

Разработка:Принятые соглашения

2017-05-29T07:46:36Z

Polikarpov: /* Права */

=Принятые соглашения=

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

==Уникальные наименования==
Коды программ, дисциплин и т.п. Должны включать в себя только цифры, русские и латинские буквы, дефис. В базу данных код сохраняется всегда только в нижнем регистре. Независимо от того, как был введен в форме.
=== Правила именования плагинов sync ===
Все плагины sync, которые производят синхронизацию объектов с moodle должны называться как объект storage и иметь суффикс "tom". Пример: ''persons'''''tom'''.

==Коды и названия статусов.==
* future => предстоящий; - (от Алексея: нужно уточнить, для чего нужен этот статус)
* new => новый/заявка; - актуальный статус, он уже существут для системы (не мусорный), но еще не перешел в активный статус.
* deleted => удаленный; - мусорный статус, объекта "не существует" для системы, он не показывается даже в архиве. В него, например, могут быть переведены черновики. Обычные пользователи могут перевести в этот статус только объекты, которые еще не успели побывать в активном статусе.
* active => идет/действует; - активный статус
* completed => завершен; - реальный конечный статус, аналогичный архивному, но обозначает успех в изучения дисциплины, программы.
* failed => неуспешно завершен; - реальный конечный статус, аналогичный архивному, но обозначает неудачу в изучении дисциплины, программы по вине слушателя (двойка, отчислен).
* canceled => отменен; - реальный конечный статус. Аналогичен архивному, но обозначает неудачу по объективным причинам (обучение отменено, студент переведен в середине семестра).
* plan => запланирован; - для запланированных событий и объектов, в отличие от черновиков, их предварительное редактирование уже закончено и мы используем объекты для моделирования будущей ситуации. Пример: изменения расписания, которые вступят в силу с определенной даты.
* archive => помещен в архив; - конечный статус, объект остается только для архива.
* suspend => приостановлен; - это не конечный статус, объект временно исключен из бизнес-процессов, но может быть возвращен.
* approved => подтвержден; - это не конечный статус, актуальный статус. Аналогичен запланированному, но для приказов, договоров, заявок.
* notapproved => не подтвержден; - это не конечный статус объекта, ожидающиего подтверждения.
* returned => возвращен; - это не конечный, актуальный статус, обозначающий, что объект возвращен на доработку, но еще не потерявший шанса стать активным.
* rejected => отклонён; - это конечный, реальный статус. Объект отклонён навсегда, вместо подтверждения, но должен остаться для архива рассмотренных заявок.
* available => доступен; - вариация активного статуса обозначающая, что с объектом можно выполнять определенные действия (подписываться на программу).
* notavailable => недоступен; - вариация активного статуса, например, для программы: подписки на программу активны, но новых временно создать нельзя.
* draft => черновик; - это не конечный статус, объект пока еще не существует для системы, но пользователь может сменить статус, когда объект будет "готов".
=== Мета-статусы ===
Объединяют в себе несколько статусов, и используются для того чтобы указать общее состояние объекта. Мета-статус - это виртуальный, иногда мнимый статус, которому соответствуют 1 или несколько реальных статусов
==== Активный объект (active) ====
Объект, участвующий в активной фазе бизнес-процесса (например, учебные процессы в статусе "идёт", договоры в статусе "оказание услуг").

Все активные объекты объекты являются, одновременно, актуальными и реальными, но не наоборот.
==== Актуальный объект (actual) ====
Объект, жизненный цикл которого уже начат, но еще не завершен. Он включает в себя все активные объекты (с активными статусами), а так же некоторые не активные, но которые потенциально могут стать активными: запланированные, приостановленные, подтвержденные и т.п.

Все актуальные объекты являются, одновременно, реальными, но не наоборот.
==== Реальный объект (real) ====
Объект, существование которого система признает. Помимо актуальны объектов (которые являются активными или потенциально могут ими стать), реальные объекты включают в себя объекты, которые были активными, а теперь хранятся в архиве (но не включая удалённые, черновики и прочие, которых для системы как бы совсем нет).

==== Мусорный объект (junk) ====
Объекты, которые хранятся в базе но никак не принимают участия в бизнес-процессе, даже в качестве архива: удалённые, отмененные, черновики.

В отличие от перевода в архивный статус, перевод в мусорный статус полностью вычеркивает объект из использования в системе.
В том числе: мусорные объекты не должны отображаться нигде в интерфейсе, кроме специально-отведенных мест ("просмотр удалённых" или "работа с черновиками"), кроме того, они никогда не должны использоваться при подсчете статистики или отображении истории.

== Права ==

=== Набор стандартных прав ===

* view - Право видеть полную информацию по объекту.
* viewdesk - Право видеть интерфейсы объекта
* create - Право создавать новый объект
* edit - Право редактировать существующий объект
* use - Право ссылаться на объект в других объектах

=== Общие положения ===
* Основной набор прав доступа к объектам Деканата хранится в плагине STORAGE соответствующего объекта.
* Право dof/view (из moodle) действует только на просмотр блока FDO и на просмотр главной страницы. На всех остальных страницах используется собственная система полномочий
* Если в блок dof заходит пользователь с полномочиями администратора (admin или danamanage) и для него нет персоны - то персона создается. Все данные берутся из профиля moodle, статус синхронизации (sync2moodle) равен 1.

== Синхронизация ==
При создании плагина sync следует руководствоваться следующими правилами:
* Функции синхронизации одного объекта FDO (например persons) с двумя разными системами нужно создать два плагина sync для каждой системы.
* Плагины для разных систем именуются согласно [[Разработка:Принятые соглашения#Правила_именования_плагинов_sync | правилам именования плагинов sync ]].
* Функции синхронизации следует группировать по принципу принадлежности к объекту FDO. Например функции создания персоны в moodle, получения количества входов на портал и получения информации о персоне из moodle должны находится в плагине sync/personstom
== Комментарии ==
В комментариях при описании параметров, содержащих id записей рекомендуется указывать из каких именно таблиц эти записи были взяты. При этом название таблицы можно писать одним словом, без префиксов.
например:
$personid - id пользователя в таблице persons
В данном случае имеется в виду таблица mdl_block_dof_s_persons

Заглавная страница

2017-05-29T07:39:37Z

Polikarpov: /* Документация для разработчиков */

Добро пожаловать на страницу документации по Free Dean's Office (Электронный деканата)!

== Документация для пользователей (администрация, учителя) ==
* [[Использование:Руководство по быстрому старту|Руководство по быстрому старту]]

== Документация для системных администраторов ==
* [[Администрирование:Установка | Установка]]
* [[Релизы| Выпущенные версии]]
== Документация для разработчиков ==
* [[:Категория:Разработка| Разработка]]
** [[Разработка:С чего начать| "С чего начать?"]]
** '''[[Разработка:Стандарт кодирования| Стандарт кодирования]]'''
** '''[[Разработка:Принятые соглашения|Принятые соглашения]]'''
** [[:Категория:Плагины| Плагины]]
*** [[:Категория:Плагины_im| Плагины интерфейсов]]
*** [[:Категория:Плагины_modlibs| Плагины библиотек]]
*** [[:Категория:Плагины_storages| Плагины хранилищ]]
*** [[:Категория:Плагины_sync| Плагины синхронизаций]]
*** [[:Категория:Плагины_workflows| Плагины роутеров статусов]]
** [[Разработка:Ядро| Ядро]]
*** [[:Категория:Плагины_core| Состав ядра]]
* [[Разработка:План работ| План работ]]
* [[Разработка:Идеи| Идеи]]
* [[Разработка:Структура | Структура Free Dean's Office]]
* [[Разработка:Создание плагина | Создание плагина]]
* [[Разработка:Регламент| Организация работы над Free Dean's Office]]
* [[Разработка:Пример конфигурации НИИЧаВо| Пример конфигурации НИИЧаВо]]
* [[Релизы| Выпущенные версии]]

== Материалы по бизнес-процессам документообороту в учебных заведениях ==
* [[Документооборот:Оглавление раздела| Оглавление раздела "бизнес-процессы и документооборот в учебных заведениях"]]
=== Документооборот в школе ===
=== Документооборот в ВУЗе ===
=== Документооборот в тренинг-центре ===

Заглавная страница

2017-05-23T15:10:27Z

Polikarpov: /* Документация для системных администраторов */

Добро пожаловать на страницу документации по Free Dean's Office (Электронный деканата)!

== Документация для пользователей (администрация, учителя) ==
* [[Использование:Руководство по быстрому старту|Руководство по быстрому старту]]

== Документация для системных администраторов ==
* [[Администрирование:Установка | Установка]]
* [[Релизы| Выпущенные версии]]
== Документация для разработчиков ==
* [[:Категория:Разработка| Разработка]]
** [[:Категория:Плагины| Плагины]]
*** [[:Категория:Плагины_im| Плагины интерфейсов]]
*** [[:Категория:Плагины_modlibs| Плагины библиотек]]
*** [[:Категория:Плагины_storages| Плагины хранилищ]]
*** [[:Категория:Плагины_sync| Плагины синхронизаций]]
*** [[:Категория:Плагины_workflows| Плагины роутеров статусов]]
** [[Разработка:Ядро| Ядро]]
*** [[:Категория:Плагины_core| Состав ядра]]
* [[Разработка:План работ| План работ]]
* [[Разработка:Идеи| Идеи]]
* [[Разработка:С чего начать| "С чего начать?"]] - '''рекомендации для программистов, присоединившихся к проекту'''
* [[Разработка:Стандарт кодирования| Стандарт кодирования]]
* [[Разработка:Принятые соглашения|Принятые соглашения]] - Частные случаи и типовые патерны, не достаточно универсальные, чтобы войти в стандарт кодирования.
* [[Разработка:Структура | Структура Free Dean's Office]]
* [[Разработка:Создание плагина | Создание плагина]]
* [[Разработка:Регламент| Организация работы над Free Dean's Office]]
* [[Разработка:Пример конфигурации НИИЧаВо| Пример конфигурации НИИЧаВо]]
* [[Релизы| Выпущенные версии]]

== Материалы по бизнес-процессам документообороту в учебных заведениях ==
* [[Документооборот:Оглавление раздела| Оглавление раздела "бизнес-процессы и документооборот в учебных заведениях"]]
=== Документооборот в школе ===
=== Документооборот в ВУЗе ===
=== Документооборот в тренинг-центре ===

Заглавная страница

2017-05-23T15:09:47Z

Polikarpov: /* Документация для разработчиков */

Добро пожаловать на страницу документации по Free Dean's Office (Электронный деканата)!

== Документация для пользователей (администрация, учителя) ==
* [[Использование:Руководство по быстрому старту|Руководство по быстрому старту]]

== Документация для системных администраторов ==
* [[Администрирование:Установка | Установка]]
* [[Релизы| Выпущенные версии]]
=== Документация для разработчиков ===
* [[:Категория:Разработка| Разработка]]
** [[:Категория:Плагины| Плагины]]
*** [[:Категория:Плагины_im| Плагины интерфейсов]]
*** [[:Категория:Плагины_modlibs| Плагины библиотек]]
*** [[:Категория:Плагины_storages| Плагины хранилищ]]
*** [[:Категория:Плагины_sync| Плагины синхронизаций]]
*** [[:Категория:Плагины_workflows| Плагины роутеров статусов]]
** [[Разработка:Ядро| Ядро]]
*** [[:Категория:Плагины_core| Состав ядра]]
* [[Разработка:План работ| План работ]]
* [[Разработка:Идеи| Идеи]]
* [[Разработка:С чего начать| "С чего начать?"]] - '''рекомендации для программистов, присоединившихся к проекту'''
* [[Разработка:Стандарт кодирования| Стандарт кодирования]]
* [[Разработка:Принятые соглашения|Принятые соглашения]] - Частные случаи и типовые патерны, не достаточно универсальные, чтобы войти в стандарт кодирования.
* [[Разработка:Структура | Структура Free Dean's Office]]
* [[Разработка:Создание плагина | Создание плагина]]
* [[Разработка:Регламент| Организация работы над Free Dean's Office]]
* [[Разработка:Пример конфигурации НИИЧаВо| Пример конфигурации НИИЧаВо]]
* [[Релизы| Выпущенные версии]]

== Материалы по бизнес-процессам документообороту в учебных заведениях ==
* [[Документооборот:Оглавление раздела| Оглавление раздела "бизнес-процессы и документооборот в учебных заведениях"]]
=== Документооборот в школе ===
=== Документооборот в ВУЗе ===
=== Документооборот в тренинг-центре ===

Заглавная страница

2017-05-23T15:09:31Z

Polikarpov: /* Документация для разработчиков */

Добро пожаловать на страницу документации по Free Dean's Office (Электронный деканата)!

== Документация для пользователей (администрация, учителя) ==
* [[Использование:Руководство по быстрому старту|Руководство по быстрому старту]]

== Документация для системных администраторов ==
* [[Администрирование:Установка | Установка]]
* [[Релизы| Выпущенные версии]]
=== Документация для разработчиков ===
* [[:Категория:Разработка| Разработка]]
** [[:Категория:Плагины| Плагины]]
*** [[Категория:Плагины_im| Плагины интерфейсов]]
*** [[Категория:Плагины_modlibs| Плагины библиотек]]
*** [[Категория:Плагины_storages| Плагины хранилищ]]
*** [[Категория:Плагины_sync| Плагины синхронизаций]]
*** [[Категория:Плагины_workflows| Плагины роутеров статусов]]
** [[Разработка:Ядро| Ядро]]
*** [[Категория:Плагины_core| Состав ядра]]
* [[Разработка:План работ| План работ]]
* [[Разработка:Идеи| Идеи]]
* [[Разработка:С чего начать| "С чего начать?"]] - '''рекомендации для программистов, присоединившихся к проекту'''
* [[Разработка:Стандарт кодирования| Стандарт кодирования]]
* [[Разработка:Принятые соглашения|Принятые соглашения]] - Частные случаи и типовые патерны, не достаточно универсальные, чтобы войти в стандарт кодирования.
* [[Разработка:Структура | Структура Free Dean's Office]]
* [[Разработка:Создание плагина | Создание плагина]]
* [[Разработка:Регламент| Организация работы над Free Dean's Office]]
* [[Разработка:Пример конфигурации НИИЧаВо| Пример конфигурации НИИЧаВо]]
* [[Релизы| Выпущенные версии]]

== Материалы по бизнес-процессам документообороту в учебных заведениях ==
* [[Документооборот:Оглавление раздела| Оглавление раздела "бизнес-процессы и документооборот в учебных заведениях"]]
=== Документооборот в школе ===
=== Документооборот в ВУЗе ===
=== Документооборот в тренинг-центре ===

Заглавная страница

2017-05-23T15:04:53Z

Polikarpov: /* Документация для разработчиков */

Добро пожаловать на страницу документации по Free Dean's Office (Электронный деканата)!

== Документация для пользователей (администрация, учителя) ==
* [[Использование:Руководство по быстрому старту|Руководство по быстрому старту]]

== Документация для системных администраторов ==
* [[Администрирование:Установка | Установка]]
* [[Релизы| Выпущенные версии]]
=== Документация для разработчиков ===
* [[:Категория:Разработка| Разработка]]
** [[:Категория:Плагины| Плагины]]
** [[Разработка:Ядро| Ядро]]
* [[Разработка:План работ| План работ]]
* [[Разработка:Идеи| Идеи]]
* [[Разработка:С чего начать| "С чего начать?"]] - '''рекомендации для программистов, присоединившихся к проекту'''
* [[Разработка:Стандарт кодирования| Стандарт кодирования]]
* [[Разработка:Принятые соглашения|Принятые соглашения]] - Частные случаи и типовые патерны, не достаточно универсальные, чтобы войти в стандарт кодирования.
* [[Разработка:Структура | Структура Free Dean's Office]]
* [[Разработка:Создание плагина | Создание плагина]]
* [[Разработка:Регламент| Организация работы над Free Dean's Office]]
* [[Разработка:Пример конфигурации НИИЧаВо| Пример конфигурации НИИЧаВо]]
* [[Релизы| Выпущенные версии]]

== Материалы по бизнес-процессам документообороту в учебных заведениях ==
* [[Документооборот:Оглавление раздела| Оглавление раздела "бизнес-процессы и документооборот в учебных заведениях"]]
=== Документооборот в школе ===
=== Документооборот в ВУЗе ===
=== Документооборот в тренинг-центре ===

Заглавная страница

2017-05-23T15:03:10Z

Polikarpov: /* Документация для разработчиков */

Добро пожаловать на страницу документации по Free Dean's Office (Электронный деканата)!

== Документация для пользователей (администрация, учителя) ==
* [[Использование:Руководство по быстрому старту|Руководство по быстрому старту]]

== Документация для системных администраторов ==
* [[Администрирование:Установка | Установка]]
* [[Релизы| Выпущенные версии]]
=== Документация для разработчиков ===
* [[:Категория:Разработка| Разработка]]
* [[Разработка:Ядро]] - документация по ядру Free Dean's Office
* [[:Категория:Плагины]] - '''вся основная документация по работе плагинов здесь'''
* [[Релизы| Выпущенные версии]]
* [[Разработка:План работ| План работ]]
* [[Разработка:Идеи| Идеи]]
* [[Разработка:С чего начать| "С чего начать?"]] - '''рекомендации для программистов, присоединившихся к проекту'''
* [[Разработка:Стандарт кодирования| Стандарт кодирования]]
* [[Разработка:Принятые соглашения|Принятые соглашения]] - Частные случаи и типовые патерны, не достаточно универсальные, чтобы войти в стандарт кодирования.
* [[Разработка:Структура | Структура Free Dean's Office]]
* [[Разработка:Создание плагина | Создание плагина]]
* [[Разработка:Регламент| Организация работы над Free Dean's Office]]
* [[Разработка:Пример конфигурации НИИЧаВо| Пример конфигурации НИИЧаВо]]

== Материалы по бизнес-процессам документообороту в учебных заведениях ==
* [[Документооборот:Оглавление раздела| Оглавление раздела "бизнес-процессы и документооборот в учебных заведениях"]]
=== Документооборот в школе ===
=== Документооборот в ВУЗе ===
=== Документооборот в тренинг-центре ===

Разработка:Управление доступом

2017-05-22T11:12:09Z

Polikarpov: /* Общие правила и требования */

= Управление доступом =
На этой странице содержится вся основная информация по управлению доступом. "Электронный Деканат" имеет собственную систему полномочий, которая дополняет систему полномочий moodle, и позволяет реализовать более гибкое управление правами.

== Общая информация ==

=== Плагины необходимые для системы управления доступом ===

* [[Разработка:storages/acl | acl ]] - список полномочий. Хранит информацию о том в каком плагине какие полномочия существуют.
* [[Разработка:storages/aclwarrants | aclwarrants ]] - Мандаты и доверенности.
* [[Разработка:storages/aclwarrantagents | aclwarrantagents ]] - Применение доверенностей. Определяет, каким пользователям какие доверенности выданы.

=== Общие правила и требования ===
* Сторонние плагины могут зависеть от плагинов прав доступа, а плагины прав доступа не могут зависеть от остальных плагинов, и извлекать информацию из них (за исключением события установки/обновления плагина).
* Каждый плагин, предоставляющий права доступа должен описывать права в функции acldefault()
** Формат массива:
<pre>
array(
'view' => array('teacher', 'manager'),
'edit' => array('manager')
);
</pre>
В качестве ключей указывается то право, которое назначается, а значением служит массив ролей, которые получают это право. Список стандартных ролей можно посмотреть в плагине [[Разработка:storages/aclwarrants | aclwarrants ]]
* Все плагины, отвечающие за работу с полномочиями имеют префикс acl.
* Все функции в сторонних плагинах, которые управляют правами доступа должны иметь префикс acl
* В плагинах типа im и modlib следует для проверки стандартных прав доступа обращаться к плагинам storage.
* При построении прав на смену статуса объектов деканата имеет значение лишь то, в какой статус будет осуществлен перевод. Следовательно, необходимо реализовывать только права changestatus:to:СТАТУС.
** Право changestatus:from:СТАТУС следует устанавливать только для ограничения возможности вывода из спецстатусов.
** Право changestatus без модификаторов, дает право перевода из любого статуса в любой, кроме специальных (для которых объявлено право changestatus:from:Статус). Право changestatus:to:Статус дает право на перевод в целевой статус из любого другого, кроме специальных, для которых объявлено право changestatus:from:Статус.

=== Как происходит процесс установки прав ===
При установке, обновлении или удалении любого плагина, если он предоставляет права доступа - то в функциях upgrade(), delete(), и install() нужно вызывать функцию save_roles() плагина [[Разработка:storages/acl | acl ]].

== Правила работы с правами доступа ==

=== Полномочия (acl) ===
* Полномочия не имеют статусов, поэтому при удалении плагина все полномочия, принадлежащие ему также физически удаляются из таблицы
* Для хранилищ и рабочих процессов существуют [[ Разработка:storages/acl#.D0.A1.D1.82.D0.B0.D0.BD.D0.B4.D0.B0.D1.80.D1.82.D0.BD.D1.8B.D0.B5_.D0.BF.D0.BE.D0.BB.D0.BD.D0.BE.D0.BC.D0.BE.D1.87.D0.B8.D1.8F_.D0.B4.D0.BB.D1.8F_.D1.85.D1.80.D0.B0.D0.BD.D0.B8.D0.BB.D0.B8.D1.89_.D0.B8_.D1.80.D0.B0.D0.B1.D0.BE.D1.87.D0.B8.D1.85_.D0.BF.D1.80.D0.BE.D1.86.D0.B5.D1.81.D1.81.D0.BE.D0.B2 | стандартные полномочия ]]
* Полномочия проверяются только тем плагином, в котором они содержатся. То есть - из im/persons можно проверять только права im/persons, из storage/persons только права storage/persons. Нельзя проверять из одного плагина права другого плагина.

=== Мандаты и доверенности (warrants) ===
* Действия при удалении мандата или доверенности
** Основным способом удаления мандата следует считать перевод записи в статус "archive"
** Все дочерние доверенности и мандаты также перестают действовать
** Прекращают действия все применения полномочий ([[Разработка:storages/aclwarrantagents | aclwarrantagents ]]) которые были назначены указанным мандатом.
* При установке прав новым плагином все новые права добавляются к стандартным доверенностям
* Плагины не могут добавлять свои доверенности при установке
* Стандартные доверенности не могут быть назначены пользователям
* Если запрещается наследование для доверенности, которую раньше можно было наследовать - то старые дочерние доверенности продолжают свое действие, но новые создать нельзя

==== Синхронизация ====
Здесь описаны плагины, которые должны синхронизироваться с таблицей доверенностей.
* [[Разработка:storages/positions | storage/positions]]

=== Применение полномочий (warrantagents) ===
* При прекращении действия доверенности, применение полномочия прекращает действовать (переводится в статус archive)
* При истечении срока действия применение полномочия переводится в статус archive

==== Синхронизация ====
Здесь описаны плагины, которые должны синхронизироваться с таблицей применения полномочий.
* [[Разработка:storages/appointments | storages/appointments ]]

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

Разработка:Управление доступом

2017-05-22T11:09:06Z

Polikarpov: /* Общие правила и требования */

= Управление доступом =
На этой странице содержится вся основная информация по управлению доступом. "Электронный Деканат" имеет собственную систему полномочий, которая дополняет систему полномочий moodle, и позволяет реализовать более гибкое управление правами.

== Общая информация ==

=== Плагины необходимые для системы управления доступом ===

* [[Разработка:storages/acl | acl ]] - список полномочий. Хранит информацию о том в каком плагине какие полномочия существуют.
* [[Разработка:storages/aclwarrants | aclwarrants ]] - Мандаты и доверенности.
* [[Разработка:storages/aclwarrantagents | aclwarrantagents ]] - Применение доверенностей. Определяет, каким пользователям какие доверенности выданы.

=== Общие правила и требования ===
* Сторонние плагины могут зависеть от плагинов прав доступа, а плагины прав доступа не могут зависеть от остальных плагинов, и извлекать информацию из них (за исключением события установки/обновления плагина).
* Каждый плагин, предоставляющий права доступа должен описывать права в функции acldefault()
** Формат массива:
<pre>
array(
'view' => array('teacher', 'manager'),
'edit' => array('manager')
);
</pre>
В качестве ключей указывается то право, которое назначается, а значением служит массив ролей, которые получают это право. Список стандартных ролей можно посмотреть в плагине [[Разработка:storages/aclwarrants | aclwarrants ]]
* Все плагины, отвечающие за работу с полномочиями имеют префикс acl.
* Все функции в сторонних плагинах, которые управляют правами доступа должны иметь префикс acl
* В плагинах типа im и modlib следует для проверки стандартных прав доступа обращаться к плагинам storage.
* При построении прав на смену статуса объектов деканата имеет значение лишь то, в какой статус будет осуществлен перевод. Следовательно, необходимо реализовывать только права changestatus:to:СТАТУС. Право changestatus:from:СТАТУС следует устанавливать только для ограничения возможности вывода из спецстатусов. Право changestatus без модификаторов, дает право перевода из любого статуса в любой, кроме специальных (для которых объявлено право changestatus:from:Статус). Право changestatus:to:Статус дает право на перевод в целевой статус из любого другого, кроме специальных, для которых объявлено право changestatus:from:Статус.

=== Как происходит процесс установки прав ===
При установке, обновлении или удалении любого плагина, если он предоставляет права доступа - то в функциях upgrade(), delete(), и install() нужно вызывать функцию save_roles() плагина [[Разработка:storages/acl | acl ]].

== Правила работы с правами доступа ==

=== Полномочия (acl) ===
* Полномочия не имеют статусов, поэтому при удалении плагина все полномочия, принадлежащие ему также физически удаляются из таблицы
* Для хранилищ и рабочих процессов существуют [[ Разработка:storages/acl#.D0.A1.D1.82.D0.B0.D0.BD.D0.B4.D0.B0.D1.80.D1.82.D0.BD.D1.8B.D0.B5_.D0.BF.D0.BE.D0.BB.D0.BD.D0.BE.D0.BC.D0.BE.D1.87.D0.B8.D1.8F_.D0.B4.D0.BB.D1.8F_.D1.85.D1.80.D0.B0.D0.BD.D0.B8.D0.BB.D0.B8.D1.89_.D0.B8_.D1.80.D0.B0.D0.B1.D0.BE.D1.87.D0.B8.D1.85_.D0.BF.D1.80.D0.BE.D1.86.D0.B5.D1.81.D1.81.D0.BE.D0.B2 | стандартные полномочия ]]
* Полномочия проверяются только тем плагином, в котором они содержатся. То есть - из im/persons можно проверять только права im/persons, из storage/persons только права storage/persons. Нельзя проверять из одного плагина права другого плагина.

=== Мандаты и доверенности (warrants) ===
* Действия при удалении мандата или доверенности
** Основным способом удаления мандата следует считать перевод записи в статус "archive"
** Все дочерние доверенности и мандаты также перестают действовать
** Прекращают действия все применения полномочий ([[Разработка:storages/aclwarrantagents | aclwarrantagents ]]) которые были назначены указанным мандатом.
* При установке прав новым плагином все новые права добавляются к стандартным доверенностям
* Плагины не могут добавлять свои доверенности при установке
* Стандартные доверенности не могут быть назначены пользователям
* Если запрещается наследование для доверенности, которую раньше можно было наследовать - то старые дочерние доверенности продолжают свое действие, но новые создать нельзя

==== Синхронизация ====
Здесь описаны плагины, которые должны синхронизироваться с таблицей доверенностей.
* [[Разработка:storages/positions | storage/positions]]

=== Применение полномочий (warrantagents) ===
* При прекращении действия доверенности, применение полномочия прекращает действовать (переводится в статус archive)
* При истечении срока действия применение полномочия переводится в статус archive

==== Синхронизация ====
Здесь описаны плагины, которые должны синхронизироваться с таблицей применения полномочий.
* [[Разработка:storages/appointments | storages/appointments ]]

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

Разработка:Управление доступом

2017-05-22T11:06:46Z

Polikarpov: /* Общие правила и требования */

= Управление доступом =
На этой странице содержится вся основная информация по управлению доступом. "Электронный Деканат" имеет собственную систему полномочий, которая дополняет систему полномочий moodle, и позволяет реализовать более гибкое управление правами.

== Общая информация ==

=== Плагины необходимые для системы управления доступом ===

* [[Разработка:storages/acl | acl ]] - список полномочий. Хранит информацию о том в каком плагине какие полномочия существуют.
* [[Разработка:storages/aclwarrants | aclwarrants ]] - Мандаты и доверенности.
* [[Разработка:storages/aclwarrantagents | aclwarrantagents ]] - Применение доверенностей. Определяет, каким пользователям какие доверенности выданы.

=== Общие правила и требования ===
* Сторонние плагины могут зависеть от плагинов прав доступа, а плагины прав доступа не могут зависеть от остальных плагинов, и извлекать информацию из них (за исключением события установки/обновления плагина).
* Каждый плагин, предоставляющий права доступа должен описывать права в функции acldefault()
** Формат массива:
<pre>
array(
'view' => array('teacher', 'manager'),
'edit' => array('manager')
);
</pre>
В качестве ключей указывается то право, которое назначается, а значением служит массив ролей, которые получают это право. Список стандартных ролей можно посмотреть в плагине [[Разработка:storages/aclwarrants | aclwarrants ]]
* Все плагины, отвечающие за работу с полномочиями имеют префикс acl.
* Все функции в сторонних плагинах, которые управляют правами доступа должны иметь префикс acl
* В плагинах типа im и modlib следует для проверки стандартных прав доступа обращаться к плагинам storage.
* При построении прав на смену статуса объектов деканата имеет значение лишь то, в какой статус будет осуществлен перевод. Следовательно, необходимо реализовывать только права changestatus:to:СТАТУС

=== Как происходит процесс установки прав ===
При установке, обновлении или удалении любого плагина, если он предоставляет права доступа - то в функциях upgrade(), delete(), и install() нужно вызывать функцию save_roles() плагина [[Разработка:storages/acl | acl ]].

== Правила работы с правами доступа ==

=== Полномочия (acl) ===
* Полномочия не имеют статусов, поэтому при удалении плагина все полномочия, принадлежащие ему также физически удаляются из таблицы
* Для хранилищ и рабочих процессов существуют [[ Разработка:storages/acl#.D0.A1.D1.82.D0.B0.D0.BD.D0.B4.D0.B0.D1.80.D1.82.D0.BD.D1.8B.D0.B5_.D0.BF.D0.BE.D0.BB.D0.BD.D0.BE.D0.BC.D0.BE.D1.87.D0.B8.D1.8F_.D0.B4.D0.BB.D1.8F_.D1.85.D1.80.D0.B0.D0.BD.D0.B8.D0.BB.D0.B8.D1.89_.D0.B8_.D1.80.D0.B0.D0.B1.D0.BE.D1.87.D0.B8.D1.85_.D0.BF.D1.80.D0.BE.D1.86.D0.B5.D1.81.D1.81.D0.BE.D0.B2 | стандартные полномочия ]]
* Полномочия проверяются только тем плагином, в котором они содержатся. То есть - из im/persons можно проверять только права im/persons, из storage/persons только права storage/persons. Нельзя проверять из одного плагина права другого плагина.

=== Мандаты и доверенности (warrants) ===
* Действия при удалении мандата или доверенности
** Основным способом удаления мандата следует считать перевод записи в статус "archive"
** Все дочерние доверенности и мандаты также перестают действовать
** Прекращают действия все применения полномочий ([[Разработка:storages/aclwarrantagents | aclwarrantagents ]]) которые были назначены указанным мандатом.
* При установке прав новым плагином все новые права добавляются к стандартным доверенностям
* Плагины не могут добавлять свои доверенности при установке
* Стандартные доверенности не могут быть назначены пользователям
* Если запрещается наследование для доверенности, которую раньше можно было наследовать - то старые дочерние доверенности продолжают свое действие, но новые создать нельзя

==== Синхронизация ====
Здесь описаны плагины, которые должны синхронизироваться с таблицей доверенностей.
* [[Разработка:storages/positions | storage/positions]]

=== Применение полномочий (warrantagents) ===
* При прекращении действия доверенности, применение полномочия прекращает действовать (переводится в статус archive)
* При истечении срока действия применение полномочия переводится в статус archive

==== Синхронизация ====
Здесь описаны плагины, которые должны синхронизироваться с таблицей применения полномочий.
* [[Разработка:storages/appointments | storages/appointments ]]

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

Разработка:Принятые соглашения

2017-05-22T11:06:08Z

Polikarpov: /* Права */

=Принятые соглашения=

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

==Уникальные наименования==
Коды программ, дисциплин и т.п. Должны включать в себя только цифры, русские и латинские буквы, дефис. В базу данных код сохраняется всегда только в нижнем регистре. Независимо от того, как был введен в форме.
=== Правила именования плагинов sync ===
Все плагины sync, которые производят синхронизацию объектов с moodle должны называться как объект storage и иметь суффикс "tom". Пример: ''persons'''''tom'''.

==Коды и названия статусов.==
* future => предстоящий; - (от Алексея: нужно уточнить, для чего нужен этот статус)
* new => новый/заявка; - актуальный статус, он уже существут для системы (не мусорный), но еще не перешел в активный статус.
* deleted => удаленный; - мусорный статус, объекта "не существует" для системы, он не показывается даже в архиве. В него, например, могут быть переведены черновики. Обычные пользователи могут перевести в этот статус только объекты, которые еще не успели побывать в активном статусе.
* active => идет/действует; - активный статус
* completed => завершен; - реальный конечный статус, аналогичный архивному, но обозначает успех в изучения дисциплины, программы.
* failed => неуспешно завершен; - реальный конечный статус, аналогичный архивному, но обозначает неудачу в изучении дисциплины, программы по вине слушателя (двойка, отчислен).
* canceled => отменен; - реальный конечный статус. Аналогичен архивному, но обозначает неудачу по объективным причинам (обучение отменено, студент переведен в середине семестра).
* plan => запланирован; - для запланированных событий и объектов, в отличие от черновиков, их предварительное редактирование уже закончено и мы используем объекты для моделирования будущей ситуации. Пример: изменения расписания, которые вступят в силу с определенной даты.
* archive => помещен в архив; - конечный статус, объект остается только для архива.
* suspend => приостановлен; - это не конечный статус, объект временно исключен из бизнес-процессов, но может быть возвращен.
* approved => подтвержден; - это не конечный статус, актуальный статус. Аналогичен запланированному, но для приказов, договоров, заявок.
* notapproved => не подтвержден; - это не конечный статус объекта, ожидающиего подтверждения.
* returned => возвращен; - это не конечный, актуальный статус, обозначающий, что объект возвращен на доработку, но еще не потерявший шанса стать активным.
* rejected => отклонён; - это конечный, реальный статус. Объект отклонён навсегда, вместо подтверждения, но должен остаться для архива рассмотренных заявок.
* available => доступен; - вариация активного статуса обозначающая, что с объектом можно выполнять определенные действия (подписываться на программу).
* notavailable => недоступен; - вариация активного статуса, например, для программы: подписки на программу активны, но новых временно создать нельзя.
* draft => черновик; - это не конечный статус, объект пока еще не существует для системы, но пользователь может сменить статус, когда объект будет "готов".
=== Мета-статусы ===
Объединяют в себе несколько статусов, и используются для того чтобы указать общее состояние объекта. Мета-статус - это виртуальный, иногда мнимый статус, которому соответствуют 1 или несколько реальных статусов
==== Активный объект (active) ====
Объект, участвующий в активной фазе бизнес-процесса (например, учебные процессы в статусе "идёт", договоры в статусе "оказание услуг").

Все активные объекты объекты являются, одновременно, актуальными и реальными, но не наоборот.
==== Актуальный объект (actual) ====
Объект, жизненный цикл которого уже начат, но еще не завершен. Он включает в себя все активные объекты (с активными статусами), а так же некоторые не активные, но которые потенциально могут стать активными: запланированные, приостановленные, подтвержденные и т.п.

Все актуальные объекты являются, одновременно, реальными, но не наоборот.
==== Реальный объект (real) ====
Объект, существование которого система признает. Помимо актуальны объектов (которые являются активными или потенциально могут ими стать), реальные объекты включают в себя объекты, которые были активными, а теперь хранятся в архиве (но не включая удалённые, черновики и прочие, которых для системы как бы совсем нет).

==== Мусорный объект (junk) ====
Объекты, которые хранятся в базе но никак не принимают участия в бизнес-процессе, даже в качестве архива: удалённые, отмененные, черновики.

В отличие от перевода в архивный статус, перевод в мусорный статус полностью вычеркивает объект из использования в системе.
В том числе: мусорные объекты не должны отображаться нигде в интерфейсе, кроме специально-отведенных мест ("просмотр удалённых" или "работа с черновиками"), кроме того, они никогда не должны использоваться при подсчете статистики или отображении истории.

== Права ==

* Право dof/view (из moodle) действует только на просмотр блока FDO и на просмотр главной страницы. На всех остальных страницах используется собственная система полномочий
* Если в блок dof заходит пользователь с полномочиями администратора (admin или danamanage) и для него нет персоны - то персона создается. Все данные берутся из профиля moodle, статус синхронизации (sync2moodle) равен 1.

== Синхронизация ==
При создании плагина sync следует руководствоваться следующими правилами:
* Функции синхронизации одного объекта FDO (например persons) с двумя разными системами нужно создать два плагина sync для каждой системы.
* Плагины для разных систем именуются согласно [[Разработка:Принятые соглашения#Правила_именования_плагинов_sync | правилам именования плагинов sync ]].
* Функции синхронизации следует группировать по принципу принадлежности к объекту FDO. Например функции создания персоны в moodle, получения количества входов на портал и получения информации о персоне из moodle должны находится в плагине sync/personstom
== Комментарии ==
В комментариях при описании параметров, содержащих id записей рекомендуется указывать из каких именно таблиц эти записи были взяты. При этом название таблицы можно писать одним словом, без префиксов.
например:
$personid - id пользователя в таблице persons
В данном случае имеется в виду таблица mdl_block_dof_s_persons

Разработка:Принятые соглашения

2017-05-22T10:41:02Z

Polikarpov: /* Права */

=Принятые соглашения=

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

==Уникальные наименования==
Коды программ, дисциплин и т.п. Должны включать в себя только цифры, русские и латинские буквы, дефис. В базу данных код сохраняется всегда только в нижнем регистре. Независимо от того, как был введен в форме.
=== Правила именования плагинов sync ===
Все плагины sync, которые производят синхронизацию объектов с moodle должны называться как объект storage и иметь суффикс "tom". Пример: ''persons'''''tom'''.

==Коды и названия статусов.==
* future => предстоящий; - (от Алексея: нужно уточнить, для чего нужен этот статус)
* new => новый/заявка; - актуальный статус, он уже существут для системы (не мусорный), но еще не перешел в активный статус.
* deleted => удаленный; - мусорный статус, объекта "не существует" для системы, он не показывается даже в архиве. В него, например, могут быть переведены черновики. Обычные пользователи могут перевести в этот статус только объекты, которые еще не успели побывать в активном статусе.
* active => идет/действует; - активный статус
* completed => завершен; - реальный конечный статус, аналогичный архивному, но обозначает успех в изучения дисциплины, программы.
* failed => неуспешно завершен; - реальный конечный статус, аналогичный архивному, но обозначает неудачу в изучении дисциплины, программы по вине слушателя (двойка, отчислен).
* canceled => отменен; - реальный конечный статус. Аналогичен архивному, но обозначает неудачу по объективным причинам (обучение отменено, студент переведен в середине семестра).
* plan => запланирован; - для запланированных событий и объектов, в отличие от черновиков, их предварительное редактирование уже закончено и мы используем объекты для моделирования будущей ситуации. Пример: изменения расписания, которые вступят в силу с определенной даты.
* archive => помещен в архив; - конечный статус, объект остается только для архива.
* suspend => приостановлен; - это не конечный статус, объект временно исключен из бизнес-процессов, но может быть возвращен.
* approved => подтвержден; - это не конечный статус, актуальный статус. Аналогичен запланированному, но для приказов, договоров, заявок.
* notapproved => не подтвержден; - это не конечный статус объекта, ожидающиего подтверждения.
* returned => возвращен; - это не конечный, актуальный статус, обозначающий, что объект возвращен на доработку, но еще не потерявший шанса стать активным.
* rejected => отклонён; - это конечный, реальный статус. Объект отклонён навсегда, вместо подтверждения, но должен остаться для архива рассмотренных заявок.
* available => доступен; - вариация активного статуса обозначающая, что с объектом можно выполнять определенные действия (подписываться на программу).
* notavailable => недоступен; - вариация активного статуса, например, для программы: подписки на программу активны, но новых временно создать нельзя.
* draft => черновик; - это не конечный статус, объект пока еще не существует для системы, но пользователь может сменить статус, когда объект будет "готов".
=== Мета-статусы ===
Объединяют в себе несколько статусов, и используются для того чтобы указать общее состояние объекта. Мета-статус - это виртуальный, иногда мнимый статус, которому соответствуют 1 или несколько реальных статусов
==== Активный объект (active) ====
Объект, участвующий в активной фазе бизнес-процесса (например, учебные процессы в статусе "идёт", договоры в статусе "оказание услуг").

Все активные объекты объекты являются, одновременно, актуальными и реальными, но не наоборот.
==== Актуальный объект (actual) ====
Объект, жизненный цикл которого уже начат, но еще не завершен. Он включает в себя все активные объекты (с активными статусами), а так же некоторые не активные, но которые потенциально могут стать активными: запланированные, приостановленные, подтвержденные и т.п.

Все актуальные объекты являются, одновременно, реальными, но не наоборот.
==== Реальный объект (real) ====
Объект, существование которого система признает. Помимо актуальны объектов (которые являются активными или потенциально могут ими стать), реальные объекты включают в себя объекты, которые были активными, а теперь хранятся в архиве (но не включая удалённые, черновики и прочие, которых для системы как бы совсем нет).

==== Мусорный объект (junk) ====
Объекты, которые хранятся в базе но никак не принимают участия в бизнес-процессе, даже в качестве архива: удалённые, отмененные, черновики.

В отличие от перевода в архивный статус, перевод в мусорный статус полностью вычеркивает объект из использования в системе.
В том числе: мусорные объекты не должны отображаться нигде в интерфейсе, кроме специально-отведенных мест ("просмотр удалённых" или "работа с черновиками"), кроме того, они никогда не должны использоваться при подсчете статистики или отображении истории.

== Права ==

* При построении прав на смену статуса объектов деканата имеет значение лишь то, в какой статус будет осуществлен перевод. Следовательно, необходимо реализовывать только права changestatus:to:СТАТУС
* Право dof/view (из moodle) действует только на просмотр блока FDO и на просмотр главной страницы. На всех остальных страницах используется собственная система полномочий
* Если в блок dof заходит пользователь с полномочиями администратора (admin или danamanage) и для него нет персоны - то персона создается. Все данные берутся из профиля moodle, статус синхронизации (sync2moodle) равен 1.

== Синхронизация ==
При создании плагина sync следует руководствоваться следующими правилами:
* Функции синхронизации одного объекта FDO (например persons) с двумя разными системами нужно создать два плагина sync для каждой системы.
* Плагины для разных систем именуются согласно [[Разработка:Принятые соглашения#Правила_именования_плагинов_sync | правилам именования плагинов sync ]].
* Функции синхронизации следует группировать по принципу принадлежности к объекту FDO. Например функции создания персоны в moodle, получения количества входов на портал и получения информации о персоне из moodle должны находится в плагине sync/personstom
== Комментарии ==
В комментариях при описании параметров, содержащих id записей рекомендуется указывать из каких именно таблиц эти записи были взяты. При этом название таблицы можно писать одним словом, без префиксов.
например:
$personid - id пользователя в таблице persons
В данном случае имеется в виду таблица mdl_block_dof_s_persons

Разработка:workflows/contracts

2017-04-13T14:04:42Z

Polikarpov:

{{Infobox_Plugin
| name = contracts
| type = workflows
}}

===Возможные статусы===
* Неподтвержденный (tmp) - формируется новый контракт. В этом статусе можно редактировать. В бизнес-логике не участвует, считаем что его официально нет, пока создатель не переведет его в статус "Новый".
* Новый (new) - контракт сформирован и готов к подписанию.
* Подписан клиентом (clientsign) - ученик подписывает контракт со своей стороны.
* Подписан нами (wesign) - учебное заведение подписывает контракт со своей стороны.
* Зарегистрирован учащийся (studreg) - учащемуся в системе создана учетная запись.
* Оказание услуг (work) - контракт подписан и по нему проходит обучение.
* Приостановлен (frozen) - исполнение контракта приостановлено по тем или иным причинам.
* Отменен (cancel) - контракт отменен до его исполнения.
* Расторгнут (archives) - контракт был расторгнут и передан в архив.

=== Метастатусы ===
* Активный: work
* Актуальный: new, clientsign, studreg, wesign, work, frozen
* Реальный: new, clientsign, studreg, wesign, work, frozen, archives
* Мусорный: tmp, cancel

=== Доступ ===
В этом разделе описаны права доступа, определяемые плагином

{| class="wikitable sortable"
! Код права
! Название
! Роли по-умолчанию
! Пояснение
|-
| changestatus
| Переводить договор в любой статус
| manager
|
|-
| changestatus:tmp
| Переводить договор в статус Черновика
|
| По-умолчанию право не определено для ролей Деканата.
При запросе доступа - производится предварительная проверка права changestatus
|-
| changestatus:new
| Переводить договор в статус Новый
|
| По-умолчанию право не определено для ролей Деканата.
При запросе доступа - производится предварительная проверка права changestatus
|-
| changestatus:clientsign
| Переводить договор в статус Подписан клиентом
|
| По-умолчанию право не определено для ролей Деканата.
При запросе доступа - производится предварительная проверка права changestatus
|-
| changestatus:studreg
| Переводить договор в статус Зарегистрирован учащийся
|
| По-умолчанию право не определено для ролей Деканата.
При запросе доступа - производится предварительная проверка права changestatus
|-
| changestatus:wesign
| Переводить договор в статус Подписан нами
|
| По-умолчанию право не определено для ролей Деканата.
При запросе доступа - производится предварительная проверка права changestatus
|-
| changestatus:work
| Переводить договор в статус Оказание услуг
|
| По-умолчанию право не определено для ролей Деканата.
При запросе доступа - производится предварительная проверка права changestatus
|-
| changestatus:frozen
| Переводить договор в статус Приостановлен
|
| По-умолчанию право не определено для ролей Деканата.
При запросе доступа - производится предварительная проверка права changestatus
|-
| changestatus:archives
| Переводить договор в статус Расторгнут
|
| По-умолчанию право не определено для ролей Деканата.
При запросе доступа - производится предварительная проверка права changestatus
|-
| changestatus:cancel
| Переводить договор в статус Отменен
|
| По-умолчанию право не определено для ролей Деканата.
При запросе доступа - производится предварительная проверка права changestatus
|}

=== Маршруты статусов===
Правила описания маршрутов: описания возможностей перехода в новый статус на основании текущего статуса и условия, действительные только при переходе в новый статус из текущего статуса, группируются по текущему статусу, описания возможностей перехода в новый статус не зависящие от текущего статуса группируются по новому статусу.

==== Неподтвержденный ====
Возможные переходы ИЗ этого статуса:
* Новый
* Отменен

==== Новый ====
Возможные переходы ИЗ этого статуса:
* Подписан учеником
* Отменен

==== Подписан клиентом ====
Возможные переходы ИЗ этого статуса:
* Зарегистрирован учащийся - автоматически
* Отменен

==== Зарегистрирован учащийся ====
Нельзя установить вручную. Меняется на этот статус сразу же после подписания контракта клиентом. В системе создается учетная запись для учащегося, в случае неудачи, контракт переходит в статус "Неподтвержденный"

Возможные переходы ИЗ этого статуса:
* Подписан нами
* Отменен

==== Подписан нами ====
Возможные переходы ИЗ этого статуса:
* Оказание услуг
* Приостановлен
* Расторгнут

====Оказание услуг====
При переводе в этот статус, все соответствующие подписки в статусе "Заявка" переводятся в статус "Действующая"
Возможные переходы ИЗ этого статуса:
* Приостановлен
* Расторгнут

====Приостановлен====
Возможные переходы ИЗ этого статуса:
* Оказание услуг
* Расторгнут

==== Отменен ====
Конечный статус

==== Расторгнут ====
Конечный статус

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

2016-08-31T15:40:55Z

Polikarpov: /* Приватные методы: */

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

=Таблица в базе данных=
''achievementcats'' - Справочник разделов(категорий) шаблонов достижений

==Подробный формат полей в таблице:==
* id - ID раздела.
* name - Название раздела.
* parentid - ID родительского раздела.
* departmentid - ID подразделения.
* sortorder - Поле для стандартной сортировки разделов.
* createdate - Дата создания раздела.
* status - Статус раздела.

=Методы:=

=='''Публичные методы:'''==
==='''save( $object = null, $options = [] )'''===

Сохранить раздел

Метод сохранения раздела достижений

''Аргументы:''
* $fromid(int) - счет, с которого списываем сумму.
* $object(object) - Объект раздела
** Обязательные поля:
*** ->name - Имя раздела
*** ->departmentid - Подразделение раздела
** Необязательные поля
*** ->parentid - ID родительского раздела
*** ->sortorder - Вес сортировки
* $options(array) - Массив дополнительных параметров

''Возвращаемые значения:''
* bool - В случае ошибки сохранения
* int - ID сохраненного раздела

''Пояснения:''
Метод реализует механизм сохранения(создания или обновления) раздела в системе.

''Логика работы:''
* Проверка входных данных
* Клонирование исходного объекта для безопасной манипуляции с данными
* Нормализация свойств переданного раздела
* Выбор механизма сохранения(создание или обновление)
** Сохранение
*** Генерация служебных полей(сортировка, дата создания)
*** Добавление записи в БД
** Обновление
*** Генерация служебных полей(сортировка)
*** Обновление записи в БД

=='''Приватные методы:'''==

==='''get_sortorder($saveobj)'''===

Генерация поля сортировки раздела

Метод генерации поля сортировки на основе объекта раздела

''Аргументы:''
* saveobj(object) - Объект раздела

''Возвращаемые значения:''
* int - Вес раздела

''Пояснения:''
Метод реализует механизм генерации поля сортировки раздела. В данный момент не используется и для всех разделов возвращает 0

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

2016-08-31T15:40:36Z

Polikarpov: /* Приватные методы: */

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

=Таблица в базе данных=
''achievementcats'' - Справочник разделов(категорий) шаблонов достижений

==Подробный формат полей в таблице:==
* id - ID раздела.
* name - Название раздела.
* parentid - ID родительского раздела.
* departmentid - ID подразделения.
* sortorder - Поле для стандартной сортировки разделов.
* createdate - Дата создания раздела.
* status - Статус раздела.

=Методы:=

=='''Публичные методы:'''==
==='''save( $object = null, $options = [] )'''===

Сохранить раздел

Метод сохранения раздела достижений

''Аргументы:''
* $fromid(int) - счет, с которого списываем сумму.
* $object(object) - Объект раздела
** Обязательные поля:
*** ->name - Имя раздела
*** ->departmentid - Подразделение раздела
** Необязательные поля
*** ->parentid - ID родительского раздела
*** ->sortorder - Вес сортировки
* $options(array) - Массив дополнительных параметров

''Возвращаемые значения:''
* bool - В случае ошибки сохранения
* int - ID сохраненного раздела

''Пояснения:''
Метод реализует механизм сохранения(создания или обновления) раздела в системе.

''Логика работы:''
* Проверка входных данных
* Клонирование исходного объекта для безопасной манипуляции с данными
* Нормализация свойств переданного раздела
* Выбор механизма сохранения(создание или обновление)
** Сохранение
*** Генерация служебных полей(сортировка, дата создания)
*** Добавление записи в БД
** Обновление
*** Генерация служебных полей(сортировка)
*** Обновление записи в БД

==='''Приватные методы:'''===

===='''get_sortorder($saveobj)'''====

Генерация поля сортировки раздела

Метод генерации поля сортировки на основе объекта раздела

''Аргументы:''
* saveobj(object) - Объект раздела

''Возвращаемые значения:''
* int - Вес раздела

''Пояснения:''
Метод реализует механизм генерации поля сортировки раздела. В данный момент не используется и для всех разделов возвращает 0

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

2016-08-31T15:40:14Z

Polikarpov: /* save( $object = null, $options = [] ) */

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

=Таблица в базе данных=
''achievementcats'' - Справочник разделов(категорий) шаблонов достижений

==Подробный формат полей в таблице:==
* id - ID раздела.
* name - Название раздела.
* parentid - ID родительского раздела.
* departmentid - ID подразделения.
* sortorder - Поле для стандартной сортировки разделов.
* createdate - Дата создания раздела.
* status - Статус раздела.

=Методы:=

=='''Публичные методы:'''==
==='''save( $object = null, $options = [] )'''===

Сохранить раздел

Метод сохранения раздела достижений

''Аргументы:''
* $fromid(int) - счет, с которого списываем сумму.
* $object(object) - Объект раздела
** Обязательные поля:
*** ->name - Имя раздела
*** ->departmentid - Подразделение раздела
** Необязательные поля
*** ->parentid - ID родительского раздела
*** ->sortorder - Вес сортировки
* $options(array) - Массив дополнительных параметров

''Возвращаемые значения:''
* bool - В случае ошибки сохранения
* int - ID сохраненного раздела

''Пояснения:''
Метод реализует механизм сохранения(создания или обновления) раздела в системе.

''Логика работы:''
* Проверка входных данных
* Клонирование исходного объекта для безопасной манипуляции с данными
* Нормализация свойств переданного раздела
* Выбор механизма сохранения(создание или обновление)
** Сохранение
*** Генерация служебных полей(сортировка, дата создания)
*** Добавление записи в БД
** Обновление
*** Генерация служебных полей(сортировка)
*** Обновление записи в БД

===='''Приватные методы:'''====

===='''get_sortorder($saveobj)'''====

Генерация поля сортировки раздела

Метод генерации поля сортировки на основе объекта раздела

''Аргументы:''
* saveobj(object) - Объект раздела

''Возвращаемые значения:''
* int - Вес раздела

''Пояснения:''
Метод реализует механизм генерации поля сортировки раздела. В данный момент не используется и для всех разделов возвращает 0

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

2016-08-31T15:39:32Z

Polikarpov: Новая страница: «{{Infobox_Plugin | name = achievementcats | type = storages }} =Таблица в базе данных= ''achievementcats'' - Справочник разделов...»

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

=Таблица в базе данных=
''achievementcats'' - Справочник разделов(категорий) шаблонов достижений

==Подробный формат полей в таблице:==
* id - ID раздела.
* name - Название раздела.
* parentid - ID родительского раздела.
* departmentid - ID подразделения.
* sortorder - Поле для стандартной сортировки разделов.
* createdate - Дата создания раздела.
* status - Статус раздела.

=Методы:=

=='''Публичные методы:'''==
==='''save( $object = null, $options = [] )'''===

Сохранить раздел

Метод сохранения раздела достижений

''Аргументы:''
* $fromid(int) - счет, с которого списываем сумму.
* $object(object) - Объект раздела
** Обязательные поля:
*** ->name - Имя раздела
*** ->departmentid - Подразделение раздела
** Необязательные поля
*** ->parentid - ID родительского раздела
*** ->sortorder - Вес сортировки
* $options(array) - Массив дополнительных параметров

''Возвращаемые значения:''
* bool - В случае ошибки сохранения
* int - ID сохраненного раздела

''Пояснения:''
Метод реализует механизм сохранения(создания или обновления) раздела в системе.

''Логика работы''
* Проверка входных данных
* Клонирование исходного объекта для безопасной манипуляции с данными
* Нормализация свойств переданного раздела
* Выбор механизма сохранения(создание или обновление)
** Сохранение
*** Генерация служебных полей(сортировка, дата создания)
*** Добавление записи в БД
** Обновление
*** Генерация служебных полей(сортировка)
*** Обновление записи в БД

===='''Приватные методы:'''====

===='''get_sortorder($saveobj)'''====

Генерация поля сортировки раздела

Метод генерации поля сортировки на основе объекта раздела

''Аргументы:''
* saveobj(object) - Объект раздела

''Возвращаемые значения:''
* int - Вес раздела

''Пояснения:''
Метод реализует механизм генерации поля сортировки раздела. В данный момент не используется и для всех разделов возвращает 0

Использование:im/participants

2016-07-13T11:19:16Z

Polikarpov:

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

=Участники учебного процесса=
Для того, чтобы перейти в интерфейс, необходимо:
* Войти в Деканат под аккаунтом, имеющим доступ к интерфейсу.
* На главной странице Электронного Деканата выбрать пункт "Участники" (Блок работы с контингентом).

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

=Возможности плагина=

===Поиск и создание подписок на программы===
Для перехода к Панели управления слушателями следует выбрать вкладку "Слушатели".

Если указанная вкладка отсутствует, попытайтесь произвести следующие действия:
* Проверьте, что Вы находитесь в верном подразделении.
* Убедитесь, что Вы имеете доверенность, позволяющую использовать указанный интерфейс
* Обратитесь к Администратору Электронного Деканата

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

[[Файл:participants_students1.png|800px]]

Для поиска подписок на программы заполните одно или несколько полей формы и нажмите на кнопку "Найти подписки"
Описание полей формы поиска:
* Фамилия - Фрагмент фамилии студента по подписке. Работает автозаполнение.
* Имя - Фрагмент имени студента по подписке. Работает автозаполнение.
* Отчество - Фрагмент отчества студента по подписке. Работает автозаполнение.
* Email - Email студента. Работает автозаполнение.
* Телефон - Фрагмент номера телефона.
* Программа - Данные по программе обучения(ID, Фрагмент кода, Фрагмент названия). Работает автозаполнение.
* Параллель - Параллель, на которую записан пользователь. Работает автозаполнение с учетом лимита по выбранной программе.
* Группа - Учебная Группа подписки на обучение.

Результат поиска будет представлен в виде таблицы подписок с возможностью сортировки и разбиением на страницы.

[[Файл:participants_students2.png|800px]]

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

[[Файл:participants_students3.png|800px]]

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

[[Файл:participants_students4.png|600px]]

=====Детальное создание подписки на программу=====
Интерфейс позволяет создать подписку как на основе существующего договора студента, так и для нового студента.
Процесс делится на 5 шагов:
* 1. Выбор договора на обучение по подписке(Если требуется создать договор, можно указать ФИО персоны. Можно также указать, что требуется создать новую персону для подписки).
[[Файл:participants_create_programmsbcs1.png|600px]]
* 1.1 Если было выбрано создание новой персоны, на данном шаге отображается форма создания студента
[[Файл:participants_create_programmsbcs2.png|600px]]
* 1.2 Если договор по подписке не был указан(также если создавалась новая персона), на данном шаге будет отображена форма создания договора на обучение
[[Файл:participants_create_programmsbcs3.png|600px]]
* 1.2.1 Отображение формы с данными по пользователям договора(студент, законный представитель, куратор). Если в договоре было указано создание новых пользователей, например законного представителя, но этом шаге происходит их создание.
[[Файл:participants_create_programmsbcs4.png|600px]]
* 2. Форма создания подписки на программу. В форму автоматически подставляются данные по договору на обучение.
[[Файл:participants_create_programmsbcs5.png|600px]]

===Импорт подписок на программы (students_import.php)===

Ссылка для перехода находится в панели управления слушателями справа от формы поиска.

[[Файл:participants_students_import1.png|600px]]

Стандартный интерфейс импорта подписок представляет собой форму загрузки csv-файла и выбора разделителя

[[Файл:participants_students_import2.png|600px]]

Доступный список полей импорта:
*Договор
**studentcontract_num - Номер договора, по которому будет сформирована подписка. Если не указан, будет сгенерирован автоматически
**studentcontract_startdate - Дата заключения договора на обучение в формате dd.mm.yyyy
**studentcontract_notice - Заметка по договору
*Студент по договору
**student_email - Email студента для создания нового договора
**student_firstname - Имя студента
**student_lastname - Фамилия студента
**student_middlename - Отчество студента
**student_birthdate - Дата рождения студента в формате dd.mm.yyyy
**student_gender - Пол студента в буквенном формате (m, f, м, ж)
*Законный представитель по договору
**parent_email - Email законного представителя для создания нового договора
**parent_firstname - Имя законного представителя
**parent_lastname - Фамилия законного представителя
**parent_middlename - Отчество законного представителя
**parent_birthdate - Дата рождения законного представителя в формате dd.mm.yyyy
**parent_gender - Пол законного представителя в буквенном формате (m, f, м, ж)
*Менеджер
**seller_email - Email менеджера для создания нового договора
**seller_firstname - Имя менеджера
**seller_lastname - Фамилия менеджера
**seller_middlename - Отчество менеджера
**seller_birthdate - Дата рождения менеджера в формате dd.mm.yyyy
**seller_gender - Пол менеджера в буквенном формате (m, f, м, ж)
*Куратор
**curator_email - Email куратора для создания нового договора
**curator_firstname - Имя куратора
**curator_lastname - Фамилия куратора
**curator_middlename - Отчество куратора
**curator_birthdate - Дата рождения куратора в формате dd.mm.yyyy
**curator_gender - Пол куратора в буквенном формате (m, f, м, ж)
*Программа обучения
**programm_code - Код программы для подписки
*Академическая группа
**agroup_code - Код группы для подписки на программу
*Подписка на программу
**programmsbc_agenum - Номер параллели
**programmsbc_edutype - Тип обучения(group - групповая, individual - индивидуальная). Если не указано, выбирается значение на основе данных о группе
**programmsbc_eduform - Форма обучения(internal - очная, correspondence - заочная, internally-correspondence - очно-заочная, external-studies - экстарнат). Если не указано. выбирается значение по - умолчанию
**programmsbc_freeattendance - Свободное посещение(0, 1)
**programmsbc_datestart - Дата начала подписки в формате dd.mm.yyyy
**programmsbc_salfactor - Поправочный коэффициент

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

[[Файл:participants_students_import3.png|600px]]

Использование:im/participants

2016-07-13T11:11:01Z

Polikarpov: /* Поиск подписок на программы */

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

=Участники учебного процесса=
Для того, чтобы перейти в интерфейс, необходимо:
* Войти в Деканат под аккаунтом, имеющим доступ к интерфейсу.
* На главной странице Электронного Деканата выбрать пункт "Участники" (Блок работы с контингентом).

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

=Возможности плагина=

===Поиск и создание подписок на программы===
Для перехода к Панели управления слушателями следует выбрать вкладку "Слушатели".

Если указанная вкладка отсутствует, попытайтесь произвести следующие действия:
* Проверьте, что Вы находитесь в верном подразделении.
* Убедитесь, что Вы имеете доверенность, позволяющую использовать указанный интерфейс
* Обратитесь к Администратору Электронного Деканата

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

[[Файл:participants_students1.png|800px]]

Для поиска подписок на программы заполните одно или несколько полей формы и нажмите на кнопку "Найти подписки"
Описание полей формы поиска:
* Фамилия - Фрагмент фамилии студента по подписке. Работает автозаполнение.
* Имя - Фрагмент имени студента по подписке. Работает автозаполнение.
* Отчество - Фрагмент отчества студента по подписке. Работает автозаполнение.
* Email - Email студента. Работает автозаполнение.
* Телефон - Фрагмент номера телефона.
* Программа - Данные по программе обучения(ID, Фрагмент кода, Фрагмент названия). Работает автозаполнение.
* Параллель - Параллель, на которую записан пользователь. Работает автозаполнение с учетом лимита по выбранной программе.
* Группа - Учебная Группа подписки на обучение.

Результат поиска будет представлен в виде таблицы подписок с возможностью сортировки и разбиением на страницы.

[[Файл:participants_students2.png|800px]]

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

[[Файл:participants_students3.png|800px]]

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

[[Файл:participants_students4.png|600px]]

===Страница детального создания подписки на программу (create_programmsbc.php)===
Станица предоставляет интерфейс детального создания новой подписки на программу для студента (Интерфейс быстрого создания подписки находится в панели управления слушателями).
Интерфейс позволяет создать подписку как на основе существующего договора студента, так и для нового студента.
Процесс делится на 5 шагов:
* 1. Выбор договора на обучение по подписке(Если требуется создать договор, можно указать ФИО персоны. Можно также указать, что требуется создать новую персону для подписки).
[[Файл:participants_create_programmsbcs1.png|600px]]
* 1.1 Если было выбрано создание новой персоны, на данном шаге отображается форма создания студента
[[Файл:participants_create_programmsbcs2.png|600px]]
* 1.2 Если договор по подписке не был указан(также если создавалась новая персона), на данном шаге будет отображена форма создания договора на обучение
[[Файл:participants_create_programmsbcs3.png|600px]]
* 1.2.1 Отображение формы с данными по пользователям договора(студент, законный представитель, куратор). Если в договоре было указано создание новых пользователей, например законного представителя, но этом шаге происходит их создание.
[[Файл:participants_create_programmsbcs4.png|600px]]
* 2. Форма создания подписки на программу. В форму автоматически подставляются данные по договору на обучение.
[[Файл:participants_create_programmsbcs5.png|600px]]

===Импорт подписок на программы (students_import.php)===

Ссылка для перехода находится в панели управления слушателями справа от формы поиска.

[[Файл:participants_students_import1.png|600px]]

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

[[Файл:participants_students_import2.png|600px]]

Доступный список полей импорта:
*Договор
**studentcontract_num - Номер договора, по которому будет сформирована подписка. Если не указан, будет сгенерирован автоматически
**studentcontract_startdate - Дата заключения договора на обучение в формате dd.mm.yyyy
**studentcontract_notice - Заметка по договору
*Студент по договору
**student_email - Email студента для создания нового договора
**student_firstname - Имя студента
**student_lastname - Фамилия студента
**student_middlename - Отчество студента
**student_birthdate - Дата рождения студента в формате dd.mm.yyyy
**student_gender - Пол студента в буквенном формате (m, f, м, ж)
*Законный представитель по договору
**parent_email - Email законного представителя для создания нового договора
**parent_firstname - Имя законного представителя
**parent_lastname - Фамилия законного представителя
**parent_middlename - Отчество законного представителя
**parent_birthdate - Дата рождения законного представителя в формате dd.mm.yyyy
**parent_gender - Пол законного представителя в буквенном формате (m, f, м, ж)
*Менеджер
**seller_email - Email менеджера для создания нового договора
**seller_firstname - Имя менеджера
**seller_lastname - Фамилия менеджера
**seller_middlename - Отчество менеджера
**seller_birthdate - Дата рождения менеджера в формате dd.mm.yyyy
**seller_gender - Пол менеджера в буквенном формате (m, f, м, ж)
*Куратор
**curator_email - Email куратора для создания нового договора
**curator_firstname - Имя куратора
**curator_lastname - Фамилия куратора
**curator_middlename - Отчество куратора
**curator_birthdate - Дата рождения куратора в формате dd.mm.yyyy
**curator_gender - Пол куратора в буквенном формате (m, f, м, ж)
*Программа обучения
**programm_code - Код программы для подписки
*Академическая группа
**agroup_code - Код группы для подписки на программу
*Подписка на программу
**programmsbc_agenum - Номер параллели
**programmsbc_edutype - Тип обучения(group - групповая, individual - индивидуальная). Если не указано, выбирается значение на основе данных о группе
**programmsbc_eduform - Форма обучения(internal - очная, correspondence - заочная, internally-correspondence - очно-заочная, external-studies - экстарнат). Если не указано. выбирается значение по - умолчанию
**programmsbc_freeattendance - Свободное посещение(0, 1)
**programmsbc_datestart - Дата начала подписки в формате dd.mm.yyyy
**programmsbc_salfactor - Поправочный коэффициент

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

[[Файл:participants_students_import3.png|600px]]

Использование:im/participants

2016-07-13T11:09:46Z

Polikarpov:

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

=Участники учебного процесса=
Для того, чтобы перейти в интерфейс, необходимо:
* Войти в Деканат под аккаунтом, имеющим доступ к интерфейсу.
* На главной странице Электронного Деканата выбрать пункт "Участники" (Блок работы с контингентом).

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

=Возможности плагина=

===Поиск и создание подписок на программы===
Для перехода к Панели управления слушателями следует выбрать вкладку "Слушатели".

Если указанная вкладка отсутствует, попытайтесь произвести следующие действия:
* Проверьте, что Вы находитесь в верном подразделении.
* Убедитесь, что Вы имеете доверенность, позволяющую использовать указанный интерфейс
* Обратитесь к Администратору Электронного Деканата

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

[[Файл:participants_students1.png|600px]]

Для поиска подписок на программы заполните одно или несколько полей формы и нажмите на кнопку "Найти подписки"
Описание полей формы поиска:
* Фамилия - Фрагмент фамилии студента по подписке. Работает автозаполнение.
* Имя - Фрагмент имени студента по подписке. Работает автозаполнение.
* Отчество - Фрагмент отчества студента по подписке. Работает автозаполнение.
* Email - Email студента. Работает автозаполнение.
* Телефон - Фрагмент номера телефона.
* Программа - Данные по программе обучения(ID, Фрагмент кода, Фрагмент названия). Работает автозаполнение.
* Параллель - Параллель, на которую записан пользователь. Работает автозаполнение с учетом лимита по выбранной программе.
* Группа - Учебная Группа подписки на обучение.

Результат поиска будет представлен в виде таблицы подписок с возможностью сортировки и разбиением на страницы.

[[Файл:participants_students2.png|600px]]

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

[[Файл:participants_students3.png|600px]]

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

[[Файл:participants_students4.png|600px]]

===Страница детального создания подписки на программу (create_programmsbc.php)===
Станица предоставляет интерфейс детального создания новой подписки на программу для студента (Интерфейс быстрого создания подписки находится в панели управления слушателями).
Интерфейс позволяет создать подписку как на основе существующего договора студента, так и для нового студента.
Процесс делится на 5 шагов:
* 1. Выбор договора на обучение по подписке(Если требуется создать договор, можно указать ФИО персоны. Можно также указать, что требуется создать новую персону для подписки).
[[Файл:participants_create_programmsbcs1.png|600px]]
* 1.1 Если было выбрано создание новой персоны, на данном шаге отображается форма создания студента
[[Файл:participants_create_programmsbcs2.png|600px]]
* 1.2 Если договор по подписке не был указан(также если создавалась новая персона), на данном шаге будет отображена форма создания договора на обучение
[[Файл:participants_create_programmsbcs3.png|600px]]
* 1.2.1 Отображение формы с данными по пользователям договора(студент, законный представитель, куратор). Если в договоре было указано создание новых пользователей, например законного представителя, но этом шаге происходит их создание.
[[Файл:participants_create_programmsbcs4.png|600px]]
* 2. Форма создания подписки на программу. В форму автоматически подставляются данные по договору на обучение.
[[Файл:participants_create_programmsbcs5.png|600px]]

===Импорт подписок на программы (students_import.php)===

Ссылка для перехода находится в панели управления слушателями справа от формы поиска.

[[Файл:participants_students_import1.png|600px]]

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

[[Файл:participants_students_import2.png|600px]]

Доступный список полей импорта:
*Договор
**studentcontract_num - Номер договора, по которому будет сформирована подписка. Если не указан, будет сгенерирован автоматически
**studentcontract_startdate - Дата заключения договора на обучение в формате dd.mm.yyyy
**studentcontract_notice - Заметка по договору
*Студент по договору
**student_email - Email студента для создания нового договора
**student_firstname - Имя студента
**student_lastname - Фамилия студента
**student_middlename - Отчество студента
**student_birthdate - Дата рождения студента в формате dd.mm.yyyy
**student_gender - Пол студента в буквенном формате (m, f, м, ж)
*Законный представитель по договору
**parent_email - Email законного представителя для создания нового договора
**parent_firstname - Имя законного представителя
**parent_lastname - Фамилия законного представителя
**parent_middlename - Отчество законного представителя
**parent_birthdate - Дата рождения законного представителя в формате dd.mm.yyyy
**parent_gender - Пол законного представителя в буквенном формате (m, f, м, ж)
*Менеджер
**seller_email - Email менеджера для создания нового договора
**seller_firstname - Имя менеджера
**seller_lastname - Фамилия менеджера
**seller_middlename - Отчество менеджера
**seller_birthdate - Дата рождения менеджера в формате dd.mm.yyyy
**seller_gender - Пол менеджера в буквенном формате (m, f, м, ж)
*Куратор
**curator_email - Email куратора для создания нового договора
**curator_firstname - Имя куратора
**curator_lastname - Фамилия куратора
**curator_middlename - Отчество куратора
**curator_birthdate - Дата рождения куратора в формате dd.mm.yyyy
**curator_gender - Пол куратора в буквенном формате (m, f, м, ж)
*Программа обучения
**programm_code - Код программы для подписки
*Академическая группа
**agroup_code - Код группы для подписки на программу
*Подписка на программу
**programmsbc_agenum - Номер параллели
**programmsbc_edutype - Тип обучения(group - групповая, individual - индивидуальная). Если не указано, выбирается значение на основе данных о группе
**programmsbc_eduform - Форма обучения(internal - очная, correspondence - заочная, internally-correspondence - очно-заочная, external-studies - экстарнат). Если не указано. выбирается значение по - умолчанию
**programmsbc_freeattendance - Свободное посещение(0, 1)
**programmsbc_datestart - Дата начала подписки в формате dd.mm.yyyy
**programmsbc_salfactor - Поправочный коэффициент

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

[[Файл:participants_students_import3.png|600px]]

Использование:im/participants

2016-07-13T11:06:40Z

Polikarpov: Новая страница: «{{Infobox_Plugin | name = participants | type = im }} =Участники учебного процесса= Для того, чтобы перейти в инте...»

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

=Участники учебного процесса=
Для того, чтобы перейти в интерфейс, необходимо:
* Войти в Деканат под аккаунтом, имеющим доступ к интерфейсу.
* На главной странице Электронного Деканата выбрать пункт "Участники" (Блок работы с контингентом).

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

=Возможности плагина=

===Поиск и создание подписок на программы===
Для перехода к Панели управления слушателями следует выбрать вкладку "Слушатели".

Если указанная вкладка отсутствует, попытайтесь произвести следующие действия:
* Проверьте, что Вы находитесь в верном подразделении.
* Убедитесь, что Вы имеете доверенность, позволяющую использовать указанный интерфейс
* Обратитесь к Администратору Электронного Деканата

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

[[Файл:participants_students1.png|300px]]

Для поиска подписок на программы заполните одно или несколько полей формы и нажмите на кнопку "Найти подписки"
Описание полей формы поиска:
* Фамилия - Фрагмент фамилии студента по подписке. Работает автозаполнение.
* Имя - Фрагмент имени студента по подписке. Работает автозаполнение.
* Отчество - Фрагмент отчества студента по подписке. Работает автозаполнение.
* Email - Email студента. Работает автозаполнение.
* Телефон - Фрагмент номера телефона.
* Программа - Данные по программе обучения(ID, Фрагмент кода, Фрагмент названия). Работает автозаполнение.
* Параллель - Параллель, на которую записан пользователь. Работает автозаполнение с учетом лимита по выбранной программе.
* Группа - Учебная Группа подписки на обучение.

Результат поиска будет представлен в виде таблицы подписок с возможностью сортировки и разбиением на страницы.

[[Файл:participants_students2.png|300px]]

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

[[Файл:participants_students3.png|300px]]

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

[[Файл:participants_students4.png|300px]]

===Страница детального создания подписки на программу (create_programmsbc.php)===
Станица предоставляет интерфейс детального создания новой подписки на программу для студента (Интерфейс быстрого создания подписки находится в панели управления слушателями).
Интерфейс позволяет создать подписку как на основе существующего договора студента, так и для нового студента.
Процесс делится на 5 шагов:
* 1. Выбор договора на обучение по подписке(Если требуется создать договор, можно указать ФИО персоны. Можно также указать, что требуется создать новую персону для подписки).
[[Файл:participants_create_programmsbcs1.png|300px]]
* 1.1 Если было выбрано создание новой персоны, на данном шаге отображается форма создания студента
[[Файл:participants_create_programmsbcs2.png|300px]]
* 1.2 Если договор по подписке не был указан(также если создавалась новая персона), на данном шаге будет отображена форма создания договора на обучение
[[Файл:participants_create_programmsbcs3.png|300px]]
* 1.2.1 Отображение формы с данными по пользователям договора(студент, законный представитель, куратор). Если в договоре было указано создание новых пользователей, например законного представителя, но этом шаге происходит их создание.
[[Файл:participants_create_programmsbcs4.png|300px]]
* 2. Форма создания подписки на программу. В форму автоматически подставляются данные по договору на обучение.
[[Файл:participants_create_programmsbcs5.png|300px]]

===Импорт подписок на программы (students_import.php)===

Ссылка для перехода находится в панели управления слушателями справа от формы поиска.

[[Файл:participants_students_import1.png|300px]]

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

[[Файл:participants_students_import2.png|300px]]

Доступный список полей импорта:
*Договор
**studentcontract_num - Номер договора, по которому будет сформирована подписка. Если не указан, будет сгенерирован автоматически
**studentcontract_startdate - Дата заключения договора на обучение в формате dd.mm.yyyy
**studentcontract_notice - Заметка по договору
*Студент по договору
**student_email - Email студента для создания нового договора
**student_firstname - Имя студента
**student_lastname - Фамилия студента
**student_middlename - Отчество студента
**student_birthdate - Дата рождения студента в формате dd.mm.yyyy
**student_gender - Пол студента в буквенном формате (m, f, м, ж)
*Законный представитель по договору
**parent_email - Email законного представителя для создания нового договора
**parent_firstname - Имя законного представителя
**parent_lastname - Фамилия законного представителя
**parent_middlename - Отчество законного представителя
**parent_birthdate - Дата рождения законного представителя в формате dd.mm.yyyy
**parent_gender - Пол законного представителя в буквенном формате (m, f, м, ж)
*Менеджер
**seller_email - Email менеджера для создания нового договора
**seller_firstname - Имя менеджера
**seller_lastname - Фамилия менеджера
**seller_middlename - Отчество менеджера
**seller_birthdate - Дата рождения менеджера в формате dd.mm.yyyy
**seller_gender - Пол менеджера в буквенном формате (m, f, м, ж)
*Куратор
**curator_email - Email куратора для создания нового договора
**curator_firstname - Имя куратора
**curator_lastname - Фамилия куратора
**curator_middlename - Отчество куратора
**curator_birthdate - Дата рождения куратора в формате dd.mm.yyyy
**curator_gender - Пол куратора в буквенном формате (m, f, м, ж)
*Программа обучения
**programm_code - Код программы для подписки
*Академическая группа
**agroup_code - Код группы для подписки на программу
*Подписка на программу
**programmsbc_agenum - Номер параллели
**programmsbc_edutype - Тип обучения(group - групповая, individual - индивидуальная). Если не указано, выбирается значение на основе данных о группе
**programmsbc_eduform - Форма обучения(internal - очная, correspondence - заочная, internally-correspondence - очно-заочная, external-studies - экстарнат). Если не указано. выбирается значение по - умолчанию
**programmsbc_freeattendance - Свободное посещение(0, 1)
**programmsbc_datestart - Дата начала подписки в формате dd.mm.yyyy
**programmsbc_salfactor - Поправочный коэффициент

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

[[Файл:participants_students_import3.png|300px]]

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

2016-07-12T08:24:29Z

Polikarpov: /* Поиск подписок на программы */

{{Infobox_Plugin
| name = participants
| type = im
}}
=Участники учебного процесса=
Интерфейс участников учебного процесса представляет собой набор панелей управления различных элементов Электронного Деканата. Все панели управления имеют свои глобальные права доступа, позволяя ограничить возможности сотрудников в Интерфейсе.

=Описание страниц=
===Точка входа в плагин (index.php)===
Данная страница является точкой входа в плагин и не предоставляет какого-либо уникального функционала.
В верхней части страницы отображены вкладки для перехода к отдельным панелям управления Интерфейса.

===Панель управления слушателями (students.php)===
Центральный интерфейс управления подписками на программы.

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

[[Файл:participants_students1.png|300px]]

Описание полей формы поиска:
* Фамилия - Фрагмент фамилии студента по подписке. Работает автозаполнение.
* Имя - Фрагмент имени студента по подписке. Работает автозаполнение.
* Отчество - Фрагмент отчества студента по подписке. Работает автозаполнение.
* Email - Email студента. Работает автозаполнение.
* Телефон - Фрагмент номера телефона.
* Программа - Данные по программе обучения(ID, Фрагмент кода, Фрагмент названия). Работает автозаполнение.
* Параллель - Параллель, на которую записан пользователь. Работает автозаполнение с учетом лимита по выбранной программе.
* Группа - Учебная Группа подписки на обучение.

По результатам поиска пользователю будет показана таблица подписок на программы, находящиеся в текущем подразделении и соответствующие критериям поиска. Если необходимо отобразить полный список подписок - критерии указывать не нужно. Таблица подписок разбита по страницам. Число подписок на одной странице можно регулировать с помощью соответствующего выпадающего списка. Также в таблице присутствует сортировка по полям(прямая и обратная).

[[Файл:participants_students2.png|300px]]

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

[[Файл:participants_students3.png|300px]]

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

[[Файл:participants_students4.png|300px]]

===Страница детального создания подписки на программу (create_programmsbc.php)===
Станица предоставляет интерфейс детального создания новой подписки на программу для студента (Интерфейс быстрого создания подписки находится в панели управления слушателями).
Интерфейс позволяет создать подписку как на основе существующего договора студента, так и для нового студента.
Процесс делится на 5 шагов, каждый новый этап подразумевает успешное прохождение предыдущих.
* 1. Выбор договора на обучение по подписке(Если требуется создать договор, можно указать ФИО персоны. Можно также указать, что требуется создать новую персону для подписки).
[[Файл:participants_create_programmsbcs1.png|300px]]
* 1.1 Если было выбрано создание новой персоны, на данном шаге отображается форма создания студента
[[Файл:participants_create_programmsbcs2.png|300px]]
* 1.2 Если договор по подписке не был указан(также если создавалась новая персона), на данном шаге будет отображена форма создания договора на обучение
[[Файл:participants_create_programmsbcs3.png|300px]]
* 1.2.1 Отображение формы с данными по пользователям договора(студент, законный представитель, куратор). Если в договоре было указано создание новых пользователей, например законного представителя, но этом шаге происходит их создание.
[[Файл:participants_create_programmsbcs4.png|300px]]
* 2. Форма создания подписки на программу. В форму автоматически подставляются данные по договору на обучение.
[[Файл:participants_create_programmsbcs5.png|300px]]

===Импорт подписок на программы (students_import.php)===

Ссылка для перехода находится в панели управления слушателями справа от формы поиска.

[[Файл:participants_students_import1.png|300px]]

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

[[Файл:participants_students_import2.png|300px]]

Доступный список полей импорта:
*Договор
**studentcontract_num - Номер договора, по которому будет сформирована подписка. Если не указан, будет сгенерирован автоматически
**studentcontract_startdate - Дата заключения договора на обучение в формате dd.mm.yyyy
**studentcontract_notice - Заметка по договору
*Студент по договору
**student_email - Email студента для создания нового договора
**student_firstname - Имя студента
**student_lastname - Фамилия студента
**student_middlename - Отчество студента
**student_birthdate - Дата рождения студента в формате dd.mm.yyyy
**student_gender - Пол студента в буквенном формате (m, f, м, ж)
*Законный представитель по договору
**parent_email - Email законного представителя для создания нового договора
**parent_firstname - Имя законного представителя
**parent_lastname - Фамилия законного представителя
**parent_middlename - Отчество законного представителя
**parent_birthdate - Дата рождения законного представителя в формате dd.mm.yyyy
**parent_gender - Пол законного представителя в буквенном формате (m, f, м, ж)
*Менеджер
**seller_email - Email менеджера для создания нового договора
**seller_firstname - Имя менеджера
**seller_lastname - Фамилия менеджера
**seller_middlename - Отчество менеджера
**seller_birthdate - Дата рождения менеджера в формате dd.mm.yyyy
**seller_gender - Пол менеджера в буквенном формате (m, f, м, ж)
*Куратор
**curator_email - Email куратора для создания нового договора
**curator_firstname - Имя куратора
**curator_lastname - Фамилия куратора
**curator_middlename - Отчество куратора
**curator_birthdate - Дата рождения куратора в формате dd.mm.yyyy
**curator_gender - Пол куратора в буквенном формате (m, f, м, ж)
*Программа обучения
**programm_code - Код программы для подписки
*Академическая группа
**agroup_code - Код группы для подписки на программу
*Подписка на программу
**programmsbc_agenum - Номер параллели
**programmsbc_edutype - Тип обучения(group - групповая, individual - индивидуальная). Если не указано, выбирается значение на основе данных о группе
**programmsbc_eduform - Форма обучения(internal - очная, correspondence - заочная, internally-correspondence - очно-заочная, external-studies - экстарнат). Если не указано. выбирается значение по - умолчанию
**programmsbc_freeattendance - Свободное посещение(0, 1)
**programmsbc_datestart - Дата начала подписки в формате dd.mm.yyyy
**programmsbc_salfactor - Поправочный коэффициент

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

[[Файл:participants_students_import3.png|300px]]

==API==

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

2016-07-12T08:15:51Z

Polikarpov:

{{Infobox_Plugin
| name = participants
| type = im
}}
=Участники учебного процесса=
Интерфейс участников учебного процесса представляет собой набор панелей управления различных элементов Электронного Деканата. Все панели управления имеют свои глобальные права доступа, позволяя ограничить возможности сотрудников в Интерфейсе.

=Описание страниц=
===Точка входа в плагин (index.php)===
Данная страница является точкой входа в плагин и не предоставляет какого-либо уникального функционала.
В верхней части страницы отображены вкладки для перехода к отдельным панелям управления Интерфейса.

===Панель управления слушателями (students.php)===
Центральный интерфейс управления подписками на программы.

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

[[Файл:participants_students1.png|300px]]

Описание полей формы поиска:
* Фамилия - Фрагмент фамилии студента по подписке. Работает автозаполнение.
* Имя - Фрагмент имени студента по подписке. Работает автозаполнение.
* Отчество - Фрагмент отчества студента по подписке. Работает автозаполнение.
* Email - Email студента. Работает автозаполнение.
* Телефон - Фрагмент номера телефона.
* Программа - Данные по программе обучения(ID, Фрагмент кода, Фрагмент названия). Работает автозаполнение.
* Параллель - Параллель, на которую записан пользователь. Работает автозаполнение с учетом лимита по выбранной программе.
* Группа - Учебная Группа подписки на обучение.

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

[[Файл:participants_students2.png|300px]]

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

[[Файл:participants_students3.png|300px]]

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

[[Файл:participants_students4.png|300px]]

===Страница детального создания подписки на программу (create_programmsbc.php)===
Станица предоставляет интерфейс детального создания новой подписки на программу для студента (Интерфейс быстрого создания подписки находится в панели управления слушателями).
Интерфейс позволяет создать подписку как на основе существующего договора студента, так и для нового студента.
Процесс делится на 5 шагов, каждый новый этап подразумевает успешное прохождение предыдущих.
* 1. Выбор договора на обучение по подписке(Если требуется создать договор, можно указать ФИО персоны. Можно также указать, что требуется создать новую персону для подписки).
[[Файл:participants_create_programmsbcs1.png|300px]]
* 1.1 Если было выбрано создание новой персоны, на данном шаге отображается форма создания студента
[[Файл:participants_create_programmsbcs2.png|300px]]
* 1.2 Если договор по подписке не был указан(также если создавалась новая персона), на данном шаге будет отображена форма создания договора на обучение
[[Файл:participants_create_programmsbcs3.png|300px]]
* 1.2.1 Отображение формы с данными по пользователям договора(студент, законный представитель, куратор). Если в договоре было указано создание новых пользователей, например законного представителя, но этом шаге происходит их создание.
[[Файл:participants_create_programmsbcs4.png|300px]]
* 2. Форма создания подписки на программу. В форму автоматически подставляются данные по договору на обучение.
[[Файл:participants_create_programmsbcs5.png|300px]]

===Импорт подписок на программы (students_import.php)===

Ссылка для перехода находится в панели управления слушателями справа от формы поиска.

[[Файл:participants_students_import1.png|300px]]

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

[[Файл:participants_students_import2.png|300px]]

Доступный список полей импорта:
*Договор
**studentcontract_num - Номер договора, по которому будет сформирована подписка. Если не указан, будет сгенерирован автоматически
**studentcontract_startdate - Дата заключения договора на обучение в формате dd.mm.yyyy
**studentcontract_notice - Заметка по договору
*Студент по договору
**student_email - Email студента для создания нового договора
**student_firstname - Имя студента
**student_lastname - Фамилия студента
**student_middlename - Отчество студента
**student_birthdate - Дата рождения студента в формате dd.mm.yyyy
**student_gender - Пол студента в буквенном формате (m, f, м, ж)
*Законный представитель по договору
**parent_email - Email законного представителя для создания нового договора
**parent_firstname - Имя законного представителя
**parent_lastname - Фамилия законного представителя
**parent_middlename - Отчество законного представителя
**parent_birthdate - Дата рождения законного представителя в формате dd.mm.yyyy
**parent_gender - Пол законного представителя в буквенном формате (m, f, м, ж)
*Менеджер
**seller_email - Email менеджера для создания нового договора
**seller_firstname - Имя менеджера
**seller_lastname - Фамилия менеджера
**seller_middlename - Отчество менеджера
**seller_birthdate - Дата рождения менеджера в формате dd.mm.yyyy
**seller_gender - Пол менеджера в буквенном формате (m, f, м, ж)
*Куратор
**curator_email - Email куратора для создания нового договора
**curator_firstname - Имя куратора
**curator_lastname - Фамилия куратора
**curator_middlename - Отчество куратора
**curator_birthdate - Дата рождения куратора в формате dd.mm.yyyy
**curator_gender - Пол куратора в буквенном формате (m, f, м, ж)
*Программа обучения
**programm_code - Код программы для подписки
*Академическая группа
**agroup_code - Код группы для подписки на программу
*Подписка на программу
**programmsbc_agenum - Номер параллели
**programmsbc_edutype - Тип обучения(group - групповая, individual - индивидуальная). Если не указано, выбирается значение на основе данных о группе
**programmsbc_eduform - Форма обучения(internal - очная, correspondence - заочная, internally-correspondence - очно-заочная, external-studies - экстарнат). Если не указано. выбирается значение по - умолчанию
**programmsbc_freeattendance - Свободное посещение(0, 1)
**programmsbc_datestart - Дата начала подписки в формате dd.mm.yyyy
**programmsbc_salfactor - Поправочный коэффициент

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

[[Файл:participants_students_import3.png|300px]]

==API==

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

2016-07-12T08:15:09Z

Polikarpov: /* Точка входа в плагин (index.php) */

{{Infobox_Plugin
| name = participants
| type = im
}}
=Участники учебного процесса=
Интерфейс участников учебного процесса представляет собой набор панелей управления различных элементов Электронного Деканата. Все панели управления имеют свои глобальные права доступа, позволяя ограничить возможности сотрудников в Интерфейсе.

=Описание страниц=
===Точка входа в плагин (index.php)===
Данная страница является точкой входа в плагин и не предоставляет какого-либо уникального функционала.
В верхней части страницы отображены вкладки для перехода к отдельным панелям управления Интерфейса.

===Панель управления слушателями (students.php)===
Центральный интерфейс управления подписками на программы.

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

[[Файл:participants_students1.png|300px]]

Описание полей формы поиска:
* Фамилия - Фрагмент фамилии студента по подписке. Работает автозаполнение.
* Имя - Фрагмент имени студента по подписке. Работает автозаполнение.
* Отчество - Фрагмент отчества студента по подписке. Работает автозаполнение.
* Email - Email студента. Работает автозаполнение.
* Телефон - Фрагмент номера телефона.
* Программа - Данные по программе обучения(ID, Фрагмент кода, Фрагмент названия). Работает автозаполнение.
* Параллель - Параллель, на которую записан пользователь. Работает автозаполнение с учетом лимита по выбранной программе.
* Группа - Учебная Группа подписки на обучение.

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

[[Файл:participants_students2.png|300px]]

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

[[Файл:participants_students3.png|300px]]

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

[[Файл:participants_students4.png|300px]]

===Страница детального создания подписки на программу (create_programmsbc.php)===
Станица предоставляет интерфейс детального создания новой подписки на программу для студента (Интерфейс быстрого создания подписки находится в панели управления слушателями).
Интерфейс позволяет создать подписку как на основе существующего договора студента, так и для нового студента.
Процесс делится на 5 шагов, каждый новый этап подразумевает успешное прохождение предыдущих.
* 1. Выбор договора на обучение по подписке(Если требуется создать договор, можно указать ФИО персоны. Можно также указать, что требуется создать новую персону для подписки).
[[Файл:participants_create_programmsbcs1.png|300px]]
* 1.1 Если было выбрано создание новой персоны, на данном шаге отображается форма создания студента
[[Файл:participants_create_programmsbcs2.png|300px]]
* 1.2 Если договор по подписке не был указан(также если создавалась новая персона), на данном шаге будет отображена форма создания договора на обучение
[[Файл:participants_create_programmsbcs3.png|300px]]
* 1.2.1 Отображение формы с данными по пользователям договора(студент, законный представитель, куратор). Если в договоре было указано создание новых пользователей, например законного представителя, но этом шаге происходит их создание.
[[Файл:participants_create_programmsbcs4.png|300px]]
* 2. Форма создания подписки на программу. В форму автоматически подставляются данные по договору на обучение.
[[Файл:participants_create_programmsbcs5.png|300px]]

===Импорт подписок на программы (students_import.php)===

Ссылка для перехода находится в панели управления слушателями справа от формы поиска.

[[Файл:participants_students_import1.png|300px]]

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

[[Файл:participants_students_import2.png|300px]]

Доступный список полей импорта:
*Договор
**studentcontract_num - Номер договора, по которому будет сформирована подписка. Если не указан, будет сгенерирован автоматически
**studentcontract_startdate - Дата заключения договора на обучение в формате dd.mm.yyyy
**studentcontract_notice - Заметка по договору
*Студент по договору
**student_email - Email студента для создания нового договора
**student_firstname - Имя студента
**student_lastname - Фамилия студента
**student_middlename - Отчество студента
**student_birthdate - Дата рождения студента в формате dd.mm.yyyy
**student_gender - Пол студента в буквенном формате (m, f, м, ж)
*Законный представитель по договору
**parent_email - Email законного представителя для создания нового договора
**parent_firstname - Имя законного представителя
**parent_lastname - Фамилия законного представителя
**parent_middlename - Отчество законного представителя
**parent_birthdate - Дата рождения законного представителя в формате dd.mm.yyyy
**parent_gender - Пол законного представителя в буквенном формате (m, f, м, ж)
*Менеджер
**seller_email - Email менеджера для создания нового договора
**seller_firstname - Имя менеджера
**seller_lastname - Фамилия менеджера
**seller_middlename - Отчество менеджера
**seller_birthdate - Дата рождения менеджера в формате dd.mm.yyyy
**seller_gender - Пол менеджера в буквенном формате (m, f, м, ж)
*Куратор
**curator_email - Email куратора для создания нового договора
**curator_firstname - Имя куратора
**curator_lastname - Фамилия куратора
**curator_middlename - Отчество куратора
**curator_birthdate - Дата рождения куратора в формате dd.mm.yyyy
**curator_gender - Пол куратора в буквенном формате (m, f, м, ж)
*Программа обучения
**programm_code - Код программы для подписки
*Академическая группа
**agroup_code - Код группы для подписки на программу
*Подписка на программу
**programmsbc_agenum - Номер параллели
**programmsbc_edutype - Тип обучения(group - групповая, individual - индивидуальная). Если не указано, выбирается значение на основе данных о группе
**programmsbc_eduform - Форма обучения(internal - очная, correspondence - заочная, internally-correspondence - очно-заочная, external-studies - экстарнат). Если не указано. выбирается значение по - умолчанию
**programmsbc_freeattendance - Свободное посещение(0, 1)
**programmsbc_datestart - Дата начала подписки в формате dd.mm.yyyy
**programmsbc_salfactor - Поправочный коэффициент

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

[[Файл:participants_students_import3.png|300px]]

==API==

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

2016-07-12T08:14:15Z

Polikarpov:

{{Infobox_Plugin
| name = participants
| type = im
}}
=Участники учебного процесса=
Интерфейс участников учебного процесса представляет собой набор панелей управления различных элементов Электронного Деканата. Все панели управления имеют свои глобальные права доступа, позволяя ограничить возможности сотрудников в Интерфейсе.

=Описание страниц=
===Точка входа в плагин (index.php)===
Данная страница является точкой входа в плагин и не предоставляет какого-либо уникального функционала.
В верхней части страницы отображены вкладки для перехода к отдельным панелям управления интерфейса.

===Панель управления слушателями (students.php)===
Центральный интерфейс управления подписками на программы.

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

[[Файл:participants_students1.png|300px]]

Описание полей формы поиска:
* Фамилия - Фрагмент фамилии студента по подписке. Работает автозаполнение.
* Имя - Фрагмент имени студента по подписке. Работает автозаполнение.
* Отчество - Фрагмент отчества студента по подписке. Работает автозаполнение.
* Email - Email студента. Работает автозаполнение.
* Телефон - Фрагмент номера телефона.
* Программа - Данные по программе обучения(ID, Фрагмент кода, Фрагмент названия). Работает автозаполнение.
* Параллель - Параллель, на которую записан пользователь. Работает автозаполнение с учетом лимита по выбранной программе.
* Группа - Учебная Группа подписки на обучение.

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

[[Файл:participants_students2.png|300px]]

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

[[Файл:participants_students3.png|300px]]

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

[[Файл:participants_students4.png|300px]]

===Страница детального создания подписки на программу (create_programmsbc.php)===
Станица предоставляет интерфейс детального создания новой подписки на программу для студента (Интерфейс быстрого создания подписки находится в панели управления слушателями).
Интерфейс позволяет создать подписку как на основе существующего договора студента, так и для нового студента.
Процесс делится на 5 шагов, каждый новый этап подразумевает успешное прохождение предыдущих.
* 1. Выбор договора на обучение по подписке(Если требуется создать договор, можно указать ФИО персоны. Можно также указать, что требуется создать новую персону для подписки).
[[Файл:participants_create_programmsbcs1.png|300px]]
* 1.1 Если было выбрано создание новой персоны, на данном шаге отображается форма создания студента
[[Файл:participants_create_programmsbcs2.png|300px]]
* 1.2 Если договор по подписке не был указан(также если создавалась новая персона), на данном шаге будет отображена форма создания договора на обучение
[[Файл:participants_create_programmsbcs3.png|300px]]
* 1.2.1 Отображение формы с данными по пользователям договора(студент, законный представитель, куратор). Если в договоре было указано создание новых пользователей, например законного представителя, но этом шаге происходит их создание.
[[Файл:participants_create_programmsbcs4.png|300px]]
* 2. Форма создания подписки на программу. В форму автоматически подставляются данные по договору на обучение.
[[Файл:participants_create_programmsbcs5.png|300px]]

===Импорт подписок на программы (students_import.php)===

Ссылка для перехода находится в панели управления слушателями справа от формы поиска.

[[Файл:participants_students_import1.png|300px]]

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

[[Файл:participants_students_import2.png|300px]]

Доступный список полей импорта:
*Договор
**studentcontract_num - Номер договора, по которому будет сформирована подписка. Если не указан, будет сгенерирован автоматически
**studentcontract_startdate - Дата заключения договора на обучение в формате dd.mm.yyyy
**studentcontract_notice - Заметка по договору
*Студент по договору
**student_email - Email студента для создания нового договора
**student_firstname - Имя студента
**student_lastname - Фамилия студента
**student_middlename - Отчество студента
**student_birthdate - Дата рождения студента в формате dd.mm.yyyy
**student_gender - Пол студента в буквенном формате (m, f, м, ж)
*Законный представитель по договору
**parent_email - Email законного представителя для создания нового договора
**parent_firstname - Имя законного представителя
**parent_lastname - Фамилия законного представителя
**parent_middlename - Отчество законного представителя
**parent_birthdate - Дата рождения законного представителя в формате dd.mm.yyyy
**parent_gender - Пол законного представителя в буквенном формате (m, f, м, ж)
*Менеджер
**seller_email - Email менеджера для создания нового договора
**seller_firstname - Имя менеджера
**seller_lastname - Фамилия менеджера
**seller_middlename - Отчество менеджера
**seller_birthdate - Дата рождения менеджера в формате dd.mm.yyyy
**seller_gender - Пол менеджера в буквенном формате (m, f, м, ж)
*Куратор
**curator_email - Email куратора для создания нового договора
**curator_firstname - Имя куратора
**curator_lastname - Фамилия куратора
**curator_middlename - Отчество куратора
**curator_birthdate - Дата рождения куратора в формате dd.mm.yyyy
**curator_gender - Пол куратора в буквенном формате (m, f, м, ж)
*Программа обучения
**programm_code - Код программы для подписки
*Академическая группа
**agroup_code - Код группы для подписки на программу
*Подписка на программу
**programmsbc_agenum - Номер параллели
**programmsbc_edutype - Тип обучения(group - групповая, individual - индивидуальная). Если не указано, выбирается значение на основе данных о группе
**programmsbc_eduform - Форма обучения(internal - очная, correspondence - заочная, internally-correspondence - очно-заочная, external-studies - экстарнат). Если не указано. выбирается значение по - умолчанию
**programmsbc_freeattendance - Свободное посещение(0, 1)
**programmsbc_datestart - Дата начала подписки в формате dd.mm.yyyy
**programmsbc_salfactor - Поправочный коэффициент

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

[[Файл:participants_students_import3.png|300px]]

==API==

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

2016-07-12T08:13:35Z

Polikarpov: /* Участники учебного процесса */

{{Infobox_Plugin
| name = participants
| type = im
}}
=Участники учебного процесса=
Интерфейс участников учебного процесса представляет собой набор панелей управления различных элементов Электронного Деканата. Все панели управления имеют свои глобальные права доступа, позволяя ограничить возможности сотрудников в Интерфейсе.

=Описание страниц=
==Точка входа в плагин (index.php)==
Данная страница является точкой входа в плагин и не предоставляет какого-либо уникального функционала.
В верхней части страницы отображены вкладки для перехода к отдельным панелям управления интерфейса.

==Панель управления слушателями (students.php)==
Центральный интерфейс управления подписками на программы.

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

[[Файл:participants_students1.png|300px]]

Описание полей формы поиска:
* Фамилия - Фрагмент фамилии студента по подписке. Работает автозаполнение.
* Имя - Фрагмент имени студента по подписке. Работает автозаполнение.
* Отчество - Фрагмент отчества студента по подписке. Работает автозаполнение.
* Email - Email студента. Работает автозаполнение.
* Телефон - Фрагмент номера телефона.
* Программа - Данные по программе обучения(ID, Фрагмент кода, Фрагмент названия). Работает автозаполнение.
* Параллель - Параллель, на которую записан пользователь. Работает автозаполнение с учетом лимита по выбранной программе.
* Группа - Учебная Группа подписки на обучение.

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

[[Файл:participants_students2.png|300px]]

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

[[Файл:participants_students3.png|300px]]

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

[[Файл:participants_students4.png|300px]]

==Страница детального создания подписки на программу (create_programmsbc.php)==
Станица предоставляет интерфейс детального создания новой подписки на программу для студента (Интерфейс быстрого создания подписки находится в панели управления слушателями).
Интерфейс позволяет создать подписку как на основе существующего договора студента, так и для нового студента.
Процесс делится на 5 шагов, каждый новый этап подразумевает успешное прохождение предыдущих.
* 1. Выбор договора на обучение по подписке(Если требуется создать договор, можно указать ФИО персоны. Можно также указать, что требуется создать новую персону для подписки).
[[Файл:participants_create_programmsbcs1.png|300px]]
* 1.1 Если было выбрано создание новой персоны, на данном шаге отображается форма создания студента
[[Файл:participants_create_programmsbcs2.png|300px]]
* 1.2 Если договор по подписке не был указан(также если создавалась новая персона), на данном шаге будет отображена форма создания договора на обучение
[[Файл:participants_create_programmsbcs3.png|300px]]
* 1.2.1 Отображение формы с данными по пользователям договора(студент, законный представитель, куратор). Если в договоре было указано создание новых пользователей, например законного представителя, но этом шаге происходит их создание.
[[Файл:participants_create_programmsbcs4.png|300px]]
* 2. Форма создания подписки на программу. В форму автоматически подставляются данные по договору на обучение.
[[Файл:participants_create_programmsbcs5.png|300px]]

==Импорт подписок на программы (students_import.php)==

Ссылка для перехода находится в панели управления слушателями справа от формы поиска.

[[Файл:participants_students_import1.png|300px]]

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

[[Файл:participants_students_import2.png|300px]]

Доступный список полей импорта:
*Договор
**studentcontract_num - Номер договора, по которому будет сформирована подписка. Если не указан, будет сгенерирован автоматически
**studentcontract_startdate - Дата заключения договора на обучение в формате dd.mm.yyyy
**studentcontract_notice - Заметка по договору
*Студент по договору
**student_email - Email студента для создания нового договора
**student_firstname - Имя студента
**student_lastname - Фамилия студента
**student_middlename - Отчество студента
**student_birthdate - Дата рождения студента в формате dd.mm.yyyy
**student_gender - Пол студента в буквенном формате (m, f, м, ж)
*Законный представитель по договору
**parent_email - Email законного представителя для создания нового договора
**parent_firstname - Имя законного представителя
**parent_lastname - Фамилия законного представителя
**parent_middlename - Отчество законного представителя
**parent_birthdate - Дата рождения законного представителя в формате dd.mm.yyyy
**parent_gender - Пол законного представителя в буквенном формате (m, f, м, ж)
*Менеджер
**seller_email - Email менеджера для создания нового договора
**seller_firstname - Имя менеджера
**seller_lastname - Фамилия менеджера
**seller_middlename - Отчество менеджера
**seller_birthdate - Дата рождения менеджера в формате dd.mm.yyyy
**seller_gender - Пол менеджера в буквенном формате (m, f, м, ж)
*Куратор
**curator_email - Email куратора для создания нового договора
**curator_firstname - Имя куратора
**curator_lastname - Фамилия куратора
**curator_middlename - Отчество куратора
**curator_birthdate - Дата рождения куратора в формате dd.mm.yyyy
**curator_gender - Пол куратора в буквенном формате (m, f, м, ж)
*Программа обучения
**programm_code - Код программы для подписки
*Академическая группа
**agroup_code - Код группы для подписки на программу
*Подписка на программу
**programmsbc_agenum - Номер параллели
**programmsbc_edutype - Тип обучения(group - групповая, individual - индивидуальная). Если не указано, выбирается значение на основе данных о группе
**programmsbc_eduform - Форма обучения(internal - очная, correspondence - заочная, internally-correspondence - очно-заочная, external-studies - экстарнат). Если не указано. выбирается значение по - умолчанию
**programmsbc_freeattendance - Свободное посещение(0, 1)
**programmsbc_datestart - Дата начала подписки в формате dd.mm.yyyy
**programmsbc_salfactor - Поправочный коэффициент

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

[[Файл:participants_students_import3.png|300px]]

==API==

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

Разработка:lib/message.php

2016-01-25T13:14:00Z

Polikarpov: /* Описание */

{{Infobox_Plugin
| name = core
| type = core
}}

== Описание ==
Класс потока сообщений Деканата

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

Отображение очереди сообщений не прерывает процесс отображения данных на странице.

Вся очередь разделяется на 3 уровня:
* Массив ошибок - Все ошибки, которые требуется отобразить пользователю. Пример: Ошибка доступа к подразделению.
* Массив уведомлений - Нейтральные напоминания для пользователя. Пример: Напоминание о несоответствии часового пояса персоны с его подразделением или несоответствие нагрузки шаблонов расписания
* Массив сообщений - Пояснения для всех успешных событий в системе. Пример: Успешное сохранение данных о подразделении.

За счет наличия большого количества CSS классов имеется возможность гибко настроить визуальную часть. В общем же случае поток приспособлен под стандартные сообщения Bootstrap.

Поток автоматически выводится системой в шапке (Позиция секций top)

== API ==

====display($opt = array())====
Отображение потока сообщений для пользователя.
Имеет встроенную защиту от множественного вызова, которая не позволит отобразить поток сообщений несколько раз

''Аргументы:''
* $opt (array) - Дополнительные опции отображения потока сообщений

''Возвращаемые значения:''
* (bool) - true/false - Результат отображения потока

====add($text, $type = 'notice')====
Добавление в поток.

Выбрасывает исключение при попытке добавить неизвестный тип сообщения
''Аргументы:''
* $text (string) - Текст сообщения
* $type (string) - Тип сообщения (message, notice, error)

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

====errors_exists()====
Наличие ошибок в очереди сообщений

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

''Возвращаемые значения:''
* (bool) - true/false - Наличие ошибок в очереди

====notices_exists()====
Наличие уведомлений в очереди сообщений

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

''Возвращаемые значения:''
* (bool) - true/false - Наличие уведомлений в очереди сообщений

====messages_exists()====
Наличие сообщений в очереди

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

''Возвращаемые значения:''
* (bool) - true/false - Наличие сообщений в очереди

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

2015-12-28T14:37:09Z

Polikarpov:

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

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

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

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

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

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

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

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

== API ==

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

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

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

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

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

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

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

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

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

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

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

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

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

Разработка:lib/message.php

2015-12-28T14:10:12Z

Polikarpov: Новая страница: «{{Infobox_Plugin | name = core | type = core }} == Описание == Класс потока сообщений Деканата Предназначен для ...»

{{Infobox_Plugin
| name = core
| type = core
}}

== Описание ==
Класс потока сообщений Деканата

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

Отображение очереди сообщений не прерывает процесс отображения данных на странице.

Вся очередь разделяется на 3 уровня:
* Массив ошибок - Все ошибки, которые требуется отобразить пользователю. Пример: Ошибка доступа к подразделению.
* Массив уведомлений - Нейтральные напоминания для пользователя. Пример: Напоминание о несоответствии часового пояса персоны с его подразделением или несоответствие нагрузки шаблонов расписания
* Массив сообщений - Пояснения для всех успешных событий в системе. Пример: Успешное сохранение данных о подразделении.

За счет наличия большого количества CSS классов имеется возможность гибко настроить визуальную часть. В общем же случае поток приспособлен под стандартные сообщения Bootstrap.

== API ==

====display($opt = array())====
Отображение потока сообщений для пользователя.
Имеет встроенную защиту от множественного вызова, которая не позволит отобразить поток сообщений несколько раз

''Аргументы:''
* $opt (array) - Дополнительные опции отображения потока сообщений

''Возвращаемые значения:''
* (bool) - true/false - Результат отображения потока

====add($text, $type = 'notice')====
Добавление в поток.

Выбрасывает исключение при попытке добавить неизвестный тип сообщения
''Аргументы:''
* $text (string) - Текст сообщения
* $type (string) - Тип сообщения (message, notice, error)

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

====errors_exists()====
Наличие ошибок в очереди сообщений

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

''Возвращаемые значения:''
* (bool) - true/false - Наличие ошибок в очереди

====notices_exists()====
Наличие уведомлений в очереди сообщений

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

''Возвращаемые значения:''
* (bool) - true/false - Наличие уведомлений в очереди сообщений

====messages_exists()====
Наличие сообщений в очереди

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

''Возвращаемые значения:''
* (bool) - true/false - Наличие сообщений в очереди