You are here

Home » API reference » Hostmaster (Aegir) 6

README.txt in Hostmaster (Aegir) 6

Same filename in this branch
  1. 6 README.txt
  2. 6 modules/hosting/quota/README.txt
API Documentation
~~~~~~~~~~~~~~~~~

Functions
---------

These are all defined in hosting_quota.module

hosting_quota_get($resource)
    Get info about a particular resource.
hosting_quota_get_usage($client, $resource, $start = NULL, $end = NULL)
    Get usage info about a resource for a given client, by calling that resources usage hook.
hosting_quota_resource_render($resource, $usage)
    Render a given resource, by calling its rendering hook.
hosting_quota_set_limit($client, $resource, $value)
    Sets the limit for a given clients quota.
hosting_quota_check($client, $resource, $start = NULL, $end = NULL)
    Convenient function to return a boolean, true if the client has not reached their limit, false if they have.
hosting_quota_get_all_info($client, $start = NULL, $end = NULL)
    Retrieve all of the info for a given clients quotas, within a declared period (defaults to the last month).

Hooks
-----

Hook definitions are documented in hosting_quota.hooks.php. A partial usage example was created in hosting_site.quota.inc

hook_hosting_quota_resource()
    Returns an array containing info about each resource provided by a module.
hook_hosting_quota_get_usage($client, $resource, $start, $end)
    This hook should return an integer that can be compared to the set limit.
hook_hosting_quota_resource_render($resource, $usage)
    This hook should return a human readable version of the usage for this resource.

File

modules/hosting/quota/README.txt
View source 
  1. API Documentation

  2. ~~~~~~~~~~~~~~~~~

  3. 

  4. Functions

  5. ---------

  6. 

  7. These are all defined in hosting_quota.module

  8. 

  9. hosting_quota_get($resource)

  10.     Get info about a particular resource.

  11. hosting_quota_get_usage($client, $resource, $start = NULL, $end = NULL)

  12.     Get usage info about a resource for a given client, by calling that resources usage hook.

  13. hosting_quota_resource_render($resource, $usage)

  14.     Render a given resource, by calling its rendering hook.

  15. hosting_quota_set_limit($client, $resource, $value)

  16.     Sets the limit for a given clients quota.

  17. hosting_quota_check($client, $resource, $start = NULL, $end = NULL)

  18.     Convenient function to return a boolean, true if the client has not reached their limit, false if they have.

  19. hosting_quota_get_all_info($client, $start = NULL, $end = NULL)

  20.     Retrieve all of the info for a given clients quotas, within a declared period (defaults to the last month).

  21. 

  22. Hooks

  23. -----

  24. 

  25. Hook definitions are documented in hosting_quota.hooks.php. A partial usage example was created in hosting_site.quota.inc

  26. 

  27. hook_hosting_quota_resource()

  28.     Returns an array containing info about each resource provided by a module.

  29. hook_hosting_quota_get_usage($client, $resource, $start, $end)

  30.     This hook should return an integer that can be compared to the set limit.

  31. hook_hosting_quota_resource_render($resource, $usage)

  32.     This hook should return a human readable version of the usage for this resource.