[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

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

(no description)

File Size: 459 lines (19 kb)
Included or required: 14 times
Referenced: 0 times
Includes or requires: 4 files
 include/class.date.php
 include/class.misc.php
 include/class.mime_helper.php
 include/class.error_handler.php

Defines 1 class

History:: (10 methods):
  formatChanges()
  add()
  getListing()
  removeByIssues()
  getTypeID()
  getTouchedIssuesByUser()
  getTouchedIssueCountByStatus()
  getHistoryByUser()
  getIssueCloser()
  fillStatusChangedOnlyIssues()


Class: History  - X-Ref

Class to handle the business logic related to the history information for
the issues entered in the system.

formatChanges($old_value, $new_value)   X-Ref
Method used to format the changes done to an issue.

param: string $old_value The old value for a specific issue parameter
param: string $new_value The new value for a specific issue parameter
return: string The formatted string

add($iss_id, $usr_id, $htt_id, $summary, $hide = false)   X-Ref
Method used to log the changes made against a specific issue.

param: integer $iss_id The issue ID
param: integer $usr_id The ID of the user.
param: integer $htt_id The type ID of this history event.
param: string $summary The summary of the changes
param: boolean $hide If this history item should be hidden.
return: void

getListing($iss_id, $order_by = 'DESC')   X-Ref
Method used to get the list of changes made against a specific issue.

param: integer $iss_id The issue ID
param: string $order_by The order to sort the history
return: array The list of changes

removeByIssues($ids)   X-Ref
Method used to remove all history entries associated with a
given set of issues.

param: array $ids The array of issue IDs
return: boolean

getTypeID($name)   X-Ref
Returns the id for the history type based on name.

param: string The name of the history type
return: integer The id of this type.

getTouchedIssuesByUser($usr_id, $start, $end, $separate_closed = false, $htt_exclude = array()   X-Ref
Returns a list of issues touched by the specified user in the specified time frame.

param: integer $usr_id The id of the user.
param: date $start The start date
param: date $end The end date
param: date $separate_closed If closed issues should be included in a separate array
param: array $htt_exclude Addtional History Types to ignore
return: array An array of issues touched by the user.

getTouchedIssueCountByStatus($usr_id, $start, $end, $statuses = false)   X-Ref
Returns the number of issues for the specified user that are currently set to the specified status(es).

param: integer $usr_id The id of the user.
param: date $start The start date
param: date $end The end date
param: array $statuses An array of status abreviations to return counts for.
return: array An array containing the number of issues for the user set tothe specified statuses.

getHistoryByUser($usr_id, $start, $end, $htt_id = false)   X-Ref
Returns the history for a specified user in a specified time frame for an optional type

param: integer $usr_id The id of the user.
param: date $start The start date
param: date $end The end date
param: array $htt_id The htt_id or id's to to return history for.
return: array An array of history items

getIssueCloser($issue_id)   X-Ref
Returns the last person to close the issue

param: integer $issue_id The ID of the issue
return: integer usr_id

fillStatusChangedOnlyIssues(&$res, $usr_id, $start, $end)   X-Ref
Fills a result set with a flag indicating if this issue only had it's status
changed in the given time period.

param: array $res User issues
param: integer $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: boolean True if only status changed else false



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