ModulePluginManager_EntityUpdate
Package | framework.modules |
---|---|
Inheritance | abstract class ModulePluginManager_EntityUpdate » EntityORM » Entity » LsObject |
Since | 2.0 |
Source Code | /framework/classes/modules/plugin_manager/entity/Update.entity.class.php |
От этого класса необходимо наследовать классы апдейтов/миграций плагина
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
_aBehaviors | Список поведений в виде готовых объектов, формируется автоматически | LsObject | |
_aData | array | Данные сущности, на этот массив мапятся методы set* и get* | Entity |
_aManyToManyRelations | array | Объекты связей many_to_many | EntityORM |
_aOriginalData | array | Массив исходных данных сущности | EntityORM |
aBehaviors | array | Список поведений | LsObject |
aFields | array | Список полей таблицы сущности | EntityORM |
aRelations | array | Список связей | EntityORM |
aRelationsData | array | Список данных связей | EntityORM |
aValidateErrors | array | Список ошибок валидации в разрезе полей, например | Entity |
aValidateRules | array | Список правил валидации полей | Entity |
bIsNew | bool | Флаг новая или нет сущность | EntityORM |
sPrimaryKey | null|string | Имя поля с первичным ключом в БД | Entity |
sValidateScenario | string | Сценарий валиадции полей | Entity |
Public Methods
Method | Description | Defined By |
---|---|---|
Add() | Добавление сущности в БД | EntityORM |
AddBehaviorHook() | Добавляет хук поведения | LsObject |
AttachBehavior() | Присоединяет поведение к объекту | LsObject |
Delete() | Удаление сущности из БД | EntityORM |
DetachBehavior() | Отсоединяет поведение от объекта | LsObject |
GetBehavior() | Возвращает объект поведения по его имени | LsObject |
GetBehaviors() | Возвращает все объекты поведения | LsObject |
Init() | Метод инициализации сущности, вызывается при её создании | Entity |
Reload() | Обновляет данные сущности из БД | EntityORM |
RemoveBehaviorHook() | Удаляет хук поведения | LsObject |
RunBehaviorHook() | Запускает хук поведения на выполнение | LsObject |
Save() | Сохранение сущности в БД (если новая то создается) | EntityORM |
ShowColumns() | Возвращает список полей сущности | EntityORM |
ShowPrimaryIndex() | Возвращает primary индекс сущности | EntityORM |
Update() | Обновление сущности в БД | EntityORM |
_SetIsNew() | Установка флага "новая" | EntityORM |
_Validate() | Выполняет валидацию данных сущности | Entity |
__call() | Ставим хук на вызов неизвестного метода и считаем что хотели вызвать метод какого либо модуля | EntityORM |
__clone() | При клонировании сбрасываем поведения | LsObject |
__construct() | Установка связей | EntityORM |
__get() | Используется для доступа к связанным данным типа MANY_TO_MANY | EntityORM |
_addValidateError() | Добавляет для поля ошибку в список ошибок | Entity |
_clearValidateErrors() | Очищает список всех ошибок или для конкретного поля | Entity |
_createValidators() | Создает и возвращает список валидаторов для сущности | Entity |
_getData() | Получает массив данных сущности | Entity |
_getDataArray() | Рекурсивное преобразование объекта и вложенных объектов в массив | Entity |
_getDataFields() | Возвращает данные для списка полей сущности | EntityORM |
_getDataOne() | Возвращает данные по конкретному полю | Entity |
_getField() | Возвращает поле в нужном формате | EntityORM |
_getFields() | Возвращает список полей сущности | EntityORM |
_getManyToManyRelationEntity() | Возвращает сущность связи при many to many | EntityORM |
_getOriginalData() | Возвращает все данные сущности | EntityORM |
_getOriginalDataOne() | Возвращает "оригинальные" данные по конкретному полю | EntityORM |
_getPrimaryKey() | Получение primary key из схемы таблицы | EntityORM |
_getPrimaryKeyValue() | Получение значения primary key | EntityORM |
_getRelations() | Возвращает список связей | EntityORM |
_getRelationsData() | Возвращает список данный связей | EntityORM |
_getTreeParentKey() | Получение имени родительского поля. Используется в связи RELATION_TYPE_TREE | EntityORM |
_getTreeParentKeyValue() | Получение значения родителя. Используется в связи RELATION_TYPE_TREE | EntityORM |
_getValidateError() | Возвращает первую ошибку для поля или среди всех полей | Entity |
_getValidateErrors() | Возвращает список ошибок для всех полей или одного поля | Entity |
_getValidateRules() | Возвращает список правил для валидации | Entity |
_getValidateScenario() | Возвращает текущий сценарий валидации | Entity |
_getValidators() | Возвращает список валидаторов с учетом текущего сценария | Entity |
_hasValidateErrors() | Проверяет есть ли ошибки валидации | Entity |
_isNew() | Новая или нет сущность | EntityORM |
_setData() | Устанавливает данные сущности | EntityORM |
_setDataSafe() | Устанавливает данные, но только те, которые есть в $this->aValidateRules | Entity |
_setManyToManyRelations() | Устанавливает вспомогательные объекты для связи many_to_many | EntityORM |
_setRelationsData() | Устанавливает данные связей | EntityORM |
_setValidateScenario() | Устанавливает сценарий валидации | Entity |
down() | Выполняется при откате версии | ModulePluginManager_EntityUpdate |
getAncestors() | Для сущности со связью RELATION_TYPE_TREE возвращает список всех предков | EntityORM |
getChildren() | Для сущности со связью RELATION_TYPE_TREE возвращает список прямых потомков | EntityORM |
getDescendants() | Для сущности со связью RELATION_TYPE_TREE возвращает список всех потомков | EntityORM |
getParent() | Для сущности со связью RELATION_TYPE_TREE возвращает предка | EntityORM |
resetRelationsData() | Сбрасывает данные необходимой связи | EntityORM |
setAncestors() | Для сущности со связью RELATION_TYPE_TREE устанавливает предков | EntityORM |
setChildren() | Для сущности со связью RELATION_TYPE_TREE устанавливает потомков | EntityORM |
setDescendants() | Для сущности со связью RELATION_TYPE_TREE устанавливает потомков | EntityORM |
setParent() | Для сущности со связью RELATION_TYPE_TREE устанавливает предка | EntityORM |
up() | Выполняется при обновлении версии | ModulePluginManager_EntityUpdate |
Protected Methods
Method | Description | Defined By |
---|---|---|
PrepareBehaviors() | Инициализация поведений | LsObject |
_Method() | Проксирует вызов методов в модуль сущности | EntityORM |
addEnumType() | Добавляет новый тип в поле enum(перечисление) | ModulePluginManager_EntityUpdate |
afterDelete() | Хук, срабатывает после удаления сущности | EntityORM |
afterSave() | Хук, срабатывает после сохранением сущности | EntityORM |
beforeDelete() | Хук, срабатывает перед удалением сущности | EntityORM |
beforeSave() | Хук, срабатывает перед сохранением сущности | EntityORM |
exportSQL() | Транслирует на базу данных запросы из указанного файла | ModulePluginManager_EntityUpdate |
exportSQLQuery() | Выполняет SQL | ModulePluginManager_EntityUpdate |
isFieldExists() | Проверяет наличие поля в таблице | ModulePluginManager_EntityUpdate |
isTableExists() | Проверяет наличие таблицы в БД | ModulePluginManager_EntityUpdate |
Method Details
addEnumType()
method
protected void addEnumType(string $sTableName, string $sFieldName, string $sType)
| ||
$sTableName | string | Название таблицы, необходимо перед именем таблицы добавлять "prefix_", это позволит учитывать произвольный префикс таблиц у пользователя |
$sFieldName | string | Название поля в таблице |
$sType | string | Название типа |
Source Code: /framework/classes/modules/plugin_manager/entity/Update.entity.class.php#106 (show)
protected function addEnumType($sTableName, $sFieldName, $sType)
{
$this->Database_addEnumType($sTableName, $sFieldName, $sType);
}
Добавляет новый тип в поле enum(перечисление)
See Also
down()
method
public void down()
|
Source Code: /framework/classes/modules/plugin_manager/entity/Update.entity.class.php#41 (show)
public function down()
{
}
Выполняется при откате версии
exportSQL()
method
protected array exportSQL(string $sFilePath)
| ||
$sFilePath | string | Полный путь до файла с SQL |
{return} | array |
Source Code: /framework/classes/modules/plugin_manager/entity/Update.entity.class.php#53 (show)
protected function exportSQL($sFilePath)
{
return $this->Database_ExportSQL($sFilePath);
}
Транслирует на базу данных запросы из указанного файла
See Also
exportSQLQuery()
method
protected array exportSQLQuery(string $sSql)
| ||
$sSql | string | Строка SQL запроса |
{return} | array |
Source Code: /framework/classes/modules/plugin_manager/entity/Update.entity.class.php#65 (show)
protected function exportSQLQuery($sSql)
{
return $this->Database_ExportSQLQuery($sSql);
}
Выполняет SQL
See Also
isFieldExists()
method
protected bool isFieldExists(string $sTableName, string $sFieldName)
| ||
$sTableName | string | Название таблицы, необходимо перед именем таблицы добавлять "prefix_", это позволит учитывать произвольный префикс таблиц у пользователя |
$sFieldName | string | Название поля в таблице |
{return} | bool |
Source Code: /framework/classes/modules/plugin_manager/entity/Update.entity.class.php#93 (show)
protected function isFieldExists($sTableName, $sFieldName)
{
return $this->Database_isFieldExists($sTableName, $sFieldName);
}
Проверяет наличие поля в таблице
See Also
isTableExists()
method
protected bool isTableExists(string $sTableName)
| ||
$sTableName | string | Название таблицы, необходимо перед именем таблицы добавлять "prefix_", это позволит учитывать произвольный префикс таблиц у пользователя
prefix_topic |
{return} | bool |
Source Code: /framework/classes/modules/plugin_manager/entity/Update.entity.class.php#80 (show)
protected function isTableExists($sTableName)
{
return $this->Database_isTableExists($sTableName);
}
Проверяет наличие таблицы в БД
See Also
up()
method
public void up()
|
Source Code: /framework/classes/modules/plugin_manager/entity/Update.entity.class.php#33 (show)
public function up()
{
}
Выполняется при обновлении версии