| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2011 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 413 lines (11 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| __construct(Input $input = null,Registry $config = null,CliOutput $output = null,CliInput $cliInput = null,DispatcherInterface $dispatcher = null,Container $container = null) X-Ref |
| Class constructor. param: Input $input An optional argument to provide dependency injection for the application's param: Registry $config An optional argument to provide dependency injection for the application's param: CliOutput $output The output handler. param: CliInput $cliInput The CLI input handler. param: DispatcherInterface $dispatcher An optional argument to provide dependency injection for the application's param: Container $container Dependency injection container. |
| __get($name) X-Ref |
| Magic method to access properties of the application. param: string $name The name of the property. return: mixed A value if the property name is valid, null otherwise. |
| getInput() X-Ref |
| Method to get the application input object. return: Input |
| getLanguage() X-Ref |
| Method to get the application language object. return: Language The language object |
| getInstance($name = null) X-Ref |
| Returns a reference to the global CliApplication object, only creating it if it doesn't already exist. This method must be invoked as: $cli = CliApplication::getInstance(); param: string $name The name (optional) of the Application Cli class to instantiate. return: CliApplication |
| execute() X-Ref |
| Execute the application. return: void |
| getOutput() X-Ref |
| Get an output object. return: CliOutput |
| getCliInput() X-Ref |
| Get a CLI input object. return: CliInput |
| out($text = '', $nl = true) X-Ref |
| Write a string to standard output. param: string $text The text to display. param: boolean $nl True (default) to append a new line at the end of the output string. return: $this |
| in() X-Ref |
| Get a value from standard input. return: string The input string from standard input. |
| setOutput(CliOutput $output) X-Ref |
| Set an output object. param: CliOutput $output CliOutput object return: $this |
| enqueueMessage($msg, $type = self::MSG_INFO) X-Ref |
| Enqueue a system message. param: string $msg The message to enqueue. param: string $type The message type. return: void |
| getMessageQueue() X-Ref |
| Get the system message queue. return: array The system message queue. |
| isClient($identifier) X-Ref |
| Check the client interface by name. param: string $identifier String identifier for the application interface return: boolean True if this application is of the given type client interface. |
| getSession() X-Ref |
| Method to get the application session object. return: SessionInterface The session object |
| getConfig() X-Ref |
| Retrieve the application configuration object. return: Registry |
| isCli() X-Ref |
| Flag if the application instance is a CLI or web based application. Helper function, you should use the native PHP functions to detect if it is a CLI application. return: boolean |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |