Batch1211 at 19:11, 10 August 2009

2009-08-10T19:11:53Z

Batch1211: New page: This method checks if valid credentials have been passed through the request. If so, they are set as the new credentials for the client. Since this method is used to determine, if the inpu...

2008-12-14T13:39:44Z

New page: This method checks if valid credentials have been passed through the request. If so, they are set as the new credentials for the client. Since this method is used to determine, if the inpu...

New page

This method checks if valid credentials have been passed through the request. If so, they are set as the new credentials for the client. Since this method is used to determine, if the input fields for the client settings need to be shown, this method returns '''FALSE''' if the credentials passed by the request could be successfully stored '''OR''' the credentials have been stored via the Global Configurations. Otherwise this method reurns '''TRUE'''.
===Syntax===
<code>boolean setCredentials ($client, $user, $pass) <code>

{| class="wikitable"
!Argument
!Data type
!Description
!Default
|-
|$client
|string
|Client name, currently only 'ftp' is supported
|}

=== Request Parameters ===
The method checks for the following two request parameters, that shall be used to set the credentials for the given client.
* '''username'''
* '''password'''

=== Returns ===
Returns '''FALSE''' if:
* Parameters 'username' and 'password' that are passed via the request are not empty '''AND''' are valid (See [[JClientHelper/setCredentials]]). '''OR''':
* The credentials for the given client are set in the Global Configurations.
===Example===
In this example, we want to find out, if we need to show the login form for the FTP client:
<source lang="php">
jimport('joomla.client.helper');

if(JClientHelper::setCredentialsFromRequest('ftp'){
// show login form
}
// continue with code
</source>
This code checks if the credentials for the FTP client are passed via the request, or are already stored via the Global Configurations. If this is the case, the code continues without the login form beeing displayed. Otherwise, the login form is displayed.
===See also===
* [[JClientHelper/setCredentials]]
* [http://api.joomla.org/Joomla-Framework/Client/JClientHelper.html#setCredentialsFromRequest JClientHelper::setCredentialsFromRequest on api.joomla.org]
<noinclude>[[Category:Development]][[Category:Framework]][[Category:JClientHelper]]</noinclude>

@@ Line 1: / Line 1: @@
 This method checks if valid credentials have been passed through the request. If so, they are set as the new credentials for the client. Since this method is used to determine, if the input fields for the client settings need to be shown, this method returns '''FALSE''' if the credentials passed by the request could be successfully stored '''OR''' the credentials have been stored via the Global Configurations. Otherwise this method reurns '''TRUE'''.
 ===Syntax===
-<code>boolean   setCredentials  ($client, $user, $pass) <code>
+<code>boolean   setCredentials  ($client, $user, $pass) </code>
 {| class="wikitable"

JClientHelper/setCredentialsFromRequest - Revision history

Batch1211 at 19:11, 10 August 2009

Batch1211: New page: This method checks if valid credentials have been passed through the request. If so, they are set as the new credentials for the client. Since this method is used to determine, if the inpu...