JClientHelper/setCredentialsFromRequest

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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

Examples[edit]

Code Examples[edit]

API16