Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe AbstractEvent
+ Graphe d'héritage de AbstractEvent:

Fonctions membres publiques

 __construct ($name, array $arguments=array())
 
 getName ()
 
 getArgument ($name, $default=null)
 
 hasArgument ($name)
 
 getArguments ()
 
 isStopped ()
 
 count ()
 
 serialize ()
 
 unserialize ($serialized)
 
 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 = array() 
)

Constructor.

Paramètres
string$nameThe event name.
array$argumentsThe event arguments.
Depuis
1.0

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

Documentation des fonctions membres

◆ 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$nameThe argument name.
mixed$defaultThe default value if not found.
Renvoie
mixed The argument value or the default value.
Depuis
1.0

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

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

◆ 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.

◆ 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$nameThe 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$nameThe 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$nameThe 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 name.

◆ unserialize()

unserialize (   $serialized)

Unserialize the event.

Paramètres
string$serializedThe serialized event.
Renvoie
void
Depuis
1.0

Références name.

Documentation des champs

◆ $arguments

◆ $name

◆ $stopped

$stopped = false
protected

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