BaseApplication
Extends \Joomla\Application\AbstractApplication Implements \Joomla\Event\DispatcherAwareInterfaceJoomla Platform Base Application Class
property-read Input |
The application input object |
---|---|
since |
3.0.0 |
deprecated |
5.0 Application classes should be based on \Joomla\Application\AbstractApplication |
package |
Joomla CMS |
Methods
__construct
Class constructor.
__construct(\Joomla\CMS\Input\Input input = null, \Joomla\Registry\Registry config = null) : mixed
since |
3.0.0 |
---|
Arguments
- input
\Joomla\CMS\Input\Input
An 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
\Joomla\Registry\Registry
An 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
\Joomla\Event\DispatcherInterface
getIdentity
Get the application identity.
getIdentity() : \Joomla\CMS\User\User
since |
4.0.0 |
---|
Response
\Joomla\CMS\User\User
getLogger
Get the logger.
getLogger() : \Psr\Log\LoggerInterface
since |
4.0.0 |
---|
Response
\Psr\Log\LoggerInterface
loadIdentity
Allows the application to load a custom or default identity.
loadIdentity(\Joomla\CMS\User\User identity = null) : $this
since |
4.0.0 |
---|
Arguments
- identity
\Joomla\CMS\User\User
An optional identity object. If omitted, a null user object is created.
Response
$this
registerEvent
Registers a handler to a particular event group.
registerEvent(string event, callable handler) : $this
since |
4.0.0 |
---|
Arguments
- event
string
The event name.- handler
callable
The handler, a function or an instance of an event object.
Response
$this
setUserFactory
Set the user factory to use.
setUserFactory(\Joomla\CMS\User\UserFactoryInterface userFactory) : void
since |
4.0.0 |
---|
Arguments
- userFactory
\Joomla\CMS\User\UserFactoryInterface
The user factory to use
triggerEvent
Calls all handlers associated with an event group.
triggerEvent(string eventName, array|\Joomla\Event\Event args = []) : array
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 |
5.0 |
Arguments
- eventName
string
The event name.- args
array|\Joomla\Event\Event
An array of arguments or an Event object (optional).
Response
array
An array of results from each function call. Note this will be an empty array if no dispatcher is set.