Class Ingo_Driver

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
 class Ingo_Driver_ldap Ingo_Driver_ldap:: Implements the Sieve_Driver api to allow scripts to be installed and set active via an LDAP server.
 class Ingo_Driver_null Ingo_Driver_null:: Implements a null api -- useful for just testing the UI and storage.
 class 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.
 class Ingo_Driver_vfs Ingo_Driver_vfs:: Implements an Ingo storage driver using Horde VFS.
 class 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
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:
Methods
Constructor Ingo_Driver (line 58)

Constructor.

Ingo_Driver Ingo_Driver ([ $params = array()])
  • $params
factory (line 43)

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

  • return: The newly created concrete Ingo_Driver instance, or false on error.
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)
  • string $script: The filter script.

Redefined in descendants as:
supportShares (line 81)

Returns whether the driver supports managing other users' rules.

  • return: True if the driver supports shares.
boolean supportShares ()

Documentation generated on Sun, 30 Jan 2011 05:29:26 +0000 by phpDocumentor 1.4.3