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

2014-09-22T14:18:10Z

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

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

2014-09-22T14:10:17Z

Konovalov: /* Коды ошибок */

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

2014-09-22T07:52:39Z

Konovalov:

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

=workflow/departments - Статусы подразделений=
Плагин рабочих процессов предназначенный для смены статусов подразделений.
Работает в паре с модулем storage/departments.
Позволяет организовать смену статуса подразделения в зависимости от текущего статуса и статусов объектов, связанных с таблицей departments.
==Возможные статусы:==
* Активен (active) - подразделение создано и отображается в списке подразделений
* Черновик (plan) - создан черновик подразделения
* Удалён (deleted) - подразделение удалено, нигде не отображается, не производится поиск

=== Метастатусы ===
* Активный: active
* Актуальный: active
* Реальный: active, plan
* Мусорный: deleted

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

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

===Черновик===
Возможные переходы ИЗ этого статуса:
* Активен
* Удалён

===Удалён===
Это конечный статус.

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

2014-09-17T10:19:04Z

Konovalov: Новая страница: «{{Infobox_Plugin | name = soap | type = sync }} =Описание= Веб-сервис для интеграции с другими системами по про...»

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

2014-08-28T09:39:38Z

Konovalov:

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

====Подробный формат полей в таблице:====
* name - название учебного периода
* begindate - дата и время начала по UTC
* enddate - дата и время окончания по UTC
* eduweeks - количество учебных недель/циклов (каждая соответствует одному циклу в расписании) продолжительности курса, которые помещаются в этом учебном периоде.
* departmentid - структурное подразделение в таблице [[Разработка:storages/departments | departments ]], объявившее учебный период
* previousid - предыдущий учебный период
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/ages | ages ]]
* schdays - количество дней в учебной неделе (по-умолчанию - 7)
* schedudays - список учебных дней в учебной неделе (по-умолчанию 1,2,3,4,5)
* schstartdaynum - номер первого дня в периоде (по умолчанию - пустое; если оставить пустым, при сохранении туда подставится номер дня недели на дату начала периода, по календарю).

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

