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

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

2011-04-26T09:57:21Z

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

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

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

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

* programmitemid - дисциплина в таблице [[Разработка:storages/programmitems | programmitems ]]. Здесь указывается дисциплина, для которой будет указываться зависимость. Т.е. эта дисциплина будет завистеть от того, что указано в следующих полях.
* type - тип зависимости, строковое поле. По содержащемуся здесь коду при проверке зависимости запускатеся соответствующий метод
* value - параметр зависимости, строковое поле. В частности поле может содержать id дисциплины, которая будет выступать зависимостью.

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

==== '''get_cfg($key=null)''' ====

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

''Аргументы:''
* string[optional] $key=null Ключ в массиве, т.е. искомый параметр. Если параметр не передан, то возвращается весь массив.
''Возвращаемые значения:''
* Параметр или null (если конфигурационный файл не найден или если параметр не найден в файле или если он найден и его значение null, это стоит учитывать)
''Структура работы:''
* Для работы требуется переменная класса для хранения массива параметров из файла, т.е. обращение в файл производится только при первой попытке.
* Ищет конфигурационный файл (в соответствии с логикой работы dof - $this->dof->plugin_path($this->type(),$this->code(),'/cfg/cfg.php'))
* Возвращает значение по ключу (если ключ не указан, то возвращает весь массив параметров из файла). к примеру return @$mas['a'], т.е. если нет значения, то не генерируется ошибка, а возвращается null.

===='''check_pridepends( $psbcid, $targetpritemid )'''====

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

''Аргументы:''
* int $targetpritemid id [[Разработка:storages/programmitems | дисциплины ]]
* int $psbcid id [[Разработка:storages/programmsbcs | подписки на программу ]]
''Возвращаемые значения:''
* Массив объектов с полями:
** тип зависимости
** текст ошибки
** параметр невыполненного предусловия.
''Структура работы''
* взять список по $targetpritemid
* для каждой записи вызвать метод, код которого указан в поле type в таблице зависимостей
* этот метод смотрит пройдена ли дисц, если да, то вернет true, иначе false

===='''get_list_by_id( $id )'''====

Метод возвращает массив зависимостей для дисциплины (массив из id дисциплин)

''Аргументы:''
* int $targetpritemid id [[Разработка:storages/programmitems | дисциплины ]]
''Возвращаемые значения:''
* Массив объектов с полями:
** тип зависимости
** текст ошибки
** параметр предусловия.

===='''requirepritem( $targetpritid, $psbcid, $dependpritid )'''====

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

''Аргументы:''
* int $targetpritid id целевой [[Разработка:storages/programmitems | дисциплины ]] (для универсальности интерфейса)
* int $psbcid id [[Разработка:storages/programmsbcs | подписки на программу ]]
* int $dependitid id [[Разработка:storages/programmitems | дисциплины ]], необходимой для подписания на целевую дисциплину
''Возвращаемые значения:''
* Массив объектов с полями:
** тип зависимости
** текст ошибки
** параметр предусловия.

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

2011-04-26T09:28:22Z

