Class GroupOperations

Description

Class for doing group related functions. Maybe of the Group object functions are just wrappers around these.

  • version: $Revision$
  • since: 0.6
  • license: GPL

Located in /class.groupoperations.inc.php (line 40)


	
			
Method Summary
boolean DeleteGroupByID (integer $id)
integer InsertGroup (mixed $group)
mixed &LoadGroupByID (integer $id)
array LoadGroups ()
boolean UpdateGroup (mixed $group)
Methods
DeleteGroupByID (line 163)

Given a group id, delete it from the database along with all its associations.

  • return: True if the delete was successful. False if not.
boolean DeleteGroupByID (integer $id)
  • integer $id: The group's id to delete
InsertGroup (line 102)

Given a group object, inserts it into the database.

  • return: The id of the newly created group. If none is created, -1
integer InsertGroup (mixed $group)
  • mixed $group: The group object to save to the database
LoadGroupByID (line 74)

Load a group from the database by its id

  • return: The group if found. If it's not found, then false
mixed &LoadGroupByID (integer $id)
  • integer $id: The id of the group to load
LoadGroups (line 47)

Loads all the groups from the database and returns them

  • return: The list of groups
array LoadGroups ()
UpdateGroup (line 133)

Given a group object, update its attributes in the database.

  • return: True if the update was successful, false if not
boolean UpdateGroup (mixed $group)
  • mixed $group: The group to update

Documentation generated on Sun, 12 Aug 2012 08:38:30 -0600 by phpDocumentor 1.3.2