JClientHelper/setCredentialsFromRequest: Difference between revisions
From Joomla! Documentation
New page: ===Description===
Determine wether input fields for client settings need to be shown
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JClientHelper/se... |
m removing red link to edit, no existant pages |
||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Syntax=== | ===Syntax=== | ||
| Line 57: | Line 57: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Examples=== | ===Examples=== | ||
| Line 72: | Line 72: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API16]] | |||
Revision as of 02:56, 13 May 2013
Description
Determine wether input fields for client settings need to be shown
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax
setCredentialsFromRequest($client)
| Parameter Name | Default Value | Description |
|---|---|---|
| $client |
Returns
boolean|JExeption True, if FTP settings should be shown, or an exeption
Defined in
libraries/joomla/client/helper.php
Importing
jimport( 'joomla.client.helper' );
Source Body
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;
}
[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples
<CodeExamplesForm />