Référence de la classe Event

Graphe d'héritage de Event:

Fonctions membres publiques
	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
Attributs protégés hérités de AbstractEvent
	$name
	$arguments
	$stopped = false

Description détaillée

Default Event class.

Depuis

1.0

Documentation des fonctions membres

addArgument()

addArgument	(		$name,
			$value
	)

Add an event argument, only if it is not existing.

Paramètres

string	$name	The argument name.
mixed	$value	The argument value.

Renvoie

$this

Depuis

1.0

Références AbstractEvent\$name, $this, et $value.

Référencé par PlgSystemSchedulerunner\runTestCron().

clearArguments()

clearArguments

(

)

Clear all event arguments.

Renvoie

array The old arguments.

Depuis

1.0

Références AbstractEvent\$arguments.

offsetSet()

offsetSet	(		$name,
			$value
	)

Set the value of an event argument.

Paramètres

string	$name	The argument name.
mixed	$value	The argument value.

Renvoie

void

Depuis

1.0

Exceptions

InvalidArgumentException

If the argument name is null.

Références AbstractEvent\$name, $value, null, et Event\setArgument().

offsetUnset()

offsetUnset

(

$name

)

Remove an event argument.

Paramètres

string

$name

The argument name.

Renvoie

void

Depuis

1.0

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

removeArgument()

removeArgument

(

$name

)

Remove an event argument.

Paramètres

string

$name

The argument name.

Renvoie

mixed The old argument value or null if it is not existing.

Depuis

1.0

Références AbstractEvent\$name, $return, et null.

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

setArgument()

setArgument	(		$name,
			$value
	)

Add argument to event.

Paramètres

string	$name	Argument name.
mixed	$value	Value.

Renvoie

$this

Depuis

1.0

Références AbstractEvent\$name, $this, et $value.

Référencé par Shortcut\addShortcuts(), Event\offsetSet(), et CaptiveModel\onAfterModuleList().

stop()

stop

(

)

Stop the event propagation.

Renvoie

void

Depuis

1.0

Obsolète:

3.0 Use stopPropogation instead

Références class, et AbstractEvent\stopPropagation().

---

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

• Event.php