Class JClientWrapperHelper

Wrapper class for JClientHelper

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: 3.4
Located at joomla/client/wrapper/helper.php

Methods summary

`public array`	# `getCredentials( string $client, boolean $force = false )` Helper wrapper method for getCredentials Helper wrapper method for getCredentials Parameters `$client` `string` - $client Client name, currently only 'ftp' is supported `$force` `boolean` - $force Forces re-creation of the login credentials. Set this to Returns `array` - Client layer configuration options, consisting of at least Since 3.4 See `JClientHelper::getCredentials()`
`public boolean`	# `setCredentials( string $client, string $user, string $pass )` Helper wrapper method for setCredentials Helper wrapper method for setCredentials 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 3.4 See `JClientHelper::setCredentials()`
`public boolean`	# `hasCredentials( string $client )` Helper wrapper method for hasCredentials Helper wrapper method for hasCredentials Parameters `$client` `string` - $client Client name, currently only 'ftp' is supported Returns `boolean` - True if login credentials are available Since 3.4 See `JClientHelper::hasCredentials()`
`public mixed`	# `setCredentialsFromRequest( string $client )` Helper wrapper method for setCredentialsFromRequest Helper wrapper method for setCredentialsFromRequest 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 3.4 See JUserHelper::setCredentialsFromRequest()

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JClientWrapperHelper

Methods summary

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Throws

Since

See

Magic methods summary