API17:JCli
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
m (→User contributed notes: bad link repair) |
||
| (One intermediate revision by one user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JCli== | ||
| + | ===Description=== | ||
| + | {{Description:JCli}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JCli|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JCli|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JCli::close/11.1|close]] | |[[JCli::close/11.1|close]] | ||
|Exit the application. | |Exit the application. | ||
|- | |- | ||
| + | |public | ||
|[[JCli::execute/11.1|execute]] | |[[JCli::execute/11.1|execute]] | ||
|Execute the application. | |Execute the application. | ||
|- | |- | ||
| + | |public | ||
|[[JCli::get/11.1|get]] | |[[JCli::get/11.1|get]] | ||
|Returns a property of the object or the default value if the property is not set. | |Returns a property of the object or the default value if the property is not set. | ||
|- | |- | ||
| + | |public | ||
|[[JCli::in/11.1|in]] | |[[JCli::in/11.1|in]] | ||
|Get a value from standard input. | |Get a value from standard input. | ||
|- | |- | ||
| + | |public | ||
| + | |[[JCli::loadConfiguration/11.1|loadConfiguration]] | ||
| + | |Load an object or array into the application configuration object. | ||
| + | |- | ||
| + | |public | ||
|[[JCli::out/11.1|out]] | |[[JCli::out/11.1|out]] | ||
|Write a string to standard output. | |Write a string to standard output. | ||
|- | |- | ||
| + | |public | ||
|[[JCli::registerEvent/11.1|registerEvent]] | |[[JCli::registerEvent/11.1|registerEvent]] | ||
|Registers a handler to a particular event group. | |Registers a handler to a particular event group. | ||
|- | |- | ||
| + | |public | ||
|[[JCli::set/11.1|set]] | |[[JCli::set/11.1|set]] | ||
|Modifies a property of the object, creating it if it does not already exist. | |Modifies a property of the object, creating it if it does not already exist. | ||
|- | |- | ||
| + | |public | ||
|[[JCli::triggerEvent/11.1|triggerEvent]] | |[[JCli::triggerEvent/11.1|triggerEvent]] | ||
|Calls all handlers associated with an event group. | |Calls all handlers associated with an event group. | ||
|- | |- | ||
| + | |public | ||
|[[JCli::getInstance/11.1|getInstance]] | |[[JCli::getInstance/11.1|getInstance]] | ||
|Returns a reference to the global object, only creating it if it doesn't already exist. | |Returns a reference to the global object, only creating it if it doesn't already exist. | ||
|- | |- | ||
| + | |protected | ||
|[[JCli::__construct/11.1|__construct]] | |[[JCli::__construct/11.1|__construct]] | ||
|Class constructor. | |Class constructor. | ||
|- | |- | ||
| − | |[[JCli:: | + | |protected |
| − | | | + | |[[JCli::fetchConfigurationData/11.1|fetchConfigurationData]] |
| + | |Method to load a PHP configuration class file based on convention and return the instantiated data object. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/application/cli.php | ||
| + | * '''Extended by''' | ||
| + | ** [[JDaemon/11.1|JDaemon]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.application.cli' );</source> | <source lang="php">jimport( 'joomla.application.cli' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JCli source code | + | * {{JVer|11.1}} '''JCli source code''' on [[jplatform:application/cli.php|BitBucket]] |
| − | * [[JCli|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Application/11.1|Application]] |
| + | * [[JCli|Other versions of JCli]] | ||
{{SeeAlso:JCli}} | {{SeeAlso:JCli}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JCli|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JCli|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 69: | Line 83: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| − | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JCli]]</noinclude> | + | <noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JCli]]</noinclude> |
Revision as of 13:32, 29 August 2012
JCli
Description
Description:JCli [Edit Descripton]
Methods
| Visibility | Method name | Description |
|---|---|---|
| public | close | Exit the application. |
| public | execute | Execute the application. |
| public | get | Returns a property of the object or the default value if the property is not set. |
| public | in | Get a value from standard input. |
| public | loadConfiguration | Load an object or array into the application configuration object. |
| public | out | Write a string to standard output. |
| public | registerEvent | Registers a handler to a particular event group. |
| public | set | Modifies a property of the object, creating it if it does not already exist. |
| public | triggerEvent | Calls all handlers associated with an event group. |
| public | getInstance | Returns a reference to the global object, only creating it if it doesn't already exist. |
| protected | __construct | Class constructor. |
| protected | fetchConfigurationData | Method to load a PHP configuration class file based on convention and return the instantiated data object. |
- Defined in libraries/joomla/application/cli.php
- Extended by
Importing
jimport( 'joomla.application.cli' );
See also
- JCli source code on BitBucket
- Subpackage Application
- Other versions of JCli
User contributed notes
<CodeExamplesForm />
