Class IMP_Quota

Description

IMP_Quota:: provides an API for retrieving Quota details from a mail server.

$Horde: imp/lib/Quota.php,v 1.23.10.15 2009/01/06 15:24:04 jan Exp $

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

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

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


	
			
Direct descendents
Class Description
 class IMP_Quota_command Implementation of the Quota API for IMAP servers with a unix quota command.
 class IMP_Quota_hook Implementation of the Quota API for a generic hook function. This
 class IMP_Quota_imap Implementation of the Quota API for IMAP servers.
 class IMP_Quota_logfile Implementation of the Quota API for servers where IMAP Quota is not supported, but it appears in the servers messages log for the IMAP server.
 class IMP_Quota_Maildir Implementation of the Quota API for servers using Maildir++ quota files on the local filesystem. Currently only supports storage limit, but should be expanded to be configurable to support storage or message limits in the configuration array.
 class IMP_Quota_mdaemon Implementation of the Quota API for MDaemon servers.
 class IMP_Quota_mercury32 Implementation of the Quota API for Mercury/32 IMAP servers.
 class IMP_Quota_sql Implementation of the Quota API for servers keeping quota information in a custom SQL database.
Variable Summary
 array $_params
Method Summary
 IMP_Quota IMP_Quota ([array $params = array()])
 mixed &factory (string $driver, [array $params = array()])
 array getMessages ()
 mixed getQuota ()
 mixed &singleton (string $driver, [array $params = array()])
Variables
array $_params = array() (line 23)

Hash containing connection parameters.

Methods
Constructor IMP_Quota (line 30)

Constructor.

IMP_Quota IMP_Quota ([array $params = array()])
  • array $params: Hash containing connection parameters.
factory (line 86)

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

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

Returns the quota messages variants, including sprintf placeholders.

  • return: A hash with quota message templates.
array getMessages ()
getQuota (line 49)

Get quota information (used/allocated), in bytes.

  • return: An associative array. 'limit' = Maximum quota allowed 'usage' = Currently used portion of quota (in bytes) Returns PEAR_Error on failure.
mixed getQuota ()

Redefined in descendants as:
singleton (line 117)

Attempts to return a reference to a concrete Quota instance based on $driver.

It will only create a new instance if no Quota instance with the same parameters currently exists.

This should be used if multiple quota sources are required.

This method must be invoked as: $var = &Quota::singleton()

  • return: The created concrete Quota instance, or false on error.
mixed &singleton (string $driver, [array $params = array()])
  • string $driver: The type of concrete Quota subclass to return.
  • array $params: A hash containing any additional configuration or connection parameters a subclass might need.

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