Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe Task
+ Graphe d'héritage de Task:

Fonctions membres publiques

 __construct (object $record)
 
 getRecord ()
 
 getContent ()
 
 acquireLock ()
 
 releaseLock (bool $update=true)
 
 log (string $message, string $priority='info')
 
 skipExecution ()
 
 isSuccess ()
 
 get (string $path, $default=null)
 
- Fonctions membres publiques hérités de LoggerAwareInterface
 setLogger (LoggerInterface $logger)
 

Fonctions membres publiques statiques

static isValidState (string $state)
 
static isValidId (string $id)
 

Champs de données

const STATE_ENABLED = 1
 
const STATE_DISABLED = 0
 
const STATE_TRASHED = -2
 
const STATE_MAP
 
 $logCategory
 

Fonctions membres protégées

 dispatchExitEvent ()
 
 set (string $path, $value, string $separator=null)
 

Attributs protégés

 $snapshot = []
 
 $taskRegistry
 
 $app
 
 $db
 
const EVENTS_MAP
 

Description détaillée

The Task class defines methods for the execution, logging and related properties of Tasks as supported by com_scheduler, a Task Scheduling component.

Depuis
4.1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( object  $record)

Constructor for {

Voir également
Task}.
Paramètres
object$recordA task from {
Voir également
TaskTable}.
Depuis
4.1.0
Exceptions

Références $options, Log\addLogger(), Log\ALL, class, Log\createDelegatedLogger(), Factory\getApplication(), Factory\getContainer(), et Psr\Log\setLogger().

Documentation des fonctions membres

◆ acquireLock()

acquireLock ( )

Acquire a pseudo-lock on the task record. ! At the moment, this method is not used anywhere as task locks are already acquired when they're fetched. As such this method is not functional and should not be reviewed until it is updated.

Renvoie
boolean
Depuis
4.1.0
Exceptions

Références $db, $id, $now, $query, Factory\getDate(), ComponentHelper\getParams(), et ParameterType\INTEGER.

◆ dispatchExitEvent()

dispatchExitEvent ( )
protected

Handles task exit (dispatch event).

Renvoie
void
Depuis
4.1.0
Exceptions

Références $this, et AbstractEvent\create().

◆ get()

get ( string  $path,
  $default = null 
)

Get a task property. This method is a proxy to {

Voir également
Registry::get()}.
Paramètres
string$pathRegistry path of the task property.
mixed$defaultDefault property to return, if the actual value is null.
Renvoie
mixed The task property.
Depuis
4.1.0

Références $default, et $path.

◆ getContent()

getContent ( )

Get the task execution snapshot. ! Access locations will need updates once a more robust Snapshot container is implemented.

Renvoie
array
Depuis
4.1.0

◆ getRecord()

getRecord ( )

Get the task as a data object that can be stored back in the database. ! This method should be removed or changed as part of a better API implementation for the driver.

Renvoie
object
Depuis
4.1.0

◆ isSuccess()

isSuccess ( )

Was the task successful?

Renvoie
boolean True if the task was successful.
Depuis
4.1.0

Références null, Status\OK, et Status\WILL_RESUME.

◆ isValidId()

static isValidId ( string  $id)
static

Static method to determine whether a task id is valid. Note that this does not validate ids against the database, but only verifies that an id may exist.

Paramètres
string$idThe task id (as a string).
Renvoie
boolean
Depuis
4.1.0

Références $id.

◆ isValidState()

static isValidState ( string  $state)
static

Static method to determine whether an enumerated task state (as a string) is valid.

Paramètres
string$stateThe task state (enumerated, as a string).
Renvoie
boolean
Depuis
4.1.0

Références $state, ArrayHelper\getValue(), et null.

◆ log()

log ( string  $message,
string  $priority = 'info' 
)
Paramètres
string$messageLog message
string$priorityLog level, defaults to 'info'
Renvoie
void
Depuis
4.1.0
Exceptions
InvalidArgumentException

Références $message.

◆ releaseLock()

releaseLock ( bool  $update = true)

Remove the pseudo-lock and optionally update the task record.

Paramètres
bool$updateIf true, the record is updated with the snapshot
Renvoie
boolean
Depuis
4.1.0
Exceptions

Références $db, $id, $query, ParameterType\INTEGER, et null.

◆ set()

set ( string  $path,
  $value,
string  $separator = null 
)
protected

Set a task property. This method is a proxy to {

Voir également
Registry::set()}.
Paramètres
string$pathRegistry path of the task property.
mixed$valueThe value to set to the property.
?string$separator The key separator.
Renvoie
mixed|null
Depuis
4.1.0

Références $path, $separator, et $value.

◆ skipExecution()

skipExecution ( )

Advance the task entry's next calculated execution, effectively skipping the current execution.

Renvoie
void
Depuis
4.1.0
Exceptions

Références $db, $id, et $query.

Documentation des champs

◆ $app

$app
protected

◆ $db

$db
protected

◆ $logCategory

$logCategory

◆ $snapshot

$snapshot = []
protected

◆ $taskRegistry

$taskRegistry
protected

◆ EVENTS_MAP

const EVENTS_MAP
protected
Valeur initiale :
= [
Status::OK => 'onTaskExecuteSuccess'

◆ STATE_DISABLED

const STATE_DISABLED = 0

Enumerated state for disabled tasks.

Depuis
4.1.0

◆ STATE_ENABLED

const STATE_ENABLED = 1

Enumerated state for enabled tasks.

Depuis
4.1.0

◆ STATE_MAP

const STATE_MAP
Valeur initiale :
= [
self::STATE_TRASHED => 'trashed'

Map state enumerations to logical language adjectives.

Depuis
4.1.0

◆ STATE_TRASHED

const STATE_TRASHED = -2

Enumerated state for trashed tasks.

Depuis
4.1.0

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