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

Вывод информации по журналам организован в виде маркированного списка следующего вида:
* ''Подразделение''
** ''Учебная программа''
*** ''Учебный период''
**** ''Предмет''
***** ''Учебный поток (дата_начала - дата_окончания)''
Каждая запись учебного потока является ссылкой на страницу журнала учебного потока.
=== Журнал класса ===
Под панелью навигации выводится надпись "Журнал группы".
Ниже таблица с информацией о потоке - программа, предмет, группа, преподаватель. Справа от этой таблицы размещена ссылка "Новый урок". Нажатие на нее позволяет создать новый отчет об уроке. Над этой ссылкой будут выводиться сообщения об ошибках сохранения данных из таблицы оценок.
Ниже отображаются две таблицы - таблица оценок и, справа от нее, таблица отчетов об уроке. Обе таблицы сделаны максимально похожими на соответствующие таблицы в бумажном "Классном журнале". Таблицы связаны друг с другом. Так, дата в таблице оценок отображаются только в том случае, если был создан отчет об уроке для этой даты. При нажатии на дату в таблице оценок, происходит перемещение к соответствующей строке отчета об уроке.
=== Таблица оценок. ===
Если таблица отчетов об уроке пуста, то в таблице оценок нет ни одной колонки с датой.
Если журнал заполнен, то в верхней строке отображаются названия месяцев, ниже номера дней месяцев, на которые приходились занятия. Каждое число месяца - ссылка, при нажатии на которую происходит переход на соответствующую этому дню строку таблицы отчета об уроке.
Сразу под числом расположен значок редактирования. Он также выполнен в виде ссылки. При нажатии на него страница перезагружается в режиме формы ввода оценок и выставления присутствия учеников на уроке, который проходил в тот день, по значку под числом которого щелкнули.
В колонке этого дня, напротив фамилии каждого ученика появляются два поля. Поле выбора из списка - для проставления оценки. И поле переключатель - для отметки присутствия на уроке. Об этом напоминает буква "н", расположенная справа от него. Если ученик был на уроке, то это поле следует оставить пустым. Если не был - поставить там флажок. Для выставления оценки следует выбрать элемент из списка. После того как изменения будут сохранены, в соответствующих клетках появятся буквы "Н" или оценки. Если кому-то была выставлена и оценка и отметка об отсутствии на уроке, на против его фамилии можно будет увидеть букву "Н". Однако перед сохранением будет выведено предупреждение о том, что выставлена оценка отсутствующему ученику. Под уведомлением будут две кнопки - "Продолжить" и "Отменить". При нажатии на "Продолжить" сценарий сохранения будет выполнен. Нажатие на другую кнопку вызовет отмену процедуры сохранения и возврат к форме с несохраненными изменениями.
При переключении в режим формы под таблицей появляется надпись "Внимание! До нажатия кнопки "сохранить" оценки не сохраняются." И три кнопки - "Сохранить", "Сохранить и продолжить", "Восстановить". Нажатие на первую кнопку сохраняет изменения, сделанные в форме и перезагружает страницу в режим просмотра. Вторая - сохраняет сделанные изменения, но страница остается в режиме формы - можно продолжать ввод. Третья кнопка отменяет сделанные изменения. Все введенные, но несохраненные данные удаляются из формы. Форма перегружается с отображением последних сохраненных изменений.
Если ученику была выставлена оценка, а затем отменена - в форме было выбрано пустое поле, то ранее выбранная оценка будет удалена. Если оценка была изменена, то оценка будет обновлена. Каждое из этих действий, а также выставление статуса присутствия на уроке, будет выполнено через издание приказа.
Если редактируется контрольная точка без события, то в форме показываеются только поля выставления оценки. Поле присутствия на уроке не показывается и статус присутствия не сохраняется.
Контрольная точка без события выводится в таблице оценок без даты. Вместо даты выводится название КТ.
Что происходит в процессе сохранения.
После того как нажата одна из кнопок, сохраняющая внесенные изменения происходит

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

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

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

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

{|border=1
|id КТ
|id темы, выбранной из списка.
|как обрабатывается
|-
|0
|0
|создается новая КТ и новое событие.
|-
|0
|выбрана из списка
|создается новое событие, привязанное к КТ, выбранной из списка
|-
|существующая КТ
|выбрана из списка и равна id КТ
|обновляем КТ и (если изменяется дата) все события, которые ей соответствуют.
Тему из списка "Элементы темтемплана" выбрать нельзя.
|-
|существующая КТ
|выбрана из списка и не равна id КТ
|такая ситуация запрещена.
|-
|существующая КТ
|0
|такая ситуация запрещена
|}

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

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

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

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

==Права==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2010-11-10T09:34:25Z

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

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

===Таблица в базе данных===
''cstreamlinks'' - участие академических групп в учебных потоках (основание для инициации учебного процесса).

====Подробный формат полей в таблице:====
* cstreamid (int) - учебный процесс в таблице [[Разработка:storages/cstreams | cstreams ]]
* agroupid (int) - академическая группа в таблице [[Разработка:storages/agroups | agroups ]] (вместе с полем cstreamid составляет уникальный ключ)
* agroupsync (char, 20) - тип связи с академической группой: полная, не обязательный курс, нет связи
=====Поведение, при разных типах связей=====
Синхронизации членов групп распространяется только на текущие, приостановленные и запланированные потоки. А на завершенные и отмененные не распространяются.
При записи студента в поток через синхронизацию, в таблице [[Разработка:storages/cpassed | cpassed ]] устанавливается id академической группы, чтобы отслеживать связь при отчислении.
* Полная - при добавлении студента в группу, он добавляется и в поток, при исключении - отчисляется.
* Не обязательный курс - при добавлении студента в группу, он НЕ добавляется в поток, а при исключении - отчисляется.
* Нет связи - нет автоматических синхронизаций ни при включении в группу, ни при исключении, но поток числится связанным с группой. Все добавленные студенты из этой группы числятся индивидуалами (записанными на поток вручную по одному, не зависимо от группы).

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

===='''get_typesync_cstreamlink($typesync)'''====

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

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

===='''get_agroup_cstreamlink($id)''' ====

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

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

===='''get_cstream_cstreamlink($id)'''====

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

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

===='''get_link_cstreamlink($agid, $csid)'''====

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

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

===='''get_type_cstreamlink($agid, $csid)'''====

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

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

===='''get_list_agroupsync()'''====

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

''Аргументы:''
* (нет).
''Возвращаемые значения:''
* (array)
''Структура работы:''
* Создаёт массив из записей типа: 'тип связки' => 'описание'.

===='''enrol_agroup_on_cstream($agroupid, $cstreamid, $agroupsync='full')'''====

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

''Аргументы:''
* $agroupid(int) - id группы в таблице [[Разработка:storages/agroups | agroups ]].
* $cstreamid(int) - id учебного потока в таблице [[Разработка:storages/cstreams | cstreams ]].
* $agroupsync(string) - тип связи с академической группой: полная(full), не обязательный курс(norequired), нет связи(nolink).
''Возвращаемые значения:''
* (int) - id новой записи в таблице cstreams
* (bool) - true, если такая запись уже существует, и false, если произошла ошибка.
''Структура работы:''
* Получает все доступные виды связей академических групп с потоками.
* Проверяет, является ли переданный вариант допустимым.
* Если всё правильно вставляет запись с переданными данными в базу и возвращает результат.

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-10T09:32:36Z

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

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

===Таблица в базе данных===
''cstreamlinks'' - участие академических групп в учебных потоках (основание для инициации учебного процесса).

====Подробный формат полей в таблице:====
* cstreamid (int) - учебный процесс в таблице [[Разработка:storages/cstreams | cstreams ]]
* agroupid (int) - академическая группа в таблице [[Разработка:storages/agroups | agroups ]] (вместе с полем cstreamid составляет уникальный ключ)
* agroupsync (char, 20) - тип связи с академической группой: полная, не обязательный курс, нет связи
=====Поведение, при разных типах связей=====
Синхронизации членов групп распространяется только на текущие, приостановленные и запланированные потоки. А на завершенные и отмененные не распространяются.
При записи студента в поток через синхронизацию, в таблице [[Разработка:storages/cpassed | cpassed ]] устанавливается id академической группы, чтобы отслеживать связь при отчислении.
* Полная - при добавлении студента в группу, он добавляется и в поток, при исключении - отчисляется.
* Не обязательный курс - при добавлении студента в группу, он НЕ добавляется в поток, а при исключении - отчисляется.
* Нет связи - нет автоматических синхронизаций ни при включении в группу, ни при исключении, но поток числится связанным с группой. Все добавленные студенты из этой группы числятся индивидуалами (записанными на поток вручную по одному, не зависимо от группы).

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

===='''get_typesync_cstreamlink($typesync)'''====

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

''Аргументы:''
* $typesync(string) - статус потока.
''Возвращаемые значения:''
* (array) - список связей.
* (bool) - false, если связи не найдены.
''Структура работы:''
#* по типу сязи находит все необходимые записи.

===='''get_agroup_cstreamlink($id)''' ====

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

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

===='''get_cstream_cstreamlink($id)'''====

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

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

===='''get_link_cstreamlink($agid, $csid)'''====

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

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

===='''get_type_cstreamlink($agid, $csid)'''====

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

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

===='''get_list_agroupsync()'''====

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

''Аргументы:''
* (нет).
''Возвращаемые значения:''
* (array)
''Структура работы:''
#* Создаёт массив из записей типа: 'тип связки' => 'описание'.

===='''enrol_agroup_on_cstream($agroupid, $cstreamid, $agroupsync='full')'''====

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

''Аргументы:''
* $agroupid(int) - id группы в таблице [[Разработка:storages/agroups | agroups ]].
* $cstreamid(int) - id учебного потока в таблице [[Разработка:storages/cstreams | cstreams ]].
* $agroupsync(string) - тип связи с академической группой: полная(full), не обязательный курс(norequired), нет связи(nolink).
''Возвращаемые значения:''
* (int) - id новой записи в таблице cstreams
* (bool) - true, если такая запись уже существует, и false, если произошла ошибка.
''Структура работы:''
#* Получает все доступные виды связей академических групп с потоками.
#* Проверяет, является ли переданный вариант допустимым.
#* Если всё правильно вставляет запись с переданными данными в базу и возвращает результат.

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-10T09:00:30Z

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-09T12:59:10Z

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-09T12:47:42Z

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

{{Infobox_Plugin
| name = cpassed
| type = storages
}}
===Таблица в базе данных===
''cpassed'' - изучаемые и пройденные курсы: отражает ход изучения учащимися выбранной учебной программы, итоговые отметки.

====Подробный формат полей в таблице:====
* cstreamid - id учебного процесса в таблице [[Разработка:storages/cstreams | cstreams ]], по которому велось обучение.
* programmsbcid - id подписки контракта в таблице [[Разработка:storages/contracts | contracts ]] на программу обучения.
* programmitemid - id дисциплины в таблице [[Разработка:storages/programmitems | programmitems ]].
* studentid - id слушателя по таблице [[Разработка:storages/persons | persons ]].
* agroupid - id академической группы в таблице [[Разработка:storages/agroups | agroups ]]. Не обязательное поле (для заполнения). По умолчанию NULL. При зачислении и отчислении из группы изменяется его значение автоматически. При отчислении из группы поле становится равным нулю (0). При индивидуальном обучении - NULL. На основании этого принимается решение подписке/отписке на предмет.
* grade - итоговая отметка по курсу.
* gradelevel - уровень оценки (оценка не идет в кондуит, дисциплина, курсовая работа, практика, междисциплинарный экзамин, дипломная работа). Берется из [[Разработка:storages/programmitems | programmitems ]].
* credit - количество кредитов, полученное за прохождение дисциплины.
* notice - текстовое пояснение об источнике оценки при перезачете.
* repeatid - id предыдущей подписки на дисциплину, если обучение выполняется повторно (пересдача или повторное обучение - при этом подписка, на которую выполняется ссылка должна иметь статус "пересдан"). Пересдачей может считаться только пересдача дисциплины, пройденной в рамках этой же подписки на учебную программу. Если было несколько пересдач данной дисциплины в данной учебной программе, то все они ссылаются на один и тот же исходный cpassedid.
* typesync - тип синхронизации (выставление вручную, синхронизация с moodle).
* mdlinstance - id задания в moodle, с которым выполнялась синхронизация.
* teacherid - id сотрудника по справочнику [[Разработка:storages/persons | persons ]], вручную выставившего итоговую отметку.
* ageid - id периода в таблице [[Разработка:storages/ages | ages ]] по которому велось обучение.
* orderid - id приказа в таблице [[Разработка:storages/orders | orders ]], согласно которому была выставлена оценка.
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/cpassed | cpassed ]].

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

===='''get_cstream_students($csid, $status = null)'''====

Получает список всех подписок студентов, приписаных к одному предмето-потоку.

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

===='''get_cstream_agroup($cstreamid, $agroupid, $status = null)'''====

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

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

===='''get_cpasseds_student($stid, $status = 'active')'''====

Получает список всех подписок для слушателя.

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

===='''get_cpassed_programm($stid, $prid, $status = 'complete')'''====

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

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

===='''get_cpasseds_programmitem($stid, $prid, $status = 'complete', $levelgrade = null)'''====

Получает подписки на дисциплину по id слушателя и id дисциплины.

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

===='''insert_grade_reoffset($stid, $prid, $cpid, $grade, $status, $comment, $initialid)'''====

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

