CliApplication
Extends BaseApplicationBase class for a Joomla! command line application.
| since |
2.5.0 |
|---|---|
| note |
As of 4.0 this class will be abstract |
| 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\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
\Joomla\Registry\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
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() : void
| since |
3.4 |
|---|---|
| deprecated |
4.0 The default concrete implementation of doExecute() will be removed, subclasses will need to provide their own implementation. |
execute
Execute the application.
execute() : void
| since |
1.7.0 |
|---|
fetchConfigurationData
Method to load a PHP configuration class file based on convention and return the instantiated data object. You will extend this method in child classes to provide configuration data from whatever data source is relevant for your specific application.
fetchConfigurationData(string file = '', string class = '\JConfig') : mixed
| since |
1.7.0 |
|---|
Arguments
- file
stringThe path and filename of the configuration file. If not provided, configuration.php in JPATH_CONFIGURATION will be used.- class
stringThe class name to instantiate.
Response
mixedEither an array or object to be loaded into the configuration object.
getIdentity
Get the application identity.
getIdentity() : mixed
| since |
3.0.0 |
|---|
Response
mixedA \JUser object or null.
getInstance
Returns a reference to the global CliApplication object, only creating it if it doesn't already exist.
getInstance(string name = null) : \Joomla\CMS\Application\CliApplication
This method must be invoked as: $cli = CliApplication::getInstance();
| since |
1.7.0 |
|---|
Arguments
- name
stringThe name (optional) of the JApplicationCli class to instantiate.
Response
\Joomla\CMS\Application\CliApplication
getOutput
Get an output object.
getOutput() : \Joomla\Application\Cli\CliOutput
| since |
3.3 |
|---|
Response
\Joomla\Application\Cli\CliOutput
in
Get a value from standard input.
in() : string
| since |
1.7.0 |
|---|
Response
stringThe input string from standard input.
loadConfiguration
Load an object or array into the application configuration object.
loadConfiguration(mixed data) : \Joomla\CMS\Application\CliApplication
| since |
1.7.0 |
|---|
Arguments
- data
mixedEither an array or object to be loaded into the configuration object.
Response
\Joomla\CMS\Application\CliApplicationInstance of $this to allow chaining.
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
\JEventDispatcherAn optional dispatcher object. If omitted, the factory dispatcher is created.
Response
\Joomla\CMS\Application\BaseApplicationThis 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
\JUserAn optional identity object. If omitted, the factory user is created.
Response
\Joomla\CMS\Application\BaseApplicationThis method is chainable.
out
Write a string to standard output.
out(string text = '', bool nl = true) : \Joomla\CMS\Application\CliApplication
| since |
1.7.0 |
|---|
Arguments
- text
stringThe text to display.- nl
boolTrue (default) to append a new line at the end of the output string.
Response
\Joomla\CMS\Application\CliApplicationInstance of $this to allow chaining.
registerEvent
Registers a handler to a particular event group.
registerEvent(string event, callable handler) : \Joomla\CMS\Application\BaseApplication
| since |
3.0.0 |
|---|
Arguments
- event
stringThe event name.- handler
callableThe handler, a function or an instance of an event object.
Response
\Joomla\CMS\Application\BaseApplicationThe application to allow chaining.
setOutput
Set an output object.
setOutput(\Joomla\Application\Cli\CliOutput output) : \Joomla\CMS\Application\CliApplication
| since |
3.3 |
|---|
Arguments
- output
\Joomla\Application\Cli\CliOutputCliOutput object
Response
\Joomla\CMS\Application\CliApplicationInstance of $this to allow chaining.
triggerEvent
Calls all handlers associated with an event group.
triggerEvent(string event, array args = null) : array
| since |
3.0.0 |
|---|
Arguments
- event
stringThe event name.- args
arrayAn array of arguments (optional).
Response
arrayAn array of results from each function call, or null if no dispatcher is defined.
Properties
output
The output type.
| since |
3.3 |
|---|
Type(s)
\Joomla\Application\Cli\CliOutput
instance
The application instance.
| since |
1.7.0 |
|---|
Type(s)
\Joomla\CMS\Application\CliApplication
dispatcher
The application dispatcher object.
| since |
3.0.0 |
|---|
Type(s)
\JEventDispatcher
identity
The application identity object.
| since |
3.0.0 |
|---|
Type(s)
\JUser
input
The application input object
Type(s)
\JInput