Class JApplicationCli

Base class for a Joomla! command line application.

Joomla\Application\AbstractApplication implements Psr\Log\LoggerAwareInterface

JApplicationBase

JApplicationCli

Direct known subclasses

JApplicationDaemon, JCli

Indirect known subclasses

JDaemon

Package: Joomla\Platform\Application
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.4
Note: As of 4.0 this class will be abstract
Located at joomla/application/cli.php

Methods summary

`public`	# `__construct( JInputCli $input = null, Joomla\Registry\Registry $config = null, JEventDispatcher $dispatcher = null )` Class constructor. Class constructor. Parameters `$input` `JInputCli` - $input An 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` `Joomla\Registry\Registry` - $config 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. `$dispatcher` `JEventDispatcher` - $dispatcher An optional argument to provide dependency injection for the application's event dispatcher. If the argument is a JEventDispatcher 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. Since 11.1 See `JApplicationBase::loadDispatcher()` Overrides `JApplicationBase::__construct`
`public static JApplicationCli`	# `getInstance( string $name = null )` Returns a reference to the global JApplicationCli object, only creating it if it doesn't already exist. Returns a reference to the global JApplicationCli object, only creating it if it doesn't already exist. This method must be invoked as: $cli = JApplicationCli::getInstance(); Parameters `$name` `string` - $name The name (optional) of the JApplicationCli class to instantiate. Returns `JApplicationCli` Since 11.1
`public`	# `execute( )` Execute the application. Execute the application. Since 11.1 Overrides `Joomla\Application\AbstractApplication::execute`
`public JApplicationCli`	# `loadConfiguration( mixed $data )` Load an object or array into the application configuration object. Load an object or array into the application configuration object. Parameters `$data` `mixed` - $data Either an array or object to be loaded into the configuration object. Returns `JApplicationCli` - Instance of $this to allow chaining. Since 11.1
`public JApplicationCli`	# `out( string $text = '', boolean $nl = true )` Write a string to standard output. Write a string to standard output. Parameters `$text` `string` - $text The text to display. `$nl` `boolean` - $nl True (default) to append a new line at the end of the output string. Returns `JApplicationCli` - Instance of $this to allow chaining. Since 11.1 CodeCoverageIgnore
`public Joomla\Application\Cli\CliOutput`	# `getOutput( )` Get an output object. Get an output object. Returns `Joomla\Application\Cli\CliOutput` Since 3.3
`public JApplicationCli`	# `setOutput( Joomla\Application\Cli\CliOutput $output )` Set an output object. Set an output object. Parameters `$output` `Joomla\Application\Cli\CliOutput` - $output CliOutput object Returns `JApplicationCli` - Instance of $this to allow chaining. Since 3.3
`public string`	# `in( )` Get a value from standard input. Get a value from standard input. Returns `string` - The input string from standard input. Since 11.1 CodeCoverageIgnore
`protected mixed`	# `fetchConfigurationData( string $file = '', string $class = 'JConfig' )` 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. 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. Parameters `$file` `string` - $file The path and filename of the configuration file. If not provided, configuration.php in JPATH_CONFIGURATION will be used. `$class` `string` - $class The class name to instantiate. Returns `mixed` - Either an array or object to be loaded into the configuration object. Since 11.1

Methods inherited from JApplicationBase

doExecute(), getIdentity(), loadDispatcher(), loadIdentity(), registerEvent(), triggerEvent()

Methods inherited from Joomla\Application\AbstractApplication

close(), get(), getLogger(), initialise(), set(), setConfiguration(), setLogger()

Magic methods summary

Properties summary

`protected Joomla\Application\Cli\CliOutput`	`$output`	# The output type. The output type. Since 3.3
`protected static JApplicationCli`	`$instance`	# The application instance. The application instance. Since 11.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JApplicationCli

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Since

See

Overrides

Parameters

Returns

Since

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

CodeCoverageIgnore

Returns

Since

Parameters

Returns

Since

Returns

Since

CodeCoverageIgnore

Parameters

Returns

Since

Methods inherited from JApplicationBase

Methods inherited from Joomla\Application\AbstractApplication

Magic methods summary

Properties summary

Since

Since

Properties inherited from JApplicationBase

Properties inherited from Joomla\Application\AbstractApplication

Magic properties inherited from JApplicationBase