[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Plugin/ -> CMSPlugin.php (summary)

Joomla! Content Management System

Copyright: (C) 2007 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 375 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 8 functions

  __construct()
  loadLanguage()
  registerListeners()
  registerLegacyListener()
  registerListener()
  parameterImplementsEventInterface()
  getApplication()
  setApplication()

Functions
Functions that are not part of a class:

__construct(&$subject, $config = array()   X-Ref
Constructor

param: DispatcherInterface  &$subject  The object to observe
param: array                $config    An optional associative array of configuration settings.

loadLanguage($extension = '', $basePath = JPATH_ADMINISTRATOR)   X-Ref
Loads the plugin language file

param: string  $extension  The extension for which a language file should be loaded
param: string  $basePath   The basepath to use
return: boolean  True, if the file has successfully loaded.

registerListeners()   X-Ref
Registers legacy Listeners to the Dispatcher, emulating how plugins worked under Joomla! 3.x and below.

By default, this method will look for all public methods whose name starts with "on". It will register
lambda functions (closures) which try to unwrap the arguments of the dispatched Event into method call
arguments and call your on<Something> method. The result will be passed back to the Event into its 'result'
argument.

This method additionally supports Joomla\Event\SubscriberInterface and plugins implementing this will be
registered to the dispatcher as a subscriber.

return: void

registerLegacyListener(string $methodName)   X-Ref
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: string  $methodName  The method name to register
return: void

registerListener(string $methodName)   X-Ref
No description

parameterImplementsEventInterface(\ReflectionParameter $parameter)   X-Ref
Checks if parameter is typehinted to accept \Joomla\Event\EventInterface.

param: \ReflectionParameter  $parameter
return: boolean

getApplication()   X-Ref
Returns the internal application or null when not set.

return: CMSApplicationInterface|null

setApplication(CMSApplicationInterface $application)   X-Ref
Sets the application to use.

param: CMSApplicationInterface  $application  The application
return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer