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

Материал из DOF
Перейти к: навигация, поиск
(→‎Дополнительные методы:)
м (→‎Подробный формат полей в таблице:)
 
(не показано 8 промежуточных версий 4 участников)
Строка 12: Строка 12:
 
* programmid - id учебной программы в таблице [[Разработка:storages/programms | programms ]], которую реализует академическая группа
 
* programmid - id учебной программы в таблице [[Разработка:storages/programms | programms ]], которую реализует академическая группа
 
* departmentid - отдел в таблице [[Разработка:storages/departments | departments ]], ответственный за группу
 
* departmentid - отдел в таблице [[Разработка:storages/departments | departments ]], ответственный за группу
−
* agenum - порядковый номер текущего учебного периода (изменяется приказом по контингенту). Параллель группы может быти изменена только если группа находится в статусе "формируется".
+
* agenum - порядковый номер текущего учебного периода (изменяется приказом по контингенту). Параллель группы может быть изменена только если группа находится в статусе "формируется".
 
* status - список статусов указан в одноименном плагине рабочих процессов  [[Разработка:workflows/agroups | agroups ]]
 
* status - список статусов указан в одноименном плагине рабочих процессов  [[Разработка:workflows/agroups | agroups ]]
 +
* metacontractid - id заключенного с группой метаконтракта в таблице [[Разработка:storages/metacontracts | metacontracts ]]
 +
* salfactor - поправочный зарплатный коэффициент
  
 
===Дополнительные методы:===
 
===Дополнительные методы:===
  
  
−
===='''insert()'''====
+
===='''insert($dataobject,$quiet=NULL)'''====
  
 
Вставляет запись в таблицу(ы) плагина  
 
Вставляет запись в таблицу(ы) плагина  
  
 
''Аргументы:''  
 
''Аргументы:''  
−
* $dataobject - данные записи
+
* $dataobject(object) - данные записи.
 +
* $quiet(bool) - генерировать или нет события, по умолчанию null.
 
''Возвращаемые значения:''
 
''Возвращаемые значения:''
−
* int - id вставленной записи
+
* int - id вставленной записи.
−
* mixed bool - false если операция не удалась
+
* bool - false, если операция не удалась.
  
  
−
===='''search_group_code()'''====
+
===='''search_group_code($code)'''====
  
 
находит группу по коду
 
находит группу по коду
  
 
''Аргументы:''  
 
''Аргументы:''  
−
* $code - код группы
+
* $code - код группы.
 
''Возвращаемые значения:''
 
''Возвращаемые значения:''
−
* mixed object объект группы  
+
* object - объект группы.
−
* bool false если группа не найдена  
+
* bool - false, если группа не найдена.
  
  
−
===='''get_groups_programm()'''====
+
===='''get_groups_programm($prid, $status = 'learn', $agenum = null, $dpid = null)'''====
  
 
находит все группы, обучающиеся по учебной программе.
 
находит все группы, обучающиеся по учебной программе.
Строка 46: Строка 49:
 
''Аргументы:''  
 
''Аргументы:''  
 
* $prid(int) - id программы  в таблице [[Разработка:storages/programms | programms ]].
 
* $prid(int) - id программы  в таблице [[Разработка:storages/programms | programms ]].
−
* $status(string) - статус группы, по умолчанию - обучается(learn).
+
* $status(string) - статус группы, по умолчанию - 'learn'.
−
* $agenum(int) - номер периода.
+
* $agenum(int) - номер периода, по умолчанию - null.
−
* $dpid(int) - id структурного подразделения.
+
* $dpid(int) - id структурного подразделения, по умолчанию - null.
 
''Возвращаемые значения:''
 
''Возвращаемые значения:''
−
* (array) список групп.
+
* array - список групп.
−
* (bool) false - если группы не найдены.
+
* bool - false, если группы не найдены.
 
''Структура работы:''
 
''Структура работы:''
 
* формируем SQL-запрос и возвращаем список групп:
 
* формируем SQL-запрос и возвращаем список групп:
Строка 63: Строка 66:
  
  
−
===='''get_group_department()'''====
+
===='''get_group_department($dpid, $prid = null, $status = 'learn')'''====
  
 
Получает все группы, относящиеся к структурному подразделению и обучающиеся по программе
 
Получает все группы, относящиеся к структурному подразделению и обучающиеся по программе
Строка 70: Строка 73:
 
* $dpid(int) - id структурного подразделения в таблице [[Разработка:storages/departments | departments ]].
 
* $dpid(int) - id структурного подразделения в таблице [[Разработка:storages/departments | departments ]].
 
* $prid(int) - id программы в таблице [[Разработка:storages/programms | programms ]], по умолчанию - все(null).
 
* $prid(int) - id программы в таблице [[Разработка:storages/programms | programms ]], по умолчанию - все(null).
−
* $status(string) - статус группы, по умолчанию - обучается(learn).
+
* $status(string) - статус группы, по умолчанию - 'learn'.
 
''Возвращаемые значения:''
 
''Возвращаемые значения:''
−
* mixed array список групп или bool false если группы не найдены
+
* array - список групп.
 +
* bool - false, если группы не найдены.
 
''Структура работы:''
 
''Структура работы:''
 
* формируем SQL-запрос и возвращаем список групп:
 
* формируем SQL-запрос и возвращаем список групп:
Строка 82: Строка 86:
  
  
−
===='''get_group_cstream()'''====
+
===='''get_group_cstream($csid)'''====
  
 
Получить все группы, подписанные на учебный процесс с данным id.  
 
