Overview

Packages

  • Horde
  • None

Classes

  • Horde_Ajax_Application
  • Horde_Api
  • Horde_Block_Account
  • Horde_Block_Account_Base
  • Horde_Block_Account_Finger
  • Horde_Block_Account_Ldap
  • Horde_Block_Account_Localhost
  • Horde_Block_Cloud
  • Horde_Block_FbStream
  • Horde_Block_Feed
  • Horde_Block_Fortune
  • Horde_Block_Google
  • Horde_Block_Iframe
  • Horde_Block_Metar
  • Horde_Block_Moon
  • Horde_Block_Sunrise
  • Horde_Block_Time
  • Horde_Block_TwitterTimeline
  • Horde_Block_Vatid
  • Horde_Block_Weather
  • Horde_LoginTasks_SystemTask_GarbageCollection
  • Horde_LoginTasks_SystemTask_Upgrade
  • Horde_LoginTasks_Task_AdminCheck
  • Horde_LoginTasks_Task_LastLogin
  • Horde_LoginTasks_Task_TosAgreement
  • Horde_Prefs_Ui
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Api

Horde external API interface.

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

Horde_Registry_Api
Extended by Horde_Api
Package: Horde
Located at Api.php
Methods summary
public array
# admin_list( )

Returns a list of adminstrative links.

Returns a list of adminstrative links.

Returns

array
Keys are link labels, values are array with these keys: 
'link' - (string) Registry encoded link to page.
'name' - (string) Gettext label for page.
'icon' - (string) Graphic for page.
public array
# listApps( array $filter = null )

Returns a list of the installed and registered applications.

Returns a list of the installed and registered applications.

Parameters

$filter
<p>An array of the statuses that should be returned. Defaults to non-hidden.</p>

Returns

array

List of apps registered with Horde. If no applications are defined returns an empty array.
public array
# listAPIs( )

Returns all available registry APIs.

Returns all available registry APIs.

Returns

array
The API list.
public string
# blockTitle( string $app, string $name, array $params = array() )

Returns a Horde_Block's title.

Returns a Horde_Block's title.

Parameters

$app
The block application name.
$name
The block name (NOT the class name).
$params
Block parameters.

Returns

string
The block title.
public string
# blockContent( string $app, string $name, array $params = array() )

Returns a Horde_Block's content.

Returns a Horde_Block's content.

Parameters

$app
The block application name.
$name
The block name (NOT the classname).
$params
Block parameters.

Returns

string
The block content.
public array
# blocks( )

Returns a pretty printed list of all available blocks.

Returns a pretty printed list of all available blocks.

Returns

array

A hash with block IDs as keys and application plus block block names as values.
public string
# getPreference( string $app, string $pref )

Returns the value of the requested preference.

Returns the value of the requested preference.

Parameters

$app
The application of the preference to retrieve.
$pref
The name of the preference to retrieve.

Returns

string
The value of the preference, null if it doesn't exist.
public
# setPreference( string $app, string $pref, string $value )

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

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

Parameters

$app
The application of the preference to modify.
$pref
The name of the preference to modify.
$value
$val The new value for this preference.
public
# removeUserData( string $user, string $app = false )

Removes user data.

Removes user data.

Parameters

$user
Name of user to remove data for.
$app
<p>Remove data from this application. If boolean true, removes all applications. If boolean false, removes only base Horde data.</p>

Throws

Horde_Exception
public mixed
# addGroup( string $name, string $parent = null )

Adds a group to the groups system.

Adds a group to the groups system.

Parameters

$name
The group's name.
$parent
The group's parent's ID.

Returns

mixed
The group's ID.

Throws

Horde_Exception
public
# removeGroup( mixed $group )

Removes a group from the groups system.

Removes a group from the groups system.

Parameters

$group
The group ID.

Throws

Horde_Exception
public
# addUserToGroup( mixed $group, string $user )

Adds a user to a group.

Adds a user to a group.

Parameters

$group
The group ID.
$user
The user to add.

Throws

Horde_Exception
public
# removeUserFromGroup( mixed $group, string $user )

Removes a user from a group.

Removes a user from a group.

Parameters

$group
The group ID.
$user
The user to add.

Throws

Horde_Exception
public array
# listUsersOfGroup( mixed $group )

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

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

Parameters

$group
The group ID.

Returns

array
The user list.

Throws

Horde_Exception
public
# addShare( string $scope, string $shareName, string $shareTitle, string $userName )

Adds a share to the shares system.

Adds a share to the shares system.

Parameters

$scope
<p>The name of the share root, e.g. the application that the share belongs to.</p>
$shareName
The share's name.
$shareTitle
The share's human readable title.
$userName
The share's owner.

Throws

Horde_Exception
public
# removeShare( string $scope, string $shareName )

Removes a share from the shares system permanently.

Removes a share from the shares system permanently.

Parameters

$scope
<p>The name of the share root, e.g. the application that the share belongs to.</p>
$shareName
The share's name.

Throws

Horde_Exception
public array
# listSharesOfOwner( string $scope, string $userName )

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

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

Parameters

$scope
<p>The name of the share root, e.g. the application that the share belongs to.</p>
$userName
The share's owner.

Returns

array
The list of shares.

Throws

Horde_Exception
public
# addUserPermissions( string $scope, string $shareName, string $userName, array $permissions )

Gives a user certain privileges for a share.

Gives a user certain privileges for a share.

Parameters

$scope
<p>The name of the share root, e.g. the application that the share belongs to.</p>
$shareName
The share's name.
$userName
The user's name.
$permissions
A list of permissions (show, read, edit, delete).

Throws

Horde_Exception
public
# addGroupPermissions( string $scope, string $shareName, mixed $groupId, array $permissions )

Gives a group certain privileges for a share.

Gives a group certain privileges for a share.

Parameters

$scope
<p>The name of the share root, e.g. the application that the share belongs to.</p>
$shareName
The share's name.
$groupId
The group ID.
$permissions
<p>A list of permissions (show, read, edit, delete).</p>

Throws

Horde_Exception
public
# removeUserPermissions( string $scope, string $shareName, string $userName )

Removes a user from a share.

Removes a user from a share.

Parameters

$scope
<p>The name of the share root, e.g. the application that the share belongs to.</p>
$shareName
The share's name.
$userName
The user's name.

Throws

Horde_Exception
public
# removeGroupPermissions( string $scope, string $shareName, mixed $groupId )

Removes a group from a share.

Removes a group from a share.

Parameters

$scope
<p>The name of the share root, e.g. the application that the share belongs to.</p>
$shareName
The share's name.
$groupId
The group ID.

Throws

Horde_Exception
public array
# listUserPermissions( string $scope, string $shareName, string $userName )

Returns an array of all user permissions on a share.

Returns an array of all user permissions on a share.

Parameters

$scope
<p>The name of the share root, e.g. the application that the share belongs to.</p>
$shareName
The share's name.
$userName
The user's name.

Returns

array
All user permissions for this share.

Throws

Horde_Exception
public array
# listGroupPermissions( string $scope, string $shareName, string $groupName )

Returns an array of all group permissions on a share.

Returns an array of all group permissions on a share.

Parameters

$scope
<p>The name of the share root, e.g. the application that the share belongs to.</p>
$shareName
The share's name.
$groupName
The group's name.

Returns

array
All group permissions for this share.

Throws

Horde_Exception
public array
# listUsersOfShare( string $scope, string $shareName, array $permissions )

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

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

Parameters

$scope
<p>The name of the share root, e.g. the application that the share belongs to.</p>
$shareName
The share's name.
$permissions
A list of permissions (show, read, edit, delete).

Returns

array
List of users with the specified permissions.

Throws

Horde_Exception
public array
# listGroupsOfShare( string $scope, string $shareName, array $permissions )

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

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

Parameters

$scope
<p>The name of the share root, e.g. the application that the share belongs to.</p>
$shareName
The share's name.
$permissions
A list of permissions (show, read, edit, delete).

Returns

array
List of groups with the specified permissions.

Throws

Horde_Exception
API documentation generated by ApiGen