''Аргументы:''
* $stid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $prid(int) - id дисциплины в таблице [[Разработка:storages/departments | departments ]].
* $cpid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
* $grade(int) - итоговая оценка.
* $comment(string) - коментарий.
* $status(string) - статус - перезачет(reoffset) или пересдача(repeating).
* $initialid(int) - id исходной подписки.
''Возвращаемые значения:''
* (int) id добавленной записи.
* (bool) false если добавление не удалось.
''Структура работы:''
# если дисиплина пересдается (статус = repeating), статус исходной подписки меняем на пересдан и обновляем запись в БД.
# формируем новый объект в БД.
# вставляем сформированную запись в таблицу БД.

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

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

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

===='''unsign_student_one_cpassed($studentid, $cstreamid)'''====

Отписывает заданного студента от заданного учебного потока

''Аргументы:''
* $studentid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $cstreamid(int) - id учебного потока в таблице [[Разработка:storages/cstreams | cstreams ]].
''Возвращаемые значения:''
* (boоl) - true, в случае успеха и falsе, в остальных.

===='''unsign_agroups_from_cstream($cstreamid)'''====

Удаляет всех "лишних" подписок из потока, которые были записаны в составе группы, связи с которой сейчас нет.

''Аргументы:''
* $cstreamid(int) - id учебного потока в таблице [[Разработка:storages/cstreams | cstreams ]].
''Возвращаемые значения:''
* (boоl) - true, в случае успеха и falsе, в остальных.

unsign_student_all_cpassed($studentid, $programmsbcid)

Отписывает студента от всех потоков программы

''Аргументы:''
* $studentid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $programmsbcid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
''Возвращаемые значения:''
* (boоl) - true, в случае успеха и falsе, в остальных

===='''unsign_students_all_cpassed($students)'''====

Отписывает нескольких студентов от всех потоков программы

''Аргументы:''
* $students(array) - массив (id подписки на программу студента в таблице [[Разработка:storages/programmsbcs | programmsbcs ]]=>id студента в таблице [[Разработка:storages/persons | persons ]]).
''Возвращаемые значения:''
* (boоl) - true, в случае успеха и falsе, в остальных.

===='''get_students_without_agroup()'''====

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

''Аргументы:''
* ''(нет)''
''Возвращаемые значения:''
* (array)
* (bool) - false, если ничего не нашлось.
''Структура работы:''
* Возвращаются все записи таблицы cpassed, имеющие статус plan или active в которых поле agroupid равно:
** NULL (null-значение)
** "" (пустой строке)
** 0

===='''unsign_students_without_agroup()'''====

Отписать всех учеников, не имеющих подписки ни на одну группу

''Аргументы:''
* ''(нет)''
''Возвращаемые значения:''
* (bool) - true, если изменение всех статусов прошло нормально или false, если в процессе работы произошли ошибки.
''Структура работы:''
* Для получения списка подписок, не имеющих связи с группой вызывается функция get_students_without_agroup()
** Если таких подписок нет - возвращается true
** Если подписки есть - то в цикле выставляем каждой записи статус "canceled" (через обращение к плагину workflow)

is_already_enroled($studentid, $cstreamid, $status = null)

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

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

===='''sign_student_on_cstream($cstreamid, $programmsbcid)'''====

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

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

===='''sign_student_on_all_cstreams($programmsbcid, $ageid = null)'''====

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

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

===='''sign_all_agroups_on_all_cstreams($programmid, $ageid)'''====

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

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

===='''sign_agroup_on_all_cstreams($agroupid, $programmid, $ageid)'''====

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

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

===='''unsign_students_without_real_agroup($cstreamlink)'''====

Отменяет подписки учеников, у которых группа, указанная в подписке на программу ([[Разработка:storages/programmsbcs | programmsbcs ]]), не совпадает с группой, указанной в таблице связей учебных потоков с группами ([[Разработка:storages/cstreamlinks | cstreamlinks ]]).

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

===='''syncronize_agroups_with_cstream($cstreamid)'''====

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

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

===='''syncronize_agroup_with_cstreams($agroupid)'''====

Синхронизирует группу, со связанными с нею потоками.

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

===='''set_final_grade($cpassedid, $grade = null, $orderid = null)'''====

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

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

===='''get_last_successor($cpassedid)'''====

Находит последнего наследника данной подписки.

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

===='''get_cpassed_on_programmsbcid($id, $status = 'active')'''====

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

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

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