* '''+''' Получить список текущих учебных периодов для структурного подразделения. Возвращает массив объектов. По умолчанию - все периоды в статусе "идет учебный процесс". Если второй параметр null - возвращаются все периоды, если строка - периоды в этом статусе, если массив - все периоды в таких статусах. Для удобства нужно сделать заготовку, которая принимает такой параметр и имя sql-колонки и возвращает соответствующий фрагмент sql-запроса - и поместить ее защищенным методом в storage_base.
* '''+''' Получить id учебного периода, являющегося x по счету после периода с заданным id. При этом x=1 - это сам исходный период (период для "первого класса), x=2 - это период, для которого период x=1 был предыдущим. Метод возвращает id или false, если однозначно установить id периода не удалось.
* Создать период для структурного подразделения: получает параметры "структурное подразделение", "дата начала", "дата конца", "количество учебных недель", "название", "предыдущий период" - по умолчанию 0. Не указывать предыдущий период допускается только если для этого структурного подразделения еще не было создано периодов. Если для периода уже есть один "последующий период", то больше его указывать в качестве "предыдущего" нельзя. Метод возвращает id созданного периода или false.

===='''get_next_ageid($ageid, $agenum)'''====

Находит один из дочерних учебных периодов

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

===='''get_previous_ageid($ageid, $agenum)'''====

Находит предшествующий указанному в ageid учебный период

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

===='''create_period_for_department($deptid, $datebegin, $dateend, $numweeks, $name, $previousid=null)'''====

Создаёт период для структурного подразделения

''Аргументы:''
* $deptid(int) - id учебного подразделения в таблице [[Разработка:storages/departments | departments ]].
* $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 предыдущего учебного периода в таблице [[Разработка:storages/ages | ages ]] или null, если нет предыдущего периода, по умолчанию null.
''Возвращаемые значения:''
* int - id созданного периода.
* bool - false, если период создать нельзя.

===='''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.
|}

Разработка:moodleQuickForm

2014-08-21T07:35:48Z

Konovalov: /* Проверка на стороне сервера */

== Общие сведения ==
Библиотека ''moodleQuickForm'' (она же ''moodleform'') построена на основе библиотеки PEAR [http://pear.php.net/package/HTML_QuickForm HTML_QuickForm]. Описание работы всех функций moodleQuickForm следует искать именно по этой ссылке.

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

Перечисление всего того, что доступно в ''moodleQuickForm'' заняло бы слишком много места, поэтому перечислим только те задачи, которые при помощи этой библиотеки решить нельзя:
* создать форму в виде таблицы, в которой более 2-х столбцов
* создать длинную горизонтальную форму
Для всех остальных случаев построения форм следует использовать именно эту библиотеку.
== Внешний вид ==
Внешне все формы класса moodleform выглядят одинаково: это таблица из 2-х столбцов, и некоторого количества строк:

== Правила объявления формы ==
Установка всех элементов формы происходит либо в функции [[Разработка:moodleQuickForm#definition()|definition()]] (для статических форм), либо в функции [[Разработка:moodleQuickForm#definition_after_data()|definition_after_data()]] (для динамических форм).
== Описание стандартных методов moodleform ==
===== __construct($action, $customdata, $method, $target, $attributes, $editable) =====
Этот метод вызывается когда вы создаете новый объект формы.

Параметры:
* ''$action'' - какая страница будет обрабатывать данные это формы. Работает аналогично <form action="...">. По умолчанию - адрес той страницы, на которой находится форма.
* ''$customdata'' - дополнительные данные для формы. Эти параметры будут записаны во внутреннюю переменную '''$this->_customdata''' доступны из всех внутренних методов формы. Передать можно все что угодно, никаних ограничений нет, тип переменной - на ваше усмотрение, но если вам нужно передать несколько значений, то рекомендуется использовать объект. По умолчанию null.
* ''$method'' - метод формы, GET или POST. По умолчанию POST.
* ''$target'' - только для фреймов. Имя фрейма, обрабатывающего эту форму. Используется крайне редко. По умолчанию пустая строка.
* ''$attributes'' - строка атрибутов для тега <form>. Будет добавлена внутрь тега. Разрешены любые атрибуты, предусмотренные стандартом HTML 4.01. По умолчанию null.
* ''$editable'' - доступна ли форма для редактирования. По умолчанию true (в противном случае все поля в форме будут неактивными).

===== definition() =====
Этот абстрактный метод обязательно должен быть переопределен. В нем содержится всё объявление формы.

Существует несколько основных правил, которых следует придерживаться при написании функции definition():
* Описание каждой формы должно начинаться со ссылки на HTML_QuickForm:
* Если используются глобальные переменные - их объявление также происходит в начале.
<pre>
class myform extends dof_modlib_widgets_form
{
function definition()
{
// делаем глобальные переменные видимыми
global $DOF;
// создаем ссылку на HTML_QuickForm
$mform =& $this->_form;
...
}
}
</pre>
* При использовании этого метода все данные собираются ДО объявления формы. Сама форма только отображает и отправляет данные.
* В случае, если необходимо создать динамическую форму следует воспользоваться методом definition_after_data()
===== definition_after_data() =====
Этот метод следует использовать в случае, если вам требуется создать динамическую форму, т. е. форму, которая конструируется в зависимости от различных исходных данных. Этот метод вызывается после definition(), отправки данных в форму и set_data(), но до display().
Этот метод работает также как и definition(), но используется для динамических форм, в случаях, когда вам нужно добавить дополнительные поля в форму после отправки данных пользователем.
===== elementExists($name) =====
Только для использования внутри definition_after_data(). Проверяет существование элемента с указанным именем в форме.
* $elementName - имя элемента для проверки
===== removeElement($name) =====
Только для использования внутри definition_after_data(). Удалить ранее созданный элемент с указанным именем из формы.
* $elementName - имя элемента для удаления
===== getElementValue($name) =====
Только для использования внутри definition_after_data(). Получить введенное значение из указанного элемента формы.
* $elementName - имя элемента, значение из которого вы хотите получить
===== getElement($name) =====
Только для использования внутри definition_after_data(). Получить объект уже ранее созданного элемента формы для изменения. Используется для того, чтобы записать новые значения в форму после отправки данных пользователем.

Пример 1: Установка нового значения поля после отправки данных пользователем.
// получаем новое значение
$newvalue = 'foo';
// получаем ранее созданный элемент (например типа "text")
$element =& $mform->getElement('my_element');
// устанавливаем в него новое значение
$element->setValue($newvalue);

Пример 2: установка новых вариантов в поле select после отправки данных пользователем.
// создаем новые варианты для элемента
$options = array();
$options[-1] = 'Новый вариант1';
$options[-2] = 'Новый вариант2';
// получаем ранее созданный элемент типа "select"
$element =& $mform->getElement('my_element');
// загружаем новые данные в элемент
$element->load($options);
===== display() =====
Вывести форму на экран. Вызывается непосредственно в том месте, где должна быть форма.
===== get_data($slashed) =====
Получить данные формы после всех проверок на стороне клиента и сервера. Данные получаются в виде объекта, именами полей которого являются имена заданных в функции definition() объектов, а значениями - значения полей в форме (по умолчанию или введенные). Любой другой способ получения данных, кроме как через эту функцию, не допускается.
* $slashed - экранировать кавычки. По умолчанию true.

Пример:
$data = $form->get_data();
===== set_data($data) =====
Добавить в форму значения по умолчанию для всех перечисленных полей. Значения полей по умолчанию также можно передать в параметре конструктора $customdata, если вы имеете дело с динамической формой. Любой другой способ передачи значений по умолчанию в форму не допускается.
* $data - объект вида (имя_поля -> значение)

''Пример:''
$data = new Object();
// заполняем объект значениями по умолчанию
$data->field1 = 'value1';
$data->field2 = 'value2';
// Отправляем значения в форму
$form->set_data($data);

===== setDefault('elementName', $value) =====
Установить значение ''$value'' по умолчанию для элемента ''elementName''.
$mform->addElement('hidden', 'имяэлемента');
$mform->setDefault('имяэлемента', $value);
В случае, если нужно установить значение по умолчанию для элемента внутри группы, то нужно использовать такой синтаксис
$mform->setDefault('имягруппы[имяэлемента]', $value);
Для элемента ''hierselect'' в качестве второго аргумента нужно указывать массив со значениями по умолчанию для каждого уровня:
$mform->setDefault('имяэлемента', array(14, 2, 8));

===== setConstant('elementName', $value) =====
Установить постоянную переменную ''$value'' по умолчанию для элемента ''elementName''.
$mform->addElement('textarea', 'имяэлемента','Текстовое поле');
$mform->setDefault('имяэлемента', $value);
Не перекрывается _GET и _POST. Возможно использование, когда setDefault не помогает.

===== get_submitted_data($slashed) =====
Получить данные из формы, к которым еще не применены никакие проверки.
* $slashed - экранировать кавычки. По умолчанию true.
===== add_element($type, $name, $description, $attributes, $options) =====
Добавить элемент в форму. Наиболее часто используемая функция при построении формы.
$type - Тип элемента
$name - Имя элемента в форме. Только латинские буквы.
$description - Описание элемента. Выведется слева от него.
$attributes - строка с параметрами, вставляемая в html-тег элемента.
$options - массив с дополнительными параметрами. Назначение параметров зависит от типа элемента.

Поведение самой функции ''add_element'' также зависит от типа добавляемого элемента. Подробнее об этом - см. раздел [[Разработка:moodleQuickForm#Элементы формы|Элементы формы]].

===== create_element($type, $name, $description, $attributes, $options) =====
Этот метод используется для добавления группы элементов. Созданные элементы добавляются в массив. Отличие этой функции от ''add_element()'' состоит в том, что ''add_element()'' добавляет уже полностью готовый элемент в форму, а ''create_element()'' только создает элемент в памяти для последующего добавления. Назначение аргументов этой функции аналогично функции ''add_element()''.

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

Способ интерпретации входных параметров и поведение этой функции также зависят от указанного типа элемента. Подробнее об этом - см. раздел [[Разработка:moodleQuickForm#Элементы формы|Элементы формы]].

Пример:
// создаем массив
$objs = array();
// Создаем элементы формы
$objs[] =& $mform->createElement('text', 'testname1', 'Пояснение к полю 1');
$objs[] =& $mform->createElement('text', 'testname2', 'Пояснение к полю 2');
$objs[] =& $mform->createElement('text', 'testname3', 'Пояснение к полю 3');
// добавляем элементы в форму
$grp =& $mform->addElement('group', 'groupname', 'Пояснение для группы элементов', $objs);
===== insertElementBefore($element, $nameAfter) =====
Вставляет элемент перед уже ранее добавленным функцией [[Разработка:moodleQuickForm#add_element($type, $name, $description, $attributes, $options) | add_element()]]. Этот метод полезно применять в динамических формах, внутри функции [[Разработка:moodleQuickForm#definition()|definition()]] или [[Разработка:moodleQuickForm#definition_after_data()|definition_after_data()]].
* $element - Объект вставляемого элемента. Для создания объекта используйте функцию create_element();
* $nameAfter - Имя элемента перед которым будет вставлен элемент
Помните, что имя каждого элемента в форме должно быть уникальным (кроме элементов типа radio).

Пример:
// создаем элемент
$element =& $mform->createElement('text', 'my_new_text', 'Пояснение к текстовому полю');
// добавляем его перед уже ранее созданным элементом
$mform->insertElementBefore($element, 'my_old_text');
===== addRule($element, $message, $type, $format, $validation, $reset, $force) =====
Добавить правило для отдельного поля. Эту функцию следует использовать для проверок на стороне клиента и простых проверок на стороне сервера. Для сложных проверок данных (например с использованием обращения к БД) используйте функцию [[Разработка:moodleQuickForm#validation($data, $files) | validation()]].

* $element - имя элемента, к которому применяется проверка
* $message - сообщение, в случае если проверка не пройдена
* $type - тип правила проверки (см. таблицу ниже)
* $format - дополнительные данные, требующиеся для некоторых проверок. По умолчанию null.
* $validation - на какой стороне производить проверку. Возможные значения:
** server - на стороне сервера (по умолчанию)
** client - на стороне клиента
* $reset - используется при проверке на стороне клиента. Сбрасывать ли данные в этом поле на значение по умолчанию, если введены неправильные данные? по умолчанию false (не сбрасывать).
* $force - применять ли проверку даже если проверяемый элемент не существует? По умолчанию false (не применять). Этот параметр используется для проверок в динамических формах.

{| border="1"
|+ Таблица типов правил для полей формы
! Имя
! Описание
! width="50%" |Пример кода
|-
|required
|Обязательное поле
|<pre>$mform->addRule('testname','Это поле является обязательным', 'required',null,'client');</pre>
|-
|minlength
|Минимальная длина значения в поле.
|<pre>$mform->addRule('testname','Слишком короткое значение', 'minlength', 10,'client');</pre>
|-
|maxlength
|Максимальная длина значения в поле.
|<pre>$mform->addRule('testname','Слишком длинное значение', 'maxlength', 256,'client');</pre>
|-
|rangelength
|Проверка длины значения с обеих сторон: например не больше 5 и не меньше 7. Параметры задаются массивом из двух элементов. В данном примере от 111 до 222.
|<pre>$mform->addRule('testname','Длина значения неправильна', 'rangelength', array(111, 222),'client');</pre>
|-
|email
|Проверка email-адреса
|<pre>$mform->addRule('testname','неправильный email', 'email',null,'client');</pre>
|-
|regex
|Проверка данных регулярными выражениями. Используется редко, в случае, когда обычных проверок недостаточно.
|
|-
|lettersonly
|Только латинские буквы.
|<pre>$mform->addRule('testname','Ошибка', 'lettersonly', null,'client');</pre>
|-
|alphanumeric
|Только латинские буквы и цифры
|<pre>$mform->addRule('testname','Ошибка', 'alphanumeric', null,'client');</pre>
|-
|numeric
|Целое или дробное число
|<pre>$mform->addRule('testname', 'В этом поле разрешены только числа', 'numeric', null, 'client');</pre>
|-
|nopunctuation
|В строке не должны присутствовать специальные символы. Список: '''()./*^?#!@$%+=,"'><~[]{}'''
|<pre>$mform->addRule('testname', 'Введены запрещенные символы', 'nopunctuation', null, 'client');</pre>
|-
|nonzero
|Ненулевое значение
|<pre>$mform->addRule('testname', 'Только ненулевые значения', 'nonzero', null, 'client');</pre>
|-
|callback
|Использовать пользовательскую функцию для проверки данных. Используется крайне редко, если у вас есть сложные проверки - то лучше используйте для них функцию [[Разработка:moodleQuickForm#validation($data, $files) | validation()]].
|
|-
|compare
|Сравнить два значения. Может использоваться для сравнения чисел и строк. Операторы, используемые для сравнения:
* '''==''' равно
* '''!=''' не равно
* '''>''' больше
* '''>=''' больше или равно
* '''<''' меньше
* '''<=''' меньше или равно
|<pre></pre>
|-
|uploadedfile
|
|
|-
|maxfilesize
|Проверка максимального значения файла для конкретного поля
|
|-
|mimetype
|Проверка mime-типа загруженного файла.
|
|-
|filename
|Проверка имени файла. Убираются все потенциально опасные символы.
|
|}

===== is_submitted() =====
Возвращает ''true'' если форма подтверждена кнопкой типа "submit", и ''false'' в противном случае. Обратите внимание, что кнопка "отмена" в форме также является кнопкой типа "submit", поэтому используйте для этих целей функцию is_canceled().
Для проверки того, что данные отправлены в форму, и корректно прошли все проверки на стороне сервера и клиента, можно использовать такую конструкцию:
<pre>
if ( $form->is_submitted() AND confirm_sesskey() AND $formdata = $form->get_data() AND ! $form->is_cancelled() )
{//даные переданы и прошли все проверки

....

}elseif( $form->is_cancelled() )
{// ввод данных отменен

....

}
</pre>
Здесь:
* ''$form->is_submitted()'' - проверка того, что данные в форме были отправлены кнопкой типа "submit"
* ''confirm_sesskey()'' - проверка того, что данные отправлены внутри текущей сессии (встроенная функция moodle)
* ''$formdata = $form->get_data()'' - получение данных формы, и одновременное подтверждение того, что данные прошли все проверки, не не нажата кнопка "отмена".

Также возможно сначала проверять is_canceled(), а потом is_submitted().

===== is_cancelled() =====
Возвращает ''true'' если форма отменена, и ''false'' в противном случае.
===== setAdvanced($elementName, $advanced) =====
Устанавливает поля формы как "дополнительные" - то есть они по умолчанию скрыты, и появляются по щелчку на кнопке "показать дополнительные".
* $elementName - имя элемента, который вы хотите пометить как дополнительные
* $advanced - включить/отключить признак дополнительности. Полезно при построении динамических форм: если в зависимости от какого-либо параметра поля должны быть обязательными или необязательными.
===== setShowAdvanced($showadvancedNow) =====
Используется как дополнение к методу setAdvanced(). Изменить текст на кнопке с "Показать дополнительные" на что-нибудь более оригинальное.
* $showadvancedNow - Тип:строка, текст который вы хотите поместить на кнопке
===== add_action_buttons($cancel, $submitlabel) =====
Показывает две кнопки "Сохранить изменения" и "Отменить".
* $cancel - показывать ли кнопку "отменить". По умолчанию true.
* $submitlabel - Надпись на кнопке сохранения данных. Значение переменной по умолчанию - null. Надпись по умолчанию "Сохранить изменения".

===== add_checkbox_controller($groupid, $buttontext, $attributes, $originalValue) =====
Добавляет переключатель (ссылку или кнопку), контролирующий состояние нескольких элементов типа advcheckbox.
* $groupid - id группы элементов типа advcheckbox, которую контролирует этот переключатель
* $buttontext - текст на кнопке переключателя. По умолчанию "выделить все".
* $attributes - ассоциативный массив html-атрибутов для тега, описывающего переключатель
* $originalValue - Возможные состояния: 0 или 1. Изначальное состояние всех переключателей контролируемой группы. По умолчанию 0 (все галочки сняты).

===== setType($elementname, $paramtype) =====
Отвечает за первичную проверку значений, которые вы получаете из формы. Всегда используйте этот метод при получении данных из формы.
* $elementname - имя элемента в форме
* $paramtype - ожидаемый тип получаемых данных
Список возможных значений для $paramtype можно посмотреть в статье [[Разработка:Константы_Moodle#Константы типов данных|константы типов данных]]

===== validation($data, $files) =====
Вызывается автоматически, после отправки данных на сервер. Не вызывайте эту функцию вручную.

Используется для дополнительной проверки данных на стороне сервера. Все необходимые сложные проверки должны быть проведены именно здесь. Для простых проверок (на тип данных, проверка email-адреса и т. п.) используйте функцию [[Разработка:moodleQuickForm#addRule($element, $message, $type, $format, $validation, $reset, $force) | addRule()]]
* $data - массив вида array('имя_поля' => 'значение') из отправленных данных
* $files - массив загруженных в форму файлов. Имеет вид array('имя_поля' => 'путь_к_временному_файлу')

В случае возникших ошибок возвращает массив вида array('имя_поля' => 'текст_сообщения_об_ошибке'). По умолчанию (или в случае отсутствия ошибок при проверке) эта функция '''обязательно должна''' вернуть пустой массив.

===== disabledIf($elementName, $dependentOn, $condition, $value) =====
Эта функция используется для того чтобы установить зависимости между полями формы. До тех пор пока одно поле формы не будет выделено, или в него не будет введено нужное значение, другое не станет активным.

К одному элементу формы можно применять несколько правил disabledIf. Несколько элементов могут зависеть от одного поля.
* $elementName - имя зависимого элемента.
* $dependentOn - имя элемента, чье состояние должно быть проверено условием $condition.
* $condition - по умолчанию 'notchecked'.
* $value - значение, используемое для проверки условия. По умолчанию "1".

{| border="1"
|+ Таблица вариантов условий для параметра $condition
! Значение
! Пояснение
|-
|''checked''
|Элемент выделен. Используется для элементов radio и checkbox. Не работает с элементами advcheckbox.
|-
|''notchecked''
|Элемент не выделен. Используется для элементов radio и checkbox. Не работает с элементами advcheckbox.
|-
|''eq''
|Значение указанного элемента равно значению указанному в параметре $value.
|-
|''noteq''
|Значение указанного элемента не равно значению указанному в параметре $value.
|-
|''noitemselected''
|В указанном html-элементе "select" ничего не выбрано.
|}
===== applyFilter($elementName, $functionName); =====
Применить проверку элементу формы.

Параметры
* ''$elementName'' - название элемента внутри формы. В качестве имени можно использовать специальное значение '''__ALL__''' чтобы применить проверку ко всем элементам.
* ''$functionName'' - название функции (без скобок и аргументов), которая должна быть применена к этому элементу

Пример:
// применение проверки ко всем элементам
$mform->applyFilter('__ALL__', 'trim');

// применение проверки к одному элементу
$mform->applyFilter('lastname', 'addslashes');
===== closeHeaderBefore($elementName) =====
Закрыть рамку формы до элемента с указанным именем. Эта функция позволит вам выносить нижние элементы "за пределы" визуальной рамки формы, а также добавлять элементы без заголовка.
Иными словами, эта функция закрывает тег [http://htmlbook.ru/html/fieldset.html <FIELDSET>].
Эта функция должна быть обязательно вызвана ПОСЛЕ добавления элемента, перед которым закрывается рамка формы.

Пример:
// добавляем элемент формы
$mform->addElement('text', 'name', $this->dof->get_string('name','plans').':');
// Выносим его, и следующие элементы за рамку формы
$mform->closeHeaderBefore('name')

== Элементы формы ==
Во всех приведенных примерах переменная $form обозначает ссылку на объект HTML_QuickForm. Подробнее об этом в описании функции [[Разработка:moodleQuickForm#definition() |definition()]]. Во всех текстовых полях (кроме кнопок) можно использовать html-теги форматирования.

=== header ===
Заголовок формы. Этот заголовок будет говорить об общем содержании данных в форме. Также он используется в случае, когда вам нужно разбить форму на несколько частей.
Если вам нужно закрыть рамку заголовка перед каким-либо элементом, используйте функцию [[#closeHeaderBefore($elementName) |closeHeaderBefore()]]
<pre>$mform->addElement('header','testname', 'Текст заголовка');</pre>

=== checkbox ===
Стандартный html-элемент checkbox.
<pre>$mform->addElement('checkbox', 'testname', 'Текст_перед_галочкой', 'Текст_после галочки');</pre>

=== file ===
Стандартное диалоговое окно загрузки файла.
<pre>$mform->addElement('file', 'userfile', 'Текст перед окном загрузки файла');</pre>

=== group ===
Добавление группы элементов. Для того, чтобы добавить группу элементов, их нужно предварительно создать при помощи функции [[Разработка:moodleQuickForm#create_element($type, $name, $description, $attributes, $options)|create_element()]]
Параметры (в порядке перечисления):
* тип
* название элемента
* пояснение
* массив с элементами
* разделитель для элементов (в примере - тег <br>)
* добавить ли имя группы к имени элемента (true - добавить)
<pre>
// создаем массив
$objs = array();
// Создаем элементы формы
$objs[] =& $mform->createElement('text', 'testname1', 'Пояснение к полю 1');
$objs[] =& $mform->createElement('text', 'testname2', 'Пояснение к полю 2');
$objs[] =& $mform->createElement('text', 'testname3', 'Пояснение к полю 3');
// добавляем элементы в форму
$grp =& $mform->addElement('group', 'groupname', 'Пояснение для группы элементов', $objs, '<br>', true);
</pre>

=== password ===
Стандартный html-элемент password
<pre>mform->addElement('password', 'testname', 'Текст перед окном с паролем');</pre>

=== passwordunmask ===
То же самое, что и элемент password, но с дополнительной галочкой "отобразить пароль".
<pre>$mform->addElement('passwordunmask', 'testname', 'Текст перед окном с паролем');</pre>

=== radio ===
Стандартный html-элемент radio. Единственный элемент в quickform, несколько объектов которого можно добавить, используя одинаковое значение name.
<pre>$mform->addElement('radio', 'testname', 'Текст до переключателя 1',
'Текст после переключателя 1', 'Значение1');
$mform->addElement('radio', 'testname', 'Текст до переключателля 2',
'Текст после переключателя 2', 'Значение2');</pre>

=== select ===
Стандартный html-элемент select. Массив $choices содержит варианты для оператора select. Значениями массива являются текстовые надписи в списке выбора, а ключами - значения этих вариантов.
<pre>
// создаем массив с вариантами выбора
$choices = array('a' => 'Текст варианта 1', 'b' => 'Текст варианта 2');

// Добавляем элемент формы
$mform->addElement('select', 'testname', 'Пояснение для строки выбора', $choices);
</pre>
==== Дополнительные функции ====
Элемент select обладает дополнительными методами, которые
* addOption($text, $value, $attributes=null) - добавить новый вариант к select-элементу, уже после того как он был создан, и в него были установлены значения. Параметры:
** $text - текст, который отображается пользователю
** $value - значение, которое передается из формы
** $attributes - дополнительные html-атрибуты тега OPTION (если требуется). Передаются строкой, либо массивом в формате ключ-значение.
Пример:
<pre>
$select = $mform->getElement('testname');
$select->addOption('Текст для отображения', 555);
</pre>

=== selectgroups ===
=== submitlink ===
=== text ===
Стандартный html-элемент text. Последний параметр - строка html-атрибутов. В данном примере длина поля задана 100%. Это гарантирует, что элемент будет нормально выглядеть и умещаться в форму при любых размерах экрана.
<pre>$mform->addElement('text', 'testname', 'Пояснение для текстового поля', ' width="100%" ');</pre>
=== textarea ===
Стандартный html-элемент textarea. Значения ширины и высоты задаются в виде массива, последним аргументом. Ширину поля также рекомендуется задавать 100%.
<pre>$mform->addElement('textarea', 'testname', 'Пояснение:', array('width'=>'100%', 'height'=>'100px'));</pre>
=== date_selector ===
Диалоговое окно с выбором даты. Обратите внимание, что при получении данных через [[Разработка:moodleQuickForm#get_data($slashed)|get_data()]] значение этого поля автоматически трансформируется в метку unixtime на 12:00:00 дня выбранной даты. По умолчанию выставляется текущая дата и время. Другое начальное значение может быть задано при помощи функции [[Разработка:moodleQuickForm#setDefault($elementName, $defaultValue, $slashed)|setDefault()]].
<pre>
$options = array();// объявляем массив для установки значений по умолчанию
$options['startyear'] = 1980; // устанавливаем год, с которого начинать вывод списка
$options['stopyear'] = 2001; // устанавливаем год, которым заканчивается список
$options['optional'] = false; // убираем галочку, делающую возможным отключение этого поля

$mform->addElement('date_selector', 'testname', 'Пояснение для поля даты', $options);
// устанавливаем время по умолчанию на год вперед
$mform->setDefault('testname', time()+3600*24*365);
</pre>
=== date_time_selector ===
Этот элемент аналогичен элементу date_selector, только добавлены параметры часов и минут. Полученные данные также трансформируются в unixtime, но уже для выбранных значений часов и минут. По умолчанию выставляется текущая дата и время. Другое начальное значение может быть задано при помощи функции [[Разработка:moodleQuickForm#setDefault($elementName, $defaultValue, $slashed)|setDefault()]].
<pre>
$options = array();// объявляем массив для установки значений по умолчанию
$options['startyear'] = 1980; // устанавливаем год, с которого начинать вывод списка
$options['stopyear'] = 2001; // устанавливаем год, которым заканчивается список
$options['optional'] = false; // убираем галочку, делающую возможным отключение этого поля

$mform->addElement('date_time_selector', 'testname', 'Пояснение для поля даты', $options);
</pre>
=== htmleditor ===
Полноценный html-редактор для редактирования страниц. Его вид (обычный или расширенный) настраивается индивидуально каждым пользователем для себя (в настройках профиля moodle). Обратите внимание, что в качестве дополнительных параметров можно массивом передать значения ширины и высоты текстового поля.
<pre>
$mform->addElement('htmleditor', 'testname', 'Пояснение:', array('width'=>'100%', 'height'=>'200px')

</pre>
=== format ===
Выбор формата для редактирования сообщения. Полезно использовать вместе со встроенным html-редактором.
<pre>$mform->addElement('format', 'testname', 'Текст пояснения');</pre>
=== static ===
Обычное текстовое поле, не передает никаких данных. Полезно использовать для различных пояснений и отображения текущей информации о каком-либо объекте. Вы также можете использовать этот элемент для разбиения формы на небольшие смысловые блоки, не разрывая рамку формы. Для более явного разбиения используйте элемент header.
<pre>$mform->addElement('static', 'testname', 'Пояснение:', '<b><i>Само текстовое значение</i></b>');</pre>
=== hidden ===
Стандартный html-элемент hidden, скрытое поле для передачи служебных id, адресов для перенаправления и т. д. Помните о необходимости проверки значений из этого поля.
<pre>$mform->addElement('hidden','testname', 'Значение скрытого поля');</pre>
=== modvisible ===
Установить модуль видимым/скрытым. Только для использования внутри Mooodle.
=== selectyesno ===
Элемент с двумя стандартными select-вариантами выбора: да и нет.
<pre>
$mform->addElement('selectyesno', 'testname', 'Текст пояснения');
// установить значение по умолчанию "да"
$mform->setDefault('stoponerror', 1);
</pre>
=== modgrade ===
Шкала выставление оценки за задание. Только для использования внутри Moodle.
=== cancel ===
Кнопка "отменить форму". При нажатии на нее происходит отмена всех произведенных в форме действий.
<pre>$mform->addElement('cancel', 'testname', 'Надпись на кнопке'); </pre>
=== button ===
Элемент аналогичен кнопке типа submit, но при использовании button пропускается проверка данных на стороне клиента.
<pre>$mform->addElement('button', 'testname', 'Надпись на кнопке');</pre>
=== choosecoursefile ===
Выбрать файл из курса. Только для использования внутри курса Moodle.
=== submit ===
Кнопка отправки данных из формы. Обязательно ставьте ее в конце, иначе все введенные данные нельзя будет отправить. Существует также альтернативный способ задать такую кнопку - это функция [[Разработка:moodleQuickForm#add_action_buttons($cancel, $submitlabel)|get_data()]]
<pre>$mform->addElement('submit', 'testname', 'Текст на кнопке');</pre>
=== questioncategory ===
Выбрать вопрос из категории. Только при редактировании теста и только внутри курса Moodle.
=== advcheckbox ===
Элемент checkbox c расширенными функциями - такие элементы можно объединять в группы и устанавливать им контрольный переключатель (делает либо все галочки поставлеными либо снятыми) при помощи функции [[Разработка:moodleQuickForm#add_checkbox_controller($groupid, $buttontext, $attributes, $originalValue) |add_checkbox_controller()]].

Поскольку таких галочек всегда задается несколько - то целесообразно в указании имени элемента использовать квадратные скобки, чтобы собрать значения всех элементов в один массив. Последним аргументом задается группа, к которой принадлежит созданный элемент. Именно это значение должно быть указано в первом параметре функции [[Разработка:moodleQuickForm#add_checkbox_controller($groupid, $buttontext, $attributes, $originalValue) |add_checkbox_controller()]].

Несовместим с функцией [[Разработка:moodleQuickForm#disabledIf($elementName, $dependentOn, $condition, $value) | disabledIf()]]

<pre>
$mform->addElement('advcheckbox', 'testname[1]', 'Описание:', 'Текст за галочкой', array('group' => 'id_группы'));

$mform->addElement('advcheckbox', 'testname[2]', 'Описание:', 'Текст за галочкой', array('group' => 'id_группы'));
</pre>
=== recaptcha ===
Окно с картинкой для использования Capcha проверки. Обратите внимание, что для того чтобы использовать этот элемент вы сначала должны получить уникальный ключ с на сайте <nowiki>http://recaptcha.net/api/getkey</nowiki>.
<pre>$mform->addElement('recaptcha', 'testname', 'Текст с пояснением');</pre>
=== hierselect ===
Несколько зависимых друг от друга html-элементов типа "select". В зависимости от выбранной опции в первом элементе, меняются значения остальных.
При вызове функции addElement в последнем параметре указывается, какими символами разделять операторы select.
<pre>
// для начала создадим два массива - по количеству операторов select
// которые нам предстоит создать

// Первый, главный элемент select
$select1[0] = 'Pop';
$select1[1] = 'Classical';
$select1[2] = 'Funeral doom';

// второй элемент select - его варианты зависят от первого
$select2[0][0] = '--- Artist ---';
$select2[0][1] = 'Red Hot Chil Peppers';
$select2[0][2] = 'The Pixies';

$select2[1][0] = '--- Artist ---';
$select2[1][1] = 'Wagner';
$select2[1][2] = 'Strauss';

$select2[2][0] = '--- Artist ---';
$select2[2][1] = 'Pantheist';
$select2[2][2] = 'Skepticism';

// добавляем новый элемент в форму
$myselect =& $mform->addElement('hierselect', 'testname', 'Текст с пояснением:',null,'<br>');
// устанавливаем для него варианты ответа
$myselect->setOptions(array($select1, $select2));
// устанавливаем значения по умолчанию: 'Funeral doom'->'Pantheist'
$mform->setDefault('testname', array(2, 1));
</pre>
=== html ===
Добавить собственный html-код. Используйте этот тип элементов формы, только в случае, если ни один из перечисленных элементов вам не подходит, или нужно решить какую-либо нетривиальную задачу с форматированием.
Может помочь в случае решения задачи разбиения формы на 3, или более колонок ([http://docs.moodle.org/en/User:Frank_Ralf/Moodle_forms3] [http://moodle.org/mod/forum/discuss.php?d=126935]).
<pre>$mform->addElement('html', '<div class="qheader">');</pre>
=== autocomplete ===
Элемент, который автоматически подсказывает варианты по мере набора текста. Выглядит как обычный элемент text, но имеет встроенный javascript. Значение по умолчанию устанавливается стандартным образом.
<pre>// Создаем массив подсказок
$options = array('апельсин', 'ананас', 'авокадо');
// добавляем новый элемент в форму
$element =& $mform->addElement('autocomplete', 'testname', 'Текст с пояснением:', 'size=12');
// устанавливаем массив подсказок
$element->setOptions($options);
</pre>

=== dof_calendar ===
Элемент, который автоматически отображает 2 календаря для выбора диапазона дат. Календари находятся на одной линии. Под каждым календарем поле-указывает в формате д.м.гг дату, которая выбрана на календаре. В скрытое поле каждого календаря помещается время в unixtime, причем первый календарь (слева) отсчитывает время от 00.00.01, а второй (справа) с 23.59.59. Если на правом и на левом календарях отмечена одна дата, то диапазон, соответственно, равен 00.00.01-23.59.59, что полностью охватывает выбранный день.
Так же, у этого элемента есть возможность удаления тегов, как правил это select-поля(старый вариант выбора дат). Для этого нужно в $options указать имена этих полей

'''Пример:'''
<pre>
// добавляем новый элемент в форму
$element = $mform->addElement('dof_calendar', 'calendarname', 'Текст с пояснением:', $options),где
'Текст с пояснением:' - Текст, который будет выведен выше календарей
$options - массив, с указанием дат(левый и правый календарь)
* $options['date_from'] - с какой даты брать отсчет(левый календарь)(unix time)
* $options['date_to'] - по какую дату брать отсчет(правый календарь)(unix time)
-------------
* $options[] = 'field_from'; (элемент будет удален $mform->addElement('date_selector', 'field_from',$this->dof->modlib('ig')->igs('from'),$options); )
* $options[] = 'field_to'; (элемент будет удален $mform->addElement('date_selector', 'field_to',$this->dof->modlib('ig')->igs('from'),$options); )
</pre>
Если параметр options опущен, то берется текущая дата.
Важно !! При объявлении времени, нужно брать массив именно с этими параметры(date_from, date_to).
Выходные данные имеют вид
<pre>
[calendarname] = Array
[date_from] = ... (unux time)
[date_to] = ... (unux time)
</pre>

=== dof_autocomplete ===
Элемент с выпадающим списком подсказок по мере набора текста. Выглядит как обычный элемент text, но имеет встроенный javascript. В помощь с ним создается автоматически hidden поле, значение которого будет равно индексу выбранного элемента (name="id_autocomplete" id="id_hidden_auto"). В dof_autocomplete есть обязательные параметры, работа без которых невозможна. Записываются они в переменную массив <b>$options</b>. В неё же и помещается массив $options(ключ=>значение), это так называемые значения по умолчанию (необязательные).
*Список обязательных полей для переменной $options:
**plugintype - тип плагина (например storage)
**plugincode - код плагина (например plans)
**querytype - тип запроса, именно по нему и определяется, что надо делать( например plans_name ). Этот тип должен совпадать с типом, который будет находиться в этом в плагине в методе widgets_field_variants_list
**sesskey - ключ сессии(чтоб идентифицировать запрос) задается методом sesskey()
**type - тип действия ( например autocomplete ). Есть ещё тип savefield
*Необязательные поля:
**default - массив значений по умолчания( например $a[19]= "primer"), где ключ - это id элемента из бд
**departmentid - id подразделения, из которого пришел запрос
**extoptions - подключает расширенные возможности dof_autocomplete
==== Простой пример ====
<pre>
$mform->addElement('dof_autocomplete', $elementName = null, $elementLabel = null, $attributes = null, $options = null);
</pre>
==== Более подробный пример ====
<pre>
//Создаем массив входных данных
$options = array();
$options['plugintype'] = "storage";
$options['plugincode'] = "plans";
$options['querytype'] = "plans_name";
$options['sesskey'] = sesskey();
$options['type'] = 'autocomplete';
$options['departmentid'] = $departmentid;
// установим значение по умолчанию
$default = array( 19 => 'Test text' );
$options['default'] = $default;

// добавляем новый элемент в форму
$mform->addElement('dof_autocomplete', 'testname', 'Надпись перед полем:', array('width' => '100%'), $options);
</pre>
*Замечение:
**следует помнить, что элемент autocomplete сам в себе подключает js-библиотеки, и потому, объявление класса формы на странице должно быть ''раньше'', чем печать шапки страницы
**выходные данные имеют вид
<pre>
[testname] = Array
[text] = выбранное в меню значение (текст, который отображается в поле формы)
[id] = id выбранного объекта (как правило число)
</pre>
Необходимые методы:
Плагин, данные которого будут составлять автозаполнение должен иметь метод <b>widgets_field_variants_list($querytype, $data="")</b>, который возвращает массив объектов в формате
<pre>
$a = array();
a[1] = object(
name -> ЗНАЧЕНИЕ_1 ДЛЯ ВЫПАДАЮЩЕГО СПИСКА
id -> id элемента_1
);
a[2] = object(
name -> ЗНАЧЕНИЕ_2 ВЫПАДАЮЩЕГО СПИСКА
id -> id элемента_2
);
...
]
</pre>

Здесь:
* $querytype - тип запроса (только маленькие латинские буквы, цифры и знак подчеркивания)
* $data - входные данные, (как правило строка) набранные данные в поле autocomplete

'''Замечания:'''
* поля name и id обязательны в возвращаемых объектах
* рекомендуется возвращать не более 15 записей для быстрой работы AJAX-запроса, пользуйтесь ограничением SQL-выборки

==== Расширенный autocomplete ====

Добавляет к возможностям dof_autocomplete не только выбирать значения, но и создавать их, переименовывать и удалять.
Активируется при помощи дополнительного параметра extoptions, который имеет свои настройки:
*empty - активирует пустое значение(для удаления)
*create - активирует создание записи
*rename - активирует переименование записи
Сами по себе настройки не взаимосвязаны, поэтому можно задавать только необходимые нам расширения. Отсутствие всех настроек не активирует ни одного расширения. Настройки empty и create активируются передачей обычного булевского значения true, для активации rename понадобится передача id переименовываемого обьекта.
==== Пример активизации расширенного autocomplete====
<pre>
$options['extoptions'] = new stdClass;
$options['extoptions']->create = true;
if (!empty($id))
{
$options['extoptions']->empty = true;
$options['default'] = array($id => $name.' ['.$id.']');
$options['extoptions']->rename = $id;
}
</pre>

Для обработки значений autocomplete используется метод из modlib/widgets '''get_extvalues_autocomplete($name,$autocomplite)''', где
*name - имя поля dof_autocomplete,
*autocomplite - данные полученыые из [[Разработка:moodleQuickForm#get_data.28.24slashed.29|get_data()]] формы поля dof_autocomplete.

'''Замечания:'''
* Использовать расширенные возможности можно только выбрав соответствующий пункт из меню. Обычное "стирание" или "вбивание" данных не дадут никакого эффекта.

==== Работа dof_autocomplete с id ====

=== dof_duration ===
Элемент для задания длительности временного интервала в часах, днях, неделях, и т. п.
<pre>
// задаем возможные единицы измерения: часы и минуты
$options['availableunits'] = array(60 => $this->dof->modlib('ig')->igs('minutes'),
3600 => $this->dof->modlib('ig')->igs('hours'));
// добавляем сам элемент
$mform->addElement('dof_duration', 'testname', 'Текст с пояснением:', $minutesoptions);
</pre>
=== dof_single_use_submit ===
Одноразовая submit-кнопка. Отправляет данные формы и сразу же становится неактивной, для того чтобы избежать повторного нажатия и отправки данных (doubleclick). Имеет дополнительный метод setPleaseWaitText(), при помощи которого можно устанавливать надпись, которая появляется после нажатия на кнопку.
<pre>
// создаем кнопку, с надписью "сохранить"
$submit = &$mform->addElement('dof_single_use_submit', 'testsinglesubmit', $this->dof->modlib('ig')->igs('save'));
// Устанавливаем сообщение после нажатия - "обработка"
$submit->setPleaseWaitText($this->dof->modlib('ig')->igs('processing'));
</pre>

== Решение наиболее распространенных задач ==

=== Установка обязательных полей ===
Установка обязательных полей происходит при помощи функции [[Разработка:moodleQuickForm#addRule($element, $message, $type, $format, $validation, $reset, $force)|addRule()]].

Пример:
// устанавливаем поле "город"
$mform->addElement('text', 'city', 'Город :', 'maxlength="100" size="30"');
// делаем поле обязательным
$mform->addRule('city','Это поле является обязательным', 'required',null,'client');

=== Установка дополнительных полей ===
Установка дополнительных полей производится при помощи функции [[Разработка:moodleQuickForm#setAdvanced($elementName, $advanced)|setAdvanced()]]. Необязательные элементы должны располагаться один за другим.

Пример:
// устанавливаем два текстовых поля и делаем их необязательными
$mform->addElement('text', 'my_field1', 'Пояснение :');
$mform->setAdvanced('my_field1');
$mform->addElement('text', 'my_field2', 'Пояснение :');
$mform->setAdvanced('my_field2');

=== Установка проверки на стороне клиента или сервера ===
По умолчанию все данные из формы подлежат проверке на стороне сервера. Существует возможность добавить проверку на стороне клиента. Не забывайте при этом, что эти данные нужно потом все равно еще раз проверить на стороне сервера, так как всегда существует возможность послать данные в обход формы.
==== Проверка на стороне сервера ====
Если вам требуется дополнительная проверка данных на стороне сервера, то используйте стандартный метод [[Разработка:moodleQuickForm#validation($data, $files) | validation()]]. Любые другие способы проверки данных после формы должны использоваться только в исключительных случаях.

==== Проверка на стороне клиента ====
Все малозначимые проверки желательно производить на стороне клиента для увеличения быстродействия приложения. Все проверки на стороне клиента производятся при помощи функции [[Разработка:moodleQuickForm#addRule($element, $message, $type, $format, $validation, $reset, $force)|addRule()]].

В параметре validation обязательно нужно указать 'client'.

Пример:
// устанавливаем поле "фамилия"
$mform->addElement('text', 'lastname', 'Фамилия :');
// делаем его обязательным
$mform->addRule('lastname','Это поле является обязательным', 'required',null,'client');
=== Установка зависимых полей ===
==== Стандартный вариант ====
Установка зависимых полей производится при помощи функции [[Разработка:moodleQuickForm#disabledIf($elementName, $dependentOn, $condition, $value)|disabledIf()]].

Пример:
// Устанавливаем элемент checkbox
$mform->addElement('checkbox', 'my_checkbox', get_string('forcedownload', 'resource'));
// устанавливаем текстовое поле
$mform->addElement('text', 'my_field', 'Пояснение :');
// устанавливаем зависимость
$mform->disabledIf('my_field', 'my_checkbox', 'checked');
==== Расширенный вариант ====
Для html-элеметов "select", есть возможность установить иерархическую зависимость элементов (то есть в зависимости от того, что было выбрано в первом "select", меняются значения в остальных). Синтаксис этого элемента указан в разделе [[Разработка:moodleQuickForm#Элементы формы|Элементы формы]] (в самом конце, он называется hierselect).

== Известные проблемы ==
В этом разделе собраны обнаруженные проблемы с элементами формы и способы их решения.
=== Данные не приходят из поля формы, даже в validation ===
Возможно на странице обработчика формы есть функция optional_param (или required_param) которая называется точно также как поле в форме. Если это так, то указанное поле из данных формы пропадет.
=== text ===
* Поле ввода слишком широкое, слишком узкое, или вылезает за границы заголовка
** Решение: Нужно в свойства элемента добавить style="width:100%;". В этом случае элемент растянется до конца формы, и не будет вылезать за границы формы вне зависимости от того - большой монитор у пользователя или маленький.
** Пример:
<pre>
$mform->addElement('select', 'my_select', 'Description...', $options, ' style="max-width:400px;width:100%;" ');
</pre>
=== textarea ===
* Поле ввода слишком широкое, слишком узкое, или вылезает за границы заголовка
** Решение: Нужно в свойства элемента добавить style="width:100%;". В этом случае элемент растянется до конца формы, и не будет вылезать за границы формы вне зависимости от того - большой монитор у пользователя или маленький.
** Пример:
<pre>
$mform->addElement('textarea', 'name', 'Description...', array('style' => 'width:100%;max-width:400px;height:150px;'));
</pre>
=== hierselect ===
* Не работает Javascript если в качестве значения hierselect используются цифры
** Решение: в списке значений после цифры добавлять пробел, или любой другой символ.
** Пример: array('1' => '''"1 "'''); вместо array('1' => '''"1"''');
* Невозможно отключить только одно поле hierselect не отключая при этом остальные
** Решение: отсутствует.
* При количестве select-элементов 3 или больше портится верстка. Подписи к select-элементам не совпадают с самими элементами.
** Решение: до элемента hierselect вставить html-элемент который содержит div, устанавливающий фиксированный межстрочный интервал (см. пример). После добавления hierselect-элемента закрыть div.
** Пример:
<pre>
// выравниваем строки по высоте
$mform->addElement('html', '<div style=" line-height: 1.9; ">');

// Дальше идет объявление hierselect...
// ...

// закрываем тег выравнивания строк
$mform->addElement('html', '</div>');
</pre>
* При указании строковых ключей массива hierselect не работает. Это происходит из-за того что в Javascript мы можем иметь дело либо с индексированными массивами, либо с объектами. Ассоциативные массивы там не предусмотрены.
** Решение: не использовать ассоциативные ключи массивов при создании элементов hierselect. Если же обойтись без них никак нельзя - то можно закодировать ассоциативные элементы числами ('option1' - 1, 'option2' - 2 и т. д.), а на стороне обработчика раскодировать обратно.
* По неизвестным причинам иногда перестает работать переключение с одной опции на другую.
** Решение: скорее всего в списке дочерних опций присутствуют элементы не для всех родительских опций (см. пример). Для каждой опции верхнего уровня должен присутствовать хотя бы один элемент нижнего уровня.
** Пример:
'''Неправильный код:'''
<pre>
$level1 = array();
$level1[0] = 'option0';
$level1[1] = 'option1';

$level2 = array();
$level2[1][0] = 'option1_0';
$level2[1][1] = 'option1_1';
</pre>
'''Правильный код:'''
<pre>
$level1 = array();
$level1[0] = 'option0';
$level1[1] = 'option1';

$level2 = array();
$level2[0][0] = 'option0_0'; // без этой строки ничего не будет работать
$level2[1][0] = 'option1_0';
$level2[1][1] = 'option1_1';
</pre>
* Данные из поля hierselect передаются вне зависимости от того, было отключено поле или нет.
** Решение: отсутствует.
* При проверке данных в функции validation() нельзя сообщить о том, что ошибка произошла внутри какого-то конкретного select-элемента.
** Решение: отсутствует. Можно указать только указывать сам hierselect-элемент как источник ошибки, и сообщить подробности в сообщении.

=== hidden ===
* Не работает правило disabledif. Невозможно установить значение из hidden-поля для использования disabledif-правила.
** Решение: создать другой элемент (например checkbox), записать в него нужное значение, и в стилях установить ему display:none
** Пример:
<pre>
$mform->addElement('radio', 'hidden_hack', '', '', 'true', 'style' => 'display:none;');
</pre>

== Ссылки ==
* [http://pear.php.net/manual/en/package.html.html-quickform.php Справка по базовым методам класса HTML_QuickForm]
* [http://docs.moodle.org/en/Development:lib/formslib.php_Form_Definition Справки по элементам класса moodleform]
* [http://web.archive.org/web/20080214041550/http://www.midnighthax.com/quickform.php Getting Started Guide по элементам оригинального класса HTML_QuickForm. Некоторые обращения к методам могут отличаться от moodleform.]
* [http://wiki.triangle-solutions.com/index.php/PEAR_HTML_QuickForm] Примеры объявления элементов.

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

2014-08-20T15:30:16Z

Konovalov: /* Возможные статусы */

{{Infobox_Plugin
| name = cpassed
| type = workflows
}}
==Возможные статусы==
* Запланирован (plan) - слушатель подписан на обучение данной дисциплине в данном учебном процессе, но обучение еще не началось.
* Идет обучение (active) - слушатель обучается в составе учебного процесса.
* Приостановлен (suspend) - обучение приостановлено по тем или иным причинам (например, непоступление оплаты или приостановка всего процесса)
* Отменен (canceled) - обучение отменено до его завершения (слушатель отчислен, учебный процесс отменен, слушатель перевелся или отказался от дисциплины).
* Успешно завершен (completed) - учебный процесс был проведен и успешно завершен. Студент считается сдавшим данную дисциплину, а текущая оценка считается окончательным результатом студента. Каждая запись с таким статусом считается отдельной итоговой оценкой, поэтому нужно заботиться о том, чтобы не было дублирования (при пересдачи старые оценки переводить в статус "неуспешно завершен"). Считаем, что в рамках одной подписки на программу может быть только одна подписка на каждую дисциплину с таким статусом (но могут быть в других статусах).
* Перезачет из другой программы или учебного заведения (reoffset) - оценка была выставлена по результатам учебного процесса в другой подписке или по предъявленным документам из другого учебного заведения. Обучения не проводилось, но оценка выставлена.
* Неуспешно завершен (failed) - обучение было проведено, но студент не сдал предмет или предмет был пересдан в другой подписке (cpassed). Оценка из текущей записи не является окончательной, отображается только в истории пересдач и в сохраненных приказах-ведомостях. Если пересдачи со статусом completed нет, дисциплина считается не сданной. Если дисциплина была передана, то окончательной является оценка из другой записи, в которой поле repeatid ссылается на текущую запись.
* Академическая разница (задолженность) (academicdebt) - академическая разница, образовавшаяся при приеме сразу на 2-ой/3-ий курс с перезачетом сданных дисциплин из другого учебного заведения. Этот статус равносилен "неуспешному перезачету" (перезачету на неудовлетворительную оценку), который требуется пересдать вне основного учебного плана. Конечный, реальный статус неуспешного перезачета дисциплины, противоположный reoffset (успешному перезачету на положительную оценку). Обозначает обязанность ученика пересдать эту дисциплину вне индивидуального учебного плана (в произвольное время за период обучения) без изучения данной дисциплины.

=== Метастатусы ===
* Активный: active
* Актуальный: plan, active, suspend
* Реальный:plan, active, suspend, completed, reoffset, failed, academicdebt
* Мусорный: canceled

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

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

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

Возможные переходы ИЗ этого статуса:
* Успешно завершен (одновременно выставляется итоговая оценка)
* Неуспешно завершен
* Приостановлен
* Отменен

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

==== Приостановлен ====
* Идет обучение
* Отменен
* Успешно завершен
* Неуспешно завершен

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

==== Успешно завершен ====
Возможные переходы ИЗ этого статуса:
* Неуспешно завершен - в случае, если студент пересдал итоговую оценку, то старая подписка должна быть переведена в статус "неуспешно завершен", а новая ссылаться на старую через repeatid

==== Перезачет ====
Возможные переходы ИЗ этого статуса:
* Неуспешно завершен - в случае, если студент пересдал итоговую оценку, то старая подписка должна быть переведена в статус "неуспешно завершен", а новая ссылаться на старую через repeatid

==== Неуспешно завершен ====
Конечный статус

==== Академическая разница ====
Конечный статус

== API ==

==== get_list() ====
Получить список всех возможных статусов для подписки на предмет

''Аргументы:''
* (нет)
''Возвращаемые значения:''
* Массив, со списком всех возможных статусов в формате "обозначение" => "Перевод"

==== get_name() ====
Получить название статуса по его обозначению в базе данных

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

==== get_available() ====
Получить список статусов, в которые может перейти указанная подписка на предмет

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

==== change() ====
Сменить статус подписки на предмет на указанный.

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

При обращении к функции change() выполняются дополнительные действия, указанные выше, в разделе "Маршруты статусов". При каждом изменении статуса данные записываются в таблицу [[Разработка:storages/statushistory|statushistory]].
==== init() ====
Запускается при вставке в таблицу [[Разработка:storages/cpassed|cpassed]] новой записи. Автоматически назначает созданной подписке на предмет статус "запланирован" (plan).

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

==Перехватываемые события==

{| border="1"
|+ Таблица событий, которые перхватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Пояснение
|-
|storage
|[[Разработка:storages/cpassed|cpassed]]
|insert
|Каждая новая созданная подписка на предмет автоматически переводится в статус "запланирована" (plan), путем вызова функции [[#init()|init()]].
|}

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

2014-08-20T09:55:07Z

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

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

====Подробный формат полей в таблице:====
* '''programmsbcsid''' - id подписки ученика на учебную программу в таблице [[Разработка:storages/programmsbcs|programmsbcs]].
* '''ageid''' - id учебного периода в таблице [[Разработка:storages/ages|ages]], в котором были пройдены дисциплины данной параллели
* '''agenum''' - номер параллели (класс или семестр и т. п.)
* '''changedate''' - дата создания записи в формате unixtimestamp
* '''orderid''' - id приказа, в результате которого учащийся был записан на данную параллель (таблица [[Разработка:storages/orders|orders]]). Возможно null-значение, если изменения не были связаны ни с каким приказом.

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

===='''get_ageid_agenum($programmsbcid, $agenum)'''====

Получить id учебного периода подписки на программу по номеру семестра

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

===='''get_first_learning_data($programmsbcid)''' ====

Получить первую запись на момент начала обучения

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

===='''get_actual_learning_data($programmsbcid)'''====

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

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

===='''get_history($programmsbcid, $timefrom=null, $timeto=null)'''====

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

''Аргументы:''
* $programmsbcid - id подписки ученика на учебную программу (таблица [[Разработка:storages/programmsbcs|programmsbcs]]), по которой запрашивается история
* $timefrom - начало временного периода, за который запрашивается история изменения подписок, по умолчанию null
* $timeto - конец временного периода, за который запрашивается история изменения подписок, по умолчанию null
''Возвращаемое значение:''
* (mix) object|bool - объект из таблицы [[Разработка:storages/learninghistory|learninghistory]], или false

===='''get_subscribe_ages($programmsbcid)'''====

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

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

===='''add($programmsbc)'''====

Добавляет историю изменения учебного процесса для ученика.

''Аргументы:''
* $programmsbc - id в таблице [[Разработка:storages/programmsbcs|programmsbcs]]) или сам объект с таким id
''Возвращаемое значение:''
* array - массив записей или false

===='''set_actual_learninghistoryid($cpassed)'''====

Устанавливает learninghistoryid для записей cpassed, если есть актуальные данные в истории обучения

''Аргументы:''
* (object|int) $cpassed - изучаемый или пройденный курс
''Возвращаемое значение:''
* bool - результат операции

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

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|cpassed
|insert
|Стандартные
|
|-
|storage
|cpassed
|update
|Стандартные
|
|-
|storage
|cpassed
|delete
|Стандартные
|
|}

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

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

2014-08-20T09:54:33Z

Konovalov: /* Дополнительные методы: */ исправил различия в коде и документации

{{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_next_ageid($ageid, $agenum)'''====

Находит один из дочерних учебных периодов

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

===='''get_previous_ageid($ageid, $agenum)'''====

Находит предшествующий указанному в ageid учебный период

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

===='''create_period_for_department($deptid, $datebegin, $dateend, $numweeks, $name, $previousid=null)'''====

Создаёт период для структурного подразделения

''Аргументы:''
* $deptid(int) - id учебного подразделения в таблице [[Разработка:storages/departments | departments ]].
* $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 предыдущего учебного периода в таблице [[Разработка:storages/ages | ages ]] или null, если нет предыдущего периода, по умолчанию null.
''Возвращаемые значения:''
* int - id созданного периода.
* bool - false, если период создать нельзя.

===='''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.
|}

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

2014-08-14T09:03:19Z

Konovalov: /* Метастатусы */

{{Infobox_Plugin
| name = cpassed
| type = workflows
}}
==Возможные статусы==
* Запланирован (plan) - слушатель подписан на обучение данной дисциплине в данном учебном процессе, но обучение еще не началось.
* Идет обучение (active) - слушатель обучается в составе учебного процесса.
* Приостановлен (suspend) - обучение приостановлено по тем или иным причинам (например, не поступление оплаты или приостановка всего процесса)
* Отменен (canceled) - обучение отменено до его завершения (слушатель отчислен, учебный процесс отменен, слушатель перевелся или отказался от дисциплины).
* Успешно завершен (completed) - учебный процесс был проведен и успешно завершен. Студент считается сдавшим данную дисциплину, а текущая оценка считается окончательным результатом студента. Каждая запись с таким статусом считается отдельной итоговой оценкой, поэтому нужно заботиться о том, чтобы не было дублирования (при пересдачи старые оценки переводить в статус "неуспешно завершен"). Считаем, что в рамках одной подписки на программу может быть только одна подписка на каждую дисциплину с таким статусом (но могут быть в других статусах).
* Перезачет из другой программы или учебного заведения (reoffset) - оценка была выставлена по результатам учебного процесса в другой подписке или по предъявленным документам из другого учебного заведения. Обучения не проводилось, но оценка выставлена.
* Неуспешно завершен (failed) - обучение было проведено, но студент не сдал предмет или предмет был пересдан в другой подписке (cpassed). Оценка из текущей записи не является окончательной, отображается только в истории пересдач и в сохраненных приказах-ведомостях. Если пересдачи со статусом completed нет, дисциплина считается не сданной. Если дисциплина была передана, то окончательной является оценка из другой записи, в которой поле repeatid ссылается на текущую запись.
* Академическая разница (academicdebt) - слушателю добавили дисциплину в качестве разницы учебного плана, возникшей в результате перезачётов (reoffset). Подписка на дисциплину с этим статусом используется при назначении слушателю пересдачи с конкретным преподавателем и учебным периодом.

=== Метастатусы ===
* Активный: active
* Актуальный: plan, active, suspend
* Реальный:plan, active, suspend, completed, reoffset, failed, academicdebt
* Мусорный: canceled

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

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

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

Возможные переходы ИЗ этого статуса:
* Успешно завершен (одновременно выставляется итоговая оценка)
* Неуспешно завершен
* Приостановлен
* Отменен

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

==== Приостановлен ====
* Идет обучение
* Отменен
* Успешно завершен
* Неуспешно завершен

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

==== Успешно завершен ====
Возможные переходы ИЗ этого статуса:
* Неуспешно завершен - в случае, если студент пересдал итоговую оценку, то старая подписка должна быть переведена в статус "неуспешно завершен", а новая ссылаться на старую через repeatid

==== Перезачет ====
Возможные переходы ИЗ этого статуса:
* Неуспешно завершен - в случае, если студент пересдал итоговую оценку, то старая подписка должна быть переведена в статус "неуспешно завершен", а новая ссылаться на старую через repeatid

==== Неуспешно завершен ====
Конечный статус

==== Академическая разница ====
Конечный статус

== API ==

==== get_list() ====
Получить список всех возможных статусов для подписки на предмет

''Аргументы:''
* (нет)
''Возвращаемые значения:''
* Массив, со списком всех возможных статусов в формате "обозначение" => "Перевод"

==== get_name() ====
Получить название статуса по его обозначению в базе данных

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

==== get_available() ====
Получить список статусов, в которые может перейти указанная подписка на предмет

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

==== change() ====
Сменить статус подписки на предмет на указанный.

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

При обращении к функции change() выполняются дополнительные действия, указанные выше, в разделе "Маршруты статусов". При каждом изменении статуса данные записываются в таблицу [[Разработка:storages/statushistory|statushistory]].
==== init() ====
Запускается при вставке в таблицу [[Разработка:storages/cpassed|cpassed]] новой записи. Автоматически назначает созданной подписке на предмет статус "запланирован" (plan).

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

==Перехватываемые события==

{| border="1"
|+ Таблица событий, которые перхватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Пояснение
|-
|storage
|[[Разработка:storages/cpassed|cpassed]]
|insert
|Каждая новая созданная подписка на предмет автоматически переводится в статус "запланирована" (plan), путем вызова функции [[#init()|init()]].
|}

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

2014-08-14T08:47:24Z

Konovalov: /* Возможные статусы */

{{Infobox_Plugin
| name = cpassed
| type = workflows
}}
==Возможные статусы==
* Запланирован (plan) - слушатель подписан на обучение данной дисциплине в данном учебном процессе, но обучение еще не началось.
* Идет обучение (active) - слушатель обучается в составе учебного процесса.
* Приостановлен (suspend) - обучение приостановлено по тем или иным причинам (например, не поступление оплаты или приостановка всего процесса)
* Отменен (canceled) - обучение отменено до его завершения (слушатель отчислен, учебный процесс отменен, слушатель перевелся или отказался от дисциплины).
* Успешно завершен (completed) - учебный процесс был проведен и успешно завершен. Студент считается сдавшим данную дисциплину, а текущая оценка считается окончательным результатом студента. Каждая запись с таким статусом считается отдельной итоговой оценкой, поэтому нужно заботиться о том, чтобы не было дублирования (при пересдачи старые оценки переводить в статус "неуспешно завершен"). Считаем, что в рамках одной подписки на программу может быть только одна подписка на каждую дисциплину с таким статусом (но могут быть в других статусах).
* Перезачет из другой программы или учебного заведения (reoffset) - оценка была выставлена по результатам учебного процесса в другой подписке или по предъявленным документам из другого учебного заведения. Обучения не проводилось, но оценка выставлена.
* Неуспешно завершен (failed) - обучение было проведено, но студент не сдал предмет или предмет был пересдан в другой подписке (cpassed). Оценка из текущей записи не является окончательной, отображается только в истории пересдач и в сохраненных приказах-ведомостях. Если пересдачи со статусом completed нет, дисциплина считается не сданной. Если дисциплина была передана, то окончательной является оценка из другой записи, в которой поле repeatid ссылается на текущую запись.
* Академическая разница (academicdebt) - слушателю добавили дисциплину в качестве разницы учебного плана, возникшей в результате перезачётов (reoffset). Подписка на дисциплину с этим статусом используется при назначении слушателю пересдачи с конкретным преподавателем и учебным периодом.

=== Метастатусы ===
* Активный: active
* Актуальный: plan, active, suspend
* Реальный:plan, active, suspend, completed, reoffset, failed
* Мусорный: canceled

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

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

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

Возможные переходы ИЗ этого статуса:
* Успешно завершен (одновременно выставляется итоговая оценка)
* Неуспешно завершен
* Приостановлен
* Отменен

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

==== Приостановлен ====
* Идет обучение
* Отменен
* Успешно завершен
* Неуспешно завершен

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

==== Успешно завершен ====
Возможные переходы ИЗ этого статуса:
* Неуспешно завершен - в случае, если студент пересдал итоговую оценку, то старая подписка должна быть переведена в статус "неуспешно завершен", а новая ссылаться на старую через repeatid

==== Перезачет ====
Возможные переходы ИЗ этого статуса:
* Неуспешно завершен - в случае, если студент пересдал итоговую оценку, то старая подписка должна быть переведена в статус "неуспешно завершен", а новая ссылаться на старую через repeatid

==== Неуспешно завершен ====
Конечный статус

==== Академическая разница ====
Конечный статус

== API ==

==== get_list() ====
Получить список всех возможных статусов для подписки на предмет

''Аргументы:''
* (нет)
''Возвращаемые значения:''
* Массив, со списком всех возможных статусов в формате "обозначение" => "Перевод"

==== get_name() ====
Получить название статуса по его обозначению в базе данных

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

==== get_available() ====
Получить список статусов, в которые может перейти указанная подписка на предмет

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

==== change() ====
Сменить статус подписки на предмет на указанный.

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

При обращении к функции change() выполняются дополнительные действия, указанные выше, в разделе "Маршруты статусов". При каждом изменении статуса данные записываются в таблицу [[Разработка:storages/statushistory|statushistory]].
==== init() ====
Запускается при вставке в таблицу [[Разработка:storages/cpassed|cpassed]] новой записи. Автоматически назначает созданной подписке на предмет статус "запланирован" (plan).

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

==Перехватываемые события==

{| border="1"
|+ Таблица событий, которые перхватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Пояснение
|-
|storage
|[[Разработка:storages/cpassed|cpassed]]
|insert
|Каждая новая созданная подписка на предмет автоматически переводится в статус "запланирована" (plan), путем вызова функции [[#init()|init()]].
|}

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

2014-08-14T08:35:58Z

Konovalov: /* Маршруты статусов */

{{Infobox_Plugin
| name = cpassed
| type = workflows
}}
==Возможные статусы==
* Запланирован (plan) - слушатель подписан на обучение данной дисциплине в данном учебном процессе, но обучение еще не началось.
* Идет обучение (active) - слушатель обучается в составе учебного процесса.
* Приостановлен (suspend) - обучение приостановлено по тем или иным причинам (например, не поступление оплаты или приостановка всего процесса)
* Отменен (canceled) - обучение отменено до его завершения (слушатель отчислен, учебный процесс отменен, слушатель перевелся или отказался от дисциплины).
* Успешно завершен (completed) - учебный процесс был проведен и успешно завершен. Студент считается сдавшим данную дисциплину, а текущая оценка считается окончательным результатом студента. Каждая запись с таким статусом считается отдельной итоговой оценкой, поэтому нужно заботиться о том, чтобы не было дублирования (при пересдачи старые оценки переводить в статус "неуспешно завершен"). Считаем, что в рамках одной подписки на программу может быть только одна подписка на каждую дисциплину с таким статусом (но могут быть в других статусах).
* Перезачет из другой программы или учебного заведения (reoffset) - оценка была выставлена по результатам учебного процесса в другой подписке или по предъявленным документам из другого учебного заведения. Обучения не проводилось, но оценка выставлена.
* Неуспешно завершен (failed) - обучение было проведено, но студент не сдал предмет или предмет был пересдан в другой подписке (cpassed). Оценка из текущей записи не является окончательной, отображается только в истории пересдач и в сохраненных приказах-ведомостях. Если пересдачи со статусом completed нет, дисциплина считается не сданной. Если дисциплина была передана, то окончательной является оценка из другой записи, в которой поле repeatid ссылается на текущую запись.

=== Метастатусы ===
* Активный: active
* Актуальный: plan, active, suspend
* Реальный:plan, active, suspend, completed, reoffset, failed
* Мусорный: canceled

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

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

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

Возможные переходы ИЗ этого статуса:
* Успешно завершен (одновременно выставляется итоговая оценка)
* Неуспешно завершен
* Приостановлен
* Отменен

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

==== Приостановлен ====
* Идет обучение
* Отменен
* Успешно завершен
* Неуспешно завершен

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

==== Успешно завершен ====
Возможные переходы ИЗ этого статуса:
* Неуспешно завершен - в случае, если студент пересдал итоговую оценку, то старая подписка должна быть переведена в статус "неуспешно завершен", а новая ссылаться на старую через repeatid

==== Перезачет ====
Возможные переходы ИЗ этого статуса:
* Неуспешно завершен - в случае, если студент пересдал итоговую оценку, то старая подписка должна быть переведена в статус "неуспешно завершен", а новая ссылаться на старую через repeatid

==== Неуспешно завершен ====
Конечный статус

==== Академическая разница ====
Конечный статус

== API ==

==== get_list() ====
Получить список всех возможных статусов для подписки на предмет

''Аргументы:''
* (нет)
''Возвращаемые значения:''
* Массив, со списком всех возможных статусов в формате "обозначение" => "Перевод"

==== get_name() ====
Получить название статуса по его обозначению в базе данных

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

==== get_available() ====
Получить список статусов, в которые может перейти указанная подписка на предмет

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

==== change() ====
Сменить статус подписки на предмет на указанный.

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

При обращении к функции change() выполняются дополнительные действия, указанные выше, в разделе "Маршруты статусов". При каждом изменении статуса данные записываются в таблицу [[Разработка:storages/statushistory|statushistory]].
==== init() ====
Запускается при вставке в таблицу [[Разработка:storages/cpassed|cpassed]] новой записи. Автоматически назначает созданной подписке на предмет статус "запланирован" (plan).

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

==Перехватываемые события==

{| border="1"
|+ Таблица событий, которые перхватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Пояснение
|-
|storage
|[[Разработка:storages/cpassed|cpassed]]
|insert
|Каждая новая созданная подписка на предмет автоматически переводится в статус "запланирована" (plan), путем вызова функции [[#init()|init()]].
|}

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

2014-08-14T08:34:05Z

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

{{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 ]].
* begindate - дата начала действия подписки.
* enddate - дата окончания действия подписки.
* sbcorderid - id приказа в таблице [[Разработка:storages/orders | orders ]], которым учащийся был подписан на дисциплину.
* learninghistoryid - id записи в таблице [[Разработка:storages/learninghistory | learninghistory ]], соответствующая текущей параллели данной подписки.

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

===='''get_actual_reoffset_cpassed($cpasseds)'''====

Возвращает только последнюю пересдачу (по времени) из массива пересдач.

''Аргументы:''
* $cpasseds(array) - записи, полученные по одной подписке и дисциплине.
''Возвращаемые значения:''
* (object) - объект последней пересдачи
* (bool) - false, в случае ошибки
''Структура работы:''
# в эту функцию должны передаваться только cpassed->status == 'reoffset'

===='''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_cpasseds_reoffset($conds=null, $countonly=false, $limitfrom, $limitnum)'''====

Возвращает список учебных потоков по заданным критериям, упрощённая версия get_listing() с поиском только по таблице cpassed для "Ведомости перезачёта оценок"

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

===='''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), статус исходной подписки меняем на пересдан и обновляем запись в БД.
# формируем новый объект в БД.
# вставляем сформированную запись в таблицу БД.

===='''insert_grade_register_reoffset($programmsbcid, $programmitemid, $studentid, $grade, $orderid, $teacherid, $date)'''====

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

''Аргументы:''
* $programmsbcid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
* $programmitemid(int) - id дисциплины в таблице [[Разработка:storages/programmitems | programmitems ]].
* $studentid(int) - id студента (personid) в таблице [[Разработка:storages/persons | persons ]].
* $grade(int) - итоговая оценка.
* $orderid(int) - id приказа в таблице [[Разработка:storages/orders | orders ]], по которому выставляется перезачёт.
* $teacherid(int) - personid из таблицы [[Разработка:storages/persons | persons ]], кто ставил оценку
* $date(int) - дата перезачёта
''Возвращаемые значения:''
* (int) id добавленной записи.
* (bool) false если добавление не удалось.
''Структура работы:''
# Cоздаются cpassed-ы не привязанные к периоду (ageid=0).
# Если у студента уже был cpassed по этой дисциплине, перезачет ссылается на него полем repeatid (если несколько - то на самый первый, если старая подписка была активна - закрывается с неуспешным статусом).

===='''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, если произошла ошибка.

===='''get_cpassed_on_studentid_programmsbcid_active_complete($programmsbcid, $programmitemid)'''====

Возвращает список активных или завершённых подписок на дисциплину по номеру подписки (номер студента берётся из неё) на программу.

''Аргументы:''
* $programmsbcid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
* $programmitemid(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.
|}

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|resync_age_cpassed
|Обязателен. Указывается id периода из таблицы [[Разработка:storages/ages | ages ]]
|Находит все активные подписки на дисциплины в указанном периоде, после чего каждую из них приостанавливает и заново возобновляет. Необходимо для записи учащихся на курс Moodle, если курс Moodle был присвоен дисциплинам во время учебного процесса.
|-
|active_to_suspend_cpassed
|Обязателен. Указывается id периода из таблицы [[Разработка:storages/ages | ages ]]
|Находит все активные подписки на дисциплины в указанном периоде, после чего каждую из них приостанавливает. Необходимо для отписывания учащихся с курса Moodle, если необходимо сменить курс Moodle в дисциплинах. Работает в паре с '''suspend_to_active_cpassed'''.
|-
|suspend_to_active_cpassed
|Обязателен. Указывается id периода из таблицы [[Разработка:storages/ages | ages ]]
|Находит все приостановленные подписки на дисциплины в указанном периоде, после чего каждую из них активирует. Необходимо для записи учащихся на курс Moodle, если после смены курса Moodle в дисциплинах. Работает в паре с '''active_to_suspend_cpassed'''.
|-
|comparecpassed
|Необязателен
|Находит все незавершенные подписки на дисциплины, после чего каждую из них синхронизирует с учебным процессом, выставляя в подписке тот же id дисциплины, что и в процессе. Необходимо для сопоставления правильной дисциплины в подписке и процессе, если дисциплину в процессе сменили уже во время обучения.
|-
|cancaled_repeatid_to_null
|Необязателен
|Находит все отмененные подписки на дисциплины, у которых есть родители, и разрывает с ними связь. Необходимо для разрыва связи активный родитель->отмененный наследник, если по какой-то причине такие связи были созданы.
|-
|fill_learninghistoryid
|Необязателен
|Находит все подписки с пустым learninghistoryid и обновляет это поле, связывая его с записью в таблице [[Разработка:storages/learninghistory | learninghistory ]].
|}

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

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

2014-08-14T08:33:37Z

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

{{Infobox_Plugin
| name = learningplan
| type = storages
}}
=Таблица в базе данных=
''learningplan'' - запланированные на будущие периоды дисциплины.

====Подробный формат полей в таблице:====
* type - тип объекта, на которого запланирована дисциплина (programmsbc, agroup).
* programmsbcid - id слушателя из таблицы [[Разработка:storages/programmsbcs | programmsbcs ]], type=programmsbc или NULL
* agroupid - id группы из таблицы [[Разработка:storages/agroups | agroups ]], если type=agroup или NULL
* agenum - номер параллели, для которой задан план. Если слушатель обязан пройти дисциплину в любой период обучения 0. Уточнение: ageid мы не планируем, так как он пока не известен.
* programmitemid - id запланированной дисциплины из таблицы [[Разработка:storages/programmitems | programmitems ]] (дисциплина должна относится к той программе, на которую подписан слушатель или группа и быть активной на момент перевода в соответствующую параллель, чтобы произошла подписка).

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

===='''add_to_planned($type, $typeid, $agenum, $pitemid)'''====

Добавить к учебному плану запланированную дисциплину $pitemid для параллели $agenum

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции (false - ошибка, true - запись уже существует)
* (int) - id добавленной записи

===='''add_to_planned_required_agenum($type, $typeid, $agenum = false)'''====

Метод для планирования всех обязательных дисциплин для одной указанной параллели $agenum или всех обязательных дисциплин программы

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - результат операции

===='''check_programmitems_delete($intvar)'''====

Проверяет целостность таблицы, исключая из неё те дисциплины, которые были удалены

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

===='''check_programmitems_update($intvar, $new)'''====

Проверяет целостность таблицы, исключая из неё те дисциплины, которые стали неактивными

''Аргументы:''
* $intvar(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
* $new(object) - объект дисциплины после обновления
''Возвращаемые значения:''
* (bool) - результат операции

===='''remove_from_planned($type, $typeid, $pitemid)'''====

Убрать из учебного плана запланированную дисциплину

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции (false - ошибка, true - запись удалена)

===='''change_planned_agenum($type, $typeid, $agenum, $pitemid)'''====

Изменить в учебном плане запланированной дисциплине $pitemid параллель на $agenum

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции

===='''create_learningplan($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - результат операции

===='''get_all_pitems($type, $typeid, $agenum = false, $status = null)'''====

Получить все дисциплины программы, кроме запланированных в виде академической разницы (agenum=0), для всех параллелей, или только указанной

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - дисциплины программы, исключая запланированные

===='''get_current_agenum_type_typeid($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (int) - номер текущего семестра.

===='''get_learned_pitems($type, $typeid, $agenum = false, $status = null)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - изученные, активные и перезачтённые дисциплины.

===='''get_learningplan_info($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (object) - возвращаемый объект с полями
** type - тип учебного плана ('programmsbc' или 'agroup')
** typeid - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
** code - код объекта
** name - имя объекта (содержит либо имя группы, либо полное имя персоны с номером договора)
** programm - учебная программа, на которую планируются дисциплины - объект с полями id, code, name
** agenum - текущий семестр
** age - текущий период - объект с полями id, name, begindate, eduweeks
** agenums - количество семестров в программе
* (bool) - false в случае возникновения ошибки

===='''get_learningplan_pitems($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (object) - возвращаемый объект с полями
** planning(array) - дисциплины, предусмотренные программной на эту параллель, которые возможно запланировать
** planned(array) - запланированные дисциплины
** learned(array) - изученные дисциплины
** all(array) - все дисциплины, предусмотренные программой для этой параллели (включая уже запланированные и изученные, исключая дисциплины из нулевой параллели)
* (bool) - false в случае возникновения ошибки

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

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

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

===='''get_pitem_grade($type, $typeid, $pitemid)'''====

Получить оценку дисциплины учебного плана по подписке

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (null) - оценки не получено
* (int) - оценка
* (string) - оценка.

====''' get_pitem_status($type, $typeid, $pitemid)'''====

Получить статус дисциплины учебного плана (запланирована, в программе, изучена)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (string) - одно из трёх возможных значений: 'planned', 'programm', 'learned'.

===='''get_planned_pitems($type, $typeid, $agenum = false)'''====

Получить запланированные для указанной параллели дисцплины ($agenum = 0 - академическая разница)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - запланированные дисциплины.

===='''get_planning_pitems($type, $typeid, $agenum)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - планируемые дисциплины (которые можно добавить в план).

===='''get_programmid_type_typeid($type, $typeid)'''====

Получить номер программы по типу и номеру индивидуального плана

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (int) - номер программы.

===='''get_reoffset_pitems($type, $typeid, $agenum = false, $status = null)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - перезачтённые дисциплины.

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

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

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

===='''get_signed_pitems($type, $typeid, $agenum = false)'''====

Получить запланированные и изученные (поиск во всех семестрах get_learned_pitems) для указанной параллели дисцплины ($agenum = 0 - академическая разница)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - запланированные и изученные дисциплины.

===='''get_subscribe_current_agenum_pitems($type, $typeid, $options = array())'''====

Получить запланированные на текущую параллель дисциплины с учётом дополнительных настроек (используется для передачи в функцию автоподписки)

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

===='''get_unsigned_pitems($type, $typeid, $agenum = false)'''====

Получить запланированные, но не изученные (поиск во всех семестрах get_learned_pitems) для указанной параллели дисцплины ($agenum = 0 - академическая разница)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - запланированные, но не изученные дисциплины.

=События=
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|[[Разработка:storages/programmitems|programmitems]]
|update
|Только $mixedvar['new'] и $intvar
|Обрабатывается событие добавления дисциплины, вызывается функция [[#check_programmitems_update($intvar, $new)|check_programmitems_update($intvar, $new)]]
|-
|storage
|[[Разработка:storages/programmitems|programmitems]]
|delete
|Только $intvar
|Обрабатывается событие добавления дисциплины, вызывается функция [[#check_programmitems_delete($intvar)|check_programmitems_delete($intvar)]]
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не генерирует никаких событий''
|}

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|colspan=4 align=center | ''Этот плагин не выполняет никаких заданий''
|}

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

2014-07-31T13:35:32Z

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

{{Infobox_Plugin
| name = learningplan
| type = storages
}}
=Таблица в базе данных=
''learningplan'' - запланированные на будущие периоды дисциплины.

====Подробный формат полей в таблице:====
* type - тип объекта, на которого запланирована дисциплина (programmsbc, agroup).
* programmsbcid - id слушателя из таблицы [[Разработка:storages/programmsbcs | programmsbcs ]], type=programmsbc или NULL
* agroupid - id группы из таблицы [[Разработка:storages/agroups | agroups ]], если type=agroup или NULL
* agenum - номер параллели, для которой задан план. Если слушатель обязан пройти дисциплину в любой период обучения 0. Уточнение: ageid мы не планируем, так как он пока не известен.
* programmitemid - id запланированной дисциплины из таблицы [[Разработка:storages/programmitems | programmitems ]] (дисциплина должна относится к той программе, на которую подписан слушатель или группа и быть активной на момент перевода в соответствующую параллель, чтобы произошла подписка).

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

===='''add_to_planned($type, $typeid, $agenum, $pitemid)'''====

Добавить к учебному плану запланированную дисциплину $pitemid для параллели $agenum

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции (false - ошибка, true - запись уже существует)
* (int) - id добавленной записи

===='''add_to_planned_required_agenum($type, $typeid, $agenum = false)'''====

Метод для планирования всех обязательных дисциплин для одной указанной параллели $agenum или всех обязательных дисциплин программы

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - результат операции

===='''check_programmitems_delete($intvar)'''====

Проверяет целостность таблицы, исключая из неё те дисциплины, которые были удалены

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

===='''check_programmitems_update($intvar, $new)'''====

Проверяет целостность таблицы, исключая из неё те дисциплины, которые стали неактивными

''Аргументы:''
* $intvar(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
* $new(object) - объект дисциплины после обновления
''Возвращаемые значения:''
* (bool) - результат операции

===='''remove_from_planned($type, $typeid, $pitemid)'''====

Убрать из учебного плана запланированную дисциплину

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции (false - ошибка, true - запись удалена)

===='''change_planned_agenum($type, $typeid, $agenum, $pitemid)'''====

Изменить в учебном плане запланированной дисциплине $pitemid параллель на $agenum

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции

===='''create_learningplan($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - результат операции

===='''get_all_pitems($type, $typeid, $agenum = false, $status = null)'''====

Получить все дисциплины программы, кроме запланированных в виде академической разницы (agenum=0), для всех параллелей, или только указанной

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - дисциплины программы, исключая запланированные

===='''get_current_agenum_type_typeid($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (int) - номер текущего семестра.

===='''get_learned_pitems($type, $typeid, $agenum = false, $status = null)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - изученные, активные и перезачтённые дисциплины.

===='''get_learningplan_info($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (object) - возвращаемый объект с полями
** type - тип учебного плана ('programmsbc' или 'agroup')
** typeid - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
** code - код объекта
** name - имя объекта (содержит либо имя группы, либо полное имя персоны с номером договора)
** programm - учебная программа, на которую планируются дисциплины - объект с полями id, code, name
** agenum - текущий семестр
** age - текущий период - объект с полями id, name, begindate, eduweeks
** agenums - количество семестров в программе
* (bool) - false в случае возникновения ошибки

===='''get_learningplan_pitems($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (object) - возвращаемый объект с полями
** planning(array) - дисциплины, предусмотренные программной на эту параллель, которые возможно запланировать
** planned(array) - запланированные дисциплины
** learned(array) - изученные дисциплины
** all(array) - все дисциплины, предусмотренные программой для этой параллели (включая уже запланированные и изученные, исключая дисциплины из нулевой параллели)
* (bool) - false в случае возникновения ошибки

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

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

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

===='''get_pitem_grade($type, $typeid, $pitemid)'''====

Получить оценку дисциплины учебного плана по подписке

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (null) - оценки не получено
* (int) - оценка
* (string) - оценка.

====''' get_pitem_status($type, $typeid, $pitemid)'''====

Получить статус дисциплины учебного плана (запланирована, в программе, изучена)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (string) - одно из трёх возможных значений: 'planned', 'programm', 'learned'.

===='''get_planned_pitems($type, $typeid, $agenum = false)'''====

Получить запланированные для указанной параллели дисцплины ($agenum = 0 - академическая разница)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - запланированные дисциплины.

===='''get_planning_pitems($type, $typeid, $agenum)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - планируемые дисциплины (которые можно добавить в план).

===='''get_programmid_type_typeid($type, $typeid)'''====

Получить номер программы по типу и номеру индивидуального плана

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (int) - номер программы.

===='''get_reoffset_pitems($type, $typeid, $agenum = false, $status = null)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - перезачтённые дисциплины.

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

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

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

===='''get_signed_pitems($type, $typeid, $agenum = false)'''====

Получить запланированные и изученные (поиск во всех семестрах get_learned_pitems) для указанной параллели дисцплины ($agenum = 0 - академическая разница)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - запланированные и изученные дисциплины.

===='''get_unsigned_pitems($type, $typeid, $agenum = false)'''====

Получить запланированные, но не изученные (поиск во всех семестрах get_learned_pitems) для указанной параллели дисцплины ($agenum = 0 - академическая разница)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - запланированные, но не изученные дисциплины.

=События=
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|[[Разработка:storages/programmitems|programmitems]]
|update
|Только $mixedvar['new'] и $intvar
|Обрабатывается событие добавления дисциплины, вызывается функция [[#check_programmitems_update($intvar, $new)|check_programmitems_update($intvar, $new)]]
|-
|storage
|[[Разработка:storages/programmitems|programmitems]]
|delete
|Только $intvar
|Обрабатывается событие добавления дисциплины, вызывается функция [[#check_programmitems_delete($intvar)|check_programmitems_delete($intvar)]]
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не генерирует никаких событий''
|}

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|colspan=4 align=center | ''Этот плагин не выполняет никаких заданий''
|}

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

2014-07-24T09:31:17Z

Konovalov: /* Задания */

{{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 ]].
* begindate - дата начала действия подписки.
* enddate - дата окончания действия подписки.
* sbcorderid - id приказа в таблице [[Разработка:storages/orders | orders ]], которым учащийся был подписан на дисциплину.
* learninghistoryid - id записи в таблице [[Разработка:storages/learninghistory | learninghistory ]], соответствующая текущей параллели данной подписки.

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

===='''get_actual_reoffset_cpassed($cpasseds)'''====

Возвращает только последнюю пересдачу (по времени) из массива пересдач.

''Аргументы:''
* $cpasseds(array) - записи, полученные по одной подписке и дисциплине.
''Возвращаемые значения:''
* (object) - объект последней пересдачи
* (bool) - false, в случае ошибки
''Структура работы:''
# в эту функцию должны передаваться только cpassed->status == 'reoffset'

===='''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_cpasseds_reoffset($conds=null, $countonly=false, $limitfrom, $limitnum)'''====

Возвращает список учебных потоков по заданным критериям, упрощённая версия get_listing() с поиском только по таблице cpassed для "Ведомости перезачёта оценок"

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

===='''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), статус исходной подписки меняем на пересдан и обновляем запись в БД.
# формируем новый объект в БД.
# вставляем сформированную запись в таблицу БД.

===='''insert_grade_register_reoffset($programmsbcid, $programmitemid, $studentid, $grade, $orderid, $teacherid, $date)'''====

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

''Аргументы:''
* $programmsbcid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
* $programmitemid(int) - id дисциплины в таблице [[Разработка:storages/programmitems | programmitems ]].
* $studentid(int) - id студента (personid) в таблице [[Разработка:storages/persons | persons ]].
* $grade(int) - итоговая оценка.
* $orderid(int) - id приказа в таблице [[Разработка:storages/orders | orders ]], по которому выставляется перезачёт.
* $teacherid(int) - personid из таблицы [[Разработка:storages/persons | persons ]], кто ставил оценку
* $date(int) - дата перезачёта
''Возвращаемые значения:''
* (int) id добавленной записи.
* (bool) false если добавление не удалось.
''Структура работы:''
# Cоздаются cpassed-ы не привязанные к периоду (ageid=0).
# Если у студента уже был cpassed по этой дисциплине, перезачет ссылается на него полем repeatid (если несколько - то на самый первый, если старая подписка была активна - закрывается с неуспешным статусом).

===='''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, если произошла ошибка.

===='''get_cpassed_on_studentid_programmsbcid_active_complete($programmsbcid, $programmitemid)'''====

Возвращает список активных или завершённых подписок на дисциплину по номеру подписки (номер студента берётся из неё) на программу.

''Аргументы:''
* $programmsbcid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
* $programmitemid(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.
|}

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|resync_age_cpassed
|Обязателен. Указывается id периода из таблицы [[Разработка:storages/ages | ages ]]
|Находит все активные подписки на дисциплины в указанном периоде, после чего каждую из них приостанавливает и заново возобновляет. Необходимо для записи учащихся на курс Moodle, если курс Moodle был присвоен дисциплинам во время учебного процесса.
|-
|active_to_suspend_cpassed
|Обязателен. Указывается id периода из таблицы [[Разработка:storages/ages | ages ]]
|Находит все активные подписки на дисциплины в указанном периоде, после чего каждую из них приостанавливает. Необходимо для отписывания учащихся с курса Moodle, если необходимо сменить курс Moodle в дисциплинах. Работает в паре с '''suspend_to_active_cpassed'''.
|-
|suspend_to_active_cpassed
|Обязателен. Указывается id периода из таблицы [[Разработка:storages/ages | ages ]]
|Находит все приостановленные подписки на дисциплины в указанном периоде, после чего каждую из них активирует. Необходимо для записи учащихся на курс Moodle, если после смены курса Moodle в дисциплинах. Работает в паре с '''active_to_suspend_cpassed'''.
|-
|comparecpassed
|Необязателен
|Находит все незавершенные подписки на дисциплины, после чего каждую из них синхронизирует с учебным процессом, выставляя в подписке тот же id дисциплины, что и в процессе. Необходимо для сопоставления правильной дисциплины в подписке и процессе, если дисциплину в процессе сменили уже во время обучения.
|-
|cancaled_repeatid_to_null
|Необязателен
|Находит все отмененные подписки на дисциплины, у которых есть родители, и разрывает с ними связь. Необходимо для разрыва связи активный родитель->отмененный наследник, если по какой-то причине такие связи были созданы.
|-
|fill_learninghistoryid
|Необязателен
|Находит все подписки с пустым learninghistoryid и обновляет это поле, связывая его с записью в таблице [[Разработка:storages/learninghistory | learninghistory ]].
|}

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

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

2014-07-24T08:24:08Z

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

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

====Подробный формат полей в таблице:====
* '''programmsbcsid''' - id подписки ученика на учебную программу в таблице [[Разработка:storages/programmsbcs|programmsbcs]].
* '''ageid''' - id учебного периода в таблице [[Разработка:storages/ages|ages]], в котором были пройдены дисциплины данной параллели
* '''agenum''' - номер параллели (класс или семестр и т. п.)
* '''changedate''' - дата создания записи в формате unixtimestamp
* '''orderid''' - id приказа, в результате которого учащийся был записан на данную параллель (таблица [[Разработка:storages/orders|orders]]). Возможно null-значение, если изменения не были связаны ни с каким приказом.

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

===='''get_first_learning_data($programmsbcid)''' ====

Получить первую запись на момент начала обучения

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

===='''get_actual_learning_data($programmsbcid)'''====

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

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

===='''get_history($programmsbcid, $timefrom=null, $timeto=null)'''====

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

''Аргументы:''
* $programmsbcid - id подписки ученика на учебную программу (таблица [[Разработка:storages/programmsbcs|programmsbcs]]), по которой запрашивается история
* $timefrom - начало временного периода, за который запрашивается история изменения подписок, по умолчанию null
* $timeto - конец временного периода, за который запрашивается история изменения подписок, по умолчанию null
''Возвращаемое значение:''
* (mix) object|bool - объект из таблицы [[Разработка:storages/learninghistory|learninghistory]], или false

===='''get_subscribe_ages($programmsbcid)'''====

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

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

===='''add($programmsbc)'''====

Добавляет историю изменения учебного процесса для ученика.

''Аргументы:''
* $programmsbc - id в таблице [[Разработка:storages/programmsbcs|programmsbcs]]) или сам объект с таким id
''Возвращаемое значение:''
* array - массив записей или false

===='''set_actual_learninghistoryid($cpassed)'''====

Устанавливает learninghistoryid для записей cpassed, если есть актуальные данные в истории обучения

''Аргументы:''
* (object|int) $cpassed - изучаемый или пройденный курс
''Возвращаемое значение:''
* bool - результат операции

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

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|cpassed
|insert
|Стандартные
|
|-
|storage
|cpassed
|update
|Стандартные
|
|-
|storage
|cpassed
|delete
|Стандартные
|
|}

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

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

2014-07-24T07:39:10Z

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

{{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 ]].
* begindate - дата начала действия подписки.
* enddate - дата окончания действия подписки.
* sbcorderid - id приказа в таблице [[Разработка:storages/orders | orders ]], которым учащийся был подписан на дисциплину.
* learninghistoryid - id записи в таблице [[Разработка:storages/learninghistory | learninghistory ]], соответствующая текущей параллели данной подписки.

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

===='''get_actual_reoffset_cpassed($cpasseds)'''====

Возвращает только последнюю пересдачу (по времени) из массива пересдач.

''Аргументы:''
* $cpasseds(array) - записи, полученные по одной подписке и дисциплине.
''Возвращаемые значения:''
* (object) - объект последней пересдачи
* (bool) - false, в случае ошибки
''Структура работы:''
# в эту функцию должны передаваться только cpassed->status == 'reoffset'

===='''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_cpasseds_reoffset($conds=null, $countonly=false, $limitfrom, $limitnum)'''====

Возвращает список учебных потоков по заданным критериям, упрощённая версия get_listing() с поиском только по таблице cpassed для "Ведомости перезачёта оценок"

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

===='''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), статус исходной подписки меняем на пересдан и обновляем запись в БД.
# формируем новый объект в БД.
# вставляем сформированную запись в таблицу БД.

===='''insert_grade_register_reoffset($programmsbcid, $programmitemid, $studentid, $grade, $orderid, $teacherid, $date)'''====

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

''Аргументы:''
* $programmsbcid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
* $programmitemid(int) - id дисциплины в таблице [[Разработка:storages/programmitems | programmitems ]].
* $studentid(int) - id студента (personid) в таблице [[Разработка:storages/persons | persons ]].
* $grade(int) - итоговая оценка.
* $orderid(int) - id приказа в таблице [[Разработка:storages/orders | orders ]], по которому выставляется перезачёт.
* $teacherid(int) - personid из таблицы [[Разработка:storages/persons | persons ]], кто ставил оценку
* $date(int) - дата перезачёта
''Возвращаемые значения:''
* (int) id добавленной записи.
* (bool) false если добавление не удалось.
''Структура работы:''
# Cоздаются cpassed-ы не привязанные к периоду (ageid=0).
# Если у студента уже был cpassed по этой дисциплине, перезачет ссылается на него полем repeatid (если несколько - то на самый первый, если старая подписка была активна - закрывается с неуспешным статусом).

===='''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, если произошла ошибка.

===='''get_cpassed_on_studentid_programmsbcid_active_complete($programmsbcid, $programmitemid)'''====

Возвращает список активных или завершённых подписок на дисциплину по номеру подписки (номер студента берётся из неё) на программу.

''Аргументы:''
* $programmsbcid(int) - id подписки на программу в таблице [[Разработка:storages/programmsbcs | programmsbcs ]].
* $programmitemid(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.
|}

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|resync_age_cpassed
|Обязателен. Указывается id периода из таблицы [[Разработка:storages/ages | ages ]]
|Находит все активные подписки на дисциплины в указанном периоде, после чего каждую из них приостанавливает и заново возобновляет. Необходимо для записи учащихся на курс Moodle, если курс Moodle был присвоен дисциплинам во время учебного процесса.
|-
|active_to_suspend_cpassed
|Обязателен. Указывается id периода из таблицы [[Разработка:storages/ages | ages ]]
|Находит все активные подписки на дисциплины в указанном периоде, после чего каждую из них приостанавливает. Необходимо для отписывания учащихся с курса Moodle, если необходимо сменить курс Moodle в дисциплинах. Работает в паре с '''suspend_to_active_cpassed'''.
|-
|suspend_to_active_cpassed
|Обязателен. Указывается id периода из таблицы [[Разработка:storages/ages | ages ]]
|Находит все приостановленные подписки на дисциплины в указанном периоде, после чего каждую из них активирует. Необходимо для записи учащихся на курс Moodle, если после смены курса Moodle в дисциплинах. Работает в паре с '''active_to_suspend_cpassed'''.
|-
|comparecpassed
|Необязателен
|Находит все незавершенные подписки на дисциплины, после чего каждую из них синхронизирует с учебным процессом, выставляя в подписке тот же id дисциплины, что и в процессе. Необходимо для сопоставления правильной дисциплины в подписке и процессе, если дисциплину в процессе сменили уже во время обучения.
|-
|cancaled_repeatid_to_null
|Необязателен
|Находит все отмененные подписки на дисциплины, у которых есть родители, и разрывает с ними связь. Необходимо для разрыва связи активный родитель->отмененный наследник, если по какой-то причине такие связи были созданы.
|}

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

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

2014-07-22T12:33:51Z

Konovalov: /* Перехватываемые события */

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

====Подробный формат полей в таблице:====
* '''programmsbcsid''' - id подписки ученика на учебную программу в таблице [[Разработка:storages/programmsbcs|programmsbcs]].
* '''ageid''' - id учебного периода в таблице [[Разработка:storages/ages|ages]], в котором были пройдены дисциплины данной параллели
* '''agenum''' - номер параллели (класс или семестр и т. п.)
* '''changedate''' - дата создания записи в формате unixtimestamp
* '''orderid''' - id приказа, в результате которого учащийся был записан на данную параллель (таблица [[Разработка:storages/orders|orders]]). Возможно null-значение, если изменения не были связаны ни с каким приказом.

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

===='''get_first_learning_data($programmsbcid)''' ====

Получить первую запись на момент начала обучения

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

===='''get_actual_learning_data($programmsbcid)'''====

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

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

===='''get_history($programmsbcid, $timefrom=null, $timeto=null)'''====

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

''Аргументы:''
* $programmsbcid - id подписки ученика на учебную программу (таблица [[Разработка:storages/programmsbcs|programmsbcs]]), по которой запрашивается история
* $timefrom - начало временного периода, за который запрашивается история изменения подписок, по умолчанию null
* $timeto - конец временного периода, за который запрашивается история изменения подписок, по умолчанию null
''Возвращаемое значение:''
* (mix) object|bool - объект из таблицы [[Разработка:storages/learninghistory|learninghistory]], или false

===='''get_subscribe_ages($programmsbcid)'''====

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

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

===='''add($programmsbc)'''====

Добавляет историю изменения учебного процесса для ученика.

''Аргументы:''
* $programmsbc - id в таблице [[Разработка:storages/programmsbcs|programmsbcs]]) или сам объект с таким id
''Возвращаемое значение:''
* array - массив записей или false

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

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|cpassed
|insert
|Стандартные
|
|-
|storage
|cpassed
|update
|Стандартные
|
|-
|storage
|cpassed
|delete
|Стандартные
|
|}

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

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

2014-07-21T08:04:17Z

Konovalov:

{{Infobox_Plugin
| name = learningplan
| type = storages
}}
=Таблица в базе данных=
''learningplan'' - запланированные на будущие периоды дисциплины.

====Подробный формат полей в таблице:====
* type - тип объекта, на которого запланирована дисциплина (programmsbc, agroup).
* programmsbcid - id слушателя из таблицы [[Разработка:storages/programmsbcs | programmsbcs ]], type=programmsbc или NULL
* agroupid - id группы из таблицы [[Разработка:storages/agroups | agroups ]], если type=agroup или NULL
* agenum - номер параллели, для которой задан план. Если слушатель обязан пройти дисциплину в любой период обучения 0. Уточнение: ageid мы не планируем, так как он пока не известен.
* programmitemid - id запланированной дисциплины из таблицы [[Разработка:storages/programmitems | programmitems ]] (дисциплина должна относится к той программе, на которую подписан слушатель или группа и быть активной на момент перевода в соответствующую параллель, чтобы произошла подписка).

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

===='''add_to_planned($type, $typeid, $agenum, $pitemid)'''====

Добавить к учебному плану запланированную дисциплину $pitemid для параллели $agenum

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции (false - ошибка, true - запись уже существует)
* (int) - id добавленной записи

===='''add_to_planned_required_agenum($type, $typeid, $agenum = false)'''====

Метод для планирования всех обязательных дисциплин для одной указанной параллели $agenum или всех обязательных дисциплин программы

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - результат операции

===='''check_programmitems_delete($intvar)'''====

Проверяет целостность таблицы, исключая из неё те дисциплины, которые были удалены

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

===='''check_programmitems_update($intvar, $new)'''====

Проверяет целостность таблицы, исключая из неё те дисциплины, которые стали неактивными

''Аргументы:''
* $intvar(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
* $new(object) - объект дисциплины после обновления
''Возвращаемые значения:''
* (bool) - результат операции

===='''remove_from_planned($type, $typeid, $pitemid)'''====

Убрать из учебного плана запланированную дисциплину

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции (false - ошибка, true - запись удалена)

===='''change_planned_agenum($type, $typeid, $agenum, $pitemid)'''====

Изменить в учебном плане запланированной дисциплине $pitemid параллель на $agenum

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции

===='''create_learningplan($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - результат операции

===='''get_all_pitems($type, $typeid, $agenum = false, $status = null)'''====

Получить все дисциплины программы, кроме запланированных в виде академической разницы (agenum=0), для всех параллелей, или только указанной

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - дисциплины программы, исключая запланированные

===='''get_current_agenum_type_typeid($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (int) - номер текущего семестра.

===='''get_learned_pitems($type, $typeid, $agenum = false, $status = null)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - изученные, активные и перезачтённые дисциплины.

===='''get_learningplan_info($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (object) - возвращаемый объект с полями
** type - тип учебного плана ('programmsbc' или 'agroup')
** typeid - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
** code - код объекта
** name - имя объекта (содержит либо имя группы, либо полное имя персоны с номером договора)
** programm - учебная программа, на которую планируются дисциплины - объект с полями id, code, name
** agenum - текущий семестр
** age - текущий период - объект с полями id, name, begindate, eduweeks
** agenums - количество семестров в программе
* (bool) - false в случае возникновения ошибки

===='''get_learningplan_pitems($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (object) - возвращаемый объект с полями
** planning(array) - дисциплины, предусмотренные программной на эту параллель, которые возможно запланировать
** planned(array) - запланированные дисциплины
** learned(array) - изученные дисциплины
** all(array) - все дисциплины, предусмотренные программой для этой параллели (включая уже запланированные и изученные, исключая дисциплины из нулевой параллели)
* (bool) - false в случае возникновения ошибки

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

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

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

===='''get_pitem_grade($type, $typeid, $pitemid)'''====

Получить оценку дисциплины учебного плана по подписке

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (null) - оценки не получено
* (int) - оценка
* (string) - оценка.

====''' get_pitem_status($type, $typeid, $pitemid)'''====

Получить статус дисциплины учебного плана (запланирована, в программе, изучена)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (string) - одно из трёх возможных значений: 'planned', 'programm', 'learned'.

===='''get_planned_pitems($type, $typeid, $agenum = false)'''====

Получить запланированные для указанной параллели дисцплины ($agenum = 0 - академическая разница)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - запланированные дисциплины.

===='''get_planning_pitems($type, $typeid, $agenum)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - планируемые дисциплины (которые можно добавить в план).

===='''get_programmid_type_typeid($type, $typeid)'''====

Получить номер программы по типу и номеру индивидуального плана

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (int) - номер программы.

===='''get_reoffset_pitems($type, $typeid, $agenum = false, $status = null)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - перезачтённые дисциплины.

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

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

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

=События=
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|[[Разработка:storages/programmitems|programmitems]]
|update
|Только $mixedvar['new'] и $intvar
|Обрабатывается событие добавления дисциплины, вызывается функция [[#check_programmitems_update($intvar, $new)|check_programmitems_update($intvar, $new)]]
|-
|storage
|[[Разработка:storages/programmitems|programmitems]]
|delete
|Только $intvar
|Обрабатывается событие добавления дисциплины, вызывается функция [[#check_programmitems_delete($intvar)|check_programmitems_delete($intvar)]]
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не генерирует никаких событий''
|}

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|colspan=4 align=center | ''Этот плагин не выполняет никаких заданий''
|}

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

2014-07-17T13:32:18Z

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

{{Infobox_Plugin
| name = learningplan
| type = storages
}}
=Таблица в базе данных=
''learningplan'' - запланированные на будущие периоды дисциплины.

====Подробный формат полей в таблице:====
* type - тип объекта, на которого запланирована дисциплина (programmsbc, agroup).
* programmsbcid - id слушателя из таблицы [[Разработка:storages/programmsbcs | programmsbcs ]], type=programmsbc или NULL
* agroupid - id группы из таблицы [[Разработка:storages/agroups | agroups ]], если type=agroup или NULL
* agenum - номер параллели, для которой задан план. Если слушатель обязан пройти дисциплину в любой период обучения 0. Уточнение: ageid мы не планируем, так как он пока не известен.
* programmitemid - id запланированной дисциплины из таблицы [[Разработка:storages/programmitems | programmitems ]] (дисциплина должна относится к той программе, на которую подписан слушатель или группа и быть активной на момент перевода в соответствующую параллель, чтобы произошла подписка).

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

===='''add_to_planned($type, $typeid, $agenum, $pitemid)'''====

Добавить к учебному плану запланированную дисциплину $pitemid для параллели $agenum

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции (false - ошибка, true - запись уже существует)
* (int) - id добавленной записи

===='''add_to_planned_agenum($type, $typeid, $agenum = false)'''====

Метод для планирования всех обязательных дисциплин для одной указанной параллели $agenum или всех обязательных дисциплин программы

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - результат операции

===='''check_programmitems_delete($intvar)'''====

Проверяет целостность таблицы, исключая из неё те дисциплины, которые были удалены

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

===='''check_programmitems_update($intvar, $new)'''====

Проверяет целостность таблицы, исключая из неё те дисциплины, которые стали неактивными

''Аргументы:''
* $intvar(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
* $new(object) - объект дисциплины после обновления
''Возвращаемые значения:''
* (bool) - результат операции

===='''remove_from_planned($type, $typeid, $pitemid)'''====

Убрать из учебного плана запланированную дисциплину

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции (false - ошибка, true - запись удалена)

===='''change_planned_agenum($type, $typeid, $agenum, $pitemid)'''====

Изменить в учебном плане запланированной дисциплине $pitemid параллель на $agenum

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции

===='''create_learningplan($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - результат операции

===='''get_all_pitems($type, $typeid, $agenum = false, $status = null)'''====

Получить все дисциплины программы, кроме запланированных в виде академической разницы (agenum=0), для всех параллелей, или только указанной

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - дисциплины программы, исключая запланированные

===='''get_current_agenum_type_typeid($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (int) - номер текущего семестра.

===='''get_learned_pitems($type, $typeid, $agenum = false, $status = null)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - изученные, активные и перезачтённые дисциплины.

===='''get_learningplan_info($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (object) - возвращаемый объект с полями
** type - тип учебного плана ('programmsbc' или 'agroup')
** typeid - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
** code - код объекта
** name - имя объекта (содержит либо имя группы, либо полное имя персоны с номером договора)
** programm - учебная программа, на которую планируются дисциплины - объект с полями id, code, name
** agenum - текущий семестр
** age - текущий период - объект с полями id, name, begindate, eduweeks
** agenums - количество семестров в программе
* (bool) - false в случае возникновения ошибки

===='''get_learningplan_pitems($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (object) - возвращаемый объект с полями
** planning(array) - дисциплины, предусмотренные программной на эту параллель, которые возможно запланировать
** planned(array) - запланированные дисциплины
** learned(array) - изученные дисциплины
** all(array) - все дисциплины, предусмотренные программой для этой параллели (включая уже запланированные и изученные, исключая дисциплины из нулевой параллели)
* (bool) - false в случае возникновения ошибки

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

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

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

===='''get_pitem_grade($type, $typeid, $pitemid)'''====

Получить оценку дисциплины учебного плана по подписке

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (null) - оценки не получено
* (int) - оценка
* (string) - оценка.

====''' get_pitem_status($type, $typeid, $pitemid)'''====

Получить статус дисциплины учебного плана (запланирована, в программе, изучена)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (string) - одно из трёх возможных значений: 'planned', 'programm', 'learned'.

===='''get_planned_pitems($type, $typeid, $agenum = false)'''====

Получить запланированные для указанной параллели дисцплины ($agenum = 0 - академическая разница)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - запланированные дисциплины.

===='''get_planning_pitems($type, $typeid, $agenum)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - планируемые дисциплины (которые можно добавить в план).

===='''get_programmid_type_typeid($type, $typeid)'''====

Получить номер программы по типу и номеру индивидуального плана

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (int) - номер программы.

===='''get_reoffset_pitems($type, $typeid, $agenum = false, $status = null)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - перезачтённые дисциплины.

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

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

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

=События=
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|[[Разработка:storages/programmitems|programmitems]]
|update
|Только $mixedvar['new'] и $intvar
|Обрабатывается событие добавления дисциплины, вызывается функция [[#check_programmitems_update($intvar, $new)|check_programmitems_update($intvar, $new)]]
|-
|storage
|[[Разработка:storages/programmitems|programmitems]]
|delete
|Только $intvar
|Обрабатывается событие добавления дисциплины, вызывается функция [[#check_programmitems_delete($intvar)|check_programmitems_delete($intvar)]]
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не генерирует никаких событий''
|}

=Задания=

{| border="1"
|+ Таблица заданий, которые выполняет этот плагин
! Код задания
! Дополнительный параметр
! Пояснение
|-
|colspan=4 align=center | ''Этот плагин не выполняет никаких заданий''
|}

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

2014-07-16T12:37:36Z

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

{{Infobox_Plugin
| name = learningplan
| type = storages
}}
=Таблица в базе данных=
''learningplan'' - запланированные на будущие периоды дисциплины.

====Подробный формат полей в таблице:====
* type - тип объекта, на которого запланирована дисциплина (programmsbc, agroup).
* programmsbcid - id слушателя из таблицы [[Разработка:storages/programmsbcs | programmsbcs ]], type=programmsbc или NULL
* agroupid - id группы из таблицы [[Разработка:storages/agroups | agroups ]], если type=agroup или NULL
* agenum - номер параллели, для которой задан план. Если слушатель обязан пройти дисциплину в любой период обучения 0. Уточнение: ageid мы не планируем, так как он пока не известен.
* programmitemid - id запланированной дисциплины из таблицы [[Разработка:storages/programmitems | programmitems ]] (дисциплина должна относится к той программе, на которую подписан слушатель или группа и быть активной на момент перевода в соответствующую параллель, чтобы произошла подписка).

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

===='''add_to_planned($type, $typeid, $agenum, $pitemid)'''====

Добавить к учебному плану запланированную дисциплину $pitemid для параллели $agenum

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции (false - ошибка, true - запись уже существует)
* (int) - id добавленной записи

===='''remove_from_planned($type, $typeid, $pitemid)'''====

Убрать из учебного плана запланированную дисциплину

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции (false - ошибка, true - запись удалена)

===='''change_planned_agenum($type, $typeid, $agenum, $pitemid)'''====

Изменить в учебном плане запланированной дисциплине $pitemid параллель на $agenum

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - результат операции

===='''create_learningplan($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - результат операции

===='''get_all_pitems($type, $typeid, $agenum = false, $status = null)'''====

Получить все дисциплины программы, кроме запланированных в виде академической разницы (agenum=0), для всех параллелей, или только указанной

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - дисциплины программы, исключая запланированные

===='''get_current_agenum_type_typeid($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (int) - номер текущего семестра.

===='''get_learned_pitems($type, $typeid, $agenum = false, $status = null)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - изученные, активные и перезачтённые дисциплины.

===='''get_learningplan_info($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (object) - возвращаемый объект с полями
** type - тип учебного плана ('programmsbc' или 'agroup')
** typeid - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
** code - код объекта
** name - имя объекта (содержит либо имя группы, либо полное имя персоны с номером договора)
** programm - учебная программа, на которую планируются дисциплины - объект с полями id, code, name
** agenum - текущий семестр
** age - текущий период - объект с полями id, name, begindate, eduweeks
** agenums - количество семестров в программе
* (bool) - false в случае возникновения ошибки

===='''get_learningplan_pitems($type, $typeid)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (object) - возвращаемый объект с полями
** planning(array) - дисциплины, предусмотренные программной на эту параллель, которые возможно запланировать
** planned(array) - запланированные дисциплины
** learned(array) - изученные дисциплины
** all(array) - все дисциплины, предусмотренные программой для этой параллели (включая уже запланированные и изученные, исключая дисциплины из нулевой параллели)
* (bool) - false в случае возникновения ошибки

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

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

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

===='''get_pitem_grade($type, $typeid, $pitemid)'''====

Получить оценку дисциплины учебного плана по подписке

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (null) - оценки не получено
* (int) - оценка
* (string) - оценка.

====''' get_pitem_status($type, $typeid, $pitemid)'''====

Получить статус дисциплины учебного плана (запланирована, в программе, изучена)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $pitemid(int) - id записи в таблице [[Разработка:storages/programmitems|programmitems]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (string) - одно из трёх возможных значений: 'planned', 'programm', 'learned'.

===='''get_planned_pitems($type, $typeid, $agenum = false)'''====

Получить запланированные для указанной параллели дисцплины ($agenum = 0 - академическая разница)

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - запланированные дисциплины.

===='''get_planning_pitems($type, $typeid, $agenum)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - планируемые дисциплины (которые можно добавить в план).

===='''get_programmid_type_typeid($type, $typeid)'''====

Получить номер программы по типу и номеру индивидуального плана

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (int) - номер программы.

===='''get_reoffset_pitems($type, $typeid, $agenum = false, $status = null)'''====

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

''Аргументы:''
* $type(string) - тип индивидуального учебного плана (ИП), может быть 'programmsbc' или 'agroup'
* $typeid(int) - id записи в таблице [[Разработка:storages/programmsbcs|programmsbcs]] или [[Разработка:storages/agroups|agroups]]
* $agenum(int) - номер семестра (параллели), если false - все семестры
* $status(string|array) - статус дисциплин, можно передать строку (в этом случае условие меняется на отрицательное: status != $status) массив или false для всех
''Возвращаемые значения:''
* (bool) - false в случае ошибки
* (array) - перезачтённые дисциплины.

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

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

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

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

2014-07-15T05:38:54Z

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

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

2014-07-15T05:29:03Z

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

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

2014-07-08T17:33:28Z

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

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

2014-07-08T11:08:24Z

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

{{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_ageid_agenum($programmsbcid, $agenum)'''====

Получить id учебного периода подписки на программу по номеру семестра

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

===='''get_department_ages($departmentid, $status="active")'''====

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

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

===='''get_next_ageid($ageid, $agenum)'''====

находит один из дочерних учебных периодов

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

===='''get_previous_ageid($ageid, $agenum)'''====

находит предшествующий указанному в ageid учебный период

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

===='''create_period_for_department($deptid, $datebegin, $dateend, $numweeks, $name, $previousid=null)'''====

создаёт период для структурного подразделения

''Аргументы:''
* $deptid(int) - id учебного подразделения в таблице [[Разработка:storages/departments | departments ]].
* $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 предыдущего учебного периода в таблице [[Разработка:storages/ages | ages ]] или 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/learningplan

2014-07-07T15:24:08Z

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

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

2014-07-03T13:58:43Z

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

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

2014-07-03T13:29:52Z

Konovalov: /* get_history(get_history($programmsbcid, $timefrom=null, $timeto=null)) */

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

====Подробный формат полей в таблице:====
* '''programmsbcsid''' - id подписки ученика на учебную программу в таблице [[Разработка:storages/programmsbcs|programmsbcs]].
* '''ageid''' - id учебного периода в таблице [[Разработка:storages/ages|ages]], в котором были пройдены дисциплины данной параллели
* '''agenum''' - номер параллели (класс или семестр и т. п.)
* '''changedate''' - дата создания записи в формате unixtimestamp
* '''orderid''' - id приказа, в результате которого учащийся был записан на данную параллель (таблица [[Разработка:storages/orders|orders]]). Возможно null-значение, если изменения не были связаны ни с каким приказом.

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

===='''get_first_learning_data($programmsbcid)''' ====

Получить первую запись на момент начала обучения

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

===='''get_actual_learning_data($programmsbcid)'''====

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

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

===='''get_history($programmsbcid, $timefrom=null, $timeto=null)'''====

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

''Аргументы:''
* $programmsbcid - id подписки ученика на учебную программу (таблица [[Разработка:storages/programmsbcs|programmsbcs]]), по которой запрашивается история
* $timefrom - начало временного периода, за который запрашивается история изменения подписок, по умолчанию null
* $timeto - конец временного периода, за который запрашивается история изменения подписок, по умолчанию null
''Возвращаемое значение:''
* (mix) object|bool - объект из таблицы [[Разработка:storages/learninghistory|learninghistory]], или false

===='''get_subscribe_ages($programmsbcid)'''====

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

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

===='''add($programmsbc)'''====

Добавляет историю изменения учебного процесса для ученика.

''Аргументы:''
* $programmsbc - id в таблице [[Разработка:storages/programmsbcs|programmsbcs]]) или сам объект с таким id
''Возвращаемое значение:''
* array - массив записей или false

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

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