Class GroupAdminService

Description

The GroupAdminService is used for write access to Groups.

  • version: $Id: GroupAdminService.php,v 1.5 2006/11/26 22:04:06 kpapst Exp $
  • copyright: Copyright (C) 2002-2006 Kevin Papst
  • author: Kevin Papst
  • license: GNU Public License


			
Method Summary
void addToGroup ( $groupid,  $userid)
the createGroup (String $name)
mixed createGroupWithID ( $id,  $name)
void deleteAllGroups ()
void deleteGroup (int $groupid)
void removeFromGroup ( $groupid,  $userid)
Methods
addToGroup (line 41)

Adds an User to a Group.

void addToGroup ( $groupid,  $userid)
  • $groupid
  • $userid
createGroup (line 95)

Creates a new UserGroup.

  • return: new ID
the createGroup (String $name)
  • String $name: name the Name of the new UserGroup
createGroupWithID (line 108)

Creates a new UserGroup with the given ID.

DO NOT USE THIS METHOD FOR SIMPLY CREATING A NEW GROUP!

  • return: the Database result
  • access: protected
mixed createGroupWithID ( $id,  $name)
  • $id
  • $name
deleteAllGroups (line 83)

Deletes all UserGroups.

This does not delete the User-Group mapping, make sure to fix this!!!!!!!

void deleteAllGroups ()
deleteGroup (line 70)

Deletes an UserGroup.

Make sure that no UserGroup mapping matches this Group, this will not be handled by this function.

void deleteGroup (int $groupid)
  • int $groupid: groupid ID of the Group to be deleted
removeFromGroup (line 54)

Removes an User from a Group.

void removeFromGroup ( $groupid,  $userid)
  • $groupid
  • $userid

Documentation generated by phpDocumentor 1.3.1