[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

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

(no description)

File Size: 4258 lines (175 kb)
Included or required: 32 times
Referenced: 0 times
Includes or requires: 27 files
 include/class.support.php
 include/class.status.php
 include/class.history.php
 include/class.user.php
 include/class.validation.php
 include/class.workflow.php
 include/class.custom_field.php
 include/class.search_profile.php
 include/class.release.php
 include/class.date.php
 include/class.misc.php
 include/class.resolution.php
 include/class.time_tracking.php
 include/class.category.php
 include/class.notification.php
 include/class.phone_support.php
 include/class.attachment.php
 include/class.authorized_replier.php
 include/class.pager.php
 include/class.scm.php
 include/class.reminder_action.php
 include/class.session.php
 include/class.round_robin.php
 include/class.auth.php
 include/class.note.php
 include/class.priority.php
 include/class.impact_analysis.php

Defines 1 class

Issue:: (79 methods):
  exists()
  getColumnHeadings()
  getDateFieldsAssocList()
  getAssocListByProject()
  getStatusID()
  recordLastCustomerAction()
  getCustomerID()
  getContractID()
  setContractID()
  getContactID()
  getProjectID()
  remoteAssign()
  setStatus()
  setRemoteStatus()
  setRelease()
  getRelease()
  setPriority()
  getPriority()
  setCategory()
  getCategory()
  getOpenIssues()
  getReplyDetails()
  markAsUpdated()
  hasDuplicates()
  updateDuplicates()
  getDuplicateList()
  getDuplicateDetailsList()
  clearDuplicateStatus()
  markAsDuplicate()
  getAssignedUsersStatus()
  getTitle()
  getIssueID()
  addAnonymousReport()
  removeByProjects()
  close()
  update()
  addAssociation()
  deleteAssociations()
  deleteAssociation()
  addUserAssociation()
  deleteUserAssociations()
  deleteUserAssociation()
  createFromEmail()
  insert()
  getParam()
  saveSearchParams()
  getSortingInfo()
  getLastActionFields()
  getListing()
  formatLastActionDates()
  getLastStatusChangeDates()
  buildWhereClause()
  getSides()
  getAssignedUserIDs()
  isAssignedToUser()
  getReportersByIssues()
  getAssignedUsersByIssues()
  getDescriptionByIssues()
  getAssignedUsers()
  getDetails()
  getDuplicatedDetails()
  bulkUpdate()
  setImpactAnalysis()
  getColList()
  getAssocList()
  getAssociatedIssues()
  getAssociatedIssuesDetails()
  isClosed()
  getQuarantinedIssueList()
  getQuarantineInfo()
  setQuarantine()
  setGroup()
  getGroupID()
  getFullTextIssues()
  canAccess()
  isPrivate()
  clearClosed()
  getRootMessageID()
  getIssueByRootMessageID()


Class: Issue  - X-Ref

Class designed to handle all business logic related to the issues in the
system, such as adding or updating them or listing them in the grid mode.

exists($issue_id, $check_project = true)   X-Ref
Method used to check whether a given issue ID exists or not.

param: integer $issue_id The issue ID
param: boolean $check_project If we should check that this issue is in the current project
return: boolean

getColumnHeadings($prj_id)   X-Ref
Method used to get the list of column heading titles for the
CSV export functionality of the issue listing screen.

param: integer $prj_id The project ID
return: array The list of column heading titles

getDateFieldsAssocList($display_customer_fields = FALSE)   X-Ref
Method used to get the full list of date fields available to issues, to
be used when customizing the issue listing screen in the 'last status
change date' column.

param: boolean $display_customer_fields Whether to include any customer related fields or not
return: array The list of available date fields

getAssocListByProject($prj_id)   X-Ref
Method used to get the full list of issue IDs and their respective
titles associated to a given project.

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

getStatusID($issue_id)   X-Ref
Method used to get the status of a given issue.

param: integer $issue_id The issue ID
return: integer The status ID

recordLastCustomerAction($issue_id)   X-Ref
Records the last customer action date for a given issue ID.

param: integer $issue_id The issue ID
return: integer 1 if the update worked, -1 otherwise

getCustomerID($issue_id)   X-Ref
Returns the customer ID associated with the given issue ID.

param: integer $issue_id The issue ID
return: integer The customer ID associated with the issue

getContractID($issue_id)   X-Ref
Returns the contract ID associated with the given issue ID.

param: integer $issue_id The issue ID
return: integer The customer ID associated with the issue

setContractID($issue_id, $contract_id)   X-Ref
Sets the contract ID for a specific issue.

param: integer $issue_id The issue ID
param: integer The contract ID
return: integer 1 if the update worked, -1 otherwise

getContactID($issue_id)   X-Ref
Returns the customer ID associated with the given issue ID.

param: integer $issue_id The issue ID
return: integer The customer ID associated with the issue

getProjectID($issue_id)   X-Ref
Method used to get the project associated to a given issue.

param: integer $issue_id The issue ID
return: integer The project ID

remoteAssign($issue_id, $usr_id, $assignee)   X-Ref
Method used to remotely assign a given issue to an user.

param: integer $issue_id The issue ID
param: integer $usr_id The user ID of the person performing the change
param: boolean $assignee The user ID of the assignee
return: integer The status ID

setStatus($issue_id, $status_id, $notify = false)   X-Ref
Method used to set the status of a given issue.

param: integer $issue_id The issue ID
param: integer $status_id The new status ID
param: boolean $notify If a notification should be sent about this change.
return: integer 1 if the update worked, -1 otherwise

setRemoteStatus($issue_id, $usr_id, $new_status)   X-Ref
Method used to remotely set the status of a given issue.

param: integer $issue_id The issue ID
param: integer $usr_id The user ID of the person performing this change
param: integer $new_status The new status ID
return: integer 1 if the update worked, -1 otherwise

setRelease($issue_id, $pre_id)   X-Ref
Method used to set the release of an issue

param: integer $issue_id The ID of the issue
param: integer $pre_id The ID of the release to set this issue too
return: integer 1 if the update worked, -1 otherwise

getRelease($issue_id)   X-Ref
Returns the current release of an issue

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

setPriority($issue_id, $pri_id)   X-Ref
Method used to set the priority of an issue

param: integer $issue_id The ID of the issue
param: integer $pri_id The ID of the priority to set this issue too
return: integer 1 if the update worked, -1 otherwise

getPriority($issue_id)   X-Ref
Returns the current issue priority

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

setCategory($issue_id, $prc_id)   X-Ref
Method used to set the category of an issue

param: integer $issue_id The ID of the issue
param: integer $prc_id The ID of the category to set this issue too
return: integer 1 if the update worked, -1 otherwise

getCategory($issue_id)   X-Ref
Returns the current issue category

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

getOpenIssues($prj_id, $usr_id, $show_all_issues, $status_id)   X-Ref
Method used to get all issues associated with a status that doesn't have
the 'closed' context.

param: integer $prj_id The project ID to list issues from
param: integer $usr_id The user ID of the user requesting this information
param: boolean $show_all_issues Whether to show all open issues, or just the ones assigned to the given email address
param: integer $status_id The status ID to be used to restrict results
return: array The list of open issues

getReplyDetails($issue_id)   X-Ref
Method used to build the required parameters to simulate an email reply
to the user who reported the issue, using the issue details like summary
and description as email fields.

param: integer $issue_id The issue ID
return: array The email parameters

markAsUpdated($issue_id, $type = false)   X-Ref
Method used to record the last updated timestamp for a given
issue ID.

param: integer $issue_id The issue ID
param: string $type The type of update that was made (optional)
return: boolean

hasDuplicates($issue_id)   X-Ref
Method used to check whether a given issue has duplicates
or not.

param: integer $issue_id The issue ID
return: boolean

updateDuplicates($issue_id)   X-Ref
Method used to update the duplicated issues for a given
issue ID.

param: integer $issue_id The issue ID
return: integer 1 if the update worked, -1 otherwise

getDuplicateList($issue_id)   X-Ref
Method used to get a list of the duplicate issues for a given
issue ID.

param: integer $issue_id The issue ID
return: array The list of duplicates

getDuplicateDetailsList($issue_id)   X-Ref
Method used to get a list of the duplicate issues (and their details)
for a given issue ID.

param: integer $issue_id The issue ID
return: array The list of duplicates

clearDuplicateStatus($issue_id)   X-Ref
Method used to clear the duplicate status of an issue.

param: integer $issue_id The issue ID
return: integer 1 if the update worked, -1 otherwise

markAsDuplicate($issue_id)   X-Ref
Method used to mark an issue as a duplicate of an existing one.

param: integer $issue_id The issue ID
return: integer 1 if the update worked, -1 otherwise

getAssignedUsersStatus($issue_id)   X-Ref
Method used to get an associative array of user ID => user
status associated with a given issue ID.

param: integer $issue_id The issue ID
return: array The list of users

getTitle($issue_id)   X-Ref
Method used to get the summary associated with a given issue ID.

param: integer $issue_id The issue ID
return: string The issue summary

getIssueID($summary)   X-Ref
Method used to get the issue ID associated with a specific summary.

param: string $summary The summary to look for
return: integer The issue ID

addAnonymousReport()   X-Ref
Method used to add a new anonymous based issue in the system.

return: integer The new issue ID

removeByProjects($ids)   X-Ref
Method used to remove all issues associated with a specific list of
projects.

param: array $ids The list of projects to look for
return: boolean

close($usr_id, $issue_id, $send_notification, $resolution_id, $status_id, $reason, $send_notification_to = 'internal')   X-Ref
Method used to close off an issue.

param: integer $usr_id The user ID
param: integer $issue_id The issue ID
param: bool $send_notification Whether to send a notification about this action or not
param: integer $resolution_id The resolution ID
param: integer $status_id The status ID
param: string $reason The reason for closing this issue
param: string  $send_notification_to Who this notification should be sent too
return: integer 1 if the update worked, -1 otherwise

update($issue_id)   X-Ref
Method used to update the details of a specific issue.

param: integer $issue_id The issue ID
return: integer 1 if the update worked, -1 or -2 otherwise

addAssociation($issue_id, $associated_id, $usr_id, $link_issues = TRUE)   X-Ref
Method used to associate an existing issue with another one.

param: integer $issue_id The issue ID
param: integer $issue_id The other issue ID
return: void

deleteAssociations($issue_id, $usr_id = FALSE)   X-Ref
Method used to remove the issue associations related to a specific issue.

param: integer $issue_id The issue ID
return: void

deleteAssociation($issue_id, $associated_id)   X-Ref
Method used to remove a issue association from an issue.

param: integer $issue_id The issue ID
param: integer $associated_id The associated issue ID to remove.
return: void

addUserAssociation($usr_id, $issue_id, $assignee_usr_id, $add_history = TRUE)   X-Ref
Method used to assign an issue with an user.

param: integer $usr_id The user ID of the person performing this change
param: integer $issue_id The issue ID
param: integer $assignee_usr_id The user ID of the assignee
param: boolean $add_history Whether to add a history entry about this or not
return: integer 1 if the update worked, -1 otherwise

deleteUserAssociations($issue_id, $usr_id = FALSE)   X-Ref
Method used to delete all user assignments for a specific issue.

param: integer $issue_id The issue ID
param: integer $usr_id The user ID of the person performing the change
return: void

deleteUserAssociation($issue_id, $usr_id, $add_history = true)   X-Ref
Method used to delete a single user assignments for a specific issue.

param: integer $issue_id The issue ID
param: integer $usr_id The user to remove.
param: boolean $add_history Whether to add a history entry about this or not
return: void

createFromEmail($prj_id, $usr_id, $sender, $summary, $description, $category, $priority, $assignment, $date, $msg_id)   X-Ref
Creates an issue with the given email information.

param: integer $prj_id The project ID
param: integer $usr_id The user responsible for this action
param: string $sender The original sender of this email
param: string $summary The issue summary
param: string $description The issue description
param: integer $category The category ID
param: integer $priority The priority ID
param: array $assignment The list of users to assign this issue to
param: string $date The date the email was originally sent.
param: string $msg_id The message ID of the email we are creating this issue from.
return: void

insert()   X-Ref
Method used to add a new issue using the normal report form.

return: integer The new issue ID

getParam($name)   X-Ref
Method used to get a specific parameter in the issue listing cookie.

param: string $name The name of the parameter
return: mixed The value of the specified parameter

saveSearchParams()   X-Ref
Method used to save the current search parameters in a cookie.

return: array The search parameters

getSortingInfo($options)   X-Ref
Method used to get the current sorting options used in the grid layout
of the issue listing page.

param: array $options The current search parameters
return: array The sorting options

getLastActionFields()   X-Ref
Returns the list of action date fields appropriate for the
current user ID.

return: array The list of action date fields

getListing($prj_id, $options, $current_row = 0, $max = 5)   X-Ref
Method used to get the list of issues to be displayed in the grid layout.

param: integer $prj_id The current project ID
param: array $options The search parameters
param: integer $current_row The current page number
param: integer $max The maximum number of rows per page
return: array The list of issues to be displayed

formatLastActionDates(&$result)   X-Ref
Processes a result set to format the "Last Action Date" column.

param: array $result The result set

getLastStatusChangeDates($prj_id, &$result)   X-Ref
Retrieves the last status change date for the given issue.

param: integer $prj_id The project ID
param: array $result The associative array of data

buildWhereClause($options)   X-Ref
Method used to get the list of issues to be displayed in the grid layout.

param: array $options The search parameters
return: string The where clause

getSides($issue_id, $options)   X-Ref
Method used to get the previous and next issues that are available
according to the current search parameters.

param: integer $issue_id The issue ID
param: array $options The search parameters
return: array The list of issues

getAssignedUserIDs($issue_id)   X-Ref
Method used to get the full list of user IDs assigned to a specific
issue.

param: integer $issue_id The issue ID
return: array The list of user IDs

isAssignedToUser($issue_id, $usr_id)   X-Ref
Method used to see if a user is assigned to an issue.

param: integer $issue_id The issue ID
param: integer $usr_id An integer containg the ID of the user.
return: boolean true if the user(s) are assigned to the issue.

getReportersByIssues(&$result)   X-Ref
Method used to get the full list of reporters associated with a given
list of issues.

param: array $result The result set
return: void

getAssignedUsersByIssues(&$result)   X-Ref
Method used to get the full list of assigned users by a list
of issues. This was originally created to optimize the issue
listing page.

param: array $result The result set
return: void

getDescriptionByIssues(&$result)   X-Ref
Method used to add the issue description to a list of issues.

param: array $result The result set
return: void

getAssignedUsers($issue_id)   X-Ref
Method used to get the full list of users (the full names) assigned to a
specific issue.

param: integer $issue_id The issue ID
return: array The list of users

getDetails($issue_id, $force_refresh = false)   X-Ref
Method used to get the details for a specific issue.

param: integer $issue_id The issue ID
param: boolean $force_refresh If the cache should not be used.
return: array The details for the specified issue

getDuplicatedDetails($issue_id)   X-Ref
Method used to get some simple details about the given duplicated issue.

param: integer $issue_id The issue ID
return: array The duplicated issue details

bulkUpdate()   X-Ref
Method used to bulk update a list of issues

return: boolean

setImpactAnalysis($issue_id)   X-Ref
Method used to set the initial impact analysis for a specific issue

param: integer $issue_id The issue ID
return: integer 1 if the update worked, -1 otherwise

getColList($extra_condition = NULL)   X-Ref
Method used to get the full list of issue IDs that area available in the
system.

param: string $extra_condition An extra condition in the WHERE clause
return: array The list of issue IDs

getAssocList($extra_condition = NULL)   X-Ref
Method used to get the full list of issue IDs and their respective
titles.

param: string $extra_condition An extra condition in the WHERE clause
return: array The list of issues

getAssociatedIssues($issue_id)   X-Ref
Method used to get the list of issues associated to a specific issue.

param: integer $issue_id The issue ID
return: array The list of associated issues

getAssociatedIssuesDetails($issue_id)   X-Ref
Method used to get the list of issues associated details to a
specific issue.

param: integer $issue_id The issue ID
return: array The list of associated issues

isClosed($issue_id)   X-Ref
Method used to check whether an issue was already closed or not.

param: integer $issue_id The issue ID
return: boolean

getQuarantinedIssueList()   X-Ref
Returns a simple list of issues that are currently set to some
form of quarantine. This is mainly used by the IRC interface.

return: array List of quarantined issues

getQuarantineInfo($issue_id)   X-Ref
Returns the status of a quarantine.

param: integer $issue_id The issue ID
return: integer Indicates what the current state of quarantine is.

setQuarantine($issue_id, $status, $expiration = '')   X-Ref
Sets the quarantine status. Optionally an expiration date can be set
to indicate when the quarantine expires. A status > 0 indicates that quarantine is active.

param: integer $issue_id The issue ID
param: integer $status The quarantine status
param: string  $expiration The expiration date of quarantine (default empty)

setGroup($issue_id, $group_id)   X-Ref
Sets the group of the issue.

param: integer $issue_id The ID of the issue
param: integer $group_id The ID of the group
return: integer 1 if successful, -1 or -2 otherwise

getGroupID($issue_id)   X-Ref
Returns the group ID associated with the given issue ID.

param: integer $issue_id The issue ID
return: integer The associated group ID

getFullTextIssues($options)   X-Ref
Returns an array of issues based on full text search results.

param: array $options An array of search options
return: array An array of issue IDS

canAccess($issue_id, $usr_id)   X-Ref
Method to determine if user can access a particular issue

param: integer $issue_id The ID of the issue.
param: integer $usr_id The ID of the user
return: boolean If the user can access the issue

isPrivate($issue_id)   X-Ref
Returns true if the specified issue is private, false otherwise

param: integer $issue_id The ID of the issue
return: boolean If the issue is private or not

clearClosed($issue_id)   X-Ref
Clears closed information from an issues.

param: integer $issue_id The ID of the issue

getRootMessageID($issue_id)   X-Ref
Returns the message ID that should be used as the parent ID for all messages

param: integer $issue_id The ID of the issue

getIssueByRootMessageID($msg_id)   X-Ref
Returns the issue ID of the issue with the specified root message ID, or false

param: string $msg_id The Message ID
return: integer The ID of the issue



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