Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe Status

Champs de données

const INVALID_EXIT = -2
 
const NO_EXIT = -1
 
const RUNNING = 1
 
const NO_LOCK = 2
 
const NO_RUN = 3
 
const NO_RELEASE = 4
 
const KNOCKOUT = 5
 
const WILL_RESUME = 123
 
const TIMEOUT = 124
 
const NO_TASK = 125
 
const NO_ROUTINE = 127
 
const OK = 0
 

Description détaillée

A namespace mapping Task statuses to integer values.

Depuis
4.1.0

Documentation des champs

◆ INVALID_EXIT

const INVALID_EXIT = -2

Replacement exit code used when a routine returns an invalid (non-integer) exit code.

Depuis
4.1.0

Référencé par Joomla\Component\Scheduler\Administrator\Traits\standardRoutineHandler().

◆ KNOCKOUT

const KNOCKOUT = 5

Exit code used when a routine is either "knocked out" by an exception or encounters an exception it cannot handle gracefully. ? Should this be retained ?

Depuis
4.1.0

Référencé par SiteStatus\writeConfigFile().

◆ NO_EXIT

const NO_EXIT = -1

Replacement exit code used when a routine does not return an exit code.

Depuis
4.1.0

Référencé par Joomla\Component\Scheduler\Administrator\Traits\standardRoutineHandler().

◆ NO_LOCK

const NO_LOCK = 2

Exit code used on failure to acquire a pseudo-lock.

Depuis
4.1.0

◆ NO_RELEASE

const NO_RELEASE = 4

Exit code used on failure to release lock/update the record.

Depuis
4.1.0

◆ NO_ROUTINE

const NO_ROUTINE = 127

Exit code used when a routine is missing.

Depuis
4.1.0

Référencé par TasksRunCommand\doExecute().

◆ NO_RUN

const NO_RUN = 3

Exit code used on failure to run the task.

Depuis
4.1.0

Référencé par TasksRunCommand\doExecute(), et Joomla\Component\Scheduler\Administrator\Traits\standardRoutineHandler().

◆ NO_TASK

const NO_TASK = 125

Exit code when a task does not exist.

Depuis
4.1.0

Référencé par TasksRunCommand\doExecute().

◆ OK

◆ RUNNING

const RUNNING = 1

Status code used when the routine just starts. This is not meant to be an exit code.

Depuis
4.1.0

Référencé par Joomla\Component\Scheduler\Administrator\Traits\startRoutine().

◆ TIMEOUT

const TIMEOUT = 124

Exit code used when a task times out.

Depuis
4.1.0

◆ WILL_RESUME

const WILL_RESUME = 123

Exit code used when a task needs to resume (reschedule it to run a.s.a.p.).

Use this for long running tasks, e.g. batch processing of hundreds or thousands of files, sending newsletters with thousands of subscribers etc. These are tasks which might run out of memory and/or hit a time limit when lazy scheduling or web triggering of tasks is being used. Split them into smaller batches which return Status::WILL_RESUME. When the last batch is executed return Status::OK.

Depuis
4.1.0

Référencé par TasksRunCommand\doExecute(), et Task\isSuccess().


La documentation de cette classe a été générée à partir des fichiers suivants :