Class Group_kolab

Description

The Group_kolab class provides a Kolab backend for the Horde groups system.

FIXME: A better solution would be to let this class rely on Horde/Kolab/LDAP.php.

$Horde: framework/Group/Group/kolab.php,v 1.4.2.2 2009/01/06 15:23:08 jan Exp $

Copyright 2005-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Group/Group/kolab.php (line 24)

Group
   |
   --Group_ldap
      |
      --Group_kolab
Variable Summary
 mixed $_error
Method Summary
 Group_kolab Group_kolab ( $params)
 void addGroup (Kolab_Group $group)
 string dnForMail (string $mail)
 Kolab_Group &getGroupById (string $dn)
 string getGroupId (mixed $group)
 array getGroupMemberships (string $user, [boolean $parentGroups = false])
 string getGroupParent (string $dn)
 array getGroupParentList (string $dn)
 array getGroupParents (string $dn)
 Kolab_Group &newGroup (string $name, string $parent)
 void removeGroup (Kolab_Group $group, [boolean $force = false])
 void updateGroup (Kolab_Group $group)
 array __sleep ()
 void __wakeup ()
Variables
Methods
Constructor Group_kolab (line 34)

Constructor.

Group_kolab Group_kolab ( $params)
  • $params
addGroup (line 102)

Adds a group to the groups system. The group must first be created with Group::newGroup(), and have any initial users added to it, before this function is called.

void addGroup (Kolab_Group $group)

Redefinition of:
Group_ldap::addGroup()
Add a group to the groups system. The group must first be created with Group_ldap::newGroup(), and have any initial users added to it, before this function is called.
dnForMail (line 274)

Tries to find a DN for a given kolab mail address.

  • return: The corresponding dn or false.
string dnForMail (string $mail)
  • string $mail: The mail address to search for.
getGroupById (line 136)

Return a Kolab_Group object corresponding to the given dn, with the users and other data retrieved appropriately.

  • return: The requested group.
Kolab_Group &getGroupById (string $dn)
  • string $dn: The dn of the group to retrieve.

Redefinition of:
Group_ldap::getGroupById()
Return an LDAP_Object object corresponding to the given dn, with the users and other data retrieved appropriately.
getGroupId (line 196)

Retrieve the ID of the given group.

NOTE: If given a group name, this function can be unreliable if more than one group exists with the same name.

  • return: The group's ID.
string getGroupId (mixed $group)
  • mixed $group: LDAP_Group object, or a group name (string)

Redefinition of:
Group_ldap::getGroupId()
Retrieve the ID of the given group.
getGroupMemberships (line 297)

Get a list of every group that the given user is a member of.

  • return: An array of all groups the user is in.
array getGroupMemberships (string $user, [boolean $parentGroups = false])
  • string $user: The user to get groups for.
  • boolean $parentGroups: Also return the parents of any groups?

Redefinition of:
Group_ldap::getGroupMemberships()
Get a list of every group that the given user is a member of.
getGroupParent (line 248)

Get the parent of the given group.

  • return: The dn of the parent group.
string getGroupParent (string $dn)
  • string $dn: The dn of the child group.

Redefinition of:
Group_ldap::getGroupParent()
Get the parent of the given group.
getGroupParentList (line 262)

Get a list of parents all the way up to the root object for the given group.

  • return: A flat list of all of the parents of the given group, hashed in $dn => $name format.
array getGroupParentList (string $dn)
  • string $dn: The dn of the group.

Redefinition of:
Group_ldap::getGroupParentList()
Get a list of parents all the way up to the root object for the given group.
getGroupParents (line 236)

Get a list of the parents of a child group.

  • return: Nested array of parents
array getGroupParents (string $dn)
  • string $dn: The fully qualified group dn

Redefinition of:
Group_ldap::getGroupParents()
Get a list of the parents of a child group.
newGroup (line 90)

Returns a new group object.

  • return: A new group object.
Kolab_Group &newGroup (string $name, string $parent)
  • string $name: The group's name.
  • string $parent: The group's parent's name.

Redefinition of:
Group_ldap::newGroup()
Return a new group object.
removeGroup (line 123)

Removes a group from the groups system permanently.

void removeGroup (Kolab_Group $group, [boolean $force = false])
  • Kolab_Group $group: The group to remove.
  • boolean $force: Force to remove every child.

Redefinition of:
Group_ldap::removeGroup()
Remove a group from the groups system permanently.
updateGroup (line 112)

Stores updated data - users, etc. - of a group to the backend system.

void updateGroup (Kolab_Group $group)

Redefinition of:
Group_ldap::updateGroup()
Store updated data - users, etc. - of a group to the backend system.
__sleep (line 73)

Returns the properties that need to be serialized.

  • return: List of serializable properties.
array __sleep ()

Redefinition of:
Group::__sleep()
Returns the properties that need to be serialized.
__wakeup (line 61)

Initializes the object.

void __wakeup ()

Redefinition of:
Group::__wakeup()
Initializes the object.

Inherited Methods

Inherited From Group_ldap

 Group_ldap::Group_ldap()
 Group_ldap::addGroup()
 Group_ldap::exists()
 Group_ldap::getGroup()
 Group_ldap::getGroupById()
 Group_ldap::getGroupId()
 Group_ldap::getGroupMemberships()
 Group_ldap::getGroupName()
 Group_ldap::getGroupParent()
 Group_ldap::getGroupParentList()
 Group_ldap::getGroupParents()
 Group_ldap::getGroupShortName()
 Group_ldap::getGUID()
 Group_ldap::getLevel()
 Group_ldap::listAllUsers()
 Group_ldap::listGroups()
 Group_ldap::newGroup()
 Group_ldap::removeGroup()
 Group_ldap::updateGroup()
 Group_ldap::_connect()
 Group_ldap::_nextGid()
 Group_ldap::_recursive_delete()

Inherited From Group

 Group::Group()
 Group::addGroup()
 Group::exists()
 Group::factory()
 Group::getGroup()
 Group::getGroupById()
 Group::getGroupId()
 Group::getGroupMemberships()
 Group::getGroupName()
 Group::getGroupParent()
 Group::getGroupParentList()
 Group::getGroupParents()
 Group::getGroupShortName()
 Group::getGUID()
 Group::getLevel()
 Group::listAllUsers()
 Group::listGroups()
 Group::listUsers()
 Group::newGroup()
 Group::removeGroup()
 Group::shutdown()
 Group::singleton()
 Group::updateGroup()
 Group::userIsInGroup()
 Group::_loadDriver()
 Group::__sleep()
 Group::__wakeup()

Documentation generated on Sun, 30 Jan 2011 05:18:46 +0000 by phpDocumentor 1.4.3