API Documentation
\

\Ingo_Transport_Ispconfig

Ingo_Transport_Ispconfig implements an Ingo transport driver to allow scripts to be installed and set active on an ISPConfig server.

IngoTransport

Summary

Methods
Properties
Constants
__construct()
setScriptActive()
supportShares()
quote()
No public properties found
No constants found
_getUserDetails()
_checkConfig()
_connect()
$_params
$_supportShares
$_soap
$_soap_session
$_details
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : array

Congifuration parameters.

Type

array

$_supportShares

$_supportShares : boolean

Whether this driver allows managing other users' rules.

Type

boolean

$_soap

$_soap : \SoapClient

The SOAP connection

Type

\SoapClient

$_soap_session

$_soap_session : string

The SOAP session id

Type

string

$_details

$_details : array

The current vacation details.

Type

array

Methods

__construct()

__construct(array  $params = array())

Constructor.

Parameters

array $params

Configuration parameters.

setScriptActive()

setScriptActive(array  $script)

Sets a script running on the backend.

Parameters

array $script

The filter script information. Passed elements:

  • 'name': (string) the script name.
  • 'recipes': (array) the filter recipe objects.
  • 'script': (string) the filter script.

Throws

\Ingo_Exception

supportShares()

supportShares() : boolean

Returns whether the driver supports managing other users' rules.

Returns

boolean —

True if the driver supports shares.

quote()

quote(string  $string) : string

Quotes user input if supported by the transport driver.

Parameters

string $string

A string to quote.

Returns

string —

The quoted string.

_getUserDetails()

_getUserDetails(string  $password) : array

Retrieves the current vacation details for the user.

Parameters

string $password

The password for user.

Throws

\Ingo_Exception

Returns

array —

Vacation details

_checkConfig()

_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.

Throws

\Ingo_Exception

_connect()

_connect()

Connects to the SOAP server.

Throws

\Ingo_Exception