API15

Difference between revisions of "JClientHelper/setCredentialsFromRequest"

From Joomla! Documentation

< API15:JClientHelper
(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>[[Description:JClientHelper/setCredentialsFromRequest|Edit Descripton]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
  
{{Description:JClientHelper/setCredentialsFromRequest}}
+
<! 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>[[SeeAlso:JClientHelper/setCredentialsFromRequest|Edit See Also]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
{{SeeAlso:JClientHelper/setCredentialsFromRequest}}
+
<! removed transcluded page call, red link never existed >
  
 
===Examples===
 
===Examples===
Line 72: Line 72:
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>
 +
[[Category:Archived pages API15]]

Revision as of 08:52, 12 May 2013

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

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

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;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples[edit]

<CodeExamplesForm />