Inheritance diagram for CronjobTask:

Collaboration diagram for CronjobTask:

Public Member Functions
	isCore ()

	engage ($last_result, $parameters=[])

	getValue ($field)

	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 ()

Public Member Functions inherited from SimpleORMap
	__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)

	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 ()

Data Fields
	$valid = false

Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

Protected Member Functions
	loadClass ()

Protected Member Functions inherited from SimpleORMap
	_getId ($field)

	_setId ($field, $value)

	_getAdditionalValueFromRelation ($field)

	_setAdditionalValueFromRelation ($field, $value)

	_getAdditionalValue ($field)

	_setAdditionalValue ($field, $value)

	parseRelationOptions ($type, $name, $options)

	storeRelations ($only_these=null)

	deleteRelations ()

	initializeContent ()

	applyCallbacks ($type)

	registerCallback ($types, $cb)

	unregisterCallback ($types, $cb)

	cbAutoIncrementColumn ($type)

	cbAutoKeyCreation ()

	cbNotificationMapper ($cb_type)

	cbAfterInitialize ($cb_type)

	setSerializedValue ($field, $value)

	setI18nValue ($field, $value)

	cbI18N ($type)

Static Protected Member Functions
static	configure ($config=[])

Static Protected Member Functions inherited from SimpleORMap
static	configure ($config=[])

static	config ($key)

Additional Inherited Members
Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)

static	expireTableScheme ()

static	find ($id)

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 ($name, $arguments)

Static Public Attributes inherited from SimpleORMap
static	$schemes = null

Protected Attributes inherited from SimpleORMap
	$content = []

	$content_db = []

	$is_new = true

	$is_deleted = false

	$db_table = ''

	$db_fields = null

	$pk = null

	$default_values = []

	$serialized_fields = []

	$alias_fields = []

	$i18n_fields = []

	$additional_fields = []

	$relations = []

	$has_many = []

	$has_one = []

	$belongs_to = []

	$has_and_belongs_to_many = []

	$registered_callbacks = []

	$known_slots = []

	$notification_map = []

	$additional_data = []

	$getter_setter_map = []

Static Protected Attributes inherited from SimpleORMap
static	$config = []

static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']

Member Function Documentation

◆ configure()

static configure ( $config = [] )

staticprotected

Configures the model.

Parameters

Array $config Optional configuration passed from derived class

Reimplemented from SimpleORMap.

◆ engage()

engage	(	$last_result,
		$parameters = `[]`
	)

Executes the task.

Parameters

String	$last_result	Result of last executions
Array	$parameters	Parameters to pass to the task

Here is the call graph for this function:

◆ extractDefaultParameters()

extractDefaultParameters ( )

Extracts the default parameter values from the associated task.

Returns: array

Here is the caller graph for this function:

◆ getValue()

getValue ( $field )

Proxy the static methods "getDescription", "getName" and "getParameters" from the task class.

Parameters

String $field Field which should be accessed.

Returns: String Value of the method call

Reimplemented from SimpleORMap.

Here is the call graph for this function:

◆ isCore()

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()

loadClass ( )

protected

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()

scheduleOnce	(	$timestamp,
		$priority = `CronjobSchedule::PRIORITY_NORMAL`,
		$parameters = `[]`
	)

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.

Here is the call graph for this function:

◆ 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.

Here is the call graph for this function:

Field Documentation

◆ $valid

$valid = false

The documentation for this class was generated from the following file:

lib/models/CronjobTask.class.php

Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ configure()

◆ engage()

◆ extractDefaultParameters()

◆ getValue()

◆ isCore()

◆ loadClass()

◆ scheduleOnce()

◆ schedulePeriodic()

Field Documentation

◆ $valid