JClientHelper/setCredentialsFromRequest
From Joomla! Documentation
< API15:JClientHelper
The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
Description[edit]
Determine wether input fields for client settings need to be shown
Template:Description:JClientHelper/setCredentialsFromRequest
Syntax[edit]
& setCredentialsFromRequest($client)
Parameter Name | Default Value | Description |
---|---|---|
$client |
Returns[edit]
boolean|JExeption True, if FTP settings should be shown, or an exeption
Defined in[edit]
libraries/joomla/client/helper.php
Importing[edit]
jimport( 'joomla.client.helper' );
Source Body[edit]
function &setCredentialsFromRequest($client)
{
// Determine wether FTP credentials have been passed along with the current request
$user = JRequest::getString('username', null, 'POST', JREQUEST_ALLOWRAW);
$pass = JRequest::getString('password', null, 'POST', JREQUEST_ALLOWRAW);
if ($user != '' && $pass != '')
{
// Add credentials to the session
if (JClientHelper::setCredentials($client, $user, $pass)) {
$return = false;
} else {
$return =& JError::raiseWarning('SOME_ERROR_CODE', 'JClientHelper::setCredentialsFromRequest failed');
}
}
else
{
// Just determine if the FTP input fields need to be shown
$return = !JClientHelper::hasCredentials('ftp');
}
return $return;
}
[Edit See Also] Template:SeeAlso:JClientHelper/setCredentialsFromRequest
Examples[edit]
<CodeExamplesForm />