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

Материал из DOF
Перейти к: навигация, поиск
(API)
(API)
Строка 73: Строка 73:
 
''Возвращаемые значения:''
 
''Возвращаемые значения:''
 
* (string), если запись нашлась
 
* (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 если операция не удалась
 
* (bool), false если операция не удалась

Версия 14:51, 26 ноября 2013

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


Описание

Родительский класс для справочников

API

insert($dataobject,$quiet=false,$bulk=false)

Вставляет запись в БД.

Аргументы:

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

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

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

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_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 если операция не удалась