\JApplicationCli

Base class for a Joomla! command line application.

Synopsis

class JApplicationCli extends JApplicationBase {

• // members
• protected JRegistry  $config;
• protected JApplicationCli  $instance;
• // Inherited members from JApplicationBase
• protected JEventDispatcher  $dispatcher;
• protected JUser  $identity;
• public JInput  $input;
• // methods
• public void __construct()
• public mixed get()
• public static JApplicationCli getInstance()
• public void execute()
• public JApplicationCli loadConfiguration()
• public JApplicationCli out()
• public string in()
• public mixed set()
• protected mixed fetchConfigurationData()
• protected void doExecute()
• // Inherited methods from JApplicationBase
• public void close()
• public mixed getIdentity()
• public JApplicationBase registerEvent()
• public array triggerEvent()
• public JApplicationBase loadDispatcher()
• public JApplicationBase loadIdentity()
}


Hierarchy

Extends

• JApplicationBase

Extended by

• JApplicationDaemonInspector
• JApplicationCliInspector
• KeychainManager
• Updatecron
• DeletefilesCli
• FinderCli
• GarbageCron
• MediawikiCli
• GenerateCss
• JCli
• JDaemon
• JApplicationDaemon

Members

protected

• $config — JRegistry
• $dispatcher — JEventDispatcher
  The application dispatcher object.
• $identity — JUser
  The application identity object.
• $instance — JApplicationCli

public

• $input — JInput
  The application input object.

Methods

protected

• 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.
• 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.

public

• __construct() — Class constructor.
• execute() — Execute the application.
• get() — Returns a property of the object or the default value if the property is not set.
• getInstance() — Returns a reference to the global JApplicationCli object, only creating it if it doesn't already exist.
• in() — Get a value from standard input.
• loadConfiguration() — Load an object or array into the application configuration object.
• out() — Write a string to standard output.
• set() — Modifies a property of the object, creating it if it does not already exist.

Inherited from JApplicationBase

public

• close() — Method to close the application.
• getIdentity() — Get the application identity.
• loadDispatcher() — Allows the application to load a custom or default dispatcher.
• loadIdentity() — Allows the application to load a custom or default identity.
• registerEvent() — Registers a handler to a particular event group.
• triggerEvent() — Calls all handlers associated with an event group.