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

3.0.0

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

$observer

An observer object to attach

Renvoie

void

Depuis

3.0.0

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

detach()

detach

(

$observer

)

Detach an observer object

Paramètres

object

$observer

An observer object to detach.

Renvoie

boolean True if the observer object was detached.

Depuis

3.0.0

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

3.0.0

Références null.

Référencé par UsersModelUser\activate(), Authentication\authorise(), FinderControllerIndexer\batch(), ContentModelArticle\batchMove(), UsersModelUser\block(), ContactModelContact\buildContactExtendedData(), FieldsModelField\checkDefaultValue(), CheckinModelCheckin\checkin(), Table\checkIn(), ConfigModelCms\cleanCache(), ContentModelArticle\cleanupPostBatchCopy(), CategoryView\commonCategoryDisplay(), PackageAdapter\copyBaseFiles(), MediaControllerFolder\create(), MediaControllerFolder\delete(), FinderModelMaps\delete(), FinderModelIndex\delete(), TemplatesModelStyle\delete(), UsersModelGroup\delete(), MediaControllerFile\delete(), MenusModelMenu\delete(), ModulesModelModule\delete(), UsersModelUser\delete(), AdminModel\delete(), User\delete(), Installer\discover_install(), InstallerViewInstall\display(), ContentViewArchive\display(), ContentViewArticle\display(), UsersViewProfile\display(), MenusViewItems\display(), ContentViewFeatured\display(), ContactViewContact\display(), ContentViewCategory\display(), TagsViewTag\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(), UsersModelRemind\processRemindRequest(), InstallerModelManage\publish(), FinderModelMaps\publish(), FinderModelIndex\publish(), CategoriesModelCategory\publish(), AdminModel\publish(), InstallerModelUpdatesites\rebuild(), ConfigModelApplication\removeroot(), ModulesRenderer\render(), FOFIntegrationJoomlaPlatform\runPlugins(), ConfigModelApplication\save(), 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

3.0.0

register()

register	(		$event,
			$handler
	)

Registers an event handler to the event dispatcher

Paramètres

string	$event	Name of the event to register handler for
string	$handler	Name of the event handler

Renvoie

void

Depuis

3.0.0

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	$event	The event to trigger.
array	$args	An array of arguments.

Renvoie

array An array of results from each function call.

Depuis

3.0.0

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 :

• joomla/event/dispatcher.php