Nickkang: Добавлено поле содержащее время последней синхронизации оценок + метод для выборки самых давно-синхронизированных cstream`ов

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2011-04-26T09:21:05Z

Nickkang: Добавлена информация о новых полях и добавлении зависимостей (дисциплины-предусловия)

{{Infobox_Plugin
| name = programmitems
| type = im
}}
== Учебные предметы ==
Этот плагин предназначен для работы с учебными предметами. Работает на основе типового плагина im/ages.
=== Экран просмотра списка предметов ===
Экран представляет собой таблицу со списком учебных предметов. В таблице присутствуют поля:
* ''Название''
* ''Название в стандарте''
* ''Код''
* ''Код в стандарте''
* ''Программа'' - к какой учебной программе принадлежит предмет
* ''Подразделение'' - к какому подразделению принадлежит предмет
* ''Статус'' - статус предмета. Статусы предметов описаны в плагине [[Разработка:workflows/programmitems|workflows/programmitems]]
* ''Тип'' - обязательный, рекомендованный, по выбору
* ''Обязательный'' - обязательна ли дисциплина
* ''Очки'' - количество очков, полученное за прохождение дисциплины (в кредитной системе)
* ''Количество недель''
* ''Длительность''
* ''Часов всего''
* ''Часов теории''
* ''Часов практики''
* ''Уровень компоненты'' - региональная, федеральная, и т. д.
* ''Описание'' - краткое описание предмета
* ''Заметки'' - заметки для персонала
* ''Тип итогового контроля'' - поле пока что не отображается
* ''Действия'' - просмотреть, или редактировать (если пользователь имеет права редактирования). В будущем предусмотрено удаление. Добавление зависимостей

Также можно производить поиск по параметрам: название предмета, или его код. Просмотр списка предметов происходит постранично (по умолчанию - 10 записей на странице).

=== Экран просмотра одного предмета ===
На этом экране отображается информация об одном учебном предмете.

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

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

=== Экран создания/редактирования предмета ===
Экран создания и редактирования учебного предмета представляет собой форму со списком полей. Назначение и описание полей совпадают с описанием полей в плагине [[Разработка:storages/programmitems#Подробный формат полей в таблице:|storages/programmitems]].
В будущем поля будут разбиты на 2 категории: обязательные и дополнительные.

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

'''При создании'''
* Нельзя указать номер периода, в котором идет предмет, больше, чем максимальное количество периодов в программе, в которую он добавляется.
* Нельзя создать предмет без привязки к учебному подразделению и программе
* Поле "код предмета" должно быть уникальным

'''При редактировании'''
* Нельзя указать номер периода, в котором идет предмет, больше, чем максимальное количество периодов в программе, в которую он добавляется.
* Нельзя создать предмет без привязки к учебному подразделению и программе
* Поле "код предмета" должно быть уникальным
* Нельзя изменить поле "подразделение"
* Нельзя изменить поле "учебная программа"

В будущем планируется добавить для редактирования поля "курс в moodle" и "тип итогового контроля"

=== Экран добавления зависимостей ===
Позволяет добавлять дисциплины предусловия для указанной дисциплины с указанием характера зависимости (выбор из заданных).

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

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

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

===== form() =====
Возвращает форму создания/редактирования учебного предмета с начальными данными

''Параметры:''
* $id - id учебной программы в таблице [[Разработка:storages/programmitems|programmitems]], для редактирования которой вызывается форма. По умолчанию NULL (создается новый предмет).

''Возвращаемые значения:''
* [[Разработка:moodleQuickForm|moodleQuickForm]] object - объект формы, с загруженными в нее исходными данными.

===== showlist() =====
Возвращает html-код списка предметов.

''Параметры:''
* $list - массив записей из таблицы [[Разработка:storages/programmitems|programmitems]] для отображения.

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

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

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

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

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

2011-04-26T09:03:04Z

Nickkang:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2011-04-26T08:44:14Z

Nickkang:

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

Синхронизация подписок на учебные потоки с подписками на курсы Moodle.

* Подписка на курс Moodle (вызывается из рабочего процесса cpassed при переводе объекта cpassed в статус "active", в случае, если для ученика существует пользователь Moodle, а для дисциплины задан курс Moodle). При этом, если для потока задана группа moodle, она тоже передается и при подписке происходит включение в эту группу.
* Отписка от курса Moodle (вызывается из рабочего процесса cpassed при выводе подписки из статуса active).

Подписка, отписка и включение в группу происходит с использованием плагина modlibs/ama (modlib('ama')->course($mcourse)->role()->enrol(), modlib('ama')->course($mcourse)->role()->unenrol(), modlib('ama')->course($mcourse)->group($mgroup)->add_member($muser),
== API ==
=== enrol_to_course() ===
Записывает пользователя на курс.
* возвращаемое значение: (bool)
** true если пользователя удалось подписать
** false если произошла ошибка
* $mdlcourseid - id курса в Moodle на который подписывается пользователь
* $mdluserid - id пользователя в moodle
* $mdlgroupid[optional] - id группы, в которую будет записан пользователь или null, если пользователь не будет записан в группу
* @param int $mdlroleid[optional] - id роли прльзователя в курсе (из таблицы moodle). Роль по умолчанию - ученик.
* @param int $timeend[optional] - время окончания обучения на курсе в формете unixtime (при наступлении этой даты пользователь булет отписан с курса)
* @param bool $hidden[optional] - записать пользователя в скрытом режиме (он не будет отображаться в списке пользователей для учеников и учителей курса)
=== unenrol_from_course() ===
Отписывает пользователя из курса
* возвращаемое значение: (bool)
** true если пользователя удалось отписать
** false если произошла ошибка
* $mdlcourseid - id курса в Moodle с которого отписывается пользователь
* $mdluserid - id пользователя в moodle
=== add_to_group() ===
Записывает пользователя в группу moodle
* возвращаемое значение: (bool)
* $mdlcourseid - id курса в Moodle в котором находится группа
* $mdlgroupid - id группы в курсе, куда будет записываться пользователь
* $mdluserid - id пользователя в moodle

=== get_cfg() ===
* ''Краткое описание:''
Позволяет обращаться к конфигурационному файлу данного плагина.
* ''Логика работы:''
** Для работы требуется переменная класса для хранения массива параметров из файла, т.е. обращение в файл производится только при первой попытке.
** Ищет конфигурационный файл (в соответствии с логикой работы dof - $this->dof->plugin_path($this->type(),$this->code(),'/cfg/cfg.php'))
** Возвращает значение по ключу (если ключ не указан, то возвращает весь массив параметров из файла). к примеру return @$mas['a'], т.е. если нет значения, то не генерируется ошибка, а возвращается null.
* ''Аргументы:''
** string[optional] $key=null Ключ в массиве, т.е. искомый параметр. Если параметр не передан, то возвращается весь массив.
* ''Возвращаемое значение:''
** Параметр или null (если конфигурационный файл не найден или если параметр не найден в файле или если он найден и его значение null, это стоит учитывать)

=== sync_grades() ===
* ''Краткое описание:''
Синхронизирует оценки деканата и moodle (запускается кроном)
* ''Логика работы:''
** Выбирает указанное в кофиге кол-во активных самых давно синхронизированных cstream`ов (отсортированных по дате последней синхронизации в порядке возрастания)
** вернет false, если нет параметра в конфиге
** запускает sync_cstream()
* ''Аргументы:''
* ''Возвращаемое значение:''
** bool успешность. Если в конфиге не найдено количество cstream`ов, синхронизируемых за раз, то false. Так же false в случае, если произошла ошибка синхронизации хоть одного cstream`а

