JApplicationCli
Base class for a Joomla! command line application.
| package |
Joomla.Platform |
|---|---|
| subpackage |
Application |
| since |
11.4 |
Methods
__construct
Class constructor.
__construct(mixed $input = null, mixed $config = null, mixed $dispatcher = null)
| see | \JApplicationCli::loadDispatcher() |
|---|---|
| since |
11.1 |
Arguments
- $input
mixedAn optional argument to provide dependency injection for the application's input object. If the argument is a JInputCli object that object will become the application's input object, otherwise a default input object is created.- $config
mixedAn optional argument to provide dependency injection for the application's config object. If the argument is a JRegistry object that object will become the application's config object, otherwise a default config object is created.- $dispatcher
mixedAn optional argument to provide dependency injection for the application's event dispatcher. If the argument is a JDispatcher object that object will become the application's event dispatcher, if it is null then the default event dispatcher will be created based on the application's loadDispatcher() method.
close
Exit the application.
close(integer $code) : void
| since |
11.1 |
|---|
Arguments
- $code
integerThe 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() : void
| since |
11.3 |
|---|
execute
Execute the application.
execute() : void
| since |
11.1 |
|---|
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 |
11.1 |
|---|
Arguments
- $file
stringThe path and filename of the configuration file. If not provided, configuration.php in JPATH_BASE will be used.- $class
stringThe class name to instantiate.
Response
mixedEither an array or object to be loaded into the configuration object.
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 |
11.3 |
|---|
Arguments
- $key
stringThe name of the property.- $default
mixedThe default value (optional) if none is set.
Response
mixedThe value of the configuration.
getInstance
Returns a reference to the global JApplicationCli object, only creating it if it doesn't already exist.
getInstance(string $name = null) : \JApplicationCli
This method must be invoked as: $cli = JApplicationCli::getInstance();
| since |
11.1 |
|---|
Arguments
- $name
stringThe name (optional) of the JApplicationCli class to instantiate.
Response
in
Get a value from standard input.
in() : string
| since |
11.1 |
|---|
Response
stringThe input string from standard input.
loadConfiguration
Load an object or array into the application configuration object.
loadConfiguration(mixed $data) : \JApplicationCli
| since |
11.1 |
|---|
Arguments
- $data
mixedEither an array or object to be loaded into the configuration object.
Response
\JApplicationCliInstance of $this to allow chaining.
loadDispatcher
Method to create an event dispatcher for the application. 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 based on more specific needs.
loadDispatcher() : void
| since |
11.3 |
|---|
out
Write a string to standard output.
out(string $text = '', boolean $nl = true) : \JApplicationCli
| since |
11.1 |
|---|
Arguments
- $text
stringThe text to display.- $nl
booleanTrue (default) to append a new line at the end of the output string.
Response
\JApplicationCliInstance of $this to allow chaining.
registerEvent
Registers a handler to a particular event group.
registerEvent(string $event, callback $handler) : \JApplicationCli
| since |
11.1 |
|---|
Arguments
- $event
stringThe event name.- $handler
callbackThe handler, a function or an instance of a event object.
Response
\JApplicationCliInstance of $this 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 |
11.3 |
|---|
Arguments
- $key
stringThe name of the property.- $value
mixedThe value of the property to set (optional).
Response
mixedPrevious value of the property
triggerEvent
Calls all handlers associated with an event group.
triggerEvent(string $event, array $args = null) : array
| since |
11.1 |
|---|
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
input
The application input object.
| since |
11.1 |
|---|
Type(s)
\JInputCli