CliApplication
Extends AbstractApplication Implements DispatcherAwareInterface, CMSApplicationInterfaceBase class for a Joomla! command line application.
since |
2.5.0 |
---|---|
deprecated |
4.0 will be removed in 6.0 Use the ConsoleApplication instead |
package |
Joomla CMS |
Methods
__construct
Class constructor.
__construct(\Joomla\Input\Input input = null, \Joomla\Registry\Registry config = null, \Joomla\CMS\Application\CLI\CliOutput output = null, \Joomla\CMS\Application\CLI\CliInput cliInput = null, \Joomla\Event\DispatcherInterface dispatcher = null, \Joomla\DI\Container container = null) :
since |
1.7.0 |
---|
Arguments
- input
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
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.- output
CliOutput
The output handler.- cliInput
CliInput
The CLI input handler.- dispatcher
DispatcherInterface
An optional argument to provide dependency injection for the application's event dispatcher. If the argument is a DispatcherInterface 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.- container
Container
Dependency injection container.
Response
mixed
__get
Magic method to access properties of the application.
__get( name) :
since |
4.0.0 |
---|---|
deprecated |
4.0 will be removed in 6.0 This is a B/C proxy for deprecated read accesses Example: Factory::getApplication()->getInput(); |
Arguments
- name
string
The name of the property.
Response
mixed
A value if the property name is valid, null otherwise.
bootComponent
Boots the component with the given name.
bootComponent( component) : \Joomla\CMS\Extension\ComponentInterface
bootModule
Boots the module with the given name.
bootModule( module, applicationName) : \Joomla\CMS\Extension\ModuleInterface
since |
4.0.0 |
---|
Arguments
- module
string
The module to boot- applicationName
string
The application name
Response
bootPlugin
Boots the plugin with the given name and type.
bootPlugin( plugin, type) : \Joomla\CMS\Extension\PluginInterface
since |
4.0.0 |
---|
Arguments
- plugin
string
The plugin name- type
string
The type of the plugin
Response
createExtensionNamespaceMap
Allows the application to load a custom or default identity.
createExtensionNamespaceMap() :
since |
4.0.0 |
---|
Response
void
enqueueMessage
Enqueue a system message.
enqueueMessage( msg, type = self::MSG_INFO) :
since |
4.0.0 |
---|
Arguments
- msg
string
The message to enqueue.- type
string
The message type.
Response
void
execute
Execute the application.
execute() :
since |
1.7.0 |
---|
Response
void
getCliInput
Get a CLI input object.
getCliInput() : \Joomla\CMS\Application\CLI\CliInput
getConfig
Retrieve the application configuration object.
getConfig() : \Joomla\Registry\Registry
since |
4.0.0 |
---|
Response
Registry
getContainer
Get the DI container.
getContainer() : \Joomla\DI\Container
since |
4.0.0 |
---|---|
throws |
|
Response
Container
getDispatcher
Get the event dispatcher.
getDispatcher() : \Joomla\Event\DispatcherInterface
since |
4.0.0 |
---|---|
throws |
|
Response
DispatcherInterface
getIdentity
Get the application identity.
getIdentity() : \Joomla\CMS\User\User
getInput
Method to get the application input object.
getInput() : \Joomla\Input\Input
since |
4.0.0 |
---|
Response
Input
getInstance
Returns a reference to the global CliApplication object, only creating it if it doesn't already exist.
getInstance( name = null) : \Joomla\CMS\Application\CliApplication
This method must be invoked as: $cli = CliApplication::getInstance();
since |
1.7.0 |
---|---|
deprecated |
4.0 will be removed in 6.0 Load the app through the container or via the Factory Example: Factory::getContainer()->get(CliApplication::class) |
throws |
|
Arguments
- name
string
The name (optional) of the Application Cli class to instantiate.
Response
getLanguage
Method to get the application language object.
getLanguage() : \Joomla\CMS\Language\Language
getLogger
Get the logger.
getLogger() : \Psr\Log\LoggerInterface
since |
4.0.0 |
---|
Response
LoggerInterface
getMessageQueue
Get the system message queue.
getMessageQueue() : mixed||string|int
since |
4.0.0 |
---|
Response
array<string|int, mixed>
The system message queue.
getOutput
Get an output object.
getOutput() : \Joomla\CMS\Application\CLI\CliOutput
getSession
Method to get the application session object.
getSession() : \Joomla\Session\SessionInterface
since |
4.0.0 |
---|
Response
SessionInterface
The session object
in
Get a value from standard input.
in() :
since |
4.0.0 |
---|
Response
string
The input string from standard input.
isCli
Flag if the application instance is a CLI or web based application.
isCli() :
Helper function, you should use the native PHP functions to detect if it is a CLI application.
since |
4.0.0 |
---|---|
deprecated |
4.0 will be removed in 6.0 Will be removed without replacements |
Response
bool
isClient
Check the client interface by name.
isClient( identifier) :
since |
4.0.0 |
---|
Arguments
- identifier
string
String identifier for the application interface
Response
bool
True if this application is of the given type client interface.
loadExtension
Loads the extension.
loadExtension( type, extensionName, extensionPath) : \Joomla\CMS\Extension\ComponentInterface|\Joomla\CMS\Extension\ModuleInterface|\Joomla\CMS\Extension\PluginInterface
since |
4.0.0 |
---|
Arguments
- type
string
The extension type- extensionName
string
The extension name- extensionPath
string
The path of the extension
Response
loadIdentity
Allows the application to load a custom or default identity.
loadIdentity(\Joomla\CMS\User\User identity = null) :
since |
4.0.0 |
---|
Arguments
- identity
User
An optional identity object. If omitted, a null user object is created.
Response
$this
loadPluginFromFilesystem
Creates a CMS plugin from the filesystem.
loadPluginFromFilesystem( plugin, type) : \Joomla\CMS\Plugin\CMSPlugin
out
Write a string to standard output.
out( text = '', nl = true) :
since |
4.0.0 |
---|
Arguments
- text
string
The text to display.- nl
bool
True (default) to append a new line at the end of the output string.
Response
$this
registerEvent
Registers a handler to a particular event group.
registerEvent( event, Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array handler) :
since |
4.0.0 |
---|
Arguments
- event
string
The event name.- handler
callable
The handler, a function or an instance of an event object.
Response
$this
setOutput
Set an output object.
setOutput(\Joomla\CMS\Application\CLI\CliOutput output) :
triggerEvent
Calls all handlers associated with an event group.
triggerEvent( eventName, array|\Joomla\Event\Event args = []) : mixed||string|int
This is a legacy method, implementing old-style (Joomla! 3.x) plugin calls. It's best to go directly through the Dispatcher and handle the returned EventInterface object instead of going through this method. This method is deprecated and will be removed in Joomla! 5.x.
This method will only return the 'result' argument of the event
since |
4.0.0 |
---|---|
throws |
|
deprecated |
4.0 will be removed in 6.0 Use the Dispatcher method instead Example: Factory::getApplication()->getDispatcher()->dispatch($eventName, $event); |
Arguments
- eventName
string
The event name.- args
array<string|int, mixed>|Event
An array of arguments or an Event object (optional).
Response
array<string|int, mixed>
An array of results from each function call. Note this will be an empty array if no dispatcher is set.
Properties
input
The input.
since |
4.0.0 |
---|
Type(s)
Input
messages
The application message queue.
since |
4.0.0 |
---|
Type(s)
array<string|int, mixed>