API17:JClientHelper::getCredentials
From Joomla! Documentation
(Difference between revisions)
(Bulk upload by Doxiki2) |
(Layout updates) |
||
| Line 35: | Line 35: | ||
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 in=== | ===Defined in=== | ||
| − | libraries/joomla/client/helper.php | + | libraries/joomla/client/helper.php (line 34) |
| + | * see source code in [[jplatform:client/helper.php#cl-34|BitBucket]] | ||
===Referenced by=== | ===Referenced by=== | ||
| − | * [[JFolder | + | * [[JFolder::copy/11.1|JFolder::copy]] |
| − | * [[JFile | + | * [[JFile::copy/11.1|JFile::copy]] |
| − | * [[JFolder | + | * [[JFolder::create/11.1|JFolder::create]] |
| − | * [[JFolder | + | * [[JFolder::delete/11.1|JFolder::delete]] |
| − | * [[JFile | + | * [[JFile::delete/11.1|JFile::delete]] |
| − | * [[JFactory | + | * [[JFactory::getStream/11.1|JFactory::getStream]] |
| − | * [[JFolder | + | * [[JFolder::move/11.1|JFolder::move]] |
| − | * [[JFile | + | * [[JFile::move/11.1|JFile::move]] |
* [[setCredentials/11.1|setCredentials]] | * [[setCredentials/11.1|setCredentials]] | ||
| − | * [[JFile | + | * [[JFile::upload/11.1|JFile::upload]] |
| − | * [[JFile | + | * [[JFile::write/11.1|JFile::write]] |
===See also=== | ===See also=== | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
Revision as of 20:06, 23 April 2011
JClientHelper::getCredentials
Description
Method to return the array of client layer configuration options.
Description:JClientHelper::getCredentials [Edit Descripton]
Since
Synopsis
public static JClientHelper::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 in
libraries/joomla/client/helper.php (line 34)
- see source code in BitBucket
Referenced by
- JFolder::copy
- JFile::copy
- JFolder::create
- JFolder::delete
- JFile::delete
- JFactory::getStream
- JFolder::move
- JFile::move
- setCredentials
- JFile::upload
- JFile::write
See also
SeeAlso:JClientHelper::getCredentials
Examples
<CodeExamplesForm />
