Référence de la classe Scheduler

Fonctions membres publiques
	fetchTaskRecord (int $id=0, bool $allowDisabled=false)

Champs de données
const	TASK_QUEUE_FILTERS
const const	TASK_QUEUE_LIST_CONFIG

Fonctions membres protégées
	configureTaskRunnerOptions (OptionsResolver $resolver)

Attributs privés
const	LOG_TEXT

Description détaillée

The Scheduler class provides the core functionality of ComScheduler. Currently, this includes fetching scheduled tasks from the database and execution of any or the next due task. It is planned that this class is extended with C[R]UD methods for scheduled tasks.

Depuis

4.1.0

Documentation des fonctions membres

configureTaskRunnerOptions()

configureTaskRunnerOptions ( OptionsResolver  $resolver )

protected

Set up an {

Voir également

OptionsResolver} to resolve options compatible with {

runTask}.

Paramètres

OptionsResolver

$resolver

The {

Voir également

OptionsResolver} instance to set up.

Renvoie

void

Depuis

4.1.0

Exceptions

AccessException

Références OptionsResolver\setDefaults().

fetchTaskRecord()

fetchTaskRecord	(	int	$id = 0,
		bool	$allowDisabled = false
	)

Fetches a single scheduled task in a Task instance. If no id or title is specified, a due task is returned.

Paramètres

int	$id	The task ID.
bool	$allowDisabled	Allow disabled/trashed tasks?

Renvoie

?object A matching task record, if it exists

Depuis

4.1.0

Exceptions

Références $filters, $id, et null.

Documentation des champs

LOG_TEXT

const LOG_TEXT

private

Valeur initiale :

= [
        Status::OK          => 'COM_SCHEDULER_SCHEDULER_TASK_COMPLETE'

TASK_QUEUE_FILTERS

const TASK_QUEUE_FILTERS

Valeur initiale :

= [
        'due'    => 1

Filters for the task queue. Can be used with fetchTaskRecords().

Depuis

4.1.0

TASK_QUEUE_LIST_CONFIG

const const TASK_QUEUE_LIST_CONFIG

Valeur initiale :

= [
        'multi_ordering' => ['a.priority DESC ', 'a.next_execution ASC']

List config for the task queue. Can be used with fetchTaskRecords().

Depuis

4.1.0

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Scheduler.php