Разработка:storages/programms — различия между версиями

Материал из DOF
Перейти к: навигация, поиск
(Новая: ===Таблица в базе данных=== ====Подробный формат полей в таблице:====)
 
 
(не показано 19 промежуточных версий 5 участников)
Строка 1: Строка 1:
 +
{{Infobox_Plugin
 +
| name = programms
 +
| type = storages
 +
}}
 +
 
===Таблица в базе данных===
 
===Таблица в базе данных===
 +
''programms'' - учебные программы (специальности), которые реализует учебное заведение. Могут выражаться как в длительной последовательности предметов/учебных дисциплин, так и в одной или нескольких учебных дисциплинах, на который учащийся может подписаться и окончить их независимо.
 +
 +
====Подробный формат полей в таблице====
 +
* name - название учебной программы
 +
* code - код учебной программы (текстовое поле, необязательное, уникальное). Если код не указан - то вместо него подставляется id записи.
 +
* about - описание учебной программы для учеников
 +
* status - список статусов указан в одноименном плагине рабочих процессов  [[Разработка:workflows/programms | programms ]]
 +
* departmentid - структурное подразделение, ответственное за учебную программу в таблице [[Разработка:storages/departments | departments ]]
 +
* notice - заметка для сотрудников об учебной программе
 +
* agenums - количество учебных периодов, на которое расчитано обучения
 +
* duration - общая продолжительность обучения по программе  в секундах во времени (дни, недели и года обучения).
 +
* ahours - длительность обучения в академических часах.
 +
* billingtext - цена программы
 +
* billingrules -
 +
* flowagenums - допускает ли программа плавающие учебные планы (принимает значения 0/1)
 +
 +
===Дополнительные методы:===
 +
 +
===='''get_numberof_programms($select)'''====
 +
 +
Возвращает количество периодов c указанными departmentid и статусом
 +
 +
''Аргументы:''
 +
* (str) $select - sql код после слова where
 +
''Возвращает значение:''
 +
* int - количество записей
 +
 +
===='''get_programms_list($departmentid = null, $status = null)'''====
 +
 +
Возвращает массив объектов, выбранных по sql-запросу отсортированных по имени(запрос по статусу и подразделению)
 +
 +
''Аргументы:''
 +
* (int) $departmentid - id подразделения из таблицы [[Разработка:storages/departments | departments ]], по умолчанию null
 +
* (int) $status - id подразделения из таблицы [[Разработка:storages/departments | departments ]], по умолчанию null
 +
''Возвращает значение:''
 +
* int - количество записей
 +
 +
===='''get_menu_programms_list()'''====
 +
 +
Возвращает список всех учебных программ
 +
 +
''Возвращает значение:''
 +
* array - массив учебных программ
 +
 +
===Планы:===
 +
====Дополнительные методы:====
 +
* Поиск учебной программы по коду
 +
* Список действующих учебных программ, отсортированный по названию (если указан статус - то только имеющих этот статус, если указано подразделение - то только относящихся к этому подразделению)
  
====Подробный формат полей в таблице:====
+
===События===
 +
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
 +
====Перехватываемые события====
 +
{| border="1"
 +
|+ Таблица событий, которые перехватывает этот плагин
 +
! Тип плагина
 +
! Код плагина
 +
! Код события
 +
! Доп. данные
 +
! Пояснение
 +
|-
 +
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
 +
|}
 +
====Генерируемые события====
 +
{| border="1"
 +
|+ Таблица событий, которые генерирует этот плагин
 +
! Тип плагина
 +
! Код плагина
 +
! Код события
 +
! Доп. данные
 +
! Пояснение
 +
|-
 +
|storage
 +
|programms
 +
|insert
 +
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
 +
''Пример:'' array('new' => $dataobject)
 +
|Генерируется каждый раз при вставке новой записи в таблицу programms.
 +
|-
 +
|storage
 +
|programms
 +
|update
 +
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
 +
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
 +
|Генерируется каждый раз при обновлении записи в таблице programms.
 +
|-
 +
|storage
 +
|programms
 +
|delete
 +
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
 +
''Пример:'' array('old' => $dataobject)
 +
|Генерируется каждый раз при удалении записи из таблицы programms.
 +
|}

Текущая версия на 13:48, 11 июня 2014

Плагин
Название programms
Тип storages


Таблица в базе данных

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

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

  • name - название учебной программы
  • code - код учебной программы (текстовое поле, необязательное, уникальное). Если код не указан - то вместо него подставляется id записи.
  • about - описание учебной программы для учеников
  • status - список статусов указан в одноименном плагине рабочих процессов programms
  • departmentid - структурное подразделение, ответственное за учебную программу в таблице departments
  • notice - заметка для сотрудников об учебной программе
  • agenums - количество учебных периодов, на которое расчитано обучения
  • duration - общая продолжительность обучения по программе в секундах во времени (дни, недели и года обучения).
  • ahours - длительность обучения в академических часах.
  • billingtext - цена программы
  • billingrules -
  • flowagenums - допускает ли программа плавающие учебные планы (принимает значения 0/1)

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

get_numberof_programms($select)

Возвращает количество периодов c указанными departmentid и статусом

Аргументы:

  • (str) $select - sql код после слова where

Возвращает значение:

  • int - количество записей

get_programms_list($departmentid = null, $status = null)

Возвращает массив объектов, выбранных по sql-запросу отсортированных по имени(запрос по статусу и подразделению)

Аргументы:

  • (int) $departmentid - id подразделения из таблицы departments , по умолчанию null
  • (int) $status - id подразделения из таблицы departments , по умолчанию null

Возвращает значение:

  • int - количество записей

get_menu_programms_list()

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

Возвращает значение:

  • array - массив учебных программ

Планы:

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

  • Поиск учебной программы по коду
  • Список действующих учебных программ, отсортированный по названию (если указан статус - то только имеющих этот статус, если указано подразделение - то только относящихся к этому подразделению)

События

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

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

Таблица событий, которые перехватывает этот плагин
Тип плагина Код плагина Код события Доп. данные Пояснение
Этот плагин не перехватывает никаких событий

Генерируемые события

Таблица событий, которые генерирует этот плагин
Тип плагина Код плагина Код события Доп. данные Пояснение
storage programms insert Массив, содержащий в поле "new" объект с данными для вставки в таблицу.

Пример: array('new' => $dataobject)

Генерируется каждый раз при вставке новой записи в таблицу programms.
storage programms update Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.

Пример: array('old' => $dataobject_old, 'new' => $dataobject_new)

Генерируется каждый раз при обновлении записи в таблице programms.
storage programms delete Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы

Пример: array('old' => $dataobject)

Генерируется каждый раз при удалении записи из таблицы programms.