[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

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

(no description)

File Size: 548 lines (22 kb)
Included or required: 2 times
Referenced: 0 times
Includes or requires: 2 files
 include/class.date.php
 include/class.error_handler.php

Defines 1 class

Round_Robin:: (13 methods):
  getBlackoutDates()
  getNextAssignee()
  markNextAssignee()
  getID()
  getUsersByProject()
  insert()
  addUserAssociation()
  getList()
  getAssociatedUsers()
  getDetails()
  update()
  removeUserAssociations()
  remove()


Class: Round_Robin  - X-Ref

getBlackoutDates(&$user, $start, $end)   X-Ref
Returns the blackout dates according to the user's timezone.

param: object $user The Date object associated with the user's timezone
param: integer $start The blackout start hour
param: integer $end The blackout end hour
return: array The blackout dates

getNextAssignee($prj_id)   X-Ref
Retrieves the next assignee in the given project's round robin queue.

param: integer $prj_id The project ID
return: integer The assignee's user ID

markNextAssignee($prj_id, $usr_id)   X-Ref
Marks the next user in the round robin list as the next assignee in the
round robin queue.

param: integer $prj_id The project ID
param: integer $usr_id The assignee's user ID
return: boolean

getID($prj_id)   X-Ref
Returns the round robin entry ID associated with a given project.

param: integer $prj_id The project ID
return: integer The round robin entry ID

getUsersByProject($prj_id)   X-Ref
Retrieves the list of users, round robin blackout hours and their
respective preferences with regards to timezones.

param: integer $prj_id The project ID
return: array The list of users

insert()   X-Ref
Creates a new round robin entry.

return: integer 1 if the creation worked, -1 otherwise

addUserAssociation($prr_id, $usr_id)   X-Ref
Associates a round robin entry with a user ID.

param: integer $prr_id The round robin entry ID
param: integer $usr_id The user ID
return: boolean

getList()   X-Ref
Method used to get the list of round robin entries available in the
system.

return: array The list of round robin entries

getAssociatedUsers($prr_id)   X-Ref
Returns an associative array in the form of user id => name of the users
associated to a given round robin entry ID.

param: integer $prr_id The round robin entry ID
return: array The list of users

getDetails($prr_id)   X-Ref
Method used to get the details of a round robin entry.

param: integer $prr_id The round robin entry ID
return: array The round robin entry details

update()   X-Ref
Method used to update a round robin entry in the system.

return: integer 1 if the update worked, -1 otherwise

removeUserAssociations($prr_id)   X-Ref
Method used to remove the user associations for a given round robin
entry ID.

param: integer $prr_id The round robin ID
return: boolean

remove()   X-Ref
Method used to remove a round robin entry from the system.

return: boolean



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