BaseApplication
Extends AbstractApplication Implements DispatcherAwareInterfaceJoomla Platform Base Application Class
| property-read Input |
The application input object |
|---|---|
| since |
3.0.0 |
| deprecated |
4.3 will be removed in 6.0 Application classes should directly be based on \Joomla\Application\AbstractApplication don't use this class anymore |
| package |
Joomla CMS |
Methods
__construct
Class constructor.
__construct(\Joomla\CMS\Input\Input input = null, \Joomla\Registry\Registry config = null) :
| since |
3.0.0 |
|---|
Arguments
- input
InputAn optional argument to provide dependency injection for the application's input object. If the argument is a \JInput object that object will become the application's input object, otherwise a default input object is created.- config
RegistryAn optional argument to provide dependency injection for the application's config object. If the argument is a Registry object that object will become the application's config object, otherwise a default config object is created.
Response
mixed
getDispatcher
Get the event dispatcher.
getDispatcher() : \Joomla\Event\DispatcherInterface
| since |
4.0.0 |
|---|---|
| throws |
|
Response
DispatcherInterface
getIdentity
Get the application identity.
getIdentity() : \Joomla\CMS\User\User
getLogger
Get the logger.
getLogger() : \Psr\Log\LoggerInterface
| since |
4.0.0 |
|---|
Response
LoggerInterface
loadIdentity
Allows the application to load a custom or default identity.
loadIdentity(\Joomla\CMS\User\User identity = null) :
| since |
4.0.0 |
|---|
Arguments
- identity
UserAn optional identity object. If omitted, a null user object is created.
Response
$this
registerEvent
Registers a handler to a particular event group.
registerEvent( event, Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array handler) :
| since |
4.0.0 |
|---|
Arguments
- event
stringThe event name.- handler
callableThe handler, a function or an instance of an event object.
Response
$this
triggerEvent
Calls all handlers associated with an event group.
triggerEvent( eventName, array|\Joomla\Event\Event args = []) : mixed||string|int
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
| since |
4.0.0 |
|---|---|
| throws |
|
| deprecated |
4.0 will be removed in 6.0 Use the Dispatcher method instead Example: Factory::getApplication()->getDispatcher()->dispatch($eventName, $event); |
Arguments
- eventName
stringThe event name.- args
array<string|int, mixed>|EventAn array of arguments or an Event object (optional).
Response
array<string|int, mixed>An array of results from each function call. Note this will be an empty array if no dispatcher is set.