BaseApplication
Extends \Joomla\Application\AbstractApplicationJoomla Platform Base Application Class
property-read |
The application input object |
---|---|
since |
3.0.0 |
Methods
__construct
Class constructor.
__construct(\Joomla\Input\Input $input = null, \Joomla\Registry\Registry $config = null)
since |
1.0 |
---|
Arguments
- $input
\Joomla\Input\Input
An optional argument to provide dependency injection for the application's input object. If the argument is an Input 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.
close
Method to close the application.
close(integer $code) : void
since |
1.0 |
---|
Arguments
- $code
integer
The exit code (optional; default is 0).
doExecute
Method to run the application routines. Most likely you will want to instantiate a controller and execute it, or perform some sort of task directly.
doExecute() : mixed
since |
1.0 |
---|
Response
mixed
execute
Execute the application.
execute() : void
since |
1.0 |
---|
get
Returns a property of the object or the default value if the property is not set.
get(string $key, mixed $default = null) : mixed
since |
1.0 |
---|
Arguments
- $key
string
The name of the property.- $default
mixed
The default value (optional) if none is set.
Response
mixed
The value of the configuration.
getIdentity
Get the application identity.
getIdentity() : mixed
since |
3.0.0 |
---|
Response
mixed
A \JUser object or null.
getLogger
Get the logger.
getLogger() : \Psr\Log\LoggerInterface
since |
1.0 |
---|
Response
\Psr\Log\LoggerInterface
initialise
Custom initialisation method.
initialise() : void
Called at the end of the AbstractApplication::__construct method. This is for developers to inject initialisation code for their application classes.
since |
1.0 |
---|
loadDispatcher
Allows the application to load a custom or default dispatcher.
loadDispatcher(\JEventDispatcher $dispatcher = null) : \Joomla\CMS\Application\BaseApplication
The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create event dispatchers, if required, based on more specific needs.
since |
3.0.0 |
---|
Arguments
- $dispatcher
\JEventDispatcher
An optional dispatcher object. If omitted, the factory dispatcher is created.
Response
\Joomla\CMS\Application\BaseApplication
This method is chainable.
loadIdentity
Allows the application to load a custom or default identity.
loadIdentity(\JUser $identity = null) : \Joomla\CMS\Application\BaseApplication
The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create an identity, if required, based on more specific needs.
since |
3.0.0 |
---|
Arguments
- $identity
\JUser
An optional identity object. If omitted, the factory user is created.
Response
\Joomla\CMS\Application\BaseApplication
This method is chainable.
registerEvent
Registers a handler to a particular event group.
registerEvent(string $event, callable $handler) : \Joomla\CMS\Application\BaseApplication
since |
3.0.0 |
---|
Arguments
- $event
string
The event name.- $handler
callable
The handler, a function or an instance of an event object.
Response
\Joomla\CMS\Application\BaseApplication
The application to allow chaining.
set
Modifies a property of the object, creating it if it does not already exist.
set(string $key, mixed $value = null) : mixed
since |
1.0 |
---|
Arguments
- $key
string
The name of the property.- $value
mixed
The value of the property to set (optional).
Response
mixed
Previous value of the property
setConfiguration
Sets the configuration for the application.
setConfiguration(\Joomla\Registry\Registry $config) : \Joomla\Application\AbstractApplication
since |
1.0 |
---|
Arguments
- $config
\Joomla\Registry\Registry
A registry object holding the configuration.
Response
\Joomla\Application\AbstractApplication
Returns itself to support chaining.
setLogger
Set the logger.
setLogger(\Psr\Log\LoggerInterface $logger) : \Joomla\Application\AbstractApplication
since |
1.0 |
---|
Arguments
- $logger
\Psr\Log\LoggerInterface
The logger.
Response
\Joomla\Application\AbstractApplication
Returns itself to support chaining.
triggerEvent
Calls all handlers associated with an event group.
triggerEvent(string $event, array $args = null) : array
since |
3.0.0 |
---|
Arguments
- $event
string
The event name.- $args
array
An array of arguments (optional).
Response
array
An array of results from each function call, or null if no dispatcher is defined.
Properties
identity
The application identity object.
since |
3.0.0 |
---|
Type(s)
\JUser
logger
A logger.
since |
1.0 |
---|
Type(s)
\Psr\Log\LoggerInterface
input
The application input object.
The application input object
Type(s)
\JInput