Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Espaces de nommage | Structures de données | Fonctions | Variables
Référence de l'espace de nommage Joomla\CMS\Application

Espaces de nommage

 CLI
 
 Exception
 

Structures de données

class  AdministratorApplication
 
class  ApiApplication
 
class  ApplicationHelper
 
class  BaseApplication
 
class  CliApplication
 
class  CMSApplication
 
interface  CMSApplicationInterface
 
interface  CMSWebApplicationInterface
 
class  ConsoleApplication
 
class  DaemonApplication
 
interface  EventAwareInterface
 
class  SiteApplication
 
class  WebApplication
 

Fonctions

 getDispatcher ()
 
 getLogger ()
 
 registerEvent ($event, callable $handler)
 
 triggerEvent ($eventName, $args=[])
 
 getIdentity ()
 
 loadIdentity (User $identity=null)
 
 setUserFactory (UserFactoryInterface $userFactory)
 

Variables

trait EventAware
 
trait IdentityAware
 
 $userFactory
 

Description détaillée

Joomla! Content Management System

Copyright
(C) 2013 Open Source Matters, Inc. https://www.joomla.org GNU General Public License version 2 or later; see LICENSE.txt

Joomla! Content Management System

Copyright
(C) 2019 Open Source Matters, Inc. https://www.joomla.org GNU General Public License version 2 or later; see LICENSE

Joomla! Content Management System

Copyright
(C) 2006 Open Source Matters, Inc. https://www.joomla.org GNU General Public License version 2 or later; see LICENSE.txt

Joomla! Content Management System

Copyright
(C) 2012 Open Source Matters, Inc. https://www.joomla.org GNU General Public License version 2 or later; see LICENSE.txt

Joomla! Content Management System

Copyright
(C) 2011 Open Source Matters, Inc. https://www.joomla.org GNU General Public License version 2 or later; see LICENSE.txt

Joomla! Content Management System

Copyright
(C) 2017 Open Source Matters, Inc. https://www.joomla.org GNU General Public License version 2 or later; see LICENSE

Joomla! Content Management System

Copyright
(C) 2020 Open Source Matters, Inc. https://www.joomla.org GNU General Public License version 2 or later; see LICENSE

Joomla! Content Management System

Copyright
(C) 2017 Open Source Matters, Inc. https://www.joomla.org GNU General Public License version 2 or later; see LICENSE.txt

Joomla! Content Management System

Copyright
(C) 2005 Open Source Matters, Inc. https://www.joomla.org GNU General Public License version 2 or later; see LICENSE

Joomla! Content Management System

Copyright
(C) 2022 Open Source Matters, Inc. https://www.joomla.org GNU General Public License version 2 or later; see LICENSE.txt

Joomla! Content Management System

Copyright
(C) 2005 Open Source Matters, Inc. https://www.joomla.org GNU General Public License version 2 or later; see LICENSE.txt

Documentation des fonctions

◆ getDispatcher()

Joomla\CMS\Application\getDispatcher ( )
abstract

Get the event dispatcher.

Renvoie
DispatcherInterface
Depuis
4.0.0
Exceptions

Référencé par Captcha\__construct(), Editor\__construct(), Table\__construct(), PlgEditorNone\_displayButtons(), Captcha\_load(), Editor\_loadEditor(), Table\bind(), Table\check(), Table\checkIn(), Table\checkOut(), WebAssetRegistry\dispatchAssetChanged(), AbstractApplication\dispatchEvent(), AbstractView\dispatchEvent(), BaseDatabaseModel\dispatchEvent(), DatabaseDriver\dispatchEvent(), PlgEditorCodemirror\displayButtons(), Editor\getButtons(), Table\hit(), Shortcut\initialize(), Table\load(), Table\move(), Table\publish(), Joomla\CMS\Application\registerEvent(), CMSPlugin\registerLegacyListener(), CMSPlugin\registerListener(), ModuleHelper\renderRawModule(), Table\reorder(), Table\reset(), Application\runCommand(), MVCFactory\setDispatcherOnObject(), Nested\store(), Joomla\CMS\Application\triggerEvent(), et TaskTable\unlock().

◆ getIdentity()

Joomla\CMS\Application\getIdentity ( )

Get the application identity.

Renvoie
User
Depuis
4.0.0

Référencé par HtmlView\addToolbar(), WebApplication\afterSessionStart(), CMSApplication\checkSession(), AdministratorApplication\getTemplate(), AdministratorApplication\login(), Joomla\Plugin\System\Webauthn\PluginTraits\mustDisplayButton(), et PlgFieldsMedia\onCustomFieldsPrepareDom().

◆ getLogger()

Joomla\CMS\Application\getLogger ( )
abstract

Get the logger.

Renvoie
LoggerInterface
Depuis
4.0.0

Référencé par AdministratorApplication\getTemplate(), WebApplication\loadSession(), CMSApplication\login(), et Joomla\CMS\Application\triggerEvent().

◆ loadIdentity()

Joomla\CMS\Application\loadIdentity ( User  $identity = null)

Allows the application to load a custom or default identity.

Paramètres
User$identityAn optional identity object. If omitted, a null user object is created.
Renvoie
$this
Depuis
4.0.0

Références $this.

Référencé par WebApplication\afterSessionStart().

◆ registerEvent()

Joomla\CMS\Application\registerEvent (   $event,
callable  $handler 
)

Registers a handler to a particular event group.

Paramètres
string$eventThe event name.
callable$handlerThe handler, a function or an instance of an event object.
Renvoie
$this
Depuis
4.0.0

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

◆ setUserFactory()

Joomla\CMS\Application\setUserFactory ( UserFactoryInterface  $userFactory)

Set the user factory to use.

Paramètres
UserFactoryInterface$userFactoryThe user factory to use
Renvoie
void
Depuis
4.0.0

Références Joomla\CMS\Application\$userFactory.

◆ triggerEvent()

Joomla\CMS\Application\triggerEvent (   $eventName,
  $args = [] 
)

Calls all handlers associated with an event group.

This is a legacy method, implementing old-style (Joomla! 3.x) plugin calls. It's best to go directly through the Dispatcher and handle the returned EventInterface object instead of going through this method. This method is deprecated and will be removed in Joomla! 5.x.

This method will only return the 'result' argument of the event

Paramètres
string$eventNameThe event name.
array | Event$argsAn array of arguments or an Event object (optional).
Renvoie
array An array of results from each function call. Note this will be an empty array if no dispatcher is set.
Depuis
4.0.0
Exceptions

Références $className, $result, $this, elseif, Joomla\CMS\Application\getDispatcher(), Joomla\CMS\Event\getEventClassByEventName(), et Joomla\CMS\Application\getLogger().

Référencé par AdministratorApplication\dispatch(), SiteApplication\dispatch(), ApiApplication\dispatch(), WebApplication\execute(), CliApplication\execute(), DaemonApplication\execute(), CMSApplication\initialiseApp(), CMSApplication\login(), CMSApplication\logout(), DaemonApplication\postFork(), CMSApplication\render(), AdministratorApplication\route(), SiteApplication\route(), et CMSApplication\route().

Documentation des variables

◆ $userFactory

$userFactory
private

Référencé par Basic\__construct(), Icon\__construct(), Token\__construct(), et Joomla\CMS\Application\setUserFactory().

◆ EventAware

trait EventAware
Valeur initiale :
{
use CoreEventAware

Trait for application classes which dispatch events

Depuis
4.0.0

◆ IdentityAware

trait IdentityAware
Valeur initiale :
{
protected $identity

Trait for application classes which are identity (user) aware

Depuis
4.0.0