Базовый абстрактный класс объектов ORM
Открытые члены | |
static | __construct () |
__destruct () | |
fillDefaults () | |
getClassParameter ($key=null) | |
setClassParameter ($key, $value=null) | |
issetClassParameter ($key=null) | |
setLocalParameter ($key, $value=null) | |
getLocalParameter ($key, $default=null) | |
getParameter ($key, $default=null) | |
setPropertyIterator (PropertyIterator $iterator) | |
checkRights ($bool) | |
clear () | |
offsetExists ($offset) | |
offsetGet ($offset) | |
offsetSet ($offset, $value) | |
__set ($offset, $value) | |
__get ($offset) | |
offsetUnset ($offset) | |
getShortAlias () | |
load ($primaryKeyValue=null) | |
insert ($ignore=false, $on_duplicate_update_keys=[], $on_duplicate_uniq_fields=[]) | |
update ($primaryKey=null) | |
replace () | |
delete () | |
exists ($primaryKeyValue) | |
getFromArray (array $data, $remove_prefix=null, $mark_modify=true, $call_afterload_event=false) | |
getValues () | |
isModified ($property) | |
getPropertyIterator () | |
appendProperty (array $properties) | |
_getTableArray () | |
getPrimaryKeyProperty () | |
getProperties () | |
getProp ($offset) | |
save ($primaryKeyValue=null, $user_post=[], $post_var=null, $files_var=null) | |
replaceOn ($bool) | |
setWriteBit ($n) | |
usePostKeys (array $keys) | |
excludePostKeys (array $keys) | |
checkData ($user_post=[], $post_var=null, $files_var=null, $usekeys=null, $exclude=null, $flag=self::UPDATE_FLAG) | |
fillFromPost ($user_post=[], $post_var=null, $files_var=null, $usekeys=null, $exclude=null) | |
validateData ($flag=self::UPDATE_FLAG) | |
validate () | |
setCheckFields (array $fields) | |
escapeFields (array $escape_fields) | |
escapeAll ($bool) | |
checkField ($property) | |
addError ($string, $form=null) | |
addErrors ($array, $form=null) | |
getLastError () | |
getErrors () | |
getErrorsStr () | |
hasError () | |
getFormError () | |
getErrorsByForm ($key=null, $sep=null) | |
getDisplayErrors () | |
noWriteRights ($right=DefaultModuleRights::RIGHT_UPDATE) | |
getNonFormErrors () | |
clearErrors () | |
setTemporaryId () | |
setFormTemplate ($template) | |
dbUpdate () | |
addIndex ($fields, $type=self::INDEX_KEY, $name=null, $using=null) | |
getIndexes () | |
getForm (array $tpl_vars=null, $switch=null, $is_multiedit=false, $template=null, $tpl_maker=null, $tpl_folder=null) | |
getPropertyView ($key, $attributes=[], $view_params=[]) | |
getHiddenKeyVal () | |
addHiddenFields ($keys, $value=null) | |
addDebugActions (array $actions, $local=false) | |
addDebugAction (\RS\Debug\Action\AbstractAction $action, $local=false) | |
getDebugAttributes () | |
beforeWrite ($save_flag) | |
afterWrite ($save_flag) | |
afterObjectLoad () | |
getDebugActions () | |
dropTable () | |
exportErrors () | |
current () | |
key () | |
next () | |
rewind () | |
valid () | |
__sleep () | |
__wakeup () | |
__clone () | |
__isset ($offset) | |
getRightRead () | |
getRightCreate () | |
getRightUpdate () | |
getRightDelete () | |
getHtmlEncodedFields () | |
Открытые члены унаследованные от AcceptBehavior | |
attachInstanceBehavior (BehaviorAbstract $behavior_class) | |
detachInstanceBehavior (BehaviorAbstract $behavior_class=null) | |
getAttachedBehaviors () | |
behaviorMethodExists ($method_name) | |
__call ($method_name, $arguments) | |
Открытые члены унаследованные от AcceptBehaviorInterface | |
attachInstanceBehavior (\RS\Behavior\BehaviorAbstract $behavior_class) | |
detachInstanceBehavior (\RS\Behavior\BehaviorAbstract $behavior_class=null) | |
Открытые статические члены | |
static | loadByWhere ($expr, array $values=null, $prefix= 'AND', $in_prefix= 'AND') |
static | _getTable () |
static | chkDepend ($coreobj, $value, $real_errtext, $real_chk, array $conditions, $real_params=[]) |
static | destroyClass () |
Открытые статические члены унаследованные от AcceptBehavior | |
static | attachClassBehavior (BehaviorAbstract $behavior_class) |
static | detachClassBehavior (BehaviorAbstract $behavior_class=null) |
Открытые статические члены унаследованные от AcceptBehaviorInterface | |
static | attachClassBehavior (\RS\Behavior\BehaviorAbstract $behavior_class) |
static | detachClassBehavior (\RS\Behavior\BehaviorAbstract $behavior_class=null) |
Поля данных | |
const | INSERT_FLAG = 'insert' |
const | UPDATE_FLAG = 'update' |
const | REPLACE_FLAG = 'replace' |
const | INDEX_PRIMARY = 'primary key' |
const | INDEX_UNIQUE = 'unique' |
const | INDEX_KEY = 'index' |
const | INDEX_FULLTEXT = 'fulltext' |
Поля данных унаследованные от AcceptBehavior | |
$class_behaviors = [] | |
$cache_behavior_instances = [] | |
$instance_behaviors = [] | |
Защищенные члены | |
initProperties () | |
_init () | |
_initDefaults () | |
afterInit () | |
getStorageInstance () | |
getTableEngine () | |
getPropertyHash ($is_multiedit, $switch=null) | |
Защищенные статические члены | |
static | _tableName ($with_quotes=true) |
static | _dbName ($with_quotes=true) |
Защищенные данные | |
$_values = [] | |
$_self_class | |
$_local_id | |
Статические защищенные данные | |
static | $db = DB_NAME |
static | $table = null |
static | $iterator = 0 |
static | $init_default_method = '_initDefaults' |
static | $local = [] |
static | $default_local_parameters |
static static | $class = [] |
static | $default_class_parameters |
static __construct | ( | ) |
__destruct | ( | ) |
__clone | ( | ) |
__get | ( | $offset | ) |
Возвращает значения свойства ORM Объекта через синтаксис $value = $orm->property Идентично $value = $orm['property']
string | $offset | Имя свойства |
__isset | ( | $offset | ) |
Проверяет наличие значения по ключу (ArrayAccess)
string | $offset | - имя свойства |
__set | ( | $offset, | |
$value | |||
) |
Позволяет устанавливать свойства ORM объекта через синтаксис $orm->property = 'value' Идентично $orm['property'] = 'value'
string | $offset | Имя свойства |
mixed | $value | Значение |
__sleep | ( | ) |
При сериализации объекта - достаточно сохранить массив его значений.
__wakeup | ( | ) |
Позволяет сконструировать объект заново после рассериализации
|
staticprotected |
Возвращает имя базы данных текущего объекта
bool | $with_quotes | - если true, то оборачивать в апострофами имя базы данных |
|
static |
Возвращает базу данных и имя таблицы
_getTableArray | ( | ) |
Возвращает базу данный и имя таблицы в виде массива
RSException |
|
abstractprotected |
В данном методе должны быть заданы поля объекта. Вызывается один раз для одного класса объектов в момент первого обращения к свойству
|
protected |
Внутри данной функции нужно объявлять значения свойств по умолчанию. Вызывается после конструктора.
|
staticprotected |
Возвращает имя таблицы текущего объекта
boolean | $with_quotes | - если true, то оборачивать в апострофами имя таблицы |
addDebugAction | ( | \RS\Debug\Action\AbstractAction | $action, |
$local = false |
|||
) |
addDebugActions | ( | array | $actions, |
$local = false |
|||
) |
addError | ( | $string, | |
$form = null |
|||
) |
Дабавляет ошибку
string | $string | - текст ошибки |
string | $form | - свойство, в котором произошла ошибка |
addErrors | ( | $array, | |
$form = null |
|||
) |
Добавляет ошибки
mixed | $array | - массив с ошибками |
mixed | $form | - свойство в котором произошли ошибки |
addHiddenFields | ( | $keys, | |
$value = null |
|||
) |
Добавляет скрытые поля
string | array | $keys | |
mixed | $value |
addIndex | ( | $fields, | |
$type = self::INDEX_KEY , |
|||
$name = null , |
|||
$using = null |
|||
) |
Добавляет описание индекса для данного объекта
array | string | $fields | - поля, которые должны войти в индекс |
string | $type | - тип индекса. Используйте константы: self::INDEX_PRIMARY - первичный ключ self::INDEX_UNIQUE - уникальный индекс self::INDEX_KEY - неуникальный индекс self::INDEX_FULLTEXT - полнотекстовый индекс |
string | $name | - идентификатор индекса |
string | $using | - тип индекса BTREE | HASH |
|
protected |
Производит внутреннюю инициализацию объекта. Вызывается один раз для одного имени класса
Event: orm.init paramtype
afterObjectLoad | ( | ) |
Вызывается после загрузки объекта
afterWrite | ( | $save_flag | ) |
Вызывается после сохранения объекта в storage
string | $save_flag | - тип операции (insert|update|replace) |
appendProperty | ( | array | $properties | ) |
Дополняет текущий класс объектов новыми полями(свойствами)
array | $properties | - массив со свойствами, аналогично тому, что задается в _init |
beforeWrite | ( | $save_flag | ) |
Вызывается перед сохранением объекта в storage Если возвращено false, то сохранение не произойдет
string | $save_flag | - тип операции (insert|update|replace) |
checkData | ( | $user_post = [] , |
|
$post_var = null , |
|||
$files_var = null , |
|||
$usekeys = null , |
|||
$exclude = null , |
|||
$flag = self::UPDATE_FLAG |
|||
) |
Проверка на возможность сохранения данных. при этом объект заполняется из POST. насколько это возможно.
array | $user_post | - дополнительные данные, которые будут добавлены к post_var |
array | $post_var | - если передан, то будет использован вместо $_POST |
array | $files_var | - если передан, то будет использован вместо $_FILES |
array | $usekeys | - массив с ключами, которые нужно исползовать для заполнения объекта |
array | $exclude | - массив с ключами, которые нужно исключить при заполнении объекта |
string | $flag | - флаг опреации с объектом (self::INSERT_FLAG|self::UPDATE_FLAG) |
RSException |
checkField | ( | $property | ) |
Возвращает результат проверки поля $key
string | \RS\Orm\Type\AbstractType | $key |
checkRights | ( | $bool | ) |
Устанавливает, проверять ли права на запись при попытке изменить объект
boolean | $bool |
|
static |
Проверяет поле в зависимости от значений других полей. Вызывает реальные checker'ы, если соблюдены conditions, иначе не вызывает checker
clear | ( | ) |
Очищает все значения свойств
clearErrors | ( | ) |
Очищает все ошибки в объекте
current | ( | ) |
dbUpdate | ( | ) |
Приводит базу данных в соответствие со структурой объекта
delete | ( | ) |
Удаляет объект из хранилища
|
static |
Уничтожает класс объектов, в следующем конструкторе будет вызван _init
dropTable | ( | ) |
Удаляет таблицу для данного объекта
escapeAll | ( | $bool | ) |
Переводить в entity все значения свойств перед записью?
boolean | $bool | - если true, то будут переведены в entity все свойства |
escapeFields | ( | array | $escape_fields | ) |
При заполнении данными с помощью метода check(), указанные свойства будут пропущены через функцию htmlspecialchars.
array | $escape_fields | - массив с названиями свойств, которые нужно перевести в entity |
excludePostKeys | ( | array | $keys | ) |
Устанавливает, какие ключи должны исключаться из POST при сохранении объекта
array | $keys |
exists | ( | $primaryKeyValue | ) |
Возвращает true, если объект с указанным Уникальным идентификатором существует
mixed | $primaryKeyValue | - уникальный идентификатор |
exportErrors | ( | ) |
Экспортирует все данные по ошибкам
fillDefaults | ( | ) |
Присваивает не измененным полям значение по-умолчанию
fillFromPost | ( | $user_post = [] , |
|
$post_var = null , |
|||
$files_var = null , |
|||
$usekeys = null , |
|||
$exclude = null |
|||
) |
Заполняет объект из POST. насколько это возможно.
array | $user_post | - дополнительные данные, которые будут добавлены к post_var |
array | $post_var | - если передан, то будет использован вместо $_POST |
array | $files_var | - если передан, то будет использован вместо $_FILES |
array | $usekeys | - массив с ключами, которые нужно исползовать для заполнения объекта |
array | $exclude | - массив с ключами, которые нужно исключить при заполнении объекта |
getClassParameter | ( | $key = null | ) |
string | $key | имя параметра |
getDebugActions | ( | ) |
Возвращает отладочные действия, которые можно произвести с объектом
getDebugAttributes | ( | ) |
Возвращает строку с необходимыми атрибутами блочного элемента для вставки в html
getDisplayErrors | ( | ) |
Возвращает массив с ошибками со сведениями о поле
getErrors | ( | ) |
Возвращает массив с текстами всех ошибок.
getErrorsByForm | ( | $key = null , |
|
$sep = null |
|||
) |
Возвращает ассоциативный массив с ошибками в формах, если $key = null Возвращает массив с ошибками, если $key != null и $sep = null Возвращает строку с ошибками, с разделителем $sep, если $key != null и $sep != null
string | null | $key | - имя свойство |
string | null | $sep | - разделитель |
getErrorsStr | ( | ) |
Возвращает ошибки в виде строки
getForm | ( | array | $tpl_vars = null , |
$switch = null , |
|||
$is_multiedit = false , |
|||
$template = null , |
|||
$tpl_maker = null , |
|||
$tpl_folder = null |
|||
) |
Возвращает HTML форму объекта, если её не существует по указанному пути, то создает её.
array | $tpl_vars | - дополнительные параметры, передаваемые в шаблон |
mixed | $switch | - контекст, в котором будет генерироваться форма. Позволяет скрывать какие-либо поля в зависимости от контекста |
bool | $is_multiedit | - Если true, то это форма мультиредактирования |
mixed | $template | - имя файла генерируемого шаблона |
mixed | $tpl_maker | - имя шаблона, по которому будет произведена генерация |
mixed | $tpl_folder | - каталог для генерации шаблона |
\SmartyException |
getFormError | ( | ) |
Возвращает массив форм, в которых есть ошибки
getFromArray | ( | array | $data, |
$remove_prefix = null , |
|||
$mark_modify = true , |
|||
$call_afterload_event = false |
|||
) |
Загружает данные в объект из массива
array | $data | - массив ключ => значение |
string | $remove_prefix | - префикс, который будет удален перед ключем |
bool | $mark_modify | - True - отмечать поле измененным, после загружки данных |
bool | $call_afterload_event | - True - вызывать обработчик загрузки данных |
getHiddenKeyVal | ( | ) |
Возвращает ключ => значение всех полей типа Type/Hidden
getHtmlEncodedFields | ( | ) |
Возвращает массив полей, которые лежат закодированными в базе данных
getIndexes | ( | ) |
getLastError | ( | ) |
getLocalParameter | ( | $key, | |
$default = null |
|||
) |
Возвращает параметр, заданный для текущего объекта
mixed | $key | - имя параметра |
mixed | $default | - значение по-умолчанию |
getNonFormErrors | ( | ) |
Возвращает ошибки не привязанные к формам
getParameter | ( | $key, | |
$default = null |
|||
) |
Возвращает параметр, заданный для текущего объекта, а если такой параметр не задан, заданный для текущего класса объектов
mixed | $key | - имя параметра |
mixed | $default | - значение по-умолчанию |
getPrimaryKeyProperty | ( | ) |
Возвращает имя свойства, которое помечено как первичный ключ. Для совместимости с предыдущими версиями, метод ищет первичный ключ в свойствах.
С целью увеличения производительности необходимо у наследников реализовать явное возвращение свойств, отвечающих за первичный ключ.
getProp | ( | $offset | ) |
Возвращает объект свойства
|
final |
Возвращает список объектов свойств с установленными значениями
|
protected |
Возвращает Хэш от списка свойств объекта
bool | $is_multiedit | |
string | null | $switch |
getPropertyIterator | ( | ) |
Возвращает объект PropertyIterator, который используется в текущем объекте
getPropertyView | ( | $key, | |
$attributes = [] , |
|||
$view_params = [] |
|||
) |
Возвращет HTML форму одного свойства объекта.
string | $key | - имя свойства |
array | $attributes | - массив с атрибутами для формы |
array | $view_params | - массив с атрибутами для формы [form => true, errors => true], form - только сама форма, errors - форма с ошибками |
string | $class | - список классов |
\SmartyException |
getRightCreate | ( | ) |
Возвращает идентификатор права на создание для данного объекта
getRightDelete | ( | ) |
Возвращает идентификатор права на удаление для данного объекта
getRightRead | ( | ) |
Возвращает идентификатор права на чтение для данного объекта
getRightUpdate | ( | ) |
Возвращает идентификатор права на изменение для данного объекта
getShortAlias | ( | ) |
Возвращает сокращенное наименование orm объекта. Данное имя используется в названиях событий
|
protected |
Возвращает объект хранилища
|
protected |
Возвращает тип движка таблицы БД
getValues | ( | ) |
Возвращает ассоциативный массив свойств и значений текущего объекта
hasError | ( | ) |
Возвращает true, если есть ошибки.
|
protected |
Инициирует поля ORM Объекта
insert | ( | $ignore = false , |
|
$on_duplicate_update_keys = [] , |
|||
$on_duplicate_uniq_fields = [] |
|||
) |
Добавляет объект в хранилище
bool | $ignore | - Если true, то ошибки вставки будут игнорироваться |
array | $on_duplicate_update_keys | - поля, которые необходимо обновить в случае если запись уже существует |
array | $on_duplicate_uniq_fields | - поля, которые точно идетифицируют текущаю запись, для подгрузки id объекта при обновлении |
Event: orm.beforewrite paramtype array index 'orm' => OrmObject index 'flag' => string "insert" | "replace" | "update" index 'on_duplicate_update_keys' => array of string
Event: orm.afterwrite paramtype array index 'orm' => OrmObject index 'flag' => string "insert" | "replace" | "update"
isModified | ( | $property | ) |
Возвращает true, если свойство $property изменено
string | $property | - имя свойства |
issetClassParameter | ( | $key = null | ) |
string | null | $key | - имя параметра |
key | ( | ) |
load | ( | $primaryKeyValue = null | ) |
Загружает объект из хранилища
mixed | $primaryKeyValue | - уникальный идентификатор |
|
static |
Возвращает загруженный объект по условию в случае успеха, иначе вернет пустой экземпляр объекта.
array | string | $expr | выражение WHERE. |
array | $values | массив со значениям, заменит "-КЛЮЧ-" из expr на ЗНАЧЕНИЕ |
string | $prefix | будет подставлено перед текущим выражением AND, OR,... |
string | $in_prefix | будет подставлено между выражениями, в случае если expr - массив AND, OR,... |
next | ( | ) |
noWriteRights | ( | $right = DefaultModuleRights::RIGHT_UPDATE | ) |
Возвращает true, если недостаточно прав на изменение данного объекта.
RSException |
offsetExists | ( | $offset | ) |
Проверяет наличие значения по ключу (ArrayAccess)
$offset | - имя свойства |
offsetGet | ( | $offset | ) |
Возвращает значение по ключу (имени свойства) (ArrayAccess) Если $offset начинается с "__" (двойное подчеркивание), то возвращает объект .....
string | $offset | - имя свойства. |
offsetSet | ( | $offset, | |
$value | |||
) |
Устанавливает значение в свойство (ArrayAccess)
string | $offset | - ключ( имя свойства ) |
mixed | $value | - значение |
offsetUnset | ( | $offset | ) |
Очищает значение свойства
mixed | $offset |
replace | ( | ) |
Заменяет объект в хранилище, если таковой уже имелся, в противном случае вставляет новый объект
Event: orm.beforewrite paramtype array index 'orm' => OrmObject index 'flag' => string "insert" | "replace" | "update"
Event: orm.afterwrite paramtype array index 'orm' => OrmObject index 'flag' => string "insert" | "replace" | "update"
replaceOn | ( | $bool | ) |
Устанавливает режим вставки
boolean | $bool | - если true, то метод save будет использовать для вставки вместо insert - replace. |
rewind | ( | ) |
save | ( | $primaryKeyValue = null , |
|
$user_post = [] , |
|||
$post_var = null , |
|||
$files_var = null |
|||
) |
Сохраняет объект Если передан $primaryKeyValue, то обновляет его свойства, если нет то вставляет новую запись
mixed | $primaryKeyValue |
RSException |
setCheckFields | ( | array | $fields | ) |
Устанавливает, какие поля проверять при вызове checkData
array | $fields |
setClassParameter | ( | $key, | |
$value = null |
|||
) |
string | array | $key | имя параметра или ассоциативный массив параметров и значений |
mixed | $value | значение |
setFormTemplate | ( | $template | ) |
Устанавливает шаблон, который будет использоваться для создания формы
string | $template | - путь к шаблону |
setLocalParameter | ( | $key, | |
$value = null |
|||
) |
Устанавливает параметр для текущего объекта.
string | array | $key | - имя параметра или ассоциативный массив имя => значение |
mixed | $value | - значение параметра |
setPropertyIterator | ( | PropertyIterator | $iterator | ) |
Задает новые свойства для текущего объекта. Применение данного метода накладывает ряд ограничений на последующую работу объекта. К объекту невозможно будет применить сериализацию.
PropertyIterator | $iterator |
setTemporaryId | ( | ) |
Устанавливает объекту отрицательный id
setWriteBit | ( | $n | ) |
integer | $n | - номер бита |
update | ( | $primaryKey = null | ) |
Обновляет объект в хранилище
mixed | $primaryKey | - уникальный идентификатор. Необходимо указывать, если у объекта меняется уникальный идентификатор |
Event: orm.beforewrite paramtype array index 'orm' => OrmObject index 'flag' => string "insert" | "replace" | "update"
Event: orm.afterwrite paramtype array index 'orm' => OrmObject index 'flag' => string "insert" | "replace" | "update"
usePostKeys | ( | array | $keys | ) |
Устанавливает, какие ключи должны приниматься из POST для сохранения объекта
array | $keys |
valid | ( | ) |
validate | ( | ) |
Производит валидацию текущих данных в свойствах
validateData | ( | $flag = self::UPDATE_FLAG | ) |
Проверяет возможность сохранения данных
string | $flag | - флаг опреации с объектом (self::INSERT_FLAG|self::UPDATE_FLAG) |
RSException |
|
protected |
|
protected |
|
protected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
const INDEX_FULLTEXT = 'fulltext' |
const INDEX_KEY = 'index' |
const INDEX_PRIMARY = 'primary key' |
const INDEX_UNIQUE = 'unique' |
const INSERT_FLAG = 'insert' |
const REPLACE_FLAG = 'replace' |
const UPDATE_FLAG = 'update' |