Docs For Class Ingo

Description

Ingo_Driver:: defines an API to activate filter scripts on a server.

$Horde: ingo/lib/Driver.php,v 1.10.10.8 2007/12/20 14:05:47 jan Exp $

See the enclosed file LICENSE for license information (ASL). If you did not receive this file, see http://www.horde.org/licenses/asl.php.

Located in /lib/Driver.php (line 13)

Direct descendents

Class	Description
Ingo_Driver_ldap	Ingo_Driver_ldap:: Implements the Sieve_Driver api to allow scripts to be installed and set active via an LDAP server.
Ingo_Driver_null	Ingo_Driver_null:: Implements a null api -- useful for just testing the UI and storage.
Ingo_Driver_sivtest	Ingo_Driver_sivtest:: Implements the Sieve_Driver api to allow scripts to be installed and set active via the Cyrus sivtest command line utility.
Ingo_Driver_vfs	Ingo_Driver_vfs:: Implements an Ingo storage driver using Horde VFS.
Ingo_Driver_timsieved	Ingo_Driver_timsieved:: Implements the Sieve_Driver api to allow scripts to be installed and set active via a Cyrus timsieved server.

Variable Summary

array $_params

boolean $_support_shares

Method Summary

Ingo_Driver Ingo_Driver ([ $params = array()])

mixed factory (string $driver, [array $params = array()])

mixed setScriptActive (string $script)

boolean supportShares ()

Variables

array $_params = array(
'username' => null,
'password' => null
) (line 20)

Driver specific parameters

boolean $_support_shares = false (line 30)

Whether this driver allows managing other users' rules.

Redefined in descendants as:

Ingo_Driver_null::$_support_shares : Whether this driver allows managing other users' rules.
Ingo_Driver_sivtest::$_support_shares : Whether this driver allows managing other users' rules.
Ingo_Driver_vfs::$_support_shares : Whether this driver allows managing other users' rules.
Ingo_Driver_timsieved::$_support_shares : Whether this driver allows managing other users' rules.

Methods

Constructor Ingo_Driver (line 58)

Constructor.

Ingo_Driver Ingo_Driver ([ $params = array()])

factory (line 43)

Attempts to return a concrete Ingo_Driver instance based on $driver.

mixed factory (string $driver, [array $params = array()])

string $driver: The type of concrete Ingo_Driver subclass to return.
array $params: A hash containing any additional configuration or connection parameters a subclass might need.

setScriptActive (line 71)

Sets a script running on the backend.

return: True on success, false if script can't be activated. Returns PEAR_Error on error.

mixed setScriptActive (string $script)

Redefined in descendants as:

Ingo_Driver_ldap::setScriptActive() : Sets a script running on the backend.
Ingo_Driver_sivtest::setScriptActive() : Sets a script running on the backend.
Ingo_Driver_vfs::setScriptActive() : Sets a script running on the backend.
Ingo_Driver_timsieved::setScriptActive() : Sets a script running on the backend.

supportShares (line 81)

Returns whether the driver supports managing other users' rules.

boolean supportShares ()