[ Index ] |
PHP Cross Reference of Eventum |
[Source view] [Print] [Project Stats]
(no description)
File Size: | 921 lines (36 kb) |
Included or required: | 5 times |
Referenced: | 0 times |
Includes or requires: | 8 files include/class.mail.php include/class.validation.php include/class.user.php include/class.group.php include/class.error_handler.php include/class.issue.php include/class.reminder_condition.php include/class.notification.php |
Reminder_Action:: (21 methods):
changeRank()
_getRanking()
getTitle()
getDetails()
insert()
getUserList()
associateUserList()
update()
isUserList()
clearActionUserList()
remove()
getActionTypeList()
getAdminList()
getList()
getActionType()
saveHistory()
perform()
_recordNoRecipientError()
getRepeatActions()
recordLastTriggered()
clearLastTriggered()
Class: Reminder_Action - X-Ref
Class to handle the business logic related to the reminder emailschangeRank($rem_id, $rma_id, $rank_type) X-Ref |
Method used to quickly change the ranking of a reminder action from the administration screen. param: integer $rem_id The reminder ID param: integer $rma_id The reminder action ID param: string $rank_type Whether we should change the entry down or up (options are 'asc' or 'desc') return: boolean |
_getRanking($rem_id) X-Ref |
Returns an associative array with the list of reminder action IDs and their respective ranking. param: integer $rem_id The reminder ID return: array The list of reminder actions |
getTitle($rma_id) X-Ref |
Method used to get the title of a specific reminder action. param: integer $rma_id The reminder action ID return: string The title of the reminder action |
getDetails($rma_id) X-Ref |
Method used to get the details for a specific reminder action. param: integer $rma_id The reminder action ID return: array The details for the specified reminder action |
insert() X-Ref |
Method used to create a new reminder action. return: integer 1 if the insert worked, -1 or -2 otherwise |
getUserList($rma_id) X-Ref |
Returns the list of users associated with a given reminder action ID param: integer $rma_id The reminder action ID return: array The list of associated users |
associateUserList($rma_id, $user_list) X-Ref |
Method used to associate a list of users with a given reminder action ID param: integer $rma_id The reminder action ID param: array $user_list The list of users return: void |
update() X-Ref |
Method used to update the details of a specific reminder action. return: integer 1 if the update worked, -1 or -2 otherwise |
isUserList($rmt_id) X-Ref |
Checks whether the given reminder action type is one where a list of users is used or not. param: integer $rmt_id The reminder action type ID return: boolean |
clearActionUserList($rma_id) X-Ref |
Removes the full user list for a given reminder action ID. param: integer $rma_id The reminder action ID return: void |
remove($action_ids) X-Ref |
Method used to remove reminder actions by using the administrative interface of the system. return: boolean |
getActionTypeList() X-Ref |
Method used to get an associative array of action types. return: array The list of action types |
getAdminList($rem_id) X-Ref |
Method used to get the list of reminder actions to be displayed in the administration section. param: integer $rem_id The reminder ID return: array The list of reminder actions |
getList($reminder_id) X-Ref |
Method used to get the list of reminder actions associated with a given reminder ID. param: integer $reminder_id The reminder ID return: array The list of reminder actions |
getActionType($rmt_id) X-Ref |
Method used to get the title of a reminder action type. param: integer $rmt_id The reminder action type return: string The action type title |
saveHistory($issue_id, $rma_id) X-Ref |
Method used to save a history entry about the execution of the current reminder. param: integer $issue_id The issue ID param: integer $rma_id The reminder action ID return: boolean |
perform($issue_id, $reminder, $action) X-Ref |
Method used to perform a specific action to an issue. param: integer $issue_id The issue ID param: array $reminder The reminder details param: array $action The action details return: boolean |
_recordNoRecipientError($issue_id, $type, $reminder, $action, $data, $conditions) X-Ref |
Method used to send an alert to a set of email addresses when a reminder action was triggered, but no action was really taken because no recipients could be found. param: integer $issue_id The issue ID param: string $type Which reminder are we trying to send, email or sms param: array $reminder The reminder details param: array $action The action details return: void |
getRepeatActions($issues, $rma_id) X-Ref |
Returns the given list of issues with only the issues that were last triggered for the given reminder action ID. param: array $issues The list of issue IDs param: integer $rma_id The reminder action ID return: array The list of issue IDs |
recordLastTriggered($issue_id, $rma_id) X-Ref |
Records the last triggered reminder action for a given issue ID. param: integer $issue_id The issue ID param: integer $rma_id The reminder action ID return: boolean |
clearLastTriggered($issue_id) X-Ref |
Clears the last triggered reminder for a given issue ID. param: integer $issue_id The issue ID return: boolean |
Generated: Wed Dec 19 21:21:33 2007 | Cross-referenced by PHPXref 0.7 |