JClientHelper::getCredentials
From Joomla! Documentation
The "API17" 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.
JClientHelper::getCredentials[edit]
Description[edit]
Method to return the array of client layer configuration options.
Template:Description:JClientHelper::getCredentials [Edit Descripton]
Since[edit]
Synopsis[edit]
public static JClientHelper::getCredentials ($client, $force=false)
Parameter | Type | Default | Description |
---|---|---|---|
$client | string | Client name, currently only 'ftp' is supported | |
$force | boolean | false | Forces re-creation of the login credentials. Set this to true if login credentials in the session storage have changed |
Returns[edit]
array Client layer configuration options, consisting of at least these fields: enabled, host, port, user, pass, root
Defined in[edit]
libraries/joomla/client/helper.php
Referenced by[edit]
- JFolder::copy
- JFile::copy
- JFolder::create
- JFolder::delete
- JFile::delete
- JFactory::getStream
- JFolder::move
- JFile::move
- setCredentials
- JFile::upload
- JFile::write
See also[edit]
Template:SeeAlso:JClientHelper::getCredentials
Examples[edit]
<CodeExamplesForm />