Получить все группы, подписанные на учебный процесс с данным id.  
Строка 89: Строка 93:
 
* $csid(int) - id учебного процесса  в таблице [[Разработка:storages/cstreams | cstreams ]].
 
* $csid(int) - id учебного процесса  в таблице [[Разработка:storages/cstreams | cstreams ]].
 
''Возвращаемые значения:''
 
''Возвращаемые значения:''
−
* (array) список групп.
+
* (array) - список групп.
−
* (bool) false - если группы не найдены.
+
* (bool) - false, если группы не найдены.
  
  
−
===='''get_numberof_agroups()'''====
+
===='''get_numberof_agroups($select)'''====
  
 
находит количество групп
 
находит количество групп
  
 
''Аргументы:''  
 
''Аргументы:''  
−
* $select(string) - критерии отбора записей
+
* $select(string) - критерии отбора записей.
 
''Возвращаемые значения:''
 
''Возвращаемые значения:''
−
* int - количество найденных записей
+
* int - количество найденных записей.
  
  
Строка 108: Строка 112:
  
 
''Аргументы:''  
 
''Аргументы:''  
−
* $csid(int) - id учебного процесса
+
* $csid(int) - id учебного процесса.
 
''Возвращаемые значения:''
 
''Возвращаемые значения:''
−
* array - список групп
+
* array - список групп.
−
* bool false - если произошла ошибка
+
* bool - false, если произошла ошибка.
  
 
===Планы:===
 
===Планы:===
Строка 158: Строка 162:
 
  |Генерируется каждый раз при удалении записи из таблицы agroups.
 
  |Генерируется каждый раз при удалении записи из таблицы agroups.
 
  |}
 
  |}
−
 
−
[[Категория:Разработка]]
 
−
[[Категория:Плагины_storages]]
 

Текущая версия на 13:10, 30 июля 2013

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


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

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

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

  • name - название академической группы/класса
  • code - кодовое обозначение группы (текстовое поле, обязательное, уникальное)
  • programmid - id учебной программы в таблице programms , которую реализует академическая группа
  • departmentid - отдел в таблице departments , ответственный за группу
  • agenum - порядковый номер текущего учебного периода (изменяется приказом по контингенту). Параллель группы может быть изменена только если группа находится в статусе "формируется".
  • status - список статусов указан в одноименном плагине рабочих процессов agroups
  • metacontractid - id заключенного с группой метаконтракта в таблице metacontracts
  • salfactor - поправочный зарплатный коэффициент

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

insert($dataobject,$quiet=NULL)

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

Аргументы:

  • $dataobject(object) - данные записи.
  • $quiet(bool) - генерировать или нет события, по умолчанию null.

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

  • int - id вставленной записи.
  • bool - false, если операция не удалась.


search_group_code($code)

находит группу по коду

Аргументы:

  • $code - код группы.

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

  • object - объект группы.
  • bool - false, если группа не найдена.


get_groups_programm($prid, $status = 'learn', $agenum = null, $dpid = null)

находит все группы, обучающиеся по учебной программе.

Аргументы:

  • $prid(int) - id программы в таблице programms .
  • $status(string) - статус группы, по умолчанию - 'learn'.
  • $agenum(int) - номер периода, по умолчанию - null.
  • $dpid(int) - id структурного подразделения, по умолчанию - null.

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

  • array - список групп.
  • bool - false, если группы не найдены.

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

  • формируем SQL-запрос и возвращаем список групп:
    • если указывается статус - группы с указанным статусом,
    • если статус указывается null - группы с любым статусом,
    • если статус не указывается - группы со статусом learn.
    • если указывается номер периода - группы с указанным периодом,
    • если номер периода указывается null или не указывается - группы с любым периодом.
    • если указывается id подразделения - группы указанного подразделения,
    • если id подразделения указывается null или не указывается - группы любого подразделения.


get_group_department($dpid, $prid = null, $status = 'learn')

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

Аргументы:

  • $dpid(int) - id структурного подразделения в таблице departments .
  • $prid(int) - id программы в таблице programms , по умолчанию - все(null).
  • $status(string) - статус группы, по умолчанию - 'learn'.

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

  • array - список групп.
  • bool - false, если группы не найдены.

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

  • формируем SQL-запрос и возвращаем список групп:
    • если указывается id программы - группы с указанным id,
    • если id программы не указывается или указывается как null- группы с любым id.
    • если указывается статус - группы с указанным статусом,
    • если статус указывается null - группы с любым статусом,
    • если статус не указывается - группы со статусом learn.


get_group_cstream($csid)

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

Аргументы:

  • $csid(int) - id учебного процесса в таблице cstreams .

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

  • (array) - список групп.
  • (bool) - false, если группы не найдены.


get_numberof_agroups($select)

находит количество групп

Аргументы:

  • $select(string) - критерии отбора записей.

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

  • int - количество найденных записей.


get_group_nocstream($csid)

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

Аргументы:

  • $csid(int) - id учебного процесса.

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

  • array - список групп.
  • bool - false, если произошла ошибка.

Планы:

События

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

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

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

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

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

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

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

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

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

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

Генерируется каждый раз при удалении записи из таблицы agroups.
Источник — «http://docs.deansoffice.ru/wiki/index.php?title=Разработка:storages/agroups&oldid=2656»