Joomla CMS
4.2.2
Documentation des API du CMS Joomla en version 4.2.2
|
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 |
A namespace mapping Task statuses to integer values.
const INVALID_EXIT = -2 |
Replacement exit code used when a routine returns an invalid (non-integer) exit code.
Référencé par Joomla\Component\Scheduler\Administrator\Traits\standardRoutineHandler().
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 ?
Référencé par SiteStatus\writeConfigFile().
const NO_EXIT = -1 |
Replacement exit code used when a routine does not return an exit code.
Référencé par Joomla\Component\Scheduler\Administrator\Traits\standardRoutineHandler().
const NO_LOCK = 2 |
Exit code used on failure to acquire a pseudo-lock.
const NO_RELEASE = 4 |
Exit code used on failure to release lock/update the record.
const NO_ROUTINE = 127 |
const NO_RUN = 3 |
Exit code used on failure to run the task.
Référencé par TasksRunCommand\doExecute(), et Joomla\Component\Scheduler\Administrator\Traits\standardRoutineHandler().
const NO_TASK = 125 |
const OK = 0 |
Exit code on success.
Référencé par TasksRunCommand\doExecute(), Joomla\Component\Scheduler\Administrator\Traits\endRoutine(), Task\isSuccess(), DemoTasks\sleep(), DemoTasks\stressMemory(), et SiteStatus\writeConfigFile().
const RUNNING = 1 |
Status code used when the routine just starts. This is not meant to be an exit code.
Référencé par Joomla\Component\Scheduler\Administrator\Traits\startRoutine().
const TIMEOUT = 124 |
Exit code used when a task times out.
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.
Référencé par TasksRunCommand\doExecute(), et Task\isSuccess().