[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

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

(no description)

File Size: 619 lines (24 kb)
Included or required: 7 times
Referenced: 0 times
Includes or requires: 8 files
 include/class.history.php
 include/class.user.php
 include/class.validation.php
 include/class.misc.php
 include/class.date.php
 include/class.auth.php
 include/class.error_handler.php
 include/class.issue.php

Defines 1 class

Time_Tracking:: (17 methods):
  getCategoryID()
  getDetails()
  remove()
  update()
  insert()
  getList()
  getAssocCategories()
  getTimeSpentByIssues()
  getTimeSpentByIssue()
  getListing()
  removeByIssues()
  removeEntry()
  insertEntry()
  recordRemoteEntry()
  getSummaryByUser()
  getTimeSpentByIssueAndTime()
  fillTimeSpentByIssueAndTime()


Class: Time_Tracking  - X-Ref

Class to handle the business logic related to the administration
of time tracking categories in the system.

getCategoryID($ttc_title)   X-Ref
Method used to get the ID of a given category.

param: string $ttc_title The time tracking category title
return: integerThe time tracking category ID

getDetails($ttc_id)   X-Ref
Method used to get the details of a time tracking category.

param: integer $ttc_id The time tracking category ID
return: array The details of the category

remove()   X-Ref
Method used to remove a specific set of time tracking categories

return: boolean

update()   X-Ref
Method used to update a specific time tracking category

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

insert()   X-Ref
Method used to add a new time tracking category

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

getList()   X-Ref
Method used to get the full list of time tracking categories available in
the system exclusing those reserved by the system.

return: array The list of categories

getAssocCategories()   X-Ref
Method used to get the full list of time tracking categories as an
associative array in the style of (id => title)

return: array The list of categories

getTimeSpentByIssues(&$result)   X-Ref
Method used to get the time spent on a given list of issues.

param: array $result The result set
return: void

getTimeSpentByIssue($issue_id)   X-Ref
Method used to get the total time spent for a specific issue.

param: integer $issue_id The issue ID
return: integer The total time spent

getListing($issue_id)   X-Ref
Method used to get the full listing of time entries in the system for a
specific issue

param: integer $issue_id The issue ID
return: array The full list of time entries

removeByIssues($ids)   X-Ref
Method used to remove all time entries associated with the specified list
of issues.

param: array $ids The list of issues
return: boolean

removeEntry($time_id, $usr_id)   X-Ref
Method used to remove a specific time entry from the system.

param: integer $time_id The time entry ID
param: integer $usr_id The user ID of the person trying to remove this entry
return: integer 1 if the update worked, -1 otherwise

insertEntry()   X-Ref
Method used to add a new time entry in the system.

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

recordRemoteEntry($issue_id, $usr_id, $cat_id, $summary, $time_spent)   X-Ref
Method used to remotely record a time tracking entry.

param: integer $issue_id The issue ID
param: integer $usr_id The user ID
param: integer $cat_id The time tracking category ID
param: string $summary The summary of the work entry
param: integer $time_spent The time spent in minutes
return: integer 1 if the insert worked, -1 otherwise

getSummaryByUser($usr_id, $start, $end)   X-Ref
Returns summary information about all time spent by a user in a specified time frame.

param: string $usr_id The ID of the user this report is for.
param: integer The timestamp of the beginning of the report.
param: integer The timestamp of the end of this report.
return: array An array of data containing information about time trackinge

getTimeSpentByIssueAndTime($issue_id, $usr_id, $start, $end)   X-Ref
Method used to get the time spent for a specific issue
at a specific time.

param: integer $issue_id The issue ID
param: string $usr_id The ID of the user this report is for.
param: integer The timestamp of the beginning of the report.
param: integer The timestamp of the end of this report.
return: integer The time spent

fillTimeSpentByIssueAndTime(&$res, $usr_id, $start, $end)   X-Ref
Method used to add time spent on issue to a list of user issues.

param: array $res User issues
param: string $usr_id The ID of the user this report is for.
param: integer $start The timestamp of the beginning of the report.
param: integer $end The timestamp of the end of this report.
return: void



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