API Documentation
\

\Ingo_Transport_Base

Ingo_Transport defines an API to activate filter scripts on a server.

Summary

Methods
Properties
Constants
__construct()
setScriptActive()
supportShares()
quote()
No public properties found
No constants found
No protected methods found
$_params
$_supportShares
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

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.