* <s>метод создает одному студенту подписку на все потоки программы (sign_student_on_all_cstreams)</s>
* <s>метод создает нескольким студентам подписку на все потоки программы (sign_agroup_on_all_cstreams)</s>
* <s>метод создает всем студентам группы подписку на все потоки рограммы (sign_all_agroups_on_all_cstreams)</s>

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|[[Разработка:storages/programmsbcs|programmsbcs]]
|changeagroup
|Массив, содержащий:
* в поле 'oldagroup' id старой группы
* в поле 'newagroup' id новой группы
* в поле 'programmsbc' объект из таблицы programmsbcs
''Пример:'' array('oldagroup' => $oldid, 'newagroup' => $newid, 'programmsbc' => $object)
|Обрабатывается событие изменения группы, вызывается функция [[#change_group()|change_group()]]
|-
|storage
|[[Разработка:storages/programmsbcs|cstreamlinks]]
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|По этому событию выполняется синхронизация подписок группы при помощи функции [[#syncronize_agroup_with_cstream()|syncronize_agroup_with_cstream()]]
|-
|storage
|[[Разработка:storages/programmsbcs|cstreamlinks]]
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|По этому событию удаляются подписки при помощи функции [[#unsign_agroups_from_cstream()|unsign_agroups_from_cstream()]]
|-
|storage
|[[Разработка:storages/cstreams|cstreams]]
|changestatus
|
|При изменении статуса учебного потока изменяет статус всех подписок на этот поток, через обращение к [[Разработка:workflows/cpassed|workflows/cpassed]].
|}

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-09T11:55:38Z

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

{{Infobox_Plugin
| name = cpassed
| type = storages
}}
===Таблица в базе данных===
''cpassed'' - изучаемые и пройденные курсы: отражает ход изучения учащимися выбранной учебной программы, итоговые отметки.

====Подробный формат полей в таблице:====
* cstreamid - id учебного процесса в таблице [[Разработка:storages/cstreams | cstreams ]], по которому велось обучение.
* programmsbcid - id подписки контракта в таблице [[Разработка:storages/contracts | contracts ]] на программу обучения.
* programmitemid - id дисциплины в таблице [[Разработка:storages/programmitems | programmitems ]].
* studentid - id слушателя по таблице [[Разработка:storages/persons | persons ]].
* agroupid - id академической группы в таблице [[Разработка:storages/agroups | agroups ]]. Не обязательное поле (для заполнения). По умолчанию NULL. При зачислении и отчислении из группы изменяется его значение автоматически. При отчислении из группы поле становится равным нулю (0). При индивидуальном обучении - NULL. На основании этого принимается решение подписке/отписке на предмет.
* grade - итоговая отметка по курсу.
* gradelevel - уровень оценки (оценка не идет в кондуит, дисциплина, курсовая работа, практика, междисциплинарный экзамин, дипломная работа). Берется из [[Разработка:storages/programmitems | programmitems ]].
* credit - количество кредитов, полученное за прохождение дисциплины.
* notice - текстовое пояснение об источнике оценки при перезачете.
* repeatid - id предыдущей подписки на дисциплину, если обучение выполняется повторно (пересдача или повторное обучение - при этом подписка, на которую выполняется ссылка должна иметь статус "пересдан"). Пересдачей может считаться только пересдача дисциплины, пройденной в рамках этой же подписки на учебную программу. Если было несколько пересдач данной дисциплины в данной учебной программе, то все они ссылаются на один и тот же исходный cpassedid.
* typesync - тип синхронизации (выставление вручную, синхронизация с moodle).
* mdlinstance - id задания в moodle, с которым выполнялась синхронизация.
* teacherid - id сотрудника по справочнику [[Разработка:storages/persons | persons ]], вручную выставившего итоговую отметку.
* ageid - id периода в таблице [[Разработка:storages/ages | ages ]] по которому велось обучение.
* orderid - id приказа в таблице [[Разработка:storages/orders | orders ]], согласно которому была выставлена оценка.
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/cpassed | cpassed ]].

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

===='''get_cstream_students($csid, $status = null)'''====

Получает список всех подписок студентов, приписаных к одному предмето-потоку.

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

===='''get_cstream_agroup($cstreamid, $agroupid, $status = null)'''====

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

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

===='''get_cpasseds_student($stid, $status = 'active')'''====

Получает список всех подписок для слушателя.

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

===='''get_cpassed_programm($stid, $prid, $status = 'complete')'''====

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

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

===='''get_cpasseds_programmitem($stid, $prid, $status = 'complete', $levelgrade = null)'''====

Получает подписки на дисциплину по id слушателя и id дисциплины.

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

===='''insert_grade_reoffset($stid, $prid, $cpid, $grade, $status, $comment, $initialid)'''====

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

''Аргументы:''
* $stid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $prid(int) - id дисциплины в таблице [[Разработка:storages/departments | departments ]].
* $cpid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
* $grade(int) - итоговая оценка.
* $comment(string) - коментарий.
* $status(string) - статус - перезачет(reoffset) или пересдача(repeating).
* $initialid(int) - id исходной подписки.
''Возвращаемые значения:''
* (int) id добавленной записи.
* (bool) false если добавление не удалось.
''Структура работы:''
# если дисиплина пересдается (статус = repeating), статус исходной подписки меняем на пересдан и обновляем запись в БД.
# формируем новый объект в БД.
# вставляем сформированную запись в таблицу БД.

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

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

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

===='''unsign_student_one_cpassed($studentid, $cstreamid)'''====

Отписывает заданного студента от заданного учебного потока

''Аргументы:''
* $studentid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $cstreamid(int) - id учебного потока в таблице [[Разработка:storages/cstreams | cstreams ]].
''Возвращаемые значения:''
* (boоl) - true, в случае успеха и falsе, в остальных.

===='''unsign_agroups_from_cstream($cstreamid)'''====

Удаляет всех "лишних" подписок из потока, которые были записаны в составе группы, связи с которой сейчас нет.

''Аргументы:''
* $cstreamid(int) - id учебного потока в таблице [[Разработка:storages/cstreams | cstreams ]].
''Возвращаемые значения:''
* (boоl) - true, в случае успеха и falsе, в остальных.

unsign_student_all_cpassed($studentid, $programmsbcid)

Отписывает студента от всех потоков программы

''Аргументы:''
* $studentid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $programmsbcid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
''Возвращаемые значения:''
* (boоl) - true, в случае успеха и falsе, в остальных

===='''unsign_students_all_cpassed($students)'''====

Отписывает нескольких студентов от всех потоков программы

''Аргументы:''
* $students(array) - массив (id подписки на программу студента в таблице [[Разработка:storages/programmsbcs | programmsbcs ]]=>id студента в таблице [[Разработка:storages/persons | persons ]]).
''Возвращаемые значения:''
* (boоl) - true, в случае успеха и falsе, в остальных.

===='''get_students_without_agroup()'''====

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

''Аргументы:''
* ''(нет)''
''Возвращаемые значения:''
* (array)
* (bool) - false, если ничего не нашлось.
''Структура работы:''
* Возвращаются все записи таблицы cpassed, имеющие статус plan или active в которых поле agroupid равно:
** NULL (null-значение)
** "" (пустой строке)
** 0

===='''unsign_students_without_agroup()'''====

Отписать всех учеников, не имеющих подписки ни на одну группу

''Аргументы:''
* ''(нет)''
''Возвращаемые значения:''
* (bool) - true, если изменение всех статусов прошло нормально или false, если в процессе работы произошли ошибки.
''Структура работы:''
* Для получения списка подписок, не имеющих связи с группой вызывается функция get_students_without_agroup()
** Если таких подписок нет - возвращается true
** Если подписки есть - то в цикле выставляем каждой записи статус "canceled" (через обращение к плагину workflow)

is_already_enroled($studentid, $cstreamid, $status = null)

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

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

===='''sign_student_on_cstream($cstreamid, $programmsbcid)'''====

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

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

===='''sign_student_on_all_cstreams($programmsbcid, $ageid = null)'''====

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

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

===='''sign_all_agroups_on_all_cstreams($programmid, $ageid)'''====

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

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

===='''sign_agroup_on_all_cstreams($agroupid, $programmid, $ageid)'''====

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

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

===='''unsign_students_without_real_agroup($cstreamlink)'''====

Отменяет подписки учеников, у которых группа, указанная в подписке на программу ([[Разработка:storages/programmsbcs | programmsbcs ]]), не совпадает с группой, указанной в таблице связей учебных потоков с группами ([[Разработка:storages/cstreamlinks | cstreamlinks ]]).

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

===='''syncronize_agroups_with_cstream($cstreamid)'''====

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

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

===='''syncronize_agroup_with_cstreams($agroupid)'''====

Синхронизирует группу, со связанными с нею потоками.

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

===='''set_final_grade($cpassedid, $grade = null, $orderid = null)'''====

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

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

===='''get_last_successor($cpassedid)'''====

Находит последнего наследника данной подписки.

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

===='''get_cpassed_on_programmsbcid($id, $status = 'active')'''====

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

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

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

* <s>метод создает одному студенту подписку на все потоки программы (sign_student_on_all_cstreams)</s>
* <s>метод создает нескольким студентам подписку на все потоки программы (sign_agroup_on_all_cstreams)</s>
* <s>метод создает всем студентам группы подписку на все потоки рограммы (sign_all_agroups_on_all_cstreams)</s>

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|[[Разработка:storages/programmsbcs|programmsbcs]]
|changeagroup
|Массив, содержащий:
* в поле 'oldagroup' id старой группы
* в поле 'newagroup' id новой группы
* в поле 'programmsbc' объект из таблицы programmsbcs
''Пример:'' array('oldagroup' => $oldid, 'newagroup' => $newid, 'programmsbc' => $object)
|Обрабатывается событие изменения группы, вызывается функция [[#change_group()|change_group()]]
|-
|storage
|[[Разработка:storages/programmsbcs|cstreamlinks]]
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|По этому событию выполняется синхронизация подписок группы при помощи функции [[#syncronize_agroup_with_cstream()|syncronize_agroup_with_cstream()]]
|-
|storage
|[[Разработка:storages/programmsbcs|cstreamlinks]]
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|По этому событию удаляются подписки при помощи функции [[#unsign_agroups_from_cstream()|unsign_agroups_from_cstream()]]
|-
|storage
|[[Разработка:storages/cstreams|cstreams]]
|changestatus
|
|При изменении статуса учебного потока изменяет статус всех подписок на этот поток, через обращение к [[Разработка:workflows/cpassed|workflows/cpassed]].
|}

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-09T10:29:26Z

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

{{Infobox_Plugin
| name = cpassed
| type = storages
}}
===Таблица в базе данных===
''cpassed'' - изучаемые и пройденные курсы: отражает ход изучения учащимися выбранной учебной программы, итоговые отметки.

====Подробный формат полей в таблице:====
* cstreamid - id учебного процесса в таблице [[Разработка:storages/cstreams | cstreams ]], по которому велось обучение.
* programmsbcid - id подписки контракта в таблице [[Разработка:storages/contracts | contracts ]] на программу обучения.
* programmitemid - id дисциплины в таблице [[Разработка:storages/programmitems | programmitems ]].
* studentid - id слушателя по таблице [[Разработка:storages/persons | persons ]].
* agroupid - id академической группы в таблице [[Разработка:storages/agroups | agroups ]]. Не обязательное поле (для заполнения). По умолчанию NULL. При зачислении и отчислении из группы изменяется его значение автоматически. При отчислении из группы поле становится равным нулю (0). При индивидуальном обучении - NULL. На основании этого принимается решение подписке/отписке на предмет.
* grade - итоговая отметка по курсу.
* gradelevel - уровень оценки (оценка не идет в кондуит, дисциплина, курсовая работа, практика, междисциплинарный экзамин, дипломная работа). Берется из [[Разработка:storages/programmitems | programmitems ]].
* credit - количество кредитов, полученное за прохождение дисциплины.
* notice - текстовое пояснение об источнике оценки при перезачете.
* repeatid - id предыдущей подписки на дисциплину, если обучение выполняется повторно (пересдача или повторное обучение - при этом подписка, на которую выполняется ссылка должна иметь статус "пересдан"). Пересдачей может считаться только пересдача дисциплины, пройденной в рамках этой же подписки на учебную программу. Если было несколько пересдач данной дисциплины в данной учебной программе, то все они ссылаются на один и тот же исходный cpassedid.
* typesync - тип синхронизации (выставление вручную, синхронизация с moodle).
* mdlinstance - id задания в moodle, с которым выполнялась синхронизация.
* teacherid - id сотрудника по справочнику [[Разработка:storages/persons | persons ]], вручную выставившего итоговую отметку.
* ageid - id периода в таблице [[Разработка:storages/ages | ages ]] по которому велось обучение.
* orderid - id приказа в таблице [[Разработка:storages/orders | orders ]], согласно которому была выставлена оценка.
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/cpassed | cpassed ]].

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

===='''get_cstream_students($csid, $status = null)'''====

Получает список всех подписок студентов, приписаных к одному предмето-потоку.

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

===='''get_cstream_agroup($cstreamid, $agroupid, $status = null)'''====

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

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

===='''get_cpasseds_student($stid, $status = 'active')'''====

Получает список всех подписок для слушателя.

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

===='''get_cpassed_programm($stid, $prid, $status = 'complete')'''====

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

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

===='''get_cpasseds_programmitem($stid, $prid, $status = 'complete', $levelgrade = null)'''====

Получает подписки на дисциплину по id слушателя и id дисциплины.

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

===='''insert_grade_reoffset($stid, $prid, $cpid, $grade, $status, $comment, $initialid)'''====

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

''Аргументы:''
* $stid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $prid(int) - id дисциплины в таблице [[Разработка:storages/departments | departments ]].
* $cpid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
* $grade(int) - итоговая оценка.
* $comment(string) - коментарий.
* $status(string) - статус - перезачет(reoffset) или пересдача(repeating).
* $initialid(int) - id исходной подписки.
''Возвращаемые значения:''
* (int) id добавленной записи.
* (bool) false если добавление не удалось.
''Структура работы:''
# если дисиплина пересдается (статус = repeating), статус исходной подписки меняем на пересдан и обновляем запись в БД.
# формируем новый объект в БД.
# вставляем сформированную запись в таблицу БД.

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

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

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

===='''unsign_student_one_cpassed($studentid, $cstreamid)'''====

Отписывает заданного студента от заданного учебного потока

''Аргументы:''
* $studentid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $cstreamid(int) - id учебного потока в таблице [[Разработка:storages/cstreams | cstreams ]].
''Возвращаемые значения:''
* (boоl) - true, в случае успеха и falsе, в остальных.

===='''unsign_agroups_from_cstream($cstreamid)'''====

Удаляет всех "лишних" подписок из потока, которые были записаны в составе группы, связи с которой сейчас нет.

''Аргументы:''
* $cstreamid(int) - id учебного потока в таблице [[Разработка:storages/cstreams | cstreams ]].
''Возвращаемые значения:''
* (boоl) - true, в случае успеха и falsе, в остальных.

unsign_student_all_cpassed($studentid, $programmsbcid)

Отписывает студента от всех потоков программы

''Аргументы:''
* $studentid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $programmsbcid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
''Возвращаемые значения:''
* (boоl) - true, в случае успеха и falsе, в остальных

===='''unsign_students_all_cpassed($students)'''====

Отписывает нескольких студентов от всех потоков программы

''Аргументы:''
* $students(array) - массив (id подписки на программу студента в таблице [[Разработка:storages/programmsbcs | programmsbcs ]]=>id студента в таблице [[Разработка:storages/persons | persons ]]).
''Возвращаемые значения:''
* (boоl) - true, в случае успеха и falsе, в остальных.

===='''get_students_without_agroup()'''====

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

''Аргументы:''
* ''(нет)''
''Возвращаемые значения:''
* (array)
* (bool) - false, если ничего не нашлось.
''Структура работы:''
* Возвращаются все записи таблицы cpassed, имеющие статус plan или active в которых поле agroupid равно:
** NULL (null-значение)
** "" (пустой строке)
** 0

===='''unsign_students_without_agroup()'''====

Отписать всех учеников, не имеющих подписки ни на одну группу

''Аргументы:''
* ''(нет)''
''Возвращаемые значения:''
* (bool) - true, если изменение всех статусов прошло нормально или false, если в процессе работы произошли ошибки.
''Структура работы:''
* Для получения списка подписок, не имеющих связи с группой вызывается функция get_students_without_agroup()
** Если таких подписок нет - возвращается true
** Если подписки есть - то в цикле выставляем каждой записи статус "canceled" (через обращение к плагину workflow)

is_already_enroled($studentid, $cstreamid, $status = null)

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

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

===='''sign_student_on_cstream($cstreamid, $programmsbcid)'''====

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

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

===='''sign_student_on_all_cstreams($programmsbcid, $ageid = null)'''====

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

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

===='''sign_all_agroups_on_all_cstreams($programmid, $ageid)'''====

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

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

===='''sign_agroup_on_all_cstreams($agroupid, $programmid, $ageid)'''====

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

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

===='''unsign_students_without_real_agroup($cstreamlink)'''====

Отменяет подписки учеников, у которых группа, указанная в подписке на программу ([[Разработка:storages/programmsbcs | programmsbcs ]]), не совпадает с группой, указанной в таблице связей учебных потоков с группами ([[Разработка:storages/cstreamlinks | cstreamlinks ]]).

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

===='''syncronize_agroups_with_cstream($cstreamid)'''====

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

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

===='''syncronize_agroup_with_cstreams($agroupid)'''====

Синхронизирует группу, со связанными с нею потоками.

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

===='''set_final_grade($cpassedid, $grade = null, $orderid = null)'''====

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

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

===='''get_last_successor($cpassedid)'''====

Находит последнего наследника данной подписки.

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

=====unsign_student_from_one_cstream()=====

Отписывает одного студента от одного потока

''Аргументы:''
* (int) $studentid - id студента в таблице [[Разработка:storages/persons | persons ]]
* (int) $cstreamid - id потока в таблице [[Разработка:storages/cstreams | cstreams ]]

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

''Структура работы:''

=====unsign_student_from_all_cstreams()=====

Отписывает одного студента от всех потоков программы

''Аргументы:''
* (int) $studentid - id студента в таблице [[Разработка:storages/persons | persons ]]
* (int) $programmsbcid - id подписки студента на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]]

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

''Структура работы:''

=====unsign_students_from_all_cstreams()=====

Отписывает нескольких студентов от всех потоков программы

''Аргументы:''
* (array) $students - массив (id=>подписки на программу студента=>id студента)

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

''Структура работы:''

=====set_final_grade()=====

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

''Аргументы:''
* $cpassedid - id подписки на дисциплину
* $grade - выставляемая итоговая оценка

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

''Структура работы:''

===== change_group() =====
Синхронизирует ученика с потоками при смене группы

''Аргументы:''
* $oldagroupid - id старой группы студента
* $newagroupid - id новой группы студента
* $programmsbcid - id подписки на программу

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

===== syncronize_agroup_with_cstream() =====
Синхронизировать учебную группу с потоком, проверим и обновив все подписки

''Аргументы:''
* $cstreamlinkid - id записи в таблице [[Разработка:storages/cstreamlinks|cstreamlinks]]

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

===== unsign_agroups_from_cstream() =====
Удаление всех "лишних" подписок из потока, которые были записаны в составе группы, связи с которой сейчас нет

''Аргументы:''
* $cstreamid - id записи в таблице cstreams

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

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

* <s>метод создает одному студенту подписку на все потоки программы (sign_student_on_all_cstreams)</s>
* <s>метод создает нескольким студентам подписку на все потоки программы (sign_agroup_on_all_cstreams)</s>
* <s>метод создает всем студентам группы подписку на все потоки рограммы (sign_all_agroups_on_all_cstreams)</s>

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|[[Разработка:storages/programmsbcs|programmsbcs]]
|changeagroup
|Массив, содержащий:
* в поле 'oldagroup' id старой группы
* в поле 'newagroup' id новой группы
* в поле 'programmsbc' объект из таблицы programmsbcs
''Пример:'' array('oldagroup' => $oldid, 'newagroup' => $newid, 'programmsbc' => $object)
|Обрабатывается событие изменения группы, вызывается функция [[#change_group()|change_group()]]
|-
|storage
|[[Разработка:storages/programmsbcs|cstreamlinks]]
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|По этому событию выполняется синхронизация подписок группы при помощи функции [[#syncronize_agroup_with_cstream()|syncronize_agroup_with_cstream()]]
|-
|storage
|[[Разработка:storages/programmsbcs|cstreamlinks]]
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|По этому событию удаляются подписки при помощи функции [[#unsign_agroups_from_cstream()|unsign_agroups_from_cstream()]]
|-
|storage
|[[Разработка:storages/cstreams|cstreams]]
|changestatus
|
|При изменении статуса учебного потока изменяет статус всех подписок на этот поток, через обращение к [[Разработка:workflows/cpassed|workflows/cpassed]].
|}

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T17:53:34Z

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

{{Infobox_Plugin
| name = cpassed
| type = storages
}}
===Таблица в базе данных===
''cpassed'' - изучаемые и пройденные курсы: отражает ход изучения учащимися выбранной учебной программы, итоговые отметки.

====Подробный формат полей в таблице:====
* cstreamid - id учебного процесса в таблице [[Разработка:storages/cstreams | cstreams ]], по которому велось обучение.
* programmsbcid - id подписки контракта в таблице [[Разработка:storages/contracts | contracts ]] на программу обучения.
* programmitemid - id дисциплины в таблице [[Разработка:storages/programmitems | programmitems ]].
* studentid - id слушателя по таблице [[Разработка:storages/persons | persons ]].
* agroupid - id академической группы в таблице [[Разработка:storages/agroups | agroups ]]. Не обязательное поле (для заполнения). По умолчанию NULL. При зачислении и отчислении из группы изменяется его значение автоматически. При отчислении из группы поле становится равным нулю (0). При индивидуальном обучении - NULL. На основании этого принимается решение подписке/отписке на предмет.
* grade - итоговая отметка по курсу.
* gradelevel - уровень оценки (оценка не идет в кондуит, дисциплина, курсовая работа, практика, междисциплинарный экзамин, дипломная работа). Берется из [[Разработка:storages/programmitems | programmitems ]].
* credit - количество кредитов, полученное за прохождение дисциплины.
* notice - текстовое пояснение об источнике оценки при перезачете.
* repeatid - id предыдущей подписки на дисциплину, если обучение выполняется повторно (пересдача или повторное обучение - при этом подписка, на которую выполняется ссылка должна иметь статус "пересдан"). Пересдачей может считаться только пересдача дисциплины, пройденной в рамках этой же подписки на учебную программу. Если было несколько пересдач данной дисциплины в данной учебной программе, то все они ссылаются на один и тот же исходный cpassedid.
* typesync - тип синхронизации (выставление вручную, синхронизация с moodle).
* mdlinstance - id задания в moodle, с которым выполнялась синхронизация.
* teacherid - id сотрудника по справочнику [[Разработка:storages/persons | persons ]], вручную выставившего итоговую отметку.
* ageid - id периода в таблице [[Разработка:storages/ages | ages ]] по которому велось обучение.
* orderid - id приказа в таблице [[Разработка:storages/orders | orders ]], согласно которому была выставлена оценка.
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/cpassed | cpassed ]].

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

===='''get_cstream_students($csid, $status = null)'''====

Получает список всех подписок студентов, приписаных к одному предмето-потоку.

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

===='''get_cstream_agroup($cstreamid, $agroupid, $status = null)'''====

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

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

===='''get_cpasseds_student($stid, $status = 'active')'''====

Получает список всех подписок для слушателя.

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

===='''get_cpassed_programm($stid, $prid, $status = 'complete')'''====

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

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

===='''get_cpasseds_programmitem($stid, $prid, $status = 'complete', $levelgrade = null)'''====

Получает подписки на дисциплину по id слушателя и id дисциплины.

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

===='''insert_grade_reoffset($stid, $prid, $cpid, $grade, $status, $comment, $initialid)'''====

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

''Аргументы:''
* $stid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $prid(int) - id дисциплины в таблице [[Разработка:storages/departments | departments ]].
* $cpid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
* $grade(int) - итоговая оценка.
* $comment(string) - коментарий.
* $status(string) - статус - перезачет(reoffset) или пересдача(repeating).
* $initialid(int) - id исходной подписки.
''Возвращаемые значения:''
* (int) id добавленной записи.
* (bool) false если добавление не удалось.
''Структура работы:''
# если дисиплина пересдается (статус = repeating), статус исходной подписки меняем на пересдан и обновляем запись в БД.
# формируем новый объект в БД.
# вставляем сформированную запись в таблицу БД.

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

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

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

unsign_student_one_cpassed($studentid, $cstreamid)

Отписывает заданного студента от заданного учебного потока

''Аргументы:''
* $studentid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $cstreamid(int) - id учебного потока в таблице [[Разработка:storages/cstreams | cstreams ]].
* (boоl) - true, в случае успеха и falsе, в остальных.

=====get_students_without_agroup()=====

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

''Аргументы:''
* ''(нет)''

''Возвращаемые значения:''
* bool|array - массив из записей таблицы cpassed или false, если ничего не нашлось

''Структура работы:''
* Возвращаются все записи таблицы cpassed, имеющие статус plan или active в которых поле agroupid равно:
** NULL (null-значение)
** "" (пустой строке)
** 0

=====unsign_students_without_agroup()=====

Отписать всех учеников, не имеющих подписки ни на одну группу

''Аргументы:''
* ''(нет)''

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

''Структура работы:''
* Для получения списка подписок, не имеющих связи с группой вызывается функция get_students_without_agroup()
** Если таких подписок нет - возвращается true
** Если подписки есть - то в цикле выставляем каждой записи статус "canceled" (через обращение к плагину workflow)

=====sign_student_on_cstream()=====

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

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

''Структура работы:''

=====unsign_students_without_real_agroup()=====

Отменить подписки учеников, у которых группа, указанная в подписке на программу (programmsbcs) не совпадает с группой, указанной в таблице связей учебных потоков с группами (cstreamlinks)

''Аргументы:''
* (object)$cstreamlink - объект из таблицы в таблице [[Разработка:storages/cstreamlinks | cstreamlinks ]]

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

''Структура работы:''

=====unsign_student_from_one_cstream()=====

Отписывает одного студента от одного потока

''Аргументы:''
* (int) $studentid - id студента в таблице [[Разработка:storages/persons | persons ]]
* (int) $cstreamid - id потока в таблице [[Разработка:storages/cstreams | cstreams ]]

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

''Структура работы:''

=====unsign_student_from_all_cstreams()=====

Отписывает одного студента от всех потоков программы

''Аргументы:''
* (int) $studentid - id студента в таблице [[Разработка:storages/persons | persons ]]
* (int) $programmsbcid - id подписки студента на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]]

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

''Структура работы:''

=====unsign_students_from_all_cstreams()=====

Отписывает нескольких студентов от всех потоков программы

''Аргументы:''
* (array) $students - массив (id=>подписки на программу студента=>id студента)

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

''Структура работы:''

=====set_final_grade()=====

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

''Аргументы:''
* $cpassedid - id подписки на дисциплину
* $grade - выставляемая итоговая оценка

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

''Структура работы:''

===== change_group() =====
Синхронизирует ученика с потоками при смене группы

''Аргументы:''
* $oldagroupid - id старой группы студента
* $newagroupid - id новой группы студента
* $programmsbcid - id подписки на программу

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

===== syncronize_agroup_with_cstream() =====
Синхронизировать учебную группу с потоком, проверим и обновив все подписки

''Аргументы:''
* $cstreamlinkid - id записи в таблице [[Разработка:storages/cstreamlinks|cstreamlinks]]

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

===== unsign_agroups_from_cstream() =====
Удаление всех "лишних" подписок из потока, которые были записаны в составе группы, связи с которой сейчас нет

''Аргументы:''
* $cstreamid - id записи в таблице cstreams

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

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

* <s>метод создает одному студенту подписку на все потоки программы (sign_student_on_all_cstreams)</s>
* <s>метод создает нескольким студентам подписку на все потоки программы (sign_agroup_on_all_cstreams)</s>
* <s>метод создает всем студентам группы подписку на все потоки рограммы (sign_all_agroups_on_all_cstreams)</s>

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|[[Разработка:storages/programmsbcs|programmsbcs]]
|changeagroup
|Массив, содержащий:
* в поле 'oldagroup' id старой группы
* в поле 'newagroup' id новой группы
* в поле 'programmsbc' объект из таблицы programmsbcs
''Пример:'' array('oldagroup' => $oldid, 'newagroup' => $newid, 'programmsbc' => $object)
|Обрабатывается событие изменения группы, вызывается функция [[#change_group()|change_group()]]
|-
|storage
|[[Разработка:storages/programmsbcs|cstreamlinks]]
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|По этому событию выполняется синхронизация подписок группы при помощи функции [[#syncronize_agroup_with_cstream()|syncronize_agroup_with_cstream()]]
|-
|storage
|[[Разработка:storages/programmsbcs|cstreamlinks]]
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|По этому событию удаляются подписки при помощи функции [[#unsign_agroups_from_cstream()|unsign_agroups_from_cstream()]]
|-
|storage
|[[Разработка:storages/cstreams|cstreams]]
|changestatus
|
|При изменении статуса учебного потока изменяет статус всех подписок на этот поток, через обращение к [[Разработка:workflows/cpassed|workflows/cpassed]].
|}

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T17:24:51Z

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

{{Infobox_Plugin
| name = cpassed
| type = storages
}}
===Таблица в базе данных===
''cpassed'' - изучаемые и пройденные курсы: отражает ход изучения учащимися выбранной учебной программы, итоговые отметки.

====Подробный формат полей в таблице:====
* cstreamid - id учебного процесса в таблице [[Разработка:storages/cstreams | cstreams ]], по которому велось обучение.
* programmsbcid - id подписки контракта в таблице [[Разработка:storages/contracts | contracts ]] на программу обучения.
* programmitemid - id дисциплины в таблице [[Разработка:storages/programmitems | programmitems ]].
* studentid - id слушателя по таблице [[Разработка:storages/persons | persons ]].
* agroupid - id академической группы в таблице [[Разработка:storages/agroups | agroups ]]. Не обязательное поле (для заполнения). По умолчанию NULL. При зачислении и отчислении из группы изменяется его значение автоматически. При отчислении из группы поле становится равным нулю (0). При индивидуальном обучении - NULL. На основании этого принимается решение подписке/отписке на предмет.
* grade - итоговая отметка по курсу.
* gradelevel - уровень оценки (оценка не идет в кондуит, дисциплина, курсовая работа, практика, междисциплинарный экзамин, дипломная работа). Берется из [[Разработка:storages/programmitems | programmitems ]].
* credit - количество кредитов, полученное за прохождение дисциплины.
* notice - текстовое пояснение об источнике оценки при перезачете.
* repeatid - id предыдущей подписки на дисциплину, если обучение выполняется повторно (пересдача или повторное обучение - при этом подписка, на которую выполняется ссылка должна иметь статус "пересдан"). Пересдачей может считаться только пересдача дисциплины, пройденной в рамках этой же подписки на учебную программу. Если было несколько пересдач данной дисциплины в данной учебной программе, то все они ссылаются на один и тот же исходный cpassedid.
* typesync - тип синхронизации (выставление вручную, синхронизация с moodle).
* mdlinstance - id задания в moodle, с которым выполнялась синхронизация.
* teacherid - id сотрудника по справочнику [[Разработка:storages/persons | persons ]], вручную выставившего итоговую отметку.
* ageid - id периода в таблице [[Разработка:storages/ages | ages ]] по которому велось обучение.
* orderid - id приказа в таблице [[Разработка:storages/orders | orders ]], согласно которому была выставлена оценка.
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/cpassed | cpassed ]].

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

===='''get_cstream_students($csid, $status = null)'''====

Получает список всех подписок студентов, приписаных к одному предмето-потоку.

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

===='''get_cstream_agroup($cstreamid, $agroupid, $status = null)'''====

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

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

===='''get_cpasseds_student($stid, $status = 'active')'''====

Получает список всех подписок для слушателя.

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

===='''get_cpassed_programm($stid, $prid, $status = 'complete')'''====

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

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

===='''get_cpasseds_programmitem($stid, $prid, $status = 'complete', $levelgrade = null)'''====

Получает подписки на дисциплину по id слушателя и id дисциплины.

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

===='''get_cpassed_programm($stid, $prid, $status = 'complete')'''====

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

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

=====update_total_grade()=====

Установливает/обновляет студенту итоговую оценку и комментарий для существующей подписки (в перспективе, когда будет реализован справочник с историей изменения отметок - вызов функции протоколирования). Если оценка равна или выше минимальной, подписка переводится в статус "успешно завершен".

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

=====insert_grade_reoffset()=====

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

''Аргументы:''
* $stid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $prid(int) - id дисциплины в таблице [[Разработка:storages/departments | departments ]].
* $cpid(int) - id подписки на программу.
* $grade(int) - итоговая оценка.
* $comment(string) - коментарий.
* $status(string) - статус - перезачет(reoffset) или пересдача(repeating).
* $initialid(int) - id исходной подписки.
''Возвращаемые значения:''
* (int) id добавленной записи
* (bool) false если добавление не удалось
''Структура работы:''
# если дисиплина пересдается (статус = repeating), статус исходной подписки меняем на пересдан и обновляем запись в БД.
# формируем новый объект в БД.
# вставляем сформированную запись в таблицу БД.

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

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

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

''Возвращаемые значения:''
* (array) массив записей из базы, int количество записей, соответствующих условиям (если $countonly=true), или false в случае ошибки

''Структура работы:''
# составляем запрос по переданным параметрам при помощи собственной protected-функции get_select_listing()
# Проверяем условие $countonly. Если оно истинно - то возвращаем только количество записей
# Если ложно - то возвращаем список записей

=====get_students_without_agroup()=====

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

''Аргументы:''
* ''(нет)''

''Возвращаемые значения:''
* bool|array - массив из записей таблицы cpassed или false, если ничего не нашлось

''Структура работы:''
* Возвращаются все записи таблицы cpassed, имеющие статус plan или active в которых поле agroupid равно:
** NULL (null-значение)
** "" (пустой строке)
** 0

=====unsign_students_without_agroup()=====

Отписать всех учеников, не имеющих подписки ни на одну группу

''Аргументы:''
* ''(нет)''

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

''Структура работы:''
* Для получения списка подписок, не имеющих связи с группой вызывается функция get_students_without_agroup()
** Если таких подписок нет - возвращается true
** Если подписки есть - то в цикле выставляем каждой записи статус "canceled" (через обращение к плагину workflow)

=====sign_student_on_cstream()=====

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

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

''Структура работы:''

=====unsign_students_without_real_agroup()=====

Отменить подписки учеников, у которых группа, указанная в подписке на программу (programmsbcs) не совпадает с группой, указанной в таблице связей учебных потоков с группами (cstreamlinks)

''Аргументы:''
* (object)$cstreamlink - объект из таблицы в таблице [[Разработка:storages/cstreamlinks | cstreamlinks ]]

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

''Структура работы:''

=====unsign_student_from_one_cstream()=====

Отписывает одного студента от одного потока

''Аргументы:''
* (int) $studentid - id студента в таблице [[Разработка:storages/persons | persons ]]
* (int) $cstreamid - id потока в таблице [[Разработка:storages/cstreams | cstreams ]]

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

''Структура работы:''

=====unsign_student_from_all_cstreams()=====

Отписывает одного студента от всех потоков программы

''Аргументы:''
* (int) $studentid - id студента в таблице [[Разработка:storages/persons | persons ]]
* (int) $programmsbcid - id подписки студента на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]]

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

''Структура работы:''

=====unsign_students_from_all_cstreams()=====

Отписывает нескольких студентов от всех потоков программы

''Аргументы:''
* (array) $students - массив (id=>подписки на программу студента=>id студента)

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

''Структура работы:''

=====set_final_grade()=====

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

''Аргументы:''
* $cpassedid - id подписки на дисциплину
* $grade - выставляемая итоговая оценка

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

''Структура работы:''

===== change_group() =====
Синхронизирует ученика с потоками при смене группы

''Аргументы:''
* $oldagroupid - id старой группы студента
* $newagroupid - id новой группы студента
* $programmsbcid - id подписки на программу

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

===== syncronize_agroup_with_cstream() =====
Синхронизировать учебную группу с потоком, проверим и обновив все подписки

''Аргументы:''
* $cstreamlinkid - id записи в таблице [[Разработка:storages/cstreamlinks|cstreamlinks]]

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

===== unsign_agroups_from_cstream() =====
Удаление всех "лишних" подписок из потока, которые были записаны в составе группы, связи с которой сейчас нет

''Аргументы:''
* $cstreamid - id записи в таблице cstreams

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

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

* <s>метод создает одному студенту подписку на все потоки программы (sign_student_on_all_cstreams)</s>
* <s>метод создает нескольким студентам подписку на все потоки программы (sign_agroup_on_all_cstreams)</s>
* <s>метод создает всем студентам группы подписку на все потоки рограммы (sign_all_agroups_on_all_cstreams)</s>

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|[[Разработка:storages/programmsbcs|programmsbcs]]
|changeagroup
|Массив, содержащий:
* в поле 'oldagroup' id старой группы
* в поле 'newagroup' id новой группы
* в поле 'programmsbc' объект из таблицы programmsbcs
''Пример:'' array('oldagroup' => $oldid, 'newagroup' => $newid, 'programmsbc' => $object)
|Обрабатывается событие изменения группы, вызывается функция [[#change_group()|change_group()]]
|-
|storage
|[[Разработка:storages/programmsbcs|cstreamlinks]]
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|По этому событию выполняется синхронизация подписок группы при помощи функции [[#syncronize_agroup_with_cstream()|syncronize_agroup_with_cstream()]]
|-
|storage
|[[Разработка:storages/programmsbcs|cstreamlinks]]
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|По этому событию удаляются подписки при помощи функции [[#unsign_agroups_from_cstream()|unsign_agroups_from_cstream()]]
|-
|storage
|[[Разработка:storages/cstreams|cstreams]]
|changestatus
|
|При изменении статуса учебного потока изменяет статус всех подписок на этот поток, через обращение к [[Разработка:workflows/cpassed|workflows/cpassed]].
|}

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T15:03:21Z

Puppetmaster: /* Таблица в базе данных */

{{Infobox_Plugin
| name = cpassed
| type = storages
}}
===Таблица в базе данных===
''cpassed'' - изучаемые и пройденные курсы: отражает ход изучения учащимися выбранной учебной программы, итоговые отметки.

====Подробный формат полей в таблице:====
* cstreamid - id учебного процесса в таблице [[Разработка:storages/cstreams | cstreams ]], по которому велось обучение.
* programmsbcid - id подписки контракта в таблице [[Разработка:storages/contracts | contracts ]] на программу обучения.
* programmitemid - id дисциплины в таблице [[Разработка:storages/programmitems | programmitems ]].
* studentid - id слушателя по таблице [[Разработка:storages/persons | persons ]].
* agroupid - id академической группы в таблице [[Разработка:storages/agroups | agroups ]]. Не обязательное поле (для заполнения). По умолчанию NULL. При зачислении и отчислении из группы изменяется его значение автоматически. При отчислении из группы поле становится равным нулю (0). При индивидуальном обучении - NULL. На основании этого принимается решение подписке/отписке на предмет.
* grade - итоговая отметка по курсу.
* gradelevel - уровень оценки (оценка не идет в кондуит, дисциплина, курсовая работа, практика, междисциплинарный экзамин, дипломная работа). Берется из [[Разработка:storages/programmitems | programmitems ]].
* credit - количество кредитов, полученное за прохождение дисциплины.
* notice - текстовое пояснение об источнике оценки при перезачете.
* repeatid - id предыдущей подписки на дисциплину, если обучение выполняется повторно (пересдача или повторное обучение - при этом подписка, на которую выполняется ссылка должна иметь статус "пересдан"). Пересдачей может считаться только пересдача дисциплины, пройденной в рамках этой же подписки на учебную программу. Если было несколько пересдач данной дисциплины в данной учебной программе, то все они ссылаются на один и тот же исходный cpassedid.
* typesync - тип синхронизации (выставление вручную, синхронизация с moodle).
* mdlinstance - id задания в moodle, с которым выполнялась синхронизация.
* teacherid - id сотрудника по справочнику [[Разработка:storages/persons | persons ]], вручную выставившего итоговую отметку.
* ageid - id периода в таблице [[Разработка:storages/ages | ages ]] по которому велось обучение.
* orderid - id приказа в таблице [[Разработка:storages/orders | orders ]], согласно которому была выставлена оценка.
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/cpassed | cpassed ]].

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

=====get_cstream_students()=====

Получает список всех подписок студентов, приписаных к одному предмето-потоку.

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

=====get_cpasseds_student()=====

Получает список всех подписок для слушателя.

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

=====get_cpassed_programm()=====

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

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

=====get_cpasseds_programmitem()=====

Получает подписки на дисциплину по id слушателя и id дисциплины.

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

=====update_total_grade()=====

Установливает/обновляет студенту итоговую оценку и комментарий для существующей подписки (в перспективе, когда будет реализован справочник с историей изменения отметок - вызов функции протоколирования). Если оценка равна или выше минимальной, подписка переводится в статус "успешно завершен".

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

=====insert_grade_reoffset()=====

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

''Аргументы:''
* $stid(int) - id студента в таблице [[Разработка:storages/persons | persons ]].
* $prid(int) - id дисциплины в таблице [[Разработка:storages/departments | departments ]].
* $cpid(int) - id подписки на программу.
* $grade(int) - итоговая оценка.
* $comment(string) - коментарий.
* $status(string) - статус - перезачет(reoffset) или пересдача(repeating).
* $initialid(int) - id исходной подписки.
''Возвращаемые значения:''
* (int) id добавленной записи
* (bool) false если добавление не удалось
''Структура работы:''
# если дисиплина пересдается (статус = repeating), статус исходной подписки меняем на пересдан и обновляем запись в БД.
# формируем новый объект в БД.
# вставляем сформированную запись в таблицу БД.

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

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

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

''Возвращаемые значения:''
* (array) массив записей из базы, int количество записей, соответствующих условиям (если $countonly=true), или false в случае ошибки

''Структура работы:''
# составляем запрос по переданным параметрам при помощи собственной protected-функции get_select_listing()
# Проверяем условие $countonly. Если оно истинно - то возвращаем только количество записей
# Если ложно - то возвращаем список записей

=====get_students_without_agroup()=====

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

''Аргументы:''
* ''(нет)''

''Возвращаемые значения:''
* bool|array - массив из записей таблицы cpassed или false, если ничего не нашлось

''Структура работы:''
* Возвращаются все записи таблицы cpassed, имеющие статус plan или active в которых поле agroupid равно:
** NULL (null-значение)
** "" (пустой строке)
** 0

=====unsign_students_without_agroup()=====

Отписать всех учеников, не имеющих подписки ни на одну группу

''Аргументы:''
* ''(нет)''

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

''Структура работы:''
* Для получения списка подписок, не имеющих связи с группой вызывается функция get_students_without_agroup()
** Если таких подписок нет - возвращается true
** Если подписки есть - то в цикле выставляем каждой записи статус "canceled" (через обращение к плагину workflow)

=====sign_student_on_cstream()=====

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

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

''Структура работы:''

=====unsign_students_without_real_agroup()=====

Отменить подписки учеников, у которых группа, указанная в подписке на программу (programmsbcs) не совпадает с группой, указанной в таблице связей учебных потоков с группами (cstreamlinks)

''Аргументы:''
* (object)$cstreamlink - объект из таблицы в таблице [[Разработка:storages/cstreamlinks | cstreamlinks ]]

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

''Структура работы:''

=====unsign_student_from_one_cstream()=====

Отписывает одного студента от одного потока

''Аргументы:''
* (int) $studentid - id студента в таблице [[Разработка:storages/persons | persons ]]
* (int) $cstreamid - id потока в таблице [[Разработка:storages/cstreams | cstreams ]]

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

''Структура работы:''

=====unsign_student_from_all_cstreams()=====

Отписывает одного студента от всех потоков программы

''Аргументы:''
* (int) $studentid - id студента в таблице [[Разработка:storages/persons | persons ]]
* (int) $programmsbcid - id подписки студента на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]]

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

''Структура работы:''

=====unsign_students_from_all_cstreams()=====

Отписывает нескольких студентов от всех потоков программы

''Аргументы:''
* (array) $students - массив (id=>подписки на программу студента=>id студента)

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

''Структура работы:''

=====set_final_grade()=====

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

''Аргументы:''
* $cpassedid - id подписки на дисциплину
* $grade - выставляемая итоговая оценка

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

''Структура работы:''

===== change_group() =====
Синхронизирует ученика с потоками при смене группы

''Аргументы:''
* $oldagroupid - id старой группы студента
* $newagroupid - id новой группы студента
* $programmsbcid - id подписки на программу

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

===== syncronize_agroup_with_cstream() =====
Синхронизировать учебную группу с потоком, проверим и обновив все подписки

''Аргументы:''
* $cstreamlinkid - id записи в таблице [[Разработка:storages/cstreamlinks|cstreamlinks]]

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

===== unsign_agroups_from_cstream() =====
Удаление всех "лишних" подписок из потока, которые были записаны в составе группы, связи с которой сейчас нет

''Аргументы:''
* $cstreamid - id записи в таблице cstreams

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

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

* <s>метод создает одному студенту подписку на все потоки программы (sign_student_on_all_cstreams)</s>
* <s>метод создает нескольким студентам подписку на все потоки программы (sign_agroup_on_all_cstreams)</s>
* <s>метод создает всем студентам группы подписку на все потоки рограммы (sign_all_agroups_on_all_cstreams)</s>

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|[[Разработка:storages/programmsbcs|programmsbcs]]
|changeagroup
|Массив, содержащий:
* в поле 'oldagroup' id старой группы
* в поле 'newagroup' id новой группы
* в поле 'programmsbc' объект из таблицы programmsbcs
''Пример:'' array('oldagroup' => $oldid, 'newagroup' => $newid, 'programmsbc' => $object)
|Обрабатывается событие изменения группы, вызывается функция [[#change_group()|change_group()]]
|-
|storage
|[[Разработка:storages/programmsbcs|cstreamlinks]]
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|По этому событию выполняется синхронизация подписок группы при помощи функции [[#syncronize_agroup_with_cstream()|syncronize_agroup_with_cstream()]]
|-
|storage
|[[Разработка:storages/programmsbcs|cstreamlinks]]
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|По этому событию удаляются подписки при помощи функции [[#unsign_agroups_from_cstream()|unsign_agroups_from_cstream()]]
|-
|storage
|[[Разработка:storages/cstreams|cstreams]]
|changestatus
|
|При изменении статуса учебного потока изменяет статус всех подписок на этот поток, через обращение к [[Разработка:workflows/cpassed|workflows/cpassed]].
|}

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T14:55:00Z

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

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

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

====Подробный формат полей в таблице:====
* typeid - тип договора, если у учебного заведения предусмотрено несколько разных типов договоров
* num - номер договора
* numpass - номер пропуска, студенческого билета и т.п.
* date - дата заключения
* sellerid - куратор (id по таблице [[Разработка:storages/persons | persons ]])
* clientid - клиент, оплачивающий обучение (законный представитель, сам совершеннолетний ученик или куратор от организации, может принимать значение 0 или null, если клиент создается, а контракт имеет черновой вариант) (по таблице [[Разработка:storages/persons | persons ]])
* studentid - ученик ( может принимать значение 0, если ученик создается, а контракт имеет черновой вариант) (по таблице [[Разработка:storages/persons | persons ]])
* adddate - дата добавления в БД
* notes - заметки
* departmentid - подразделение в таблице [[Разработка:storages/departments | departments ]], к которому приписан контракт на обучение (например, принявшее ученика)
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/contracts | contracts ]]
* contractform - форма договора (шаблон)
* organizationid - юридическое лицо в таблице [[Разработка:storages/organizations | organizations ]], оплачивающее договор, если ученик платит за себя сам - то не указывается.
* curatorid - куратор данного ученика от работодателя (по таблице [[Разработка:storages/persons | persons ]] или не указан)
* enddate - дата окончания договора

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

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

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

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

===='''get_list_by_seller($pid = NULL)'''====

Ищет список действующих контрактов для куратора.

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

===='''get_list_by_client($pid = NULL)'''====

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

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

===='''get_list_by_student($pid = NULL)'''====

Ищет список действующих контрактов для студента.

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

===='''get_list_by_status($status)'''====

Ищет список контрактов по статусу.

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

===='''is_person_used($pid,$except=null)'''====

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

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

===='''is_seller($contractid = null,$personid = null)'''====

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

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

===='''is_student($contractid = null,$personid = null)'''====

Проверяет, является ли персона студентом.

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

===='''is_client($contractid = null,$personid = null)'''====

Проверяет, является ли персона клиентом.

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

===='''is_personel($userid, $except=null, $where = 'moodle')'''====

Проверяет, упомянута ли данная персона в данном контракте.

''Аргументы:''
* $mdluser(int) - id пользователя в moodle
* $except(bool) - id контракта, который надо исключить из поиска
* $where(string) - идентификатор происхождения id пользователя: mоodle - id из таблицы mdl_user, fdo - из таблицы [[Разработка:storages/persons | persons ]]
''Возвращаемые значения:''
* (bool) - true, если да и false, если нет.

===='''get_seller($id)'''====

Находит ФИО продавца и его id по id контракта

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

===='''get_contracts_for_person($pid = NULL)'''====

Находит список договоров для конкретной персоны.

''Аргументы:''
* $pid(int) - id персоны, по умолчанию - null.
''Возвращаемые значения:''
* (array) - список контрактов.

===Планы:===
====Дополнительные методы:====
* Сгенерировать номер контракта
* Найти контракт по номеру
* Найти контракт по номеру пропуска
* Найти список действующих контрактов, относящихся к структурному подразделению

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T14:53:42Z

Puppetmaster: /* is_client($contractid = null,$personid = null) */

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

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

====Подробный формат полей в таблице:====
* typeid - тип договора, если у учебного заведения предусмотрено несколько разных типов договоров
* num - номер договора
* numpass - номер пропуска, студенческого билета и т.п.
* date - дата заключения
* sellerid - куратор (id по таблице [[Разработка:storages/persons | persons ]])
* clientid - клиент, оплачивающий обучение (законный представитель, сам совершеннолетний ученик или куратор от организации, может принимать значение 0 или null, если клиент создается, а контракт имеет черновой вариант) (по таблице [[Разработка:storages/persons | persons ]])
* studentid - ученик ( может принимать значение 0, если ученик создается, а контракт имеет черновой вариант) (по таблице [[Разработка:storages/persons | persons ]])
* adddate - дата добавления в БД
* notes - заметки
* departmentid - подразделение в таблице [[Разработка:storages/departments | departments ]], к которому приписан контракт на обучение (например, принявшее ученика)
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/contracts | contracts ]]
* contractform - форма договора (шаблон)
* organizationid - юридическое лицо в таблице [[Разработка:storages/organizations | organizations ]], оплачивающее договор, если ученик платит за себя сам - то не указывается.
* curatorid - куратор данного ученика от работодателя (по таблице [[Разработка:storages/persons | persons ]] или не указан)
* enddate - дата окончания договора

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

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

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

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

===='''get_list_by_seller($pid = NULL)'''====

Ищет список действующих контрактов для куратора.

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

===='''get_list_by_client($pid = NULL)'''====

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

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

===='''get_list_by_student($pid = NULL)'''====

Ищет список действующих контрактов для студента.

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

===='''get_list_by_status($status)'''====

Ищет список контрактов по статусу.

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

===='''is_person_used($pid,$except=null)'''====

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

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

===='''is_seller($contractid = null,$personid = null)'''====

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

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

===='''is_student($contractid = null,$personid = null)'''====

Проверяет, является ли персона студентом.

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

===='''is_client($contractid = null,$personid = null)'''====

Проверяет, является ли персона клиентом.

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

===='''is_personel($userid, $except=null, $where = 'moodle')'''====

Проверяет, упомянута ли данная персона в данном контракте.

''Аргументы:''
* $mdluser(int) - id пользователя в moodle
* $except(bool) - id контракта, который надо исключить из поиска
* $where(string) - идентификатор происхождения id пользователя: mоodle - id из таблицы mdl_user, fdo - из таблицы [[Разработка:storages/persons | persons ]]
''Возвращаемые значения:''
* (bool) - true, если да и false, если нет.

===='''get_seller($id)'''====

Находит ФИО продавца и его id по id контракта

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

===='''get_contracts_for_person($pid = NULL)'''====

Находит список договоров для конкретной персоны.

''Аргументы:''
* $pid(int) - id персоны, по умолчанию - null.
''Возвращаемые значения:''
*array - список контрактов.

===Планы:===
====Дополнительные методы:====
* Сгенерировать номер контракта
* Найти контракт по номеру
* Найти контракт по номеру пропуска
* Найти список действующих контрактов, относящихся к структурному подразделению

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T14:40:16Z

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

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

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

====Подробный формат полей в таблице:====
* typeid - тип договора, если у учебного заведения предусмотрено несколько разных типов договоров
* num - номер договора
* numpass - номер пропуска, студенческого билета и т.п.
* date - дата заключения
* sellerid - куратор (id по таблице [[Разработка:storages/persons | persons ]])
* clientid - клиент, оплачивающий обучение (законный представитель, сам совершеннолетний ученик или куратор от организации, может принимать значение 0 или null, если клиент создается, а контракт имеет черновой вариант) (по таблице [[Разработка:storages/persons | persons ]])
* studentid - ученик ( может принимать значение 0, если ученик создается, а контракт имеет черновой вариант) (по таблице [[Разработка:storages/persons | persons ]])
* adddate - дата добавления в БД
* notes - заметки
* departmentid - подразделение в таблице [[Разработка:storages/departments | departments ]], к которому приписан контракт на обучение (например, принявшее ученика)
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/contracts | contracts ]]
* contractform - форма договора (шаблон)
* organizationid - юридическое лицо в таблице [[Разработка:storages/organizations | organizations ]], оплачивающее договор, если ученик платит за себя сам - то не указывается.
* curatorid - куратор данного ученика от работодателя (по таблице [[Разработка:storages/persons | persons ]] или не указан)
* enddate - дата окончания договора

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

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

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

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

===='''get_list_by_seller($pid = NULL)'''====

Ищет список действующих контрактов для куратора.

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

===='''get_list_by_client($pid = NULL)'''====

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

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

===='''get_list_by_student($pid = NULL)'''====

Ищет список действующих контрактов для студента.

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

===='''get_list_by_status($status)'''====

Ищет список контрактов по статусу.

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

===='''is_person_used($pid,$except=null)'''====

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

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

===='''is_seller($contractid = null,$personid = null)'''====

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

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

===='''is_student($contractid = null,$personid = null)'''====

Проверяет, является ли персона студентом.

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

===='''is_client($contractid = null,$personid = null)'''====

Проверяет, является ли персона клиентом.

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

is_personel($userid, $except=null, $where = 'moodle')

Проверяет, упомянута ли данная персона в данном контракте.

''Аргументы:''
* $mdluser(int) - id пользователя в moodle
* $except(bool) - id контракта, который надо исключить из поиска
* $where(string) - идентификатор происхождения id пользователя: mоodle - id из таблицы mdl_user, fdo - из таблицы [[Разработка:storages/persons | persons ]]
''Возвращаемые значения:''
* (bool) - true, если да и false, если нет.

===='''get_seller($id)'''====

Находит ФИО продавца и его id по id контракта

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

===='''get_contracts_for_person($pid = NULL)'''====

Находит список договоров для конкретной персоны.

''Аргументы:''
* $pid(int) - id персоны, по умолчанию - null.
''Возвращаемые значения:''
*array - список контрактов.

===Планы:===
====Дополнительные методы:====
* Сгенерировать номер контракта
* Найти контракт по номеру
* Найти контракт по номеру пропуска
* Найти список действующих контрактов, относящихся к структурному подразделению

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T12:22:03Z

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

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

===Таблица в базе данных===
''appointments'' - Сопоставление должностей с табельными номерами.

====Подробный формат полей в таблице:====
* eagreementid - id договора с сотрудником в таблице [[Разработка:storages/eagreements | eagreements]]
* schpositionid - ссылка на вакансию в штатном расписании (таблица [[Разработка:storages/schpositions | schpositions]])
* enumber - табельный номер (уникальное поле),
* worktime - ставка в часах/неделю,
* date - дата заключения договора в формате unixtime
* begindate - дата начала работы в формате unixtime
* enddate - дата окончания работы в формате unixtime
* departmentid - подразделение, которому принадлежит учебный процесс в таблице [[Разработка:storages/departments | departments ]]
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/appointments | appointments ]]

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

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

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

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

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

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

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

===='''get_numberof($select)'''====

находит количество периодов

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

===='''is_enumber_unique($enumber)'''====

Есть ли другие записи с таким табельным номером

''Аргументы:''
* $enumber(string) - табельный номер.
''Возвращаемое значение:''
* bool

===='''get_free_worktime($schpositionid)'''====

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

''Аргументы:''
* $schpositionid(int) - id вакансии из таблицы [[Разработка:storages/schpositions | schpositions ]]
''Возвращаемое значение:''
* int

===='''get_person_by_appointment($appointment, $enum = false)'''====

находит объект из таблицы persons по id в таблице [[Разработка:storages/appointments | appointments ]]

''Аргументы:''
* $appointment(object) - объект из таблицы [[Разработка:storages/appointments | appointments ]].
* $appointment(int) - id объекта из таблицы [[Разработка:storages/appointments | appointments ]].
* $enum(bool) - возвращать ли табельный номер, по умолчанию - false.
''Возвращаемое значение:''
* object - объект из таблицы [[Разработка:storages/persons | persons ]].
* bool - false если ничего не нашлось.

===='''get_persons_by_appointments($appointments)'''====

находит список персон по переданным записям отсортированный по ФИО

''Аргументы:''
* array $appointments - массив записей из таблицы [[Разработка:storages/appointments | appointments ]].
''Возвращаемое значение:''
* array - массив записей из таблицы [[Разработка:storages/persons | persons ]], упорядоченных по sortname ASC. К каждой записи добавлено поле enumber - табельный номер, поле appointmentid - id назначения на должность.
* bool false - если произошла ошибка.

===='''get_appointment_by_persons($personid)'''====

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

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T12:09:32Z

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

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

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

====Подробный формат полей в таблице:====
* name - название академической группы/класса
* code - кодовое обозначение группы (текстовое поле, обязательное, уникальное)
* programmid - id учебной программы в таблице [[Разработка:storages/programms | programms ]], которую реализует академическая группа
* departmentid - отдел в таблице [[Разработка:storages/departments | departments ]], ответственный за группу
* agenum - порядковый номер текущего учебного периода (изменяется приказом по контингенту). Параллель группы может быти изменена только если группа находится в статусе "формируется".
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/agroups | agroups ]]

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

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

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

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

===='''search_group_code($code)'''====

находит группу по коду

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

===='''get_groups_programm($prid, $status = 'learn', $agenum = null, $dpid = null)'''====

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

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

===='''get_group_department($dpid, $prid = null, $status = 'learn')'''====

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

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

===='''get_group_cstream($csid)'''====

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

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

===='''get_numberof_agroups($select)'''====

находит количество групп

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

===='''get_group_nocstream($csid)'''====

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

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

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T11:56:08Z

Puppetmaster: /* search_group_code() */

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

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

====Подробный формат полей в таблице:====
* name - название академической группы/класса
* code - кодовое обозначение группы (текстовое поле, обязательное, уникальное)
* programmid - id учебной программы в таблице [[Разработка:storages/programms | programms ]], которую реализует академическая группа
* departmentid - отдел в таблице [[Разработка:storages/departments | departments ]], ответственный за группу
* agenum - порядковый номер текущего учебного периода (изменяется приказом по контингенту). Параллель группы может быти изменена только если группа находится в статусе "формируется".
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/agroups | agroups ]]

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

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

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

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

