Ingo_Transport_Ispconfig
extends Ingo_Transport_Base
in package
Ingo_Transport_Ispconfig implements an Ingo transport driver to allow scripts to be installed and set active on an ISPConfig server.
Ingo_Transport_
Tags
Table of Contents
- $_details : array<string|int, mixed>
- The current vacation details.
- $_params : array<string|int, mixed>
- Congifuration parameters.
- $_soap : SoapClient
- The SOAP connection
- $_soap_session : string
- The SOAP session id
- $_supportShares : bool
- Whether this driver allows managing other users' rules.
- __construct() : mixed
- Constructor.
- quote() : string
- Quotes user input if supported by the transport driver.
- setScriptActive() : mixed
- Sets a script running on the backend.
- supportShares() : bool
- Returns whether the driver supports managing other users' rules.
- _checkConfig() : mixed
- Checks if the realm has a specific configuration. If not, tries to fall back on the default configuration. If still not a valid configuration then returns an exception.
- _connect() : mixed
- Connects to the SOAP server.
- _getUserDetails() : array<string|int, mixed>
- Retrieves the current vacation details for the user.
Properties
$_details
The current vacation details.
protected
array<string|int, mixed>
$_details
= \null
$_params
Congifuration parameters.
protected
array<string|int, mixed>
$_params
= array('password' => \null, 'username' => \null)
$_soap
The SOAP connection
protected
SoapClient
$_soap
$_soap_session
The SOAP session id
protected
string
$_soap_session
$_supportShares
Whether this driver allows managing other users' rules.
protected
bool
$_supportShares
= \false
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $params : array<string|int, mixed> = array()
-
Configuration parameters.
Return values
mixed —quote()
Quotes user input if supported by the transport driver.
public
quote(string $string) : string
Parameters
- $string : string
-
A string to quote.
Return values
string —The quoted string.
setScriptActive()
Sets a script running on the backend.
public
setScriptActive(array<string|int, mixed> $script) : mixed
Parameters
- $script : array<string|int, mixed>
-
The filter script information. Passed elements:
- 'name': (string) the script name.
- 'recipes': (array) the filter recipe objects.
- 'script': (string) the filter script.
Tags
Return values
mixed —supportShares()
Returns whether the driver supports managing other users' rules.
public
supportShares() : bool
Return values
bool —True if the driver supports shares.
_checkConfig()
Checks if the realm has a specific configuration. If not, tries to fall back on the default configuration. If still not a valid configuration then returns an exception.
protected
_checkConfig() : mixed
Tags
Return values
mixed —_connect()
Connects to the SOAP server.
protected
_connect() : mixed
Tags
Return values
mixed —_getUserDetails()
Retrieves the current vacation details for the user.
protected
_getUserDetails(string $password) : array<string|int, mixed>
Parameters
- $password : string
-
The password for user.
Tags
Return values
array<string|int, mixed> —Vacation details