[commits] [Wiki] changed: HordeGroupAPI

[Ben Klang]

bklang  Sun, 30 Jan 2011 12:35:18 -0500

Modified page: http://wiki.horde.org/HordeGroupAPI
New Revision:  1.15
Change log:  Additional method doc

@@ -58,13 +58,11 @@
  +++ listUsers($gid, $recurse = false)

  Get a list of every user that is a part of this group ONLY.

-If $recurse is true then also check member groups' user list.
+If $recurse is true then also check member groups' user lists.

-* Add support to take over listAllUsers()
-
-+++ getGroupMembership($user, $parentGroups = false)
++++ getGroupsForUser($user)

  Returns an array of Horde_Group objects representing the user's membership

  +++ addUser($gid, $username)
@@ -87,16 +85,27 @@
  +++ new($name, $create = true)
  Returns an instance of a Horde group.  If $create is true and the  
group does not exist, it is created.  If $create is false and the  
group does not exist, or if $create is true and the group already  
exists, a Horde_Group_Exception is raised.

  +++ id()
+Returns the group's ID
+
++++ name()
+Returns the group's name

  +++ addUser($username)
+Adds $username to the group

  +++ removeUser($username)
+Removes $username from the group

  +++ listUsers($recurse = true)
+
++++ hasMember($username)
+Boolean; does this group have $username as a member?

  +++ delete()
+Deletes the group from the backend

  +++ rename()
+Renames the group