[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

/include/ -> class.group.php (summary)

(no description)

File Size: 453 lines (16 kb)
Included or required: 6 times
Referenced: 0 times
Includes or requires: 6 files
 include/class.date.php
 include/class.misc.php
 include/class.project.php
 include/class.auth.php
 include/class.prefs.php
 include/class.error_handler.php

Defines 1 class

Group:: (13 methods):
  insert()
  update()
  remove()
  setProjects()
  removeProjectsByGroup()
  disassociateProjects()
  getDetails()
  getName()
  getList()
  getAssocList()
  getUsers()
  getProjects()
  getGroupByName()


Class: Group  - X-Ref

Class to handle the business logic related to the administration
of groups.
Note! Any reference to the group table must use ` around the table name
due to "group" being a reserved word and some users don't use table prefixes.

insert()   X-Ref
Inserts a new group into the database

return: integer 1 if successful, -1 or -2 otherwise

update()   X-Ref
Updates a group

return: integer 1 if successful, -1 or -2 otherwise

remove()   X-Ref
Removes groups


setProjects($grp_id, $projects)   X-Ref
Sets projects for the group.

param: integer $grp_id The id of the group.
param: array $projects An array of projects to associate with the group.

removeProjectsByGroup($grp_id)   X-Ref
Removes all the projects for a group

param: integer $grp_id The ID of the group

disassociateProjects($projects)   X-Ref
Removes specified projects from all groups.

param: array $projects An array of projects to remove from all groups.
return: integer 1 if successful, -1 otherwise

getDetails($grp_id)   X-Ref
Returns details about a specific group

param: integer $grp_id The ID of the group.
return: array An array of group information

getName($grp_id)   X-Ref
Returns the name of the group

param: integer $grp_id The id of the group
return: string The name of the group

getList()   X-Ref
Returns a list of groups

return: array An array of group information

getAssocList($prj_id)   X-Ref
Returns an associative array of groups

param: integer $prj_id The project ID
return: array An associated array of groups

getUsers($grp_id)   X-Ref
Returns an array of users who belong to the current group.

param: integer $grp_id The ID of the group.
return: array An array of usr ids

getProjects($grp_id)   X-Ref
Returns an array of projects who belong to the current group.

param: integer $grp_id The ID of the group.
return: array An array of project ids

getGroupByName($name)   X-Ref
Returns a group ID based on group name

param: string $name Name of the group
return: integer The ID of the group, or -1 if no group by that name could be found.



Generated: Wed Dec 19 21:21:33 2007 Cross-referenced by PHPXref 0.7