Class Vacation_AliasDriver

Description

Vacation_AliasDriver:: defines an API for implementing vacation backends for the vacation module.

$Horde: vacation/lib/AliasDriver.php,v 1.8.2.4 2009/01/06 15:28:06 jan Exp $

Copyright 2004-2009 The Horde Project (http://www.horde.org/)

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

Located in /lib/AliasDriver.php (line 16)


	
			
Direct descendents
Class Description
 class Vacation_AliasDriver_ftp Vacation_AliasDriver:: defines an API for implementing vacation backends for the vacation module.
 class Vacation_AliasDriver_none Vacation_AliasDriver:: defines an API for implementing vacation backends for the vacation module.
Variable Summary
 array $_params
 string $_user
Method Summary
 Vacation_AliasDriver Vacation_AliasDriver (string $user, [array $params = array()])
 mixed factory (string $user, [string $driver = null], [array $params = null])
 mixed getAliases ()
Variables
array $_params (line 30)

Hash containing configuration data.

string $_user (line 23)

The current user name.

Methods
Constructor Vacation_AliasDriver (line 38)

Constructor

Vacation_AliasDriver Vacation_AliasDriver (string $user, [array $params = array()])
  • string $user: A user name.
  • array $params: Configuration parameters for the backend.
factory (line 92)

Creates a concrete Vacation_AliasDriver:: instance.

  • return: The newly created concrete Vacation_AliasDriver instance, or false on error.
mixed factory (string $user, [string $driver = null], [array $params = null])
  • string $user: A user name.
  • string $driver: The type of concrete Vacation_AliasDriver subclass to return.
  • array $params: A hash containing any additional configuration or connection parameters a subclass might need.
getAliases (line 50)

Retrieve the aliases.

  • return: A key/value array of aliases (the right-hand side is arrays), or PEAR_Error on failure.
mixed getAliases ()

Redefined in descendants as:
getAliasesForUser (line 63)

Figure out which aliases are for this user.

Here we find all aliases which have only the specified user on the right-hand-side (if there are more, it is assumed to be a list).

  • return: An array of the aliases, or PEAR_Error on failure.
mixed getAliasesForUser ()

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