Actions

API17

Difference between revisions of "JClientHelper::getCredentials"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Updated to r1448:247ba8d88526)
(One intermediate revision by one user not shown)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JClientHelper::getCredentials|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JClientHelper::getCredentials|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public static JClientHelper::getCredentials ($client, $force=false)
+
public static function getCredentials (
 +
        $client
 +
        $force=false
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 32: Line 32:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''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
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/client/helper.php
+
* '''Referenced by'''
===Referenced by===
+
** [[JFolder::copy/11.1|JFolder::copy]]
* [[JFolder/copy/11.1|JFolder::copy]]
+
** [[JFile::copy/11.1|JFile::copy]]
* [[JFile/copy/11.1|JFile::copy]]
+
** [[JFolder::create/11.1|JFolder::create]]
* [[JFolder/create/11.1|JFolder::create]]
+
** [[JFolder::delete/11.1|JFolder::delete]]
* [[JFolder/delete/11.1|JFolder::delete]]
+
** [[JFile::delete/11.1|JFile::delete]]
* [[JFile/delete/11.1|JFile::delete]]
+
** [[JFactory::getStream/11.1|JFactory::getStream]]
* [[JFactory/getStream/11.1|JFactory::getStream]]
+
** [[JFolder::move/11.1|JFolder::move]]
* [[JFolder/move/11.1|JFolder::move]]
+
** [[JFile::move/11.1|JFile::move]]
* [[JFile/move/11.1|JFile::move]]
+
** [[setCredentials/11.1|setCredentials]]
* [[setCredentials/11.1|setCredentials]]
+
** [[JFile::upload/11.1|JFile::upload]]
* [[JFile/upload/11.1|JFile::upload]]
+
** [[JFile::write/11.1|JFile::write]]
* [[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>
* [[JClientHelper/11.1|JClientHelper]]
+
===User contributed notes===
* [[JClientHelper::getCredentials|Other versions of this method]]
+
{{SeeAlso:JClientHelper::getCredentials}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 63: 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

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 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

See also

SeeAlso:JClientHelper::getCredentials [Edit See Also]

User contributed notes

<CodeExamplesForm />