Class IMP_Quota_hook

Description

Implementation of the Quota API for a generic hook function. This

requires hook_get_quota to be set in config/hooks.php . The function takes an array as argument and returns an array where the first item is the disk space used in bytes and the second the maximum diskspace in bytes. See there for an example.

You must configure this driver in horde/imp/config/servers.php. The driver supports the following parameters: 'params' => Array of parameters to pass to the quota function.

$Horde: imp/lib/Quota/hook.php,v 1.1.2.5 2009/11/06 22:22:17 slusarz 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/hook.php (line 23)

IMP_Quota
   |
   --IMP_Quota_hook
Method Summary
 mixed getQuota ()
Variables

Inherited Variables

Inherited from IMP_Quota

IMP_Quota::$_params
Methods
getQuota (line 33)

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 ()

Redefinition of:
IMP_Quota::getQuota()
Get quota information (used/allocated), in bytes.

Inherited Methods

Inherited From IMP_Quota

 IMP_Quota::IMP_Quota()
 IMP_Quota::factory()
 IMP_Quota::getMessages()
 IMP_Quota::getQuota()
 IMP_Quota::singleton()

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