API17

Difference between revisions of "JCli::loadConfiguration"

From Joomla! Documentation

(Layout updates)
m (→‎See also: moving preparation)
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
=={{JVer|11.1}} JCli::loadConfiguration==
 
=={{JVer|11.1}} JCli::loadConfiguration==
 
===Description===
 
===Description===
Load the configuration file into the site object.  
+
Load an object or array into the application configuration object.  
  
 
{{Description:JCli::loadConfiguration}}
 
{{Description:JCli::loadConfiguration}}
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JCli::loadConfiguration|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JCli::loadConfiguration|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
protected JCli::loadConfiguration ($file)
+
public function loadConfiguration ($data)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 21: Line 18:
 
!Description
 
!Description
 
|-
 
|-
|$file
+
|$data
|string
+
|mixed
 
|
 
|
|The path to the configuration file.
+
|Either an array or object to be loaded into the configuration object.
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' void
bool True on success.
+
* '''Defined''' on line 131 of libraries/joomla/application/cli.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/application/cli.php (line 251)
 
* see source code in [[jplatform:application/cli.php#cl-251|BitBucket]]
 
===Referenced by===
 
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JCli::loadConfiguration source code''' on [[jplatform:application/cli.php#cl-123|BitBucket]]
 +
* {{JVer|11.1}} Class [[API17:JCli|JCli]]
 +
* {{JVer|11.1}} Subpackage [[API17:Subpackage_Application|Application]]
 +
* [[API17:JCli::loadConfiguration|Other versions of JCli::loadConfiguration]]
 +
{{SeeAlso:JCli::loadConfiguration}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JCli::loadConfiguration|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JCli::loadConfiguration|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JCli/11.1|JCli]]
+
===User contributed notes===
* [[JCli::loadConfiguration|Other versions of this method]]
 
{{SeeAlso:JCli::loadConfiguration}}
 
===Examples===
 
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 48: Line 44:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
<noinclude>[[Category:JCli]][[Category:JCli::loadConfiguration]]</noinclude>
+
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Revision as of 19:56, 11 May 2013

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Joomla 11.1 JCli::loadConfiguration[edit]

Description[edit]

Load an object or array into the application configuration object.

Template:Description:JCli::loadConfiguration [Edit Descripton]

public function loadConfiguration ($data)
Parameter Type Default Description
$data mixed Either an array or object to be loaded into the configuration object.
  • Returns void
  • Defined on line 131 of libraries/joomla/application/cli.php
  • Since Joomla 11.1

See also[edit]

Template:SeeAlso:JCli::loadConfiguration [Edit See Also]

User contributed notes[edit]

<CodeExamplesForm />