ClientWrapper.php
2.18 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<?php
/**
* Joomla! Content Management System
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Client;
defined('JPATH_PLATFORM') or die;
/**
* Wrapper class for ClientHelper
*
* @since 3.4
* @deprecated 4.0 Will be removed without replacement
*/
class ClientWrapper
{
/**
* Helper wrapper method for getCredentials
*
* @param string $client Client name, currently only 'ftp' is supported
* @param boolean $force Forces re-creation of the login credentials. Set this to
*
* @return array Client layer configuration options, consisting of at least
*
* @see ClientHelper::getCredentials()
* @since 3.4
*/
public function getCredentials($client, $force = false)
{
return ClientHelper::getCredentials($client, $force);
}
/**
* Helper wrapper method for setCredentials
*
* @param string $client Client name, currently only 'ftp' is supported
* @param string $user Username
* @param string $pass Password
*
* @return boolean True if the given login credentials have been set and are valid
*
* @see ClientHelper::setCredentials()
* @since 3.4
*/
public function setCredentials($client, $user, $pass)
{
return ClientHelper::setCredentials($client, $user, $pass);
}
/**
* Helper wrapper method for hasCredentials
*
* @param string $client Client name, currently only 'ftp' is supported
*
* @return boolean True if login credentials are available
*
* @see ClientHelper::hasCredentials()
* @since 3.4
*/
public function hasCredentials($client)
{
return ClientHelper::hasCredentials($client);
}
/**
* Helper wrapper method for setCredentialsFromRequest
*
* @param string $client The name of the client.
*
* @return mixed True, if FTP settings; JError if using legacy tree
*
* @see UserHelper::setCredentialsFromRequest()
* @since 3.4
* @throws \InvalidArgumentException if credentials invalid
*/
public function setCredentialsFromRequest($client)
{
return ClientHelper::setCredentialsFromRequest($client);
}
}