File/lib/api.php

Description

Horde external API interface.

This file defines Horde's external API interface. Other applications can interact with Horde through this API.

$Horde: horde/lib/api.php,v 1.43.2.17 2009/12/07 18:30:20 mrubinsk Exp $

Functions
_horde_addGroup (line 463)

Adds a group to the groups system.

void _horde_addGroup (string $name, [string $parent = null])
  • string $name: The group's name.
  • string $parent: The group's parent's name.
_horde_addGroupPermissions (line 783)

Gives a group certain privileges for a share.

void _horde_addGroupPermissions (string $shareRoot, string $shareName, string $groupName, array $permissions)
  • string $shareRoot: The name of the share root, e.g. the application that the share belongs to.
  • string $shareName: The share's name.
  • string $groupName: The group's name.
  • array $permissions: A list of permissions (show, read, edit, delete).
_horde_addShare (line 660)

Adds a share to the shares system.

void _horde_addShare (string $shareRoot, string $shareName, string $shareTitle, string $userName)
  • string $shareRoot: The name of the share root, e.g. the application that the share belongs to.
  • string $shareName: The share's name.
  • string $shareTitle: The share's human readable title.
  • string $userName: The share's owner.
_horde_addUserPermissions (line 745)

Gives a user certain privileges for a share.

void _horde_addUserPermissions (string $shareRoot, string $shareName, string $userName, array $permissions)
  • string $shareRoot: The name of the share root, e.g. the application that the share belongs to.
  • string $shareName: The share's name.
  • string $userName: The user's name.
  • array $permissions: A list of permissions (show, read, edit, delete).
_horde_addUsersToGroup (line 544)

Adds multiple users to a group.

void _horde_addUsersToGroup (string $name, array $users)
  • string $name: The group's name.
  • array $users: The users to add.
_horde_addUserToGroup (line 518)

Adds a user to a group.

void _horde_addUserToGroup (string $name, string $user)
  • string $name: The group's name.
  • string $user: The user to add.
_horde_admin_list (line 189)

Returns a list of adminstrative links

void _horde_admin_list ()
_horde_block (line 271)

Helper method to return an instance of the Horde_Block class. This should not be exposed directly in the API; it is used by _horde_blockTitle and _horde_BlockContent.

  • return: The Horde_Block instance.
Horde_Block _horde_block (string $app, string $name, [array $params = array()])
  • string $app: Block application.
  • string $name: Block name.
  • array $params: Block parameters.
_horde_blockContent (line 313)

Returns a Horde_Block's content.

  • return: The block content.
string _horde_blockContent (string $app, string $name, [array $params = array()])
  • string $app: Block application.
  • string $name: Block name.
  • array $params: Block parameters.
_horde_blocks (line 328)

Returns a pretty printed list of all available blocks.

  • return: A hash with block IDs as keys and application plus block block names as values.
array _horde_blocks ()
_horde_blockTitle (line 295)

Returns a Horde_Block's title.

  • return: The block title.
string _horde_blockTitle (string $app, string $name, [array $params = array()])
  • string $app: Block application.
  • string $name: Block name.
  • array $params: Block parameters.
_horde_getPreference (line 349)

Returns the value of the requested preference.

  • return: The value of the preference, null if it doesn't exist.
string _horde_getPreference (string $app, string $pref)
  • string $app: The application of the preference to retrieve.
  • string $pref: The name of the preference to retrieve.
_horde_listAPIs (line 253)

Returns all available registry APIs.

  • return: The API list.
array _horde_listAPIs ()
_horde_listApps (line 243)

Returns a list of the installed and registered applications.

  • return: List of apps registered with Horde. If no applications are defined returns an empty array.
array _horde_listApps ([array $filter = null])
  • array $filter: An array of the statuses that should be returned. Defaults to non-hidden.
_horde_listGroupPermissions (line 930)

Returns an array of all group permissions on a share.

  • return: All group permissions for this share.
