[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Client/ -> ClientHelper.php (summary)

Joomla! Content Management System

Copyright: (C) 2007 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 217 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ClientHelper:: (4 methods):
  getCredentials()
  setCredentials()
  hasCredentials()
  setCredentialsFromRequest()


Class: ClientHelper  - X-Ref

Client helper class

getCredentials($client, $force = false)   X-Ref
Method to return the array of client layer configuration options

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

setCredentials($client, $user, $pass)   X-Ref
Method to set client login credentials

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

hasCredentials($client)   X-Ref
Method to determine if client login credentials are present

param: string  $client  Client name, currently only 'ftp' is supported
return: boolean  True if login credentials are available

setCredentialsFromRequest($client)   X-Ref
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.

param: string  $client  The name of the client.
return: boolean  True if credentials are present



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer