Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class ClientHelper - list of methods

Client helper class
Package: Joomla\CMS\Client
Copyright: (C) 2007 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Client/ClientHelper.php
Project: Joomla

Method Summary

public static array
(mixed $client, mixed $force = false)

Method to return the array of client layer configuration options
Parameters
  • string $client Client name, currently only 'ftp' is supported
  • bool $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
  • 1.7.0
Show source code of this method: getCredentials Source Code

public static bool
(mixed $client, mixed $user, mixed $pass)

Method to set client login credentials
Parameters
  • string $client Client name, currently only 'ftp' is supported
  • string $user Username
  • string $pass Password
Returns
  • bool True if the given login credentials have been set and are valid
Since
  • 1.7.0
Show source code of this method: setCredentials Source Code

public static bool
(mixed $client)

Method to determine if client login credentials are present
Parameters
  • string $client Client name, currently only 'ftp' is supported
Returns
  • bool True if login credentials are available
Since
  • 1.7.0
Show source code of this method: hasCredentials Source Code

public static bool
(mixed $client)

Determine whether input fields for client settings need to be shown
Parameters
  • string $client The name of the client.
Returns
  • bool True if credentials are present
Since
  • 1.7.0
-
  • \InvalidArgumentException if credentials invalid
Show source code of this method: setCredentialsFromRequest Source Code

Tags Summary

Since
1.7.0