array _horde_listGroupPermissions (string $shareRoot, string $shareName, string $groupName)
  • string $shareRoot: The name of the share root, e.g. the application that the share belongs to.
  • string $shareName: The share's name.
  • string $groupName: The group's name.
_horde_listGroupsOfShare (line 1006)

Returns a list of groups which have have certain permissions on a share.

  • return: List of groups with the specified permissions.
array _horde_listGroupsOfShare (string $shareRoot, string $shareName, array $permissions)
  • string $shareRoot: The name of the share root, e.g. the application that the share belongs to.
  • string $shareName: The share's name.
  • array $permissions: A list of permissions (show, read, edit, delete).
_horde_listSharesOfOwner (line 718)

Returns an array of all shares that $userName is the owner of.

  • return: The list of shares.
array _horde_listSharesOfOwner (string $shareRoot, string $userName)
  • string $shareRoot: The name of the share root, e.g. the application that the share belongs to.
  • string $userName: The share's owner.
_horde_listUserPermissions (line 888)

Returns an array of all user permissions on a share.

  • return: All user permissions for this share.
array _horde_listUserPermissions (string $shareRoot, string $shareName, string $userName)
  • string $shareRoot: The name of the share root, e.g. the application that the share belongs to.
  • string $shareName: The share's name.
  • string $userName: The user's name.
_horde_listUsersOfGroup (line 633)

Returns a list of users that are part of this group (and only this group)

  • return: The user list.
array _horde_listUsersOfGroup (string $name)
  • string $name: The group's name.
_horde_listUsersOfShare (line 972)

Returns a list of users which have have certain permissions on a share.

  • return: List of users with the specified permissions.
array _horde_listUsersOfShare (string $shareRoot, string $shareName, array $permissions)
  • string $shareRoot: The name of the share root, e.g. the application that the share belongs to.
  • string $shareName: The share's name.
  • array $permissions: A list of permissions (show, read, edit, delete).
_horde_perms (line 175)

Returns a list of available permissions.

void _horde_perms ()
_horde_removeGroup (line 492)

Removes a group from the groups system.

void _horde_removeGroup (string $name)
  • string $name: The group's name.
_horde_removeGroupPermissions (line 853)

Removes a group from a share.

void _horde_removeGroupPermissions (string $shareRoot, string $shareName, string $groupName)
  • string $shareRoot: The name of the share root, e.g. the application that the share belongs to.
  • string $shareName: The share's name.
  • string $groupName: The group's name.
_horde_removeShare (line 689)

Removes a share from the shares system permanently.

void _horde_removeShare (string $shareRoot, string $shareName)
  • string $shareRoot: The name of the share root, e.g. the application that the share belongs to.
  • string $shareName: The share's name.
_horde_removeUserData (line 374)

Removes user data.

void _horde_removeUserData (string $user)
  • string $user: Name of user to remove data for.
_horde_removeUserDataFromAllApplications (line 419)

Removes user data from all applications.

void _horde_removeUserDataFromAllApplications (string $user)
  • string $user: Name of user to remove data for.
_horde_removeUserFromGroup (line 574)

Removes a user from a group.

void _horde_removeUserFromGroup (string $name, string $user)
  • string $name: The group's name.
  • string $user: The user to add.
_horde_removeUserPermissions (line 825)

Removes a user from a share.

void _horde_removeUserPermissions (string $shareRoot, string $shareName, string $userName)
  • string $shareRoot: The name of the share root, e.g. the application that the share belongs to.
  • string $shareName: The share's name.
  • string $userName: The user's name.
_horde_removeUsersFromGroup (line 600)

Removes multiple users from a group.

void _horde_removeUsersFromGroup (string $name, array $users)
  • string $name: The group's name.
  • array $users: The users to add.
_horde_setPreference (line 363)

Sets a preference to the specified value, if the preference is allowed to be modified.

void _horde_setPreference (string $app, string $pref,  $value, string $val)
  • string $app: The application of the preference to modify.
  • string $pref: The name of the preference to modify.
  • string $val: The new value for this preference.
  • $value

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