===='''search_group_code($code)'''====

находит группу по коду

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

===='''get_groups_programm()'''====

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

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

===='''get_group_department()'''====

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

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

===='''get_group_cstream()'''====

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

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

===='''get_numberof_agroups()'''====

находит количество групп

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

===='''get_group_nocstream($csid)'''====

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

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

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T11:49:23Z

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

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

====Подробный формат полей в таблице:====
* name - название учебного периода
* begindate - дата и время начала по UTC
* enddate - дата и время окончания по UTC
* eduweeks - количество учебных недель/циклов (каждая соответствует одному циклу в расписании) продолжительности курса, которые помещаются в этом учебном периоде.
* departmentid - структурное подразделение в таблице [[Разработка:storages/departments | departments ]], объявившее учебный период
* previousid - предыдущий учебный период
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/ages | ages ]]

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

* '''+''' Получить список текущих учебных периодов для структурного подразделения. Возвращает массив объектов. По умолчанию - все периоды в статусе "идет учебный процесс". Если второй параметр null - возвращаются все периоды, если строка - периоды в этом статусе, если массив - все периоды в таких статусах. Для удобства нужно сделать заготовку, которая принимает такой параметр и имя sql-колонки и возвращает соответствующий фрагмент sql-запроса - и поместить ее защищенным методом в storage_base.
* '''+''' Получить id учебного периода, являющегося x по счету после периода с заданным id. При этом x=1 - это сам исходный период (период для "первого класса), x=2 - это период, для которого период x=1 был предыдущим. Метод возвращает id или false, если однозначно установить id периода не удалось.
* Создать период для структурного подразделения: получает параметры "структурное подразделение", "дата начала", "дата конца", "количество учебных недель", "название", "предыдущий период" - по умолчанию 0. Не указывать предыдущий период допускается только если для этого структурного подразделения еще не было создано периодов. Если для периода уже есть один "последующий период", то больше его указывать в качестве "предыдущего" нельзя. Метод возвращает id созданного периода или false.

===='''get_department_ages($departmentid, $status='active')'''====

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

''Аргументы:''
* $departmentid(int) - id учебного подразделения в таблице departments.
* $status(string) - статус учебного периода, или null если нужны периоды с любым статусом, по умолчанию 'active'.
''Возвращаемые значения:''
* array - массив объектов из таблицы ages.
* bool - false, если ничего не найдено.

===='''get_next_ageid($ageid, $agenum)'''====

находит один из дочерних учебных периодов

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

===='''get_previous_ageid($ageid, $agenum)'''====

находит предшествующий указанному в ageid учебный период

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

===='''create_period_for_department($deptid, $datebegin, $dateend, $numweeks, $name, $previousid=null)'''====

создаёт период для структурного подразделения

''Аргументы:''
* $deptid(int) - id учебного подразделения.
* $datebegin(int) - время начала периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $dateend(int) - время окончания периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $numweeks(int) - количество недель в учебном периоде.
* $name(string) - название учебного периода.
* $previosid(int) - id предыдущего учебного периода или null, если нет предыдущего периода, по умолчанию null.
''Возвращаемые значения:''
* int - id созданного периода.
* bool - false, если период создать нельзя.

===='''get_numberof_ages($select)'''====

находит количество периодов

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

===='''get_ages_by_idrange($minid, $maxid)'''====

получаеть список записей по диапазону id

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

===='''get_agenum_byageid($startageid, $currentageid, $maxagenum)'''====

находит порядковый номер периода, считая от заданного периода

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T11:47:56Z

Puppetmaster: /* get_department_ages($departmentid, $status='active') */

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

====Подробный формат полей в таблице:====
* name - название учебного периода
* begindate - дата и время начала по UTC
* enddate - дата и время окончания по UTC
* eduweeks - количество учебных недель/циклов (каждая соответствует одному циклу в расписании) продолжительности курса, которые помещаются в этом учебном периоде.
* departmentid - структурное подразделение в таблице [[Разработка:storages/departments | departments ]], объявившее учебный период
* previousid - предыдущий учебный период
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/ages | ages ]]

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

