Class Group_hooks

Description

The Group_hooks:: class provides the Horde groups system with the addition of adding support for hook functions to define if a user is in a group.

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

Copyright 2003-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/hooks.php (line 18)

Group
   |
   --Group_hooks
Variable Summary
Method Summary
 Group_hooks Group_hooks ( $params)
 array getGroupMemberships (string $user, [boolean $parentGroups = false])
 boolean userIsInGroup (string $user, integer $gid, [boolean $subgroups = true])
Variables
Methods
Constructor Group_hooks (line 25)

Constructor.

Group_hooks Group_hooks ( $params)
  • $params
getGroupMemberships (line 40)

Get a list of every group that $user is in.

  • 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::getGroupMemberships()
Get a list of every group that $user is in.
userIsInGroup (line 76)

Say if a user is a member of a group or not.

boolean userIsInGroup (string $user, integer $gid, [boolean $subgroups = true])
  • string $user: The name of the user.
  • integer $gid: The ID of the group.
  • boolean $subgroups: Return true if the user is in any subgroups of $group, also.

Redefinition of:
Group::userIsInGroup()
Say if a user is a member of a group or not.

Inherited Methods

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:00 +0000 by phpDocumentor 1.4.3