Class JClientHelper

Client helper class

Package: Joomla\Platform\Client
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/client/helper.php

Methods summary

`public static array`	# `getCredentials( string $client, boolean $force = false )` Method to return the array of client layer configuration options Method to return the array of client layer configuration options Parameters `$client` `string` - $client Client name, currently only 'ftp' is supported `$force` `boolean` - $force Forces re-creation of the login credentials. Set this to true if login credentials in the session storage have changed Returns `array` - Client layer configuration options, consisting of at least these fields: enabled, host, port, user, pass, root Since 11.1
`public static boolean`	# `setCredentials( string $client, string $user, string $pass )` Method to set client login credentials Method to set client login credentials Parameters `$client` `string` - $client Client name, currently only 'ftp' is supported `$user` `string` - $user Username `$pass` `string` - $pass Password Returns `boolean` - True if the given login credentials have been set and are valid Since 11.1
`public static boolean`	# `hasCredentials( string $client )` Method to determine if client login credentials are present Method to determine if client login credentials are present Parameters `$client` `string` - $client Client name, currently only 'ftp' is supported Returns `boolean` - True if login credentials are available Since 11.1
`public static mixed`	# `setCredentialsFromRequest( string $client )` Determine whether input fields for client settings need to be shown Determine whether input fields for client settings need to be shown If valid credentials were passed along with the request, they are saved to the session. This functions returns an exception if invalid credentials have been given or if the connection to the server failed for some other reason. Parameters `$client` `string` - $client The name of the client. Returns `mixed` - True, if FTP settings; JError if using legacy tree. Throws `InvalidArgumentException` - if credentials invalid Since 11.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JClientHelper

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Magic methods summary