Разработка:lib/workflow.php — различия между версиями

Материал из DOF
Перейти к: навигация, поиск
(Новая страница: «{{Infobox_Plugin | name = core | type = core }} == Класс интерфейса для плагинов рабочих процессов ==»)
 
Строка 4: Строка 4:
 
}}
 
}}
  
−
== Класс интерфейса для плагинов рабочих процессов ==
+
== Описание ==
 +
Родительский класс интерфейса рабочих процессов
 +
 
 +
== API ==
 +
 
 +
==== get_storage()====
 +
Получить название хранилища, которое обслуживает текущий учебный процесс
 +
 
 +
''Возвращаемые значения:''
 +
* (string) - название хранилища
 +
 
 +
====update($dataobject,$id = NULL,$quiet=false,$bulk=false)====
 +
Обновляет запись в БД.
 +
 
 +
''Аргументы:''
 +
* $dataobject (object) - данные для вставки в БД
 +
* $id (int) - id записи в базе, если значение отсутствует id ищется в dataobject.
 +
* $quiet (bool) - флаг запрета генерации событий, true - запретить, false - разрешить.
 +
* $bulk (bool) - true если операций последует много, false если обновлено будет всего несколько записей (для производительности).
 +
 
 +
''Возвращаемые значения:''
 +
* (bool), true если запись обновилась
 +
* (bool), false если операция не удалась
 +
 
 +
====delete($id,$quiet=false)====
 +
Удаляет запись из БД.
 +
 
 +
''Аргументы:''
 +
* $id (int) - id записи в базе.
 +
* $quiet (bool) - флаг запрета генерации событий, true - запретить, false - разрешить.
 +
 
 +
''Возвращаемые значения:''
 +
* (bool), true если запись удалилась
 +
* (bool), false если операция не удалась
 +
 
 +
====get($conditions, $fields='*', $strictness=IGNORE_MISSING)====
 +
Получает запись из БД.
 +
 
 +
''Аргументы:''
 +
* $conditions(int) - id записи в таблице
 +
* $fields (string) - название возвращаемых полей, '*' - все.
 +
* $strictness (constant) -
 +
    IGNORE_MISSING - если запись не найдена - то функция возвращает false и выводит отладочное сообщение
 +
    IGNORE_MULTIPLE - вернуть первое значение и игнорировать остальные, если нашлось больше одной записи (не рекомендуется)
 +
    MUST_EXIST - если запись не найдена, или найдено несколько записей вместо одной, то будет вызвано исключение.
 +
 
 +
''Возвращаемые значения:''
 +
* (object), если запись нашлась
 +
* (bool), false если операция не удалась
 +
 
 +
====get_columns($usecache = true)====
 +
 
 +
Возвращает детальную информацию о полях в таблице. Информация кешируется
 +
 
 +
''Аргументы:''
 +
* $usecache (bool) - флаг для использования внутреннего кеширования. По-умолчанию включено
 +
 
 +
''Возвращаемые значения:''
 +
* (array) объекты database_column_info проиндексированные по названию полей
 +
 
 +
====get_field($conditions,$return, $strictness=IGNORE_MISSING)====
 +
Возвращает значение поля из БД.
 +
 
 +
''Аргументы:''
 +
* $conditions(int|array) - id записи|массив полей и значений в таблице
 +
* $return (string) - название поля в таблице.
 +
* $strictness (constant) -
 +
    IGNORE_MISSING - если запись не найдена - то функция возвращает false и выводит отладочное сообщение
 +
    IGNORE_MULTIPLE - вернуть первое значение и игнорировать остальные, если нашлось больше одной записи (не рекомендуется)
 +
    MUST_EXIST - если запись не найдена, или найдено несколько записей вместо одной, то будет вызвано исключение.
 +
 
 +
''Возвращаемые значения:''
 +
* (string), если запись нашлась
 +
* (bool), false если операция не удалась
 +
 
 +
====get_record($conditions, $fields='*', $strictness=IGNORE_MISSING)====
 +
Получает запись из БД по критериям.
 +
 
 +
''Аргументы:''
 +
* $conditions(array) - массив полей и значений в таблице
 +
* $fields (string) - название возвращаемых полей, '*' - все.
 +
* $strictness (constant) -
 +
    IGNORE_MISSING - если запись не найдена - то функция возвращает false и выводит отладочное сообщение
 +
    IGNORE_MULTIPLE - вернуть первое значение и игнорировать остальные, если нашлось больше одной записи (не рекомендуется)
 +
    MUST_EXIST - если запись не найдена, или найдено несколько записей вместо одной, то будет вызвано исключение.
 +
 
 +
''Возвращаемые значения:''
 +
* (object), если запись нашлась
 +
* (bool), false если операция не удалась
 +
 
 +
====get_records($conditions=array(), $sort='', $fields='*', $limitfrom=0, $limitnum=0)====
 +
Получает записи из БД по критериям.
 +
 
 +
''Аргументы:''
 +
* $conditions(array) - массив полей и значений в таблице
 +
* $sort (string) - сортировка полей
 +
* $fields (string) - название возвращаемых полей, '*' - все
 +
* $limitfrom (int) - начиная с какой записи в выборке возвращать результат
 +
* $limitnum (int) - сколько записей вернуть
 +
 
 +
''Возвращаемые значения:''
 +
* (object), если записи нашлась
 +
* (bool), false если операция не удалась
 +
 
 +
====get_records_select($select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0)====
 +
Получает записи из БД по sql-запросу после WHERE.
 +
 
 +
''Аргументы:''
 +
* $select (string) - sql-запрос после WHERE
 +
* $params (array) - маска значений
 +
* $sort (string) - сортировка полей
 +