* '''+''' Получить список текущих учебных периодов для структурного подразделения. Возвращает массив объектов. По умолчанию - все периоды в статусе "идет учебный процесс". Если второй параметр null - возвращаются все периоды, если строка - периоды в этом статусе, если массив - все периоды в таких статусах. Для удобства нужно сделать заготовку, которая принимает такой параметр и имя sql-колонки и возвращает соответствующий фрагмент sql-запроса - и поместить ее защищенным методом в storage_base.
* '''+''' Получить id учебного периода, являющегося x по счету после периода с заданным id. При этом x=1 - это сам исходный период (период для "первого класса), x=2 - это период, для которого период x=1 был предыдущим. Метод возвращает id или false, если однозначно установить id периода не удалось.
* Создать период для структурного подразделения: получает параметры "структурное подразделение", "дата начала", "дата конца", "количество учебных недель", "название", "предыдущий период" - по умолчанию 0. Не указывать предыдущий период допускается только если для этого структурного подразделения еще не было создано периодов. Если для периода уже есть один "последующий период", то больше его указывать в качестве "предыдущего" нельзя. Метод возвращает id созданного периода или false.

===='''get_department_ages($departmentid, $status='active')'''====

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

''Аргументы:''
* $departmentid(int) - id учебного подразделения в таблице departments.
* $status(string) - статус учебного периода, или null если нужны периоды с любым статусом, по умолчанию 'active'.
''Возвращаемые значения:''
* array - массив объектов из таблицы ages.
* bool - false, если ничего не найдено.

===='''get_next_ageid($ageid, $agenum)'''====

находит один из дочерних учебных периодов

''Аргументы:''
* $ageid(int) - id учебного периода в таблице ages
* $agenum(int) - сколько периодов вперед отсчитать относительно переданного ageid. При этом переданный id считается первым.
''Возвращаемые значения:''
* int - id периода
* bool false - если установить id не удалось

===='''get_previous_ageid($ageid, $agenum)'''====

находит предшествующий указанному в ageid учебный период

''Аргументы:''
* $ageid(int) - id учебного периода в таблице ages
* $agenum(int) - сколько периодов назад отсчитать относительно переданного ageid. При этом переданный ageid считается последним.
''Возвращаемые значения:''
* int - id периода или
* bool false - если установить id не удалось

===='''create_period_for_department($deptid, $datebegin, $dateend, $numweeks, $name, $previousid=null)'''====

создаёт период для структурного подразделения

''Аргументы:''
* $deptid(int) - id учебного подразделения.
* $datebegin(int) - время начала периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $dateend(int) - время окончания периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $numweeks(int) - количество недель в учебном периоде.
* $name(string) - название учебного периода.
* $previosid(int) - id предыдущего учебного периода или null, если нет предыдущего периода, по умолчанию null.
''Возвращаемые значения:''
* int - id созданного периода.
* bool false - если период создать нельзя.

===='''get_numberof_ages($select)'''====

находит количество периодов

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

===='''get_ages_by_idrange($minid, $maxid)'''====

получаеть список записей по диапазону id

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

===='''get_agenum_byageid($startageid, $currentageid, $maxagenum)'''====

находит порядковый номер периода, считая от заданного периода

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T11:47:13Z

Puppetmaster: /* insert($dataobject,$quiet=NULL) */

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

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

====Подробный формат полей в таблице:====
* name - название академической группы/класса
* code - кодовое обозначение группы (текстовое поле, обязательное, уникальное)
* programmid - id учебной программы в таблице [[Разработка:storages/programms | programms ]], которую реализует академическая группа
* departmentid - отдел в таблице [[Разработка:storages/departments | departments ]], ответственный за группу
* agenum - порядковый номер текущего учебного периода (изменяется приказом по контингенту). Параллель группы может быти изменена только если группа находится в статусе "формируется".
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/agroups | agroups ]]

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

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

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

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

