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

Материал из DOF
Перейти к: навигация, поиск
(Подробный формат полей в таблице:)
(Дополнительные методы:)
Строка 20: Строка 20:
  
 
===Дополнительные методы:===
 
===Дополнительные методы:===
* Записать в базу данных информацию об изменении статуса
+
 
 +
'''change_status()'''
 +
 
 +
Записывает в базу данных информацию об изменении статуса.
 +
 
 +
''Аргументы:''
 +
* $plugin(mixed) - имя справочника(string) или объект плагина(object), которому принадлежит изменившийся объект
 +
* $objectid(int) - id изменившегося объекта
 +
* $status(string) - новый статус
 +
* $prevstatus(string) - старое значение статуса, по умолчанию - нет (null)
 +
* $opt(mixed) - дополнительные параметры при изменении статуса, по умолчанию - нет (null)
 +
* $notice(string) - заметка об изменении статуса, по умолчанию - нет.
 +
* $muserid(int) - id пользователя moodle, от имени которого изменяется статус, по умолчанию - нет (null)
 +
* $quiet(bool) - "тихий" режим (без отправки событий), по умолчанию - генерируется (false)
 +
''Возвращаемые значения:''
 +
* (int) id вставленной записи.
 +
* (bool) false если операция не удалась.
 +
''Структура работы:''
 +
# Создаем объект для вставки в БД:
 +
#* имя и тип плагина заносим в соответствии с полученным $plugin.
 +
#* если не указан пользователь, выполневший изменения, заносим текущего пользователя.
 +
#* заносим остальные значения в соответствии с полями.
 +
# записываем объект в таблицу БД и возвращаем результат.

Версия 17:02, 13 августа 2009

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


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

statushistory

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

  • status - текущий статус
  • prevstatus - предыдущий статус
  • plugintype - тип плигина
  • plugincode - код плагина
  • muserid - id пользователя в Moodle, выполнившего изменения
  • objectid - id объекта, в котором изменился статус
  • statusdate - дата смены статуса
  • notes - заметки
  • opt - дополнительные параметры
  • orderid - id приказа, на основании которого был изменен статус (если статус изменен на основании приказа)

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

change_status()

Записывает в базу данных информацию об изменении статуса.

Аргументы:

  • $plugin(mixed) - имя справочника(string) или объект плагина(object), которому принадлежит изменившийся объект
  • $objectid(int) - id изменившегося объекта
  • $status(string) - новый статус
  • $prevstatus(string) - старое значение статуса, по умолчанию - нет (null)
  • $opt(mixed) - дополнительные параметры при изменении статуса, по умолчанию - нет (null)
  • $notice(string) - заметка об изменении статуса, по умолчанию - нет.
  • $muserid(int) - id пользователя moodle, от имени которого изменяется статус, по умолчанию - нет (null)
  • $quiet(bool) - "тихий" режим (без отправки событий), по умолчанию - генерируется (false)

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

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

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

  1. Создаем объект для вставки в БД:
    • имя и тип плагина заносим в соответствии с полученным $plugin.
    • если не указан пользователь, выполневший изменения, заносим текущего пользователя.
    • заносим остальные значения в соответствии с полями.
  2. записываем объект в таблицу БД и возвращаем результат.