Référence de la classe CMSPlugin

Graphe d'héritage de CMSPlugin:

Fonctions membres publiques
	__construct (&$subject, $config=array())
	loadLanguage ($extension='', $basePath=JPATH_ADMINISTRATOR)
	setApplication (CMSApplicationInterface $application)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de PluginInterface
	registerListeners ()

Champs de données
	$params = null

Fonctions membres protégées
	registerLegacyListener (string $methodName)
	registerListener (string $methodName)
	getApplication ()

Attributs protégés
	$_name = null
	$_type = null
	$autoloadLanguage = false
	$allowLegacyListeners = true

Fonctions membres privées
	parameterImplementsEventInterface (\ReflectionParameter $parameter)

Attributs privés
	$application

Description détaillée

Plugin Class

Depuis

1.5

Documentation des constructeurs et destructeur

__construct()

__construct	(	&	$subject,
			$config = array()
	)

Constructor

Paramètres

DispatcherInterface	&$subject	The object to observe
array	$config	An optional associative array of configuration settings. Recognized key values include 'name', 'group', 'params', 'language' (this list is not meant to be comprehensive).

Depuis

1.5

Références $config, $subject, $this, Factory\getApplication(), Factory\getDbo(), et Joomla\Event\setDispatcher().

Documentation des fonctions membres

getApplication()

getApplication ( )

protected

Returns the internal application or null when not set.

Renvoie

CMSApplicationInterface|null

Depuis

4.2.0

Référencé par Joomla\getActionLogParams(), Joomla\onAfterDispatch(), Joomla\onAfterLogExport(), Joomla\onAfterLogPurge(), Joomla\onAfterPurge(), Joomla\onApplicationAfterSave(), Joomla\onContentAfterDelete(), Joomla\onContentAfterSave(), Joomla\onContentChangeState(), Joomla\onExtensionAfterDelete(), Joomla\onExtensionAfterInstall(), Joomla\onExtensionAfterSave(), Joomla\onExtensionAfterUninstall(), Joomla\onExtensionAfterUpdate(), Joomla\onJoomlaAfterUpdate(), Joomla\onUserAfterDelete(), Joomla\onUserAfterDeleteGroup(), Joomla\onUserAfterRemind(), Joomla\onUserAfterSave(), et Joomla\onUserAfterSaveGroup().

loadLanguage()

loadLanguage	(		$extension = '',
			$basePath = JPATH_ADMINISTRATOR
	)

Loads the plugin language file

Paramètres

string	$extension	The extension for which a language file should be loaded
string	$basePath	The basepath to use

Renvoie

boolean True, if the file has successfully loaded.

Depuis

1.5

Références $basePath, $extension, $lang, Factory\getLanguage(), et JPATH_PLUGINS.

parameterImplementsEventInterface()

parameterImplementsEventInterface ( \ReflectionParameter  $parameter )

private

Checks if parameter is typehinted to accept .

Paramètres

\ReflectionParameter

$parameter

Renvoie

boolean

Depuis

4.0.0

Références $type, class, et null.

registerLegacyListener()

registerLegacyListener ( string  $methodName )

finalprotected

Registers a legacy event listener, i.e. a method which accepts individual arguments instead of an AbstractEvent in its arguments. This provides backwards compatibility to Joomla! 3.x-style plugins.

This method will register lambda functions (closures) which try to unwrap the arguments of the dispatched Event into old style method arguments and call your on<Something> method with them. The result will be passed back to the Event, as an element into an array argument called 'result'.

Paramètres

string

$methodName

The method name to register

Renvoie

void

Depuis

4.0.0

Références $methodName, $result, AbstractEvent\getArguments(), Joomla\CMS\Application\getDispatcher(), et null.

registerListener()

registerListener ( string  $methodName )

finalprotected

Registers a proper event listener, i.e. a method which accepts an AbstractEvent as its sole argument. This is the preferred way to implement plugins in Joomla! 4.x and will be the only possible method with Joomla! 5.x onwards.

Paramètres

string

$methodName

The method name to register

Renvoie

void

Depuis

4.0.0

Références $methodName, $this, et Joomla\CMS\Application\getDispatcher().

setApplication()

setApplication

(

CMSApplicationInterface

$application

)

Sets the application to use.

Paramètres

CMSApplicationInterface

$application

The application

Renvoie

void

Depuis

4.2.0

Référencé par ServiceProviderInterface\register().

Documentation des champs

$_name

$_name = null

protected

$_type

$_type = null

protected

$allowLegacyListeners

$allowLegacyListeners = true

protected

$application

$application

private

$autoloadLanguage

$autoloadLanguage = false

protected

$params

$params = null

---

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

• CMSPlugin.php