=== sync_cstream() ===
* ''Краткое описание:''
Синхронизирует оценки деканата и moodle по конкретному cstream`у
* ''Логика работы:''
** Смотрит в дисциплине из таблицы programmitems (связанной с cstream`ом) флаг gradesyncenabled. Если false, то не синхронизируем
** Выбирает все активные cpassed`ы для данного cstream`а
** получает оценку с помощью метода get_scale_grade
** Формирует и исполняет ведомость (с помощью класса, который находится в папке плагина в файле order_itog_grades.php), которая проставляет оценку в cpassed.
** В зависимости от оценки и параметров дисциплины incjournwithoutgrade и incjournwithunsatisfgrade может не исполнить ведомость. Если передан параметр closing то в любом случае исполняет ведомость.
* ''Аргументы:''
** int $cstreamid id cstream
** bool $closing[optional] = false Если закрываем cstream (т.е. закрываем не здесь, но значит все cpassed надо обязательно проставить)
* ''Возвращаемое значение:''
** bool

=== get_scale_grade() ===
* ''Краткое описание:''
получает оценку для указанного cpassed`а из таблиц moodle
* ''Логика работы:''
** Ищет итоговую оценку курса в таблице grade_grades, id которого указан в cpassed`е. Если в дисциплине указан altgradeitem, то берет оценку из нее, т.е. из записи из grade_items с указанным id (пока для этого варианта не работает приведение оценки к шкале дисциплины ЭД)
** С помощью метода bring_grade_to_scale оценку в шкалу для данной дисциплины деканата
* ''Аргументы:''
** int|object $cpassed id cpassed`а или сам объект
** int|object[optional] $pitem id programmitem`а или сам объект
* ''Возвращаемое значение:''
** Приведенная к шкале оценка
** false в случае ошибки
** null - если нет оценки пока

