Actions

JClientHelper/setCredentials

From Joomla! Documentation

Revision as of 13:39, 20 June 2013 by Tom Hutchison (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This method checks if the given 'user' and 'password' credentials for the given client are valid. If they are, the given credentials are set to be the new login credentials for that client. Returns TRUE if given login credentials have been set and are valid.

Contents

Syntax

boolean setCredentials ($client, $user, $pass)

Argument Data type Description Default
$client string Client name, currently only 'ftp' is supported
$user string Username
$pass string Password

Returns

Returns TRUE if given login credentials have been set and are valid.

Example

jimport('joomla.client.helper');
 
JClientHelper::setCredentials('ftp','username', 'password');

See also