===='''search_group_code()'''====

находит группу по коду

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

===='''get_groups_programm()'''====

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

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

===='''get_group_department()'''====

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

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

===='''get_group_cstream()'''====

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

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

===='''get_numberof_agroups()'''====

находит количество групп

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

===='''get_group_nocstream($csid)'''====

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

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

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T11:38:20Z

Puppetmaster: /* get_ages_by_idrange($minid, $maxid) */

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

====Подробный формат полей в таблице:====
* name - название учебного периода
* begindate - дата и время начала по UTC
* enddate - дата и время окончания по UTC
* eduweeks - количество учебных недель/циклов (каждая соответствует одному циклу в расписании) продолжительности курса, которые помещаются в этом учебном периоде.
* departmentid - структурное подразделение в таблице [[Разработка:storages/departments | departments ]], объявившее учебный период
* previousid - предыдущий учебный период
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/ages | ages ]]

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

* '''+''' Получить список текущих учебных периодов для структурного подразделения. Возвращает массив объектов. По умолчанию - все периоды в статусе "идет учебный процесс". Если второй параметр null - возвращаются все периоды, если строка - периоды в этом статусе, если массив - все периоды в таких статусах. Для удобства нужно сделать заготовку, которая принимает такой параметр и имя sql-колонки и возвращает соответствующий фрагмент sql-запроса - и поместить ее защищенным методом в storage_base.
* '''+''' Получить id учебного периода, являющегося x по счету после периода с заданным id. При этом x=1 - это сам исходный период (период для "первого класса), x=2 - это период, для которого период x=1 был предыдущим. Метод возвращает id или false, если однозначно установить id периода не удалось.
* Создать период для структурного подразделения: получает параметры "структурное подразделение", "дата начала", "дата конца", "количество учебных недель", "название", "предыдущий период" - по умолчанию 0. Не указывать предыдущий период допускается только если для этого структурного подразделения еще не было создано периодов. Если для периода уже есть один "последующий период", то больше его указывать в качестве "предыдущего" нельзя. Метод возвращает id созданного периода или false.

===='''get_department_ages($departmentid, $status='active')'''====

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

''Аргументы:''
* $departmentid(int) - id учебного подразделения в таблице departments.
* $status(string) - статус учебного периода, или null если нужны периоды с любым статусом, по умолчанию 'active'.
''Возвращаемые значения:''
* array - массив объектов из таблицы ages.
* bool false - если ничего не найдено.

===='''get_next_ageid($ageid, $agenum)'''====

находит один из дочерних учебных периодов

''Аргументы:''
* $ageid(int) - id учебного периода в таблице ages
* $agenum(int) - сколько периодов вперед отсчитать относительно переданного ageid. При этом переданный id считается первым.
''Возвращаемые значения:''
* int - id периода
* bool false - если установить id не удалось

===='''get_previous_ageid($ageid, $agenum)'''====

находит предшествующий указанному в ageid учебный период

''Аргументы:''
* $ageid(int) - id учебного периода в таблице ages
* $agenum(int) - сколько периодов назад отсчитать относительно переданного ageid. При этом переданный ageid считается последним.
''Возвращаемые значения:''
* int - id периода или
* bool false - если установить id не удалось

===='''create_period_for_department($deptid, $datebegin, $dateend, $numweeks, $name, $previousid=null)'''====

создаёт период для структурного подразделения

''Аргументы:''
* $deptid(int) - id учебного подразделения.
* $datebegin(int) - время начала периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $dateend(int) - время окончания периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $numweeks(int) - количество недель в учебном периоде.
* $name(string) - название учебного периода.
* $previosid(int) - id предыдущего учебного периода или null, если нет предыдущего периода, по умолчанию null.
''Возвращаемые значения:''
* int - id созданного периода.
* bool false - если период создать нельзя.

===='''get_numberof_ages($select)'''====

находит количество периодов

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

===='''get_ages_by_idrange($minid, $maxid)'''====

получаеть список записей по диапазону id

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

===='''get_agenum_byageid($startageid, $currentageid, $maxagenum)'''====

находит порядковый номер периода, считая от заданного периода

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T11:38:01Z

Puppetmaster: /* get_agenum_byageid($startageid, $currentageid, $maxagenum) */

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

====Подробный формат полей в таблице:====
* name - название учебного периода
* begindate - дата и время начала по UTC
* enddate - дата и время окончания по UTC
* eduweeks - количество учебных недель/циклов (каждая соответствует одному циклу в расписании) продолжительности курса, которые помещаются в этом учебном периоде.
* departmentid - структурное подразделение в таблице [[Разработка:storages/departments | departments ]], объявившее учебный период
* previousid - предыдущий учебный период
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/ages | ages ]]

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

