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 JEventDispatcher
+ Graphe d'héritage de JEventDispatcher:

Fonctions membres publiques

 getState ()
 
 register ($event, $handler)
 
 trigger ($event, $args=array())
 
 attach ($observer)
 
 detach ($observer)
 

Fonctions membres publiques statiques

static getInstance ()
 

Attributs protégés

 $_observers = array()
 
 $_state = null
 
 $_methods = array()
 

Attributs protégés statiques

static $instance = null
 

Description détaillée

Class to handle dispatching of events.

This is the Observable part of the Observer design pattern for the event architecture.

Voir également
JPlugin
Depuis
12.1
Obsolète:
4.0 The CMS' Event classes will be replaced with the joomla/event package

Documentation des fonctions membres

◆ attach()

attach (   $observer)

Attach an observer object

Paramètres
object$observerAn observer object to attach
Renvoie
void
Depuis
11.3

Références $check, $class, et $key.

◆ detach()

detach (   $observer)

Detach an observer object

Paramètres
object$observerAn observer object to detach.
Renvoie
boolean True if the observer object was detached.
Depuis
11.3

Références $key.

◆ getInstance()

static getInstance ( )
static

Returns the global Event Dispatcher object, only creating it if it doesn't already exist.

Renvoie
JEventDispatcher The EventDispatcher object.
Depuis
11.1

Références null.

Référencé par UsersModelUser\activate(), Authentication\authorise(), FinderControllerIndexer\batch(), UsersModelUser\block(), ContactModelContact\buildContactExtendedData(), FieldsModelField\checkDefaultValue(), ConfigModelCms\cleanCache(), CategoryView\commonCategoryDisplay(), PackageAdapter\copyBaseFiles(), MediaControllerFolder\create(), MediaControllerFolder\delete(), FinderModelMaps\delete(), FinderModelIndex\delete(), TemplatesModelStyle\delete(), MediaControllerFile\delete(), UsersModelGroup\delete(), MenusModelMenu\delete(), ModulesModelModule\delete(), UsersModelUser\delete(), AdminModel\delete(), User\delete(), Installer\discover_install(), InstallerViewInstall\display(), ContentViewArchive\display(), ContentViewArticle\display(), UsersViewProfile\display(), TagsViewTag\display(), MenusViewItems\display(), ContentViewFeatured\display(), ContactViewContact\display(), ContentViewCategory\display(), InstallerHelper\downloadPackage(), TemplatesModelStyle\duplicate(), SearchModelSearch\getAreas(), PlgSystemCache\getCacheKey(), ContactModelContact\getContactQuery(), FinderIndexerHelper\getContentExtras(), SearchModelSearch\getData(), UsersModelRegistration\getData(), FieldsHelper\getFields(), FieldsHelper\getFieldTypes(), UsersModelNote\getItem(), PlgSystemStatsFormFieldData\getLayoutData(), ModSampledataHelper\getList(), UserHelper\getProfile(), AuthenticationHelper\getTwoFactorMethods(), MenusModelMenutypes\getTypeOptions(), PluginHelper\import(), PluginHelper\importPlugin(), FinderCli\index(), InstallerModelInstall\install(), Installer\install(), PlgSystemCache\isExcluded(), BaseApplication\loadDispatcher(), PlgSystemCache\onAfterInitialise(), PlgContentFinder\onCategoryChangeState(), PlgContentFinder\onContentAfterDelete(), PlgContentFinder\onContentAfterSave(), PlgContentFinder\onContentBeforeSave(), PlgContentFinder\onContentChangeState(), PlgEditorCodemirror\onDisplay(), PlgEditorCodemirror\onInit(), JHtmlContent\prepare(), FinderIndexerHelper\prepareContent(), JAdminCssMenu\preprocess(), ConfigModelForm\preprocessData(), FormModel\preprocessData(), ConfigModelForm\preprocessForm(), FormModel\preprocessForm(), ListModel\preprocessForm(), FinderModelMaps\publish(), FinderModelIndex\publish(), CategoriesModelCategory\publish(), AdminModel\publish(), InstallerModelUpdatesites\rebuild(), ModulesRenderer\render(), FOFIntegrationJoomlaPlatform\runPlugins(), ConfigModelComponent\save(), LanguagesModelLanguage\save(), MenusModelMenu\save(), TagsModelTag\save(), TemplatesModelStyle\save(), CategoriesModelCategory\save(), User\save(), ModulesModelModule\save(), AdminModel\save(), MenusModelItem\save(), FinderControllerIndexer\start(), ContactControllerContact\submit(), Installer\uninstall(), Installer\update(), MediaControllerFile\upload(), et FormModel\validate().

◆ getState()

getState ( )

Get the state of the JEventDispatcher object

Renvoie
mixed The state of the object.
Depuis
11.3

◆ register()

register (   $event,
  $handler 
)

Registers an event handler to the event dispatcher

Paramètres
string$eventName of the event to register handler for
string$handlerName of the event handler
Renvoie
void
Depuis
11.1
Exceptions
InvalidArgumentException

Références elseif.

◆ trigger()

trigger (   $event,
  $args = array() 
)

Triggers an event by dispatching arguments to all observers that handle the event and returning their return values.

Paramètres
string$eventThe event to trigger.
array$argsAn array of arguments.
Renvoie
array An array of results from each function call.
Depuis
11.1

Références $key, $value, et elseif.

Documentation des champs

◆ $_methods

$_methods = array()
protected

◆ $_observers

$_observers = array()
protected

◆ $_state

$_state = null
protected

◆ $instance

$instance = null
staticprotected

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