Référence de l'interface EventInterface

Graphe d'héritage de EventInterface:

Fonctions membres publiques
	getArgument ($name, $default=null)
	getName ()
	isStopped ()
	stopPropagation ()

Description détaillée

Interface for events. An event has a name and its propagation can be stopped.

Depuis

1.0

Documentation des fonctions membres

getArgument()

getArgument	(		$name,
			$default = null
	)

Get an event argument value.

Paramètres

string	$name	The argument name.
mixed	$default	The default value if not found.

Renvoie

mixed The argument value or the default value.

Depuis

2.0.0

Implémenté dans AbstractEvent, et AbstractEvent.

Référencé par Joomla\Component\Scheduler\Administrator\Traits\advertiseRoutines(), PlgWorkflowPublishing\onContentBeforeChangeState(), PlgWorkflowNotification\onContentPrepareForm(), PlgWorkflowPublishing\onContentPrepareForm(), PlgWorkflowFeaturing\onContentPrepareForm(), PlgWorkflowFeaturing\onContentVersioningPrepareTable(), et PlgWorkflowPublishing\onContentVersioningPrepareTable().

getName()

getName

(

)

Get the event name.

Renvoie

string The event name.

Depuis

1.0

Implémenté dans AbstractEvent.

Référencé par Dispatcher\addEvent(), AbstractView\dispatchEvent(), BaseDatabaseModel\dispatchEvent(), DatabaseDriver\dispatchEvent(), et Dispatcher\setEvent().

isStopped()

isStopped

(

)

Tell if the event propagation is stopped.

Renvoie

boolean True if stopped, false otherwise.

Depuis

1.0

Implémenté dans AbstractEvent.

stopPropagation()

stopPropagation

(

)

Stops the propagation of the event to further event listeners.

Renvoie

void

Depuis

2.0.0

Implémenté dans AbstractEvent.

---

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

• EventInterface.php