* '''+''' Получить список текущих учебных периодов для структурного подразделения. Возвращает массив объектов. По умолчанию - все периоды в статусе "идет учебный процесс". Если второй параметр null - возвращаются все периоды, если строка - периоды в этом статусе, если массив - все периоды в таких статусах. Для удобства нужно сделать заготовку, которая принимает такой параметр и имя sql-колонки и возвращает соответствующий фрагмент sql-запроса - и поместить ее защищенным методом в storage_base.
* '''+''' Получить id учебного периода, являющегося x по счету после периода с заданным id. При этом x=1 - это сам исходный период (период для "первого класса), x=2 - это период, для которого период x=1 был предыдущим. Метод возвращает id или false, если однозначно установить id периода не удалось.
* Создать период для структурного подразделения: получает параметры "структурное подразделение", "дата начала", "дата конца", "количество учебных недель", "название", "предыдущий период" - по умолчанию 0. Не указывать предыдущий период допускается только если для этого структурного подразделения еще не было создано периодов. Если для периода уже есть один "последующий период", то больше его указывать в качестве "предыдущего" нельзя. Метод возвращает id созданного периода или false.

===='''get_department_ages($departmentid, $status='active')'''====

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

''Аргументы:''
* $departmentid(int) - id учебного подразделения в таблице departments.
* $status(string) - статус учебного периода, или null если нужны периоды с любым статусом, по умолчанию 'active'.
''Возвращаемые значения:''
* array - массив объектов из таблицы ages.
* bool false - если ничего не найдено.

===='''get_next_ageid($ageid, $agenum)'''====

находит один из дочерних учебных периодов

''Аргументы:''
* $ageid(int) - id учебного периода в таблице ages
* $agenum(int) - сколько периодов вперед отсчитать относительно переданного ageid. При этом переданный id считается первым.
''Возвращаемые значения:''
* int - id периода
* bool false - если установить id не удалось

===='''get_previous_ageid($ageid, $agenum)'''====

находит предшествующий указанному в ageid учебный период

''Аргументы:''
* $ageid(int) - id учебного периода в таблице ages
* $agenum(int) - сколько периодов назад отсчитать относительно переданного ageid. При этом переданный ageid считается последним.
''Возвращаемые значения:''
* int - id периода или
* bool false - если установить id не удалось

===='''create_period_for_department($deptid, $datebegin, $dateend, $numweeks, $name, $previousid=null)'''====

создаёт период для структурного подразделения

''Аргументы:''
* $deptid(int) - id учебного подразделения.
* $datebegin(int) - время начала периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $dateend(int) - время окончания периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $numweeks(int) - количество недель в учебном периоде.
* $name(string) - название учебного периода.
* $previosid(int) - id предыдущего учебного периода или null, если нет предыдущего периода, по умолчанию null.
''Возвращаемые значения:''
* int - id созданного периода.
* bool false - если период создать нельзя.

===='''get_numberof_ages($select)'''====

находит количество периодов

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

===='''get_ages_by_idrange($minid, $maxid)'''====

получаеть список записей по диапазону id

''Аргументы:''
* $minid - минимальный id.
* $maxid - максимальный id.
''Возвращает значения:''
* array - массив записей.
* bool false - если ни один не найден.

===='''get_agenum_byageid($startageid, $currentageid, $maxagenum)'''====

находит порядковый номер периода, считая от заданного периода

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T11:37:30Z

Puppetmaster: /* get_numberof_ages($select) */

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

====Подробный формат полей в таблице:====
* name - название учебного периода
* begindate - дата и время начала по UTC
* enddate - дата и время окончания по UTC
* eduweeks - количество учебных недель/циклов (каждая соответствует одному циклу в расписании) продолжительности курса, которые помещаются в этом учебном периоде.
* departmentid - структурное подразделение в таблице [[Разработка:storages/departments | departments ]], объявившее учебный период
* previousid - предыдущий учебный период
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/ages | ages ]]

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

