Actions

API17

Difference between revisions of "JClientHelper::setCredentials"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JClientHelper::setCredentials|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JClientHelper::setCredentials|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public static JClientHelper::setCredentials ($client, $user, $pass)
+
public static function setCredentials (
 +
        $client
 +
        $user
 +
        $pass
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 37: Line 38:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' boolean True if the given login credentials have been set and are valid
boolean True if the given login credentials have been set and are valid
+
* '''Defined''' on line 98 of libraries/joomla/client/helper.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/client/helper.php (line 98)
+
* '''Referenced by'''
* see source code in [[jplatform:client/helper.php#cl-98|BitBucket]]
+
** [[setCredentialsFromRequest/11.1|setCredentialsFromRequest]]
===Referenced by===
+
* [[setCredentialsFromRequest/11.1|setCredentialsFromRequest]]
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JClientHelper::setCredentials source code''' on [[jplatform:client/helper.php#cl-90|BitBucket]]
 +
* {{JVer|11.1}} Class [[JClientHelper/11.1|JClientHelper]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Client/11.1|Client]]
 +
* [[JClientHelper::setCredentials|Other versions of JClientHelper::setCredentials]]
 +
{{SeeAlso:JClientHelper::setCredentials}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JClientHelper::setCredentials|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JClientHelper::setCredentials|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JClientHelper/11.1|JClientHelper]]
+
===User contributed notes===
* [[JClientHelper::setCredentials|Other versions of this method]]
+
{{SeeAlso:JClientHelper::setCredentials}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 59: Line 60:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JClientHelper]][[Category:JClientHelper::setCredentials]]</noinclude>
 
<noinclude>[[Category:JClientHelper]][[Category:JClientHelper::setCredentials]]</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::setCredentials

Description

Method to set client login credentials.

Description:JClientHelper::setCredentials [Edit Descripton]

public static function setCredentials (
        $client
        $user
        $pass
)
Parameter Type Default Description
$client string Client name, currently only 'ftp' is supported
$user string Username
$pass string Password
  • Returns boolean True if the given login credentials have been set and are valid
  • Defined on line 98 of libraries/joomla/client/helper.php
  • Since Joomla 11.1
  • Referenced by

See also

SeeAlso:JClientHelper::setCredentials [Edit See Also]

User contributed notes

<CodeExamplesForm />