API17:JClientHelper::getCredentials
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JClientHelper::getCredentials|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JClientHelper::getCredentials|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public static | + | public static function getCredentials ( |
| + | $client | ||
| + | $force=false | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 32: | Line 32: | ||
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' array Client layer configuration options, consisting of at least these fields: enabled, host, port, user, pass, root | |
| − | array Client layer configuration options, consisting of at least these fields: enabled, host, port, user, pass, root | + | * '''Defined''' on line 34 of libraries/joomla/client/helper.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/client/helper.php | + | * '''Referenced by''' |
| − | * | + | ** [[JFolder::copy/11.1|JFolder::copy]] |
| − | + | ** [[JFile::copy/11.1|JFile::copy]] | |
| − | * [[JFolder::copy/11.1|JFolder::copy]] | + | ** [[JFolder::create/11.1|JFolder::create]] |
| − | * [[JFile::copy/11.1|JFile::copy]] | + | ** [[JFolder::delete/11.1|JFolder::delete]] |
| − | * [[JFolder::create/11.1|JFolder::create]] | + | ** [[JFile::delete/11.1|JFile::delete]] |
| − | * [[JFolder::delete/11.1|JFolder::delete]] | + | ** [[JFactory::getStream/11.1|JFactory::getStream]] |
| − | * [[JFile::delete/11.1|JFile::delete]] | + | ** [[JFolder::move/11.1|JFolder::move]] |
| − | * [[JFactory::getStream/11.1|JFactory::getStream]] | + | ** [[JFile::move/11.1|JFile::move]] |
| − | * [[JFolder::move/11.1|JFolder::move]] | + | ** [[setCredentials/11.1|setCredentials]] |
| − | * [[JFile::move/11.1|JFile::move]] | + | ** [[JFile::upload/11.1|JFile::upload]] |
| − | * [[setCredentials/11.1|setCredentials]] | + | ** [[JFile::write/11.1|JFile::write]] |
| − | * [[JFile::upload/11.1|JFile::upload]] | + | |
| − | * [[JFile::write/11.1|JFile::write]] | + | |
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JClientHelper::getCredentials source code''' on [[jplatform:client/helper.php#cl-26|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JClientHelper/11.1|JClientHelper]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_Client/11.1|Client]] | ||
| + | * [[JClientHelper::getCredentials|Other versions of JClientHelper::getCredentials]] | ||
| + | {{SeeAlso:JClientHelper::getCredentials}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JClientHelper::getCredentials|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JClientHelper::getCredentials|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 64: | Line 64: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JClientHelper]][[Category:JClientHelper::getCredentials]]</noinclude> | <noinclude>[[Category:JClientHelper]][[Category:JClientHelper::getCredentials]]</noinclude> | ||
Revision as of 20:21, 27 April 2011
JClientHelper::getCredentials
Description
Method to return the array of client layer configuration options.
Description:JClientHelper::getCredentials [Edit Descripton]
public static function getCredentials ( $client $force=false )
| Parameter | Type | Default | Description |
|---|---|---|---|
| $client | string | Client name, currently only 'ftp' is supported | |
| $force | boolean | false | Forces re-creation of the login credentials. Set this to true if login credentials in the session storage have changed |
- Returns array Client layer configuration options, consisting of at least these fields: enabled, host, port, user, pass, root
- Defined on line 34 of libraries/joomla/client/helper.php
- Since
- Referenced by
See also
- JClientHelper::getCredentials source code on BitBucket
- Class JClientHelper
- Subpackage Client
- Other versions of JClientHelper::getCredentials
SeeAlso:JClientHelper::getCredentials [Edit See Also]
User contributed notes
<CodeExamplesForm />
