ModuleCron_EntityTask
Package | framework.modules |
---|---|
Inheritance | class ModuleCron_EntityTask » EntityORM » Entity » LsObject |
Since | 2.0 |
Source Code | /framework/classes/modules/cron/entity/Task.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 | Определяем правила валидации | ModuleCron_EntityTask |
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 |
ValidateMethodCheck() | ModuleCron_EntityTask | |
ValidatePluginCheck() | ModuleCron_EntityTask | |
ValidateStateCheck() | ModuleCron_EntityTask | |
ValidateTitleCheck() | ModuleCron_EntityTask | |
_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 |
beforeRun() | Выполняется перед запуском задачи | ModuleCron_EntityTask |
getAncestors() | Для сущности со связью RELATION_TYPE_TREE возвращает список всех предков | EntityORM |
getChildren() | Для сущности со связью RELATION_TYPE_TREE возвращает список прямых потомков | EntityORM |
getDescendants() | Для сущности со связью RELATION_TYPE_TREE возвращает список всех потомков | EntityORM |
getParent() | Для сущности со связью RELATION_TYPE_TREE возвращает предка | EntityORM |
getTitleWithLang() | Возвращает заголовок задачи, считая, что в поле содержится языковой код текстовки | ModuleCron_EntityTask |
resetRelationsData() | Сбрасывает данные необходимой связи | EntityORM |
run() | Запускает задачу на выполнение | ModuleCron_EntityTask |
setAncestors() | Для сущности со связью RELATION_TYPE_TREE устанавливает предков | EntityORM |
setChildren() | Для сущности со связью RELATION_TYPE_TREE устанавливает потомков | EntityORM |
setDescendants() | Для сущности со связью RELATION_TYPE_TREE устанавливает потомков | EntityORM |
setParent() | Для сущности со связью RELATION_TYPE_TREE устанавливает предка | EntityORM |
Protected Methods
Method | Description | Defined By |
---|---|---|
PrepareBehaviors() | Инициализация поведений | LsObject |
_Method() | Проксирует вызов методов в модуль сущности | EntityORM |
afterDelete() | Хук, срабатывает после удаления сущности | EntityORM |
afterSave() | Хук, срабатывает после сохранением сущности | EntityORM |
beforeDelete() | Хук, срабатывает перед удалением сущности | EntityORM |
beforeSave() | Выполняется перед сохранением | ModuleCron_EntityTask |
Property Details
aValidateRules
property
protected array $aValidateRules;
Определяем правила валидации
Method Details
ValidateMethodCheck()
method
public void ValidateMethodCheck()
|
Source Code: /framework/classes/modules/cron/entity/Task.entity.class.php#69 (show)
public function ValidateMethodCheck()
{
if (!$this->_hasValidateErrors()) {
$this->setMethod(htmlspecialchars($this->getMethod()));
}
return true;
}
ValidatePluginCheck()
method
public void ValidatePluginCheck()
|
Source Code: /framework/classes/modules/cron/entity/Task.entity.class.php#77 (show)
public function ValidatePluginCheck()
{
if (!$this->_hasValidateErrors() and $this->getPlugin()) {
$this->setPlugin(htmlspecialchars($this->getPlugin()));
}
return true;
}
ValidateStateCheck()
method
public void ValidateStateCheck($sValue, $aParams)
| ||
$sValue | ||
$aParams |
Source Code: /framework/classes/modules/cron/entity/Task.entity.class.php#85 (show)
public function ValidateStateCheck($sValue, $aParams)
{
$this->setState($this->getState() == ModuleCron::TASK_STATE_ACTIVE ? ModuleCron::TASK_STATE_ACTIVE : ModuleCron::TASK_STATE_NOT_ACTIVE);
return true;
}
ValidateTitleCheck()
method
public void ValidateTitleCheck()
|
Source Code: /framework/classes/modules/cron/entity/Task.entity.class.php#61 (show)
public function ValidateTitleCheck()
{
if (!$this->_hasValidateErrors()) {
$this->setTitle(htmlspecialchars($this->getTitle()));
}
return true;
}
beforeRun()
method
public void beforeRun($bFork $bFork)
| ||
$bFork | $bFork |
Source Code: /framework/classes/modules/cron/entity/Task.entity.class.php#118 (show)
public function beforeRun($bFork)
{
}
Выполняется перед запуском задачи В этом методе должна быть реализованна логика по инициализации окружения для выполнения задачи, например, при $bFork=true нужно убедиться в корректности ресурсов, таких как подключение к БД и т.п.
beforeSave()
method
protected bool beforeSave()
| ||
{return} | bool |
Source Code: /framework/classes/modules/cron/entity/Task.entity.class.php#51 (show)
protected function beforeSave()
{
if ($bResult = parent::beforeSave()) {
if ($this->_isNew()) {
$this->setDateCreate(date("Y-m-d H:i:s"));
}
}
return $bResult;
}
Выполняется перед сохранением
getTitleWithLang()
method
public string getTitleWithLang()
| ||
{return} | string |
Source Code: /framework/classes/modules/cron/entity/Task.entity.class.php#96 (show)
public function getTitleWithLang()
{
return $this->Lang_Get($this->getTitle());
}
Возвращает заголовок задачи, считая, что в поле содержится языковой код текстовки
run()
method
public mixed run()
| ||
{return} | mixed |
Source Code: /framework/classes/modules/cron/entity/Task.entity.class.php#106 (show)
public function run()
{
return $this->Cron_RunTask($this);
}
Запускает задачу на выполнение