Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
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=array())
 
 getName ()
 
 getArgument ($name, $default=null)
 
 hasArgument ($name)
 
 getArguments ()
 
 isStopped ()
 
 count ()
 
 serialize ()
 
 unserialize ($serialized)
 
 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$nameThe argument name.
mixed$valueThe argument value.
Renvoie
Event This method is chainable.
Depuis
1.0

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

◆ 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$nameThe argument name.
mixed$valueThe argument value.
Renvoie
void
Exceptions
InvalidArgumentExceptionIf the argument name is null.
Depuis
1.0

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

◆ offsetUnset()

offsetUnset (   $name)

Remove an event argument.

Paramètres
string$nameThe 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$nameThe 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 
)

Set the value of an event argument. If the argument already exists, it will be overridden.

Paramètres
string$nameThe argument name.
mixed$valueThe argument value.
Renvoie
Event This method is chainable.
Depuis
1.0

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

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

◆ stop()

stop ( )

Stop the event propagation.

Renvoie
void
Depuis
1.0

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