* '''+''' Получить список текущих учебных периодов для структурного подразделения. Возвращает массив объектов. По умолчанию - все периоды в статусе "идет учебный процесс". Если второй параметр null - возвращаются все периоды, если строка - периоды в этом статусе, если массив - все периоды в таких статусах. Для удобства нужно сделать заготовку, которая принимает такой параметр и имя sql-колонки и возвращает соответствующий фрагмент sql-запроса - и поместить ее защищенным методом в storage_base.
* '''+''' Получить id учебного периода, являющегося x по счету после периода с заданным id. При этом x=1 - это сам исходный период (период для "первого класса), x=2 - это период, для которого период x=1 был предыдущим. Метод возвращает id или false, если однозначно установить id периода не удалось.
* Создать период для структурного подразделения: получает параметры "структурное подразделение", "дата начала", "дата конца", "количество учебных недель", "название", "предыдущий период" - по умолчанию 0. Не указывать предыдущий период допускается только если для этого структурного подразделения еще не было создано периодов. Если для периода уже есть один "последующий период", то больше его указывать в качестве "предыдущего" нельзя. Метод возвращает id созданного периода или false.

===='''get_department_ages($departmentid, $status='active')'''====

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

''Аргументы:''
* $departmentid(int) - id учебного подразделения в таблице departments.
* $status(string) - статус учебного периода, или null если нужны периоды с любым статусом, по умолчанию 'active'.
''Возвращаемые значения:''
* array - массив объектов из таблицы ages.
* bool false - если ничего не найдено.

===='''get_next_ageid($ageid, $agenum)'''====

находит один из дочерних учебных периодов

''Аргументы:''
* $ageid(int) - id учебного периода в таблице ages
* $agenum(int) - сколько периодов вперед отсчитать относительно переданного ageid. При этом переданный id считается первым.
''Возвращаемые значения:''
* int - id периода
* bool false - если установить id не удалось

===='''get_previous_ageid($ageid, $agenum)'''====

находит предшествующий указанному в ageid учебный период

''Аргументы:''
* $ageid(int) - id учебного периода в таблице ages
* $agenum(int) - сколько периодов назад отсчитать относительно переданного ageid. При этом переданный ageid считается последним.
''Возвращаемые значения:''
* int - id периода или
* bool false - если установить id не удалось

===='''create_period_for_department($deptid, $datebegin, $dateend, $numweeks, $name, $previousid=null)'''====

создаёт период для структурного подразделения

''Аргументы:''
* $deptid(int) - id учебного подразделения.
* $datebegin(int) - время начала периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $dateend(int) - время окончания периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $numweeks(int) - количество недель в учебном периоде.
* $name(string) - название учебного периода.
* $previosid(int) - id предыдущего учебного периода или null, если нет предыдущего периода, по умолчанию null.
''Возвращаемые значения:''
* int - id созданного периода.
* bool false - если период создать нельзя.

===='''get_numberof_ages($select)'''====

находит количество периодов

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

===='''get_ages_by_idrange($minid, $maxid)'''====

получаеть список записей по диапазону id

''Аргументы:''
* $minid - минимальный id.
* $maxid - максимальный id.
''Возвращает значения:''
* array - массив записей.
* bool false - если ни один не найден.

===='''get_agenum_byageid($startageid, $currentageid, $maxagenum)'''====

находит порядковый номер периода, считая от заданного периода

''Аргументы:''
* $startageid - id периода на котором нужно остановить поиск.
* $currentageid - id периода, порядковый номер которого нам надо узнать.
* $maxagenum - максимально возможный порядковый номер периода.
''Возвращаемые значения:''
* int - порядковый номер периода.
* bool false - если не находит.

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T11:36:55Z

Puppetmaster: /* insert() */

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

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

====Подробный формат полей в таблице:====
* name - название академической группы/класса
* code - кодовое обозначение группы (текстовое поле, обязательное, уникальное)
* programmid - id учебной программы в таблице [[Разработка:storages/programms | programms ]], которую реализует академическая группа
* departmentid - отдел в таблице [[Разработка:storages/departments | departments ]], ответственный за группу
* agenum - порядковый номер текущего учебного периода (изменяется приказом по контингенту). Параллель группы может быти изменена только если группа находится в статусе "формируется".
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/agroups | agroups ]]

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

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

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

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

===='''search_group_code()'''====

находит группу по коду

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

===='''get_groups_programm()'''====

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

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

===='''get_group_department()'''====

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

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

===='''get_group_cstream()'''====

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

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

===='''get_numberof_agroups()'''====

находит количество групп

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

===='''get_group_nocstream($csid)'''====

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

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

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

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T11:29:57Z

Puppetmaster: /* get_agenum_byageid() */

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

====Подробный формат полей в таблице:====
* name - название учебного периода
* begindate - дата и время начала по UTC
* enddate - дата и время окончания по UTC
* eduweeks - количество учебных недель/циклов (каждая соответствует одному циклу в расписании) продолжительности курса, которые помещаются в этом учебном периоде.
* departmentid - структурное подразделение в таблице [[Разработка:storages/departments | departments ]], объявившее учебный период
* previousid - предыдущий учебный период
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/ages | ages ]]

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

* '''+''' Получить список текущих учебных периодов для структурного подразделения. Возвращает массив объектов. По умолчанию - все периоды в статусе "идет учебный процесс". Если второй параметр null - возвращаются все периоды, если строка - периоды в этом статусе, если массив - все периоды в таких статусах. Для удобства нужно сделать заготовку, которая принимает такой параметр и имя sql-колонки и возвращает соответствующий фрагмент sql-запроса - и поместить ее защищенным методом в storage_base.
* '''+''' Получить id учебного периода, являющегося x по счету после периода с заданным id. При этом x=1 - это сам исходный период (период для "первого класса), x=2 - это период, для которого период x=1 был предыдущим. Метод возвращает id или false, если однозначно установить id периода не удалось.
* Создать период для структурного подразделения: получает параметры "структурное подразделение", "дата начала", "дата конца", "количество учебных недель", "название", "предыдущий период" - по умолчанию 0. Не указывать предыдущий период допускается только если для этого структурного подразделения еще не было создано периодов. Если для периода уже есть один "последующий период", то больше его указывать в качестве "предыдущего" нельзя. Метод возвращает id созданного периода или false.

===='''get_department_ages($departmentid, $status='active')'''====

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

''Аргументы:''
* $departmentid(int) - id учебного подразделения в таблице departments.
* $status(string) - статус учебного периода, или null если нужны периоды с любым статусом, по умолчанию 'active'.
''Возвращаемые значения:''
* array - массив объектов из таблицы ages.
* bool false - если ничего не найдено.

===='''get_next_ageid($ageid, $agenum)'''====

находит один из дочерних учебных периодов

''Аргументы:''
* $ageid(int) - id учебного периода в таблице ages
* $agenum(int) - сколько периодов вперед отсчитать относительно переданного ageid. При этом переданный id считается первым.
''Возвращаемые значения:''
* int - id периода
* bool false - если установить id не удалось

===='''get_previous_ageid($ageid, $agenum)'''====

находит предшествующий указанному в ageid учебный период

''Аргументы:''
* $ageid(int) - id учебного периода в таблице ages
* $agenum(int) - сколько периодов назад отсчитать относительно переданного ageid. При этом переданный ageid считается последним.
''Возвращаемые значения:''
* int - id периода или
* bool false - если установить id не удалось

===='''create_period_for_department($deptid, $datebegin, $dateend, $numweeks, $name, $previousid=null)'''====

создаёт период для структурного подразделения

''Аргументы:''
* $deptid(int) - id учебного подразделения.
* $datebegin(int) - время начала периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $dateend(int) - время окончания периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $numweeks(int) - количество недель в учебном периоде.
* $name(string) - название учебного периода.
* $previosid(int) - id предыдущего учебного периода или null, если нет предыдущего периода, по умолчанию null.
''Возвращаемые значения:''
* int - id созданного периода.
* bool false - если период создать нельзя.

===='''get_numberof_ages($select)'''====

находит количество периодов

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

===='''get_ages_by_idrange($minid, $maxid)'''====

получаеть список записей по диапазону id

''Аргументы:''
* $minid - минимальный id.
* $maxid - максимальный id.
''Возвращает значения:''
* array - массив записей.
* bool false - если ни один не найден.

===='''get_agenum_byageid($startageid, $currentageid, $maxagenum)'''====

находит порядковый номер периода, считая от заданного периода

''Аргументы:''
* $startageid - id периода на котором нужно остановить поиск.
* $currentageid - id периода, порядковый номер которого нам надо узнать.
* $maxagenum - максимально возможный порядковый номер периода.
''Возвращаемые значения:''
* int - порядковый номер периода.
* bool false - если не находит.

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

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

2010-11-08T11:25:22Z

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

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

====Подробный формат полей в таблице:====
* name - название учебного периода
* begindate - дата и время начала по UTC
* enddate - дата и время окончания по UTC
* eduweeks - количество учебных недель/циклов (каждая соответствует одному циклу в расписании) продолжительности курса, которые помещаются в этом учебном периоде.
* departmentid - структурное подразделение в таблице [[Разработка:storages/departments | departments ]], объявившее учебный период
* previousid - предыдущий учебный период
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/ages | ages ]]

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

* '''+''' Получить список текущих учебных периодов для структурного подразделения. Возвращает массив объектов. По умолчанию - все периоды в статусе "идет учебный процесс". Если второй параметр null - возвращаются все периоды, если строка - периоды в этом статусе, если массив - все периоды в таких статусах. Для удобства нужно сделать заготовку, которая принимает такой параметр и имя sql-колонки и возвращает соответствующий фрагмент sql-запроса - и поместить ее защищенным методом в storage_base.
* '''+''' Получить id учебного периода, являющегося x по счету после периода с заданным id. При этом x=1 - это сам исходный период (период для "первого класса), x=2 - это период, для которого период x=1 был предыдущим. Метод возвращает id или false, если однозначно установить id периода не удалось.
* Создать период для структурного подразделения: получает параметры "структурное подразделение", "дата начала", "дата конца", "количество учебных недель", "название", "предыдущий период" - по умолчанию 0. Не указывать предыдущий период допускается только если для этого структурного подразделения еще не было создано периодов. Если для периода уже есть один "последующий период", то больше его указывать в качестве "предыдущего" нельзя. Метод возвращает id созданного периода или false.

===='''get_department_ages($departmentid, $status='active')'''====

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

''Аргументы:''
* $departmentid(int) - id учебного подразделения в таблице departments.
* $status(string) - статус учебного периода, или null если нужны периоды с любым статусом, по умолчанию 'active'.
''Возвращаемые значения:''
* array - массив объектов из таблицы ages.
* bool false - если ничего не найдено.

===='''get_next_ageid($ageid, $agenum)'''====

находит один из дочерних учебных периодов

''Аргументы:''
* $ageid(int) - id учебного периода в таблице ages
* $agenum(int) - сколько периодов вперед отсчитать относительно переданного ageid. При этом переданный id считается первым.
''Возвращаемые значения:''
* int - id периода
* bool false - если установить id не удалось

===='''get_previous_ageid($ageid, $agenum)'''====

находит предшествующий указанному в ageid учебный период

''Аргументы:''
* $ageid(int) - id учебного периода в таблице ages
* $agenum(int) - сколько периодов назад отсчитать относительно переданного ageid. При этом переданный ageid считается последним.
''Возвращаемые значения:''
* int - id периода или
* bool false - если установить id не удалось

===='''create_period_for_department($deptid, $datebegin, $dateend, $numweeks, $name, $previousid=null)'''====

создаёт период для структурного подразделения

''Аргументы:''
* $deptid(int) - id учебного подразделения.
* $datebegin(int) - время начала периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $dateend(int) - время окончания периода в формате [http://ru.wikipedia.org/wiki/UNIX-время unixtime].
* $numweeks(int) - количество недель в учебном периоде.
* $name(string) - название учебного периода.
* $previosid(int) - id предыдущего учебного периода или null, если нет предыдущего периода, по умолчанию null.
''Возвращаемые значения:''
* int - id созданного периода.
* bool false - если период создать нельзя.

===='''get_numberof_ages($select)'''====

находит количество периодов

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

===='''get_ages_by_idrange($minid, $maxid)'''====

получаеть список записей по диапазону id

''Аргументы:''
* $minid - минимальный id.
* $maxid - максимальный id.
''Возвращает значения:''
* array - массив записей.
* bool false - если ни один не найден.

===='''get_agenum_byageid()'''====

находит порядковый номер периода, считая от заданного периода

''Аргументы:''
* $startageid - id периода на котором нужно остановить поиск
* $currentageid - id периода, порядковый номер которого нам надо узнать
* $maxagenum - максимально возможный номер agenum
''Возвращаемые значения:''
* mixed int - agenum
* bool false - если не находит

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

[[Категория:Разработка]]
[[Категория:Плагины_storages]]