AbstractApplication
Implements ConfigurationAwareApplicationInterface, LoggerAwareInterface, DispatcherAwareInterfaceJoomla Framework Base Application Class
| since |
1.0.0 |
|---|---|
| package |
Joomla Framework |
Methods
__construct
Class constructor.
__construct(\Joomla\Registry\Registry|null config = null) :
| since |
1.0.0 |
|---|
Arguments
- config
Registry|nullAn 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
close
Method to close the application.
close( code) :
| since |
1.0.0 |
|---|
Arguments
- code
intThe exit code (optional; default is 0).
Response
void
dispatchEvent
Dispatches an application event if the dispatcher has been set.
dispatchEvent( eventName, \Joomla\Event\EventInterface|null event = null) : \Joomla\Event\EventInterface|null
| since |
2.0.0 |
|---|
Arguments
- eventName
stringThe event to dispatch.- event
EventInterface|nullThe event object.
Response
EventInterface|nullThe dispatched event or null if no dispatcher is set
doExecute
Method to run the application routines.
doExecute() :
Most likely you will want to instantiate a controller and execute it, or perform some sort of task directly.
| since |
1.0.0 |
|---|
Response
mixed
execute
Execute the application.
execute() :
| since |
1.0.0 |
|---|
Response
void
get
Returns a property of the object or the default value if the property is not set.
get( key, default = null) :
| since |
1.0.0 |
|---|
Arguments
- key
stringThe name of the property.- default
mixedThe default value (optional) if none is set.
Response
mixedThe value of the configuration.
getDispatcher
Get the event dispatcher.
getDispatcher() : \Joomla\Event\DispatcherInterface
| since |
1.2.0 |
|---|---|
| throws |
|
Response
getLogger
Get the logger.
getLogger() : \Psr\Log\LoggerInterface
| since |
1.0.0 |
|---|
Response
LoggerInterface
initialise
Custom initialisation method.
initialise() :
Called at the end of the AbstractApplication::__construct method. This is for developers to inject initialisation code for their application classes.
| since |
1.0.0 |
|---|
Response
void
set
Modifies a property of the object, creating it if it does not already exist.
set( key, value = null) :
| since |
1.0.0 |
|---|
Arguments
- key
stringThe name of the property.- value
mixedThe value of the property to set (optional).
Response
mixedPrevious value of the property
setConfiguration
Sets the configuration for the application.
setConfiguration(\Joomla\Registry\Registry config) :
setDispatcher
Set the dispatcher to use.
setDispatcher(\Joomla\Event\DispatcherInterface dispatcher) :