=== init_logs() ===
* ''Краткое описание:''
Инициализация логов (не обязательно вызывать метод, для использования логов)
* ''Логика работы:''
** Инициализирует переменную logs, которая является свойством текущего класса.
** Если переменная уже инициализированна раннее или в конфигурационном файле не установлено или отключено ведение логов, то ничего не делает
** Инициализация подразумевает установку:
*** формат даты для названий файлов
*** директории логов
*** базовых имен файлов. т.е. название файла логов для всех сообщений будет выглядеть так <дата в установленном формате>log.txt, а для лога с ошибками <дата в установленном формате>errorlog.txt
*** абсолютных путей к файлам логов, в которые будут писаться сообщения в данном экземпляре класса
** Вызывает метод, устанавливающий абсолютные пути файлов логов. Если говорить кратко (лучше смотреть в коде), он ищет два файла логов (обычный и для ошибок), к которым недавно происходило обращение для записи (не более заданного в конфиге кол-ва секунд). Если не находит таких файлов, то создает новые в соответствии с заданным форматом имени.
* ''Аргументы:''
** -
* ''Возвращаемое значение:''
** на данный момент не предусмотрено возвращаемого значения

=== delete_old_logs() ===
* ''Краткое описание:''
Стирает старые логи в папке логов для данного плагина (эта директория устанавливается в init_logs)
* ''Логика работы:''
** Вызывать нужно только после инициализации логов, иначе ничгео метод не сделает.
** По заданному формату даты в названии логов ищет файлы, которые созданы более чем заданное в конфиге кол-во дней, и удаляет их.
** Если в папке будут лишние файлы, формат названия которых не соответствует заданному, то они также могут быть удалены.
* ''Аргументы:''
* ''Возвращаемое значение:''
** на данный момент не предусмотрено возвращаемого значения

=== log() ===
* ''Краткое описание:''
Запись сообщения в лог (для корректной работы не требуется вызывать больше ничего, устанавливать параметры - все автоматически)
* ''Логика работы:''
** Для корректной работы не требуется вызывать больше ничего, устанавливать параметры - все автоматически
** Метод вызывает инициализацию логов
** Пишет сообщение $message в лог для всех сообщений и если передан параметр $error, то пишет еще и в лог ошибок
* ''Аргументы:''
** string $message Сообщение об ошибке
** bool[optional] $error Если это сообщение об ошибке
* ''Возвращаемое значение:''
** на данный момент не предусмотрено возвращаемого значения

=== log_get_str() ===
* ''Краткое описание:''
Вызывает log, но в качестве сообщения надо подавать код сообщения и параметр как в get_string()
* ''Логика работы:''
** Получает сообщение используя get_string и вызывает log()
* ''Аргументы:''
** string $message Сообщение об ошибке
** mixed $a Параметры для строки из файла локализации
** bool[optional] $error Если это сообщение об ошибке
* ''Возвращаемое значение:''
** на данный момент не предусмотрено возвращаемого значения

== Cron ==
* ''Периодичность запуска''
** Значение берется из конфигурационного файла (стоит учитывать, что это происходит только при установке или обновлении плагина)
* ''Что выполняется''
** sync_grades()
* ''Условия запуска (нюансы, логика запуска)''
** Запускатся если в конфигурационном файле задана переменная, активирующая синхронизацию и если пониженная нагрузка системы в данный момент, иначе вернет true.

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

2011-04-26T07:56:47Z

Nickkang:

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

2011-04-21T12:54:15Z

Nickkang: Добавлены методы синхронизации оценок