* $fields (string) - название возвращаемых полей, '*' - все
 +
* $limitfrom (int) - начиная с какой записи в выборке возвращать результат
 +
* $limitnum (int) - сколько записей вернуть
 +
 
 +
''Возвращаемые значения:''
 +
* (object), если записи нашлась
 +
* (bool), false если операция не удалась
 +
 
 +
====get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0)====
 +
Получает записи из БД по sql-запросу.
 +
 
 +
''Аргументы:''
 +
* $sql (string) - sql-запрос
 +
* $params (array) - маска значений
 +
* $limitfrom (int) - начиная с какой записи в выборке возвращать результат
 +
* $limitnum (int) - сколько записей вернуть
 +
 
 +
''Возвращаемые значения:''
 +
* (object), если записи нашлась
 +
* (bool), false если операция не удалась

Версия 11:09, 16 мая 2017

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


Описание

Родительский класс интерфейса рабочих процессов

API

get_storage()

Получить название хранилища, которое обслуживает текущий учебный процесс

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

  • (string) - название хранилища

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

Обновляет запись в БД.

Аргументы:

  • $dataobject (object) - данные для вставки в БД
  • $id (int) - id записи в базе, если значение отсутствует id ищется в dataobject.
  • $quiet (bool) - флаг запрета генерации событий, true - запретить, false - разрешить.
  • $bulk (bool) - true если операций последует много, false если обновлено будет всего несколько записей (для производительности).

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

  • (bool), true если запись обновилась
  • (bool), false если операция не удалась

delete($id,$quiet=false)

Удаляет запись из БД.

Аргументы:

  • $id (int) - id записи в базе.
  • $quiet (bool) - флаг запрета генерации событий, true - запретить, false - разрешить.

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

  • (bool), true если запись удалилась
  • (bool), false если операция не удалась

get($conditions, $fields='*', $strictness=IGNORE_MISSING)

Получает запись из БД.

Аргументы:

  • $conditions(int) - id записи в таблице
  • $fields (string) - название возвращаемых полей, '*' - все.
  • $strictness (constant) - 
   IGNORE_MISSING - если запись не найдена - то функция возвращает false и выводит отладочное сообщение
   IGNORE_MULTIPLE - вернуть первое значение и игнорировать остальные, если нашлось больше одной записи (не рекомендуется)
   MUST_EXIST - если запись не найдена, или найдено несколько записей вместо одной, то будет вызвано исключение.

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

  • (object), если запись нашлась
  • (bool), false если операция не удалась

get_columns($usecache = true)

Возвращает детальную информацию о полях в таблице. Информация кешируется

Аргументы:

  • $usecache (bool) - флаг для использования внутреннего кеширования. По-умолчанию включено

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

  • (array) объекты database_column_info проиндексированные по названию полей

get_field($conditions,$return, $strictness=IGNORE_MISSING)

Возвращает значение поля из БД.

Аргументы:

  • $conditions(int|array) - id записи|массив полей и значений в таблице
  • $return (string) - название поля в таблице.
  • $strictness (constant) - 
   IGNORE_MISSING - если запись не найдена - то функция возвращает false и выводит отладочное сообщение
   IGNORE_MULTIPLE - вернуть первое значение и игнорировать остальные, если нашлось больше одной записи (не рекомендуется)
   MUST_EXIST - если запись не найдена, или найдено несколько записей вместо одной, то будет вызвано исключение.

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

  • (string), если запись нашлась
  • (bool), false если операция не удалась

get_record($conditions, $fields='*', $strictness=IGNORE_MISSING)

Получает запись из БД по критериям.

Аргументы:

  • $conditions(array) - массив полей и значений в таблице
  • $fields (string) - название возвращаемых полей, '*' - все.
  • $strictness (constant) - 
   IGNORE_MISSING - если запись не найдена - то функция возвращает false и выводит отладочное сообщение
   IGNORE_MULTIPLE - вернуть первое значение и игнорировать остальные, если нашлось больше одной записи (не рекомендуется)
   MUST_EXIST - если запись не найдена, или найдено несколько записей вместо одной, то будет вызвано исключение.

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

  • (object), если запись нашлась
  • (bool), false если операция не удалась

get_records($conditions=array(), $sort=, $fields='*', $limitfrom=0, $limitnum=0)

Получает записи из БД по критериям.

Аргументы:

  • $conditions(array) - массив полей и значений в таблице
  • $sort (string) - сортировка полей
  • $fields (string) - название возвращаемых полей, '*' - все
  • $limitfrom (int) - начиная с какой записи в выборке возвращать результат
  • $limitnum (int) - сколько записей вернуть

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

  • (object), если записи нашлась
  • (bool), false если операция не удалась

get_records_select($select, array $params=null, $sort=, $fields='*', $limitfrom=0, $limitnum=0)

Получает записи из БД по sql-запросу после WHERE.

Аргументы:

  • $select (string) - sql-запрос после WHERE
  • $params (array) - маска значений
  • $sort (string) - сортировка полей
  • $fields (string) - название возвращаемых полей, '*' - все
  • $limitfrom (int) - начиная с какой записи в выборке возвращать результат
  • $limitnum (int) - сколько записей вернуть

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

  • (object), если записи нашлась
  • (bool), false если операция не удалась

get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0)

Получает записи из БД по sql-запросу.

Аргументы:

  • $sql (string) - sql-запрос
  • $params (array) - маска значений
  • $limitfrom (int) - начиная с какой записи в выборке возвращать результат
  • $limitnum (int) - сколько записей вернуть

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

  • (object), если записи нашлась
  • (bool), false если операция не удалась
Источник — «http://docs.deansoffice.ru/wiki/index.php?title=Разработка:lib/workflow.php&oldid=3096»