Référence de la classe AbstractEvent

Graphe d'héritage de AbstractEvent:

Fonctions membres publiques
	__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)

Attributs protégés
	$name
	$arguments
	$stopped = false

Description détaillée

Implementation of EventInterface.

Depuis

1.0

Documentation des constructeurs et destructeur

__construct()

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

Constructor.

Paramètres

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

Depuis

1.0

Références AbstractEvent\$arguments, AbstractEvent\$name, et name.

Documentation des fonctions membres

__serialize()

__serialize

(

)

Serialize the event.

Renvoie

array The data to be serialized

Depuis

2.0.0

Références AbstractEvent\$arguments, AbstractEvent\$name, et AbstractEvent\$stopped.

Référencé par AbstractEvent\serialize().

__unserialize()

__unserialize

(

array

$data

)

Unserialize the event.

Paramètres

array

$data

The serialized event.

Renvoie

void

Depuis

2.0.0

Références $data, et name.

Référencé par AbstractEvent\unserialize().

count()

count

(

)

Count the number of arguments.

Renvoie

integer The number of arguments.

Depuis

1.0

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

1.0

Implémente EventInterface.

Références $default, et AbstractEvent\$name.

Référencé par Editor\__construct(), Shortcut\addShortcuts(), AbstractEvent\offsetGet(), CaptiveModel\onAfterModuleList(), et PackageAdapter\onExtensionAfterInstall().

getArguments()

getArguments

(

)

Get all event arguments.

Renvoie

array An associative array of argument names as keys and their values as values.

Depuis

1.0

Références AbstractEvent\$arguments.

Référencé par CMSPlugin\registerLegacyListener().

getName()

getName

(

)

Get the event name.

Renvoie

string The event name.

Depuis

1.0

Implémente EventInterface.

Références AbstractEvent\$name.

hasArgument()

hasArgument

(

$name

)

Tell if the given event argument exists.

Paramètres

string

$name

The argument name.

Renvoie

boolean True if it exists, false otherwise.

Depuis

1.0

Références AbstractEvent\$name.

Référencé par AbstractEvent\offsetExists().

isStopped()

isStopped

(

)

Tell if the event propagation is stopped.

Renvoie

boolean True if stopped, false otherwise.

Depuis

1.0

Implémente EventInterface.

offsetExists()

offsetExists

(

$name

)

Tell if the given event argument exists.

Paramètres

string

$name

The argument name.

Renvoie

boolean True if it exists, false otherwise.

Depuis

1.0

Références AbstractEvent\$name, et AbstractEvent\hasArgument().

offsetGet()

offsetGet

(

$name

)

Get an event argument value.

Paramètres

string

$name

The argument name.

Renvoie

mixed The argument value or null if not existing.

Depuis

1.0

Références AbstractEvent\$name, et AbstractEvent\getArgument().

serialize()

serialize

(

)

Serialize the event.

Renvoie

string The serialized event.

Depuis

1.0

Références AbstractEvent\__serialize().

stopPropagation()

stopPropagation

(

)

Stops the propagation of the event to further event listeners.

Renvoie

void

Depuis

2.0.0

Implémente EventInterface.

Référencé par Event\stop().

unserialize()

unserialize

(

$serialized

)

Unserialize the event.

Paramètres

string

$serialized

The serialized event.

Renvoie

void

Depuis

1.0

Références AbstractEvent\__unserialize().

Documentation des champs

$arguments

$arguments

protected

Référencé par EventImmutable\__construct(), AbstractEvent\__construct(), AbstractEvent\__serialize(), Event\clearArguments(), et AbstractEvent\getArguments().

$name

$name

protected

Référencé par SessionEvent\__construct(), ApplicationEvent\__construct(), ConnectionEvent\__construct(), EventImmutable\__construct(), ConsoleEvent\__construct(), AbstractEvent\__construct(), AbstractEvent\__serialize(), Event\addArgument(), AbstractEvent\getArgument(), AbstractEvent\getName(), AbstractEvent\hasArgument(), AbstractEvent\offsetExists(), AbstractEvent\offsetGet(), EventImmutable\offsetSet(), Event\offsetSet(), EventImmutable\offsetUnset(), Event\offsetUnset(), Event\removeArgument(), et Event\setArgument().

$stopped

$stopped = false

protected

Référencé par AbstractEvent\__serialize().

---

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

• vendor/joomla/event/src/AbstractEvent.php