|
| isCore () |
|
| engage ($last_result, $parameters=[]) |
|
| scheduleOnce ($timestamp, $priority=CronjobSchedule::PRIORITY_NORMAL, $parameters=[]) |
|
| schedulePeriodic ($minute=null, $hour=null, $day=null, $month=null, $day_of_week=null, $priority=CronjobSchedule::PRIORITY_NORMAL, $parameters=[]) |
|
| extractDefaultParameters () |
|
| __construct ($id=null) |
|
| __clone () |
|
| getRelationOptions ($relation) |
|
| getTableMetadata () |
|
| hasAutoIncrementColumn () |
|
| setId ($id) |
|
| getId () |
|
| getNewId () |
|
| toArray ($only_these_fields=null) |
|
| toRawArray ($only_these_fields=null) |
|
| toArrayRecursive ($only_these_fields=null) |
|
| getValue ($field) |
|
| getRelationValue ($relation, $field) |
|
| getDefaultValue ($field) |
|
| setValue ($field, $value) |
|
| __get ($field) |
|
| __set ($field, $value) |
|
| __isset ($field) |
|
| offsetExists ($offset) |
|
| offsetGet ($offset) |
|
| offsetSet ($offset, $value) |
|
| offsetUnset ($offset) |
|
| getIterator () |
|
| count () |
|
| isField ($field) |
|
| isRelation ($field) |
|
| isAdditionalField ($field) |
|
| isAliasField ($field) |
|
| isI18nField ($field) |
|
| setData ($data, $reset=false) |
|
| isNew () |
|
| isDeleted () |
|
| setNew ($is_new) |
|
| getWhereQuery () |
|
| restore () |
|
| store () |
|
| triggerChdate () |
|
| delete () |
|
| isDirty () |
|
| isFieldDirty ($field) |
|
| revertValue ($field) |
|
| getPristineValue ($field) |
|
| initRelation ($relation) |
|
| resetRelation ($relation) |
|
| cleanup () |
|
|
static | tableScheme ($db_table) |
|
static | expireTableScheme () |
|
static | exists ($id) |
|
static | countBySql ($sql='1', $params=[]) |
|
static | create ($data) |
|
static | build ($data, $is_new=true) |
|
static | buildExisting ($data) |
|
static | import ($data) |
|
static | findBySQL ($sql, $params=[]) |
|
static | findOneBySQL ($where, $params=[]) |
|
static | findThru ($foreign_key_value, $options) |
|
static | findEachBySQL ($callable, $sql, $params=[]) |
|
static | findMany ($pks=[], $order='', $order_params=[]) |
|
static | findEachMany ($callable, $pks=[], $order='', $order_params=[]) |
|
static | findAndMapBySQL ($callable, $where, $params=[]) |
|
static | findAndMapMany ($callable, $pks=[], $order='', $order_params=[]) |
|
static | deleteBySQL ($where, $params=[]) |
|
static | toObject ($id_or_object) |
|
static | __callStatic (string $name, array $arguments) |
|
static | $schemes = null |
|
| $content = [] |
|
| $content_db = [] |
|
| $is_new = true |
|
| $is_deleted = false |
|
| $relations = [] |
|
| $additional_data = [] |
|
static | $config = [] |
|
static | $reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id'] |
|
static | $performs_batch_operation = false |
|
◆ configure()
static configure |
( |
|
$config = [] | ) |
|
|
staticprotected |
Configures the model.
- Parameters
-
Array | $config | Optional configuration passed from derived class |
◆ engage()
engage |
( |
|
$last_result, |
|
|
|
$parameters = [] |
|
) |
| |
Executes the task.
- Parameters
-
String | $last_result | Result of last executions |
Array | $parameters | Parameters to pass to the task |
◆ extractDefaultParameters()
extractDefaultParameters |
( |
| ) |
|
Extracts the default parameter values from the associated task.
- Returns
- array
◆ isCore()
Returns whether the task is defined in the core system or via a plugin.
- Returns
- bool True if task is defined in core system
◆ loadClass()
Tries to load the underlying php class. This also determines the valid state of the task. If the class does not exists, the task is marked as not valid.
◆ scheduleOnce()
Schedules this task for a single execution at the provided time.
- Parameters
-
int | $timestamp | When the task should be executed |
String | $priority | Priority of the execution (low, normal, high), defaults to normal |
Array | $parameters | Optional parameters passed to the task |
- Returns
- CronjobSchedule The generated schedule object.
◆ schedulePeriodic()
schedulePeriodic |
( |
|
$minute = null , |
|
|
|
$hour = null , |
|
|
|
$day = null , |
|
|
|
$month = null , |
|
|
|
$day_of_week = null , |
|
|
|
$priority = CronjobSchedule::PRIORITY_NORMAL , |
|
|
|
$parameters = [] |
|
) |
| |
Schedules this task for periodic execution with the provided schedule.
- Parameters
-
mixed | $minute | Minute part of the schedule:
- null for "every minute" a.k.a. "don't care"
- x < 0 for "every x minutes"
- x >= 0 for "only at minute x"
|
mixed | $hour | Hour part of the schedule:
- null for "every hour" a.k.a. "don't care"
- x < 0 for "every x hours"
- x >= 0 for "only at hour x"
|
mixed | $day | Day part of the schedule:
- null for "every day" a.k.a. "don't care"
- x < 0 for "every x days"
- x > 0 for "only at day x"
|
mixed | $month | Month part of the schedule:
- null for "every month" a.k.a. "don't care"
- x < 0 for "every x months"
- x > 0 for "only at month x"
|
mixed | $day_of_week | Day of week part of the schedule:
- null for "every day" a.k.a. "don't care"
- 1 >= x >= 7 for "exactly at day of week x" (x starts with monday at 1 and ends with sunday at 7)
|
String | $priority | Priority of the execution (low, normal, high), defaults to normal |
Array | $parameters | Optional parameters passed to the task |
- Returns
- CronjobSchedule The generated schedule object.
◆ $valid
The documentation for this class was generated from the following file: