Référence de la classe ExecuteTaskEvent

Graphe d'héritage de ExecuteTaskEvent:

Fonctions membres publiques
	__construct ($name, array $arguments=array())
	setResult (array $snapshot=[])
	getTaskId ()
	getRoutineId ()
	getResultSnapshot ()
Fonctions membres publiques hérités de AbstractEvent
	__construct (string $name, array $arguments=[])
	getArgument ($name, $default=null)
	setArgument ($name, $value)
Fonctions membres publiques hérités de Event
	addArgument ($name, $value)
	setArgument ($name, $value)
	removeArgument ($name)
	clearArguments ()
	stop ()
	offsetSet ($name, $value)
	offsetUnset ($name)
Fonctions membres publiques hérités de AbstractEvent
	__construct ($name, array $arguments=[])
	getName ()
	getArgument ($name, $default=null)
	hasArgument ($name)
	getArguments ()
	isStopped ()
	stopPropagation ()
	count ()
	serialize ()
	__serialize ()
	unserialize ($serialized)
	__unserialize (array $data)
	offsetExists ($name)
	offsetGet ($name)

Membres hérités additionnels
Fonctions membres publiques statiques hérités de AbstractEvent
static	create (string $eventName, array $arguments=[])
Attributs protégés hérités de AbstractEvent
	$name
	$arguments
	$stopped = false

Description détaillée

Event class for onExecuteTask event.

Depuis

4.1.0

Documentation des constructeurs et destructeur

__construct()

__construct	(		$name,
		array	$arguments = array()
	)

Constructor.

Paramètres

string	$name	The event name.
array	$arguments	The event arguments.

Depuis

4.1.0

Exceptions

Références $name, Symfony\Contracts\Service\__construct(), class, et null.

Documentation des fonctions membres

getResultSnapshot()

getResultSnapshot

(

)

Returns the snapshot of the triggered task if available, else an empty array

Renvoie

array The task snapshot if available, else null

Depuis

4.1.0

getRoutineId()

getRoutineId

(

)

Renvoie

string The task's 'type'.

Depuis

4.1.0

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

getTaskId()

getTaskId

(

)

Renvoie

integer The task's taskId.

Depuis

4.1.0

Référencé par Requests\makeGetRequest().

setResult()

setResult

(

array

$snapshot = []

)

Sets the task result snapshot and stops event propagation.

Paramètres

array

$snapshot

The task snapshot.

Renvoie

void

Depuis

4.1.0

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

---

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

• ExecuteTaskEvent.php