API16:JClientHelper/setCredentialsFromRequest

Description

Determine wether input fields for client settings need to be shown

<! 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 transcluded page call, red link never existed >

Examples

<CodeExamplesForm />