Overview

Packages

  • Group

Classes

  • Horde_Group_Base
  • Horde_Group_Contactlists
  • Horde_Group_Exception
  • Horde_Group_Kolab
  • Horde_Group_Ldap
  • Horde_Group_Mock
  • Horde_Group_Sql
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Group_Contactlists

This class provides a driver for the Horde group system based on Turba contact lists.

Copyright 2008-2012 Horde LLC (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Horde_Group_Base
Extended by Horde_Group_Contactlists
Package: Group
Category: Horde
License: LGPL 2.1
Author: Michael J. Rubinsky mrubinsk@horde.org
Author: Jan Schneider jan@horde.org
Located at Horde/Group/Contactlists.php
Methods summary
public
# __construct( mixed $params )

Constructor.

Constructor.

public boolean
# exists( mixed $gid )

Checks if a group exists.

Checks if a group exists.

Parameters

$gid
A group ID.

Returns

boolean
True if the group exists.

Throws

Horde_Group_Exception
public string
# getName( mixed $gid )

Returns a group name.

Returns a group name.

Parameters

$gid
A group ID.

Returns

string
The group's name.

Throws

Horde_Group_Exception
Horde_Exception_NotFound
public array
# getData( mixed $gid )

Returns all available attributes of a group.

Returns all available attributes of a group.

Parameters

$gid
A group ID.

Returns

array
The group's date.

Throws

Horde_Group_Exception
Horde_Exception_NotFound
public array
# listAll( string $member = null )

Returns a list of all groups a user may see, with IDs as keys and names as values.

Returns a list of all groups a user may see, with IDs as keys and names as values.

Parameters

$member
Only return groups that this user is a member of.

Returns

array
All existing groups.

Throws

Horde_Group_Exception
public array
# listUsers( mixed $gid )

Returns a list of users in a group.

Returns a list of users in a group.

Parameters

$gid
A group ID.

Returns

array
List of group users.

Throws

Horde_Group_Exception
Horde_Exception_NotFound
public array
# listGroups( string $user )

Returns a list of groups a user belongs to.

Returns a list of groups a user belongs to.

Parameters

$user
A user name.

Returns

array
A list of groups, with IDs as keys and names as values.

Throws

Horde_Group_Exception
public array
# search( string $name )

Searches for group names.

Searches for group names.

Parameters

$name
A search string.

Returns

array

A list of matching groups, with IDs as keys and names as values.

Throws

Horde_Group_Exception
Methods inherited from Horde_Group_Base
addUser(), create(), readOnly(), remove(), removeUser(), rename(), renameSupported(), setData()
API documentation generated by ApiGen