[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

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

(no description)

File Size: 899 lines (34 kb)
Included or required: 7 times
Referenced: 0 times
Includes or requires: 3 files
 include/class.reminder_action.php
 include/class.priority.php
 include/class.error_handler.php

Defines 1 class

Reminder:: (25 methods):
  isDebug()
  changeRank()
  _getRanking()
  getIssueAssocListByProject()
  getTitle()
  getProjectID()
  getDetails()
  getAssociatedPriorities()
  addSupportLevelAssociation()
  addIssueAssociation()
  addCustomerAssociation()
  associateAllIssues()
  addPriorityAssociation()
  removeAllAssociations()
  insert()
  update()
  remove()
  getRequirements()
  getAdminList()
  getList()
  getTriggeredIssues()
  getWhereClause()
  getSQLQuery()
  getHistoryList()
  _getReminderAlertAddresses()


Class: Reminder  - X-Ref

Class to handle the business logic related to the reminder emails
that the system sends out.

isDebug()   X-Ref
Returns whether we are in "debug mode" or not. Returning true
here will enable all sorts of helpful messages in the reminder
check script.

return: boolean

changeRank($rem_id, $rank_type)   X-Ref
Method used to quickly change the ranking of a reminder entry
from the administration screen.

param: integer $rem_id The reminder entry ID
param: string $rank_type Whether we should change the reminder ID down or up (options are 'asc' or 'desc')
return: boolean

_getRanking()   X-Ref
Returns an associative array with the list of reminder IDs and
their respective ranking.

return: array The list of reminders

getIssueAssocListByProject($prj_id)   X-Ref
Method used by the administration screen to list the available
issues in a project.

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

getTitle($rem_id)   X-Ref
Method used to get the title of a specific reminder.

param: integer $rem_id The reminder ID
return: string The title of the reminder

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

param: integer $rem_id The reminder ID
return: integer The project ID

getDetails($rem_id)   X-Ref
Method used to get the details for a specific reminder.

param: integer $rem_id The reminder ID
return: array The details for the specified reminder

getAssociatedPriorities($rem_id)   X-Ref
Method used to get a list of all priority IDs associated with the given
reminder.

param: integer $rem_id The reminder ID
return: array The list of associated priority IDs

addSupportLevelAssociation($rem_id, $support_level_id)   X-Ref
Method used to associate a support level ID with a given
reminder entry ID.

param: integer $rem_id The reminder ID
param: integer $support_level_id The support level ID
return: boolean

addIssueAssociation($rem_id, $issue_id)   X-Ref
Method used to associate an issue with a given reminder.

param: integer $rem_id The reminder ID
param: integer $issue_id The issue ID
return: boolean

addCustomerAssociation($rem_id, $customer_id)   X-Ref
Method used to associate a customer ID with a given reminder
entry ID.

param: integer $rem_id The reminder ID
param: integer $customer_id The customer ID
return: boolean

associateAllIssues($rem_id)   X-Ref
Method used to associate a reminder with any issue.

param: integer $rem_id The reminder ID
return: boolean

addPriorityAssociation($rem_id, $priority_id)   X-Ref
Method used to associate a priority with a given reminder.

param: integer $rem_id The reminder ID
param: integer $priority_id The priority ID
return: boolean

removeAllAssociations($rem_id)   X-Ref
Method used to remove all requirements and priority associations for a
given reminder.

param: integer $rem_id The reminder ID

insert()   X-Ref
Method used to create a new reminder.

return: integer 1 if the insert worked, -1 or -2 otherwise

update()   X-Ref
Method used to update the details of a specific reminder.

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

remove()   X-Ref
Method used to remove reminders by using the administrative
interface of the system.

return: boolean

getRequirements($rem_id)   X-Ref
Method used to get the list of requirements associated with a given
reminder.

param: integer $rem_id The reminder ID
return: array The list of requirements

getAdminList()   X-Ref
Method used to get the list of reminders to be displayed in the
administration section.

return: array The list of reminders

getList()   X-Ref
Method used to get the full list of reminders.

return: array The list of reminders

getTriggeredIssues($reminder, $conditions)   X-Ref
Method used to get the list of issue IDs that match the given conditions.

param: integer $rem_id The reminder ID
param: array $conditions The list of conditions
return: array The list of issue IDs

getWhereClause($reminder, $conditions)   X-Ref
Method used to generate a where clause from the given list of conditions.

param: array $reminder An array of reminder info.
param: array $conditions The list of conditions
return: string The where clause

getSQLQuery($rem_id, $rma_id)   X-Ref
Method used to generate an SQL query to be used in debugging the reminder
conditions.

param: integer $rem_id The reminder ID
param: integer $rma_id The reminder action ID
return: string The SQL query

getHistoryList($iss_id)   X-Ref
Method used to list the history of triggered reminder actions
for a given issue.

param: integer $iss_id The issue ID
return: array The list of triggered reminder actions

_getReminderAlertAddresses()   X-Ref
Method used to get the list of email addresses to use
to send diagnostic information about the reminder system.

return: array The list of alert email addresses



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