[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

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

(no description)

File Size: 525 lines (19 kb)
Included or required: 5 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Workflow:: (25 methods):
  getBackendList()
  _getBackendNameByProject()
  _getBackend()
  hasWorkflowIntegration()
  handleIssueUpdated()
  handleAssignment()
  handleAttachment()
  handlePriorityChange()
  handleBlockedEmail()
  handleAssignmentChange()
  handleNewIssue()
  handleNewEmail()
  handleManualEmailAssociation()
  handleNewNote()
  getAllowedStatuses()
  handleIssueClosed()
  handleCustomFieldsUpdated()
  handleSubscription()
  handleSCMCheckins()
  shouldEmailAddress()
  getAdditionalEmailAddresses()
  canEmailIssue()
  handleAuthorizedReplierAdded()
  preEmailDownload()
  shouldAutoAddToNotificationList()


Class: Workflow  - X-Ref

getBackendList()   X-Ref
Returns a list of backends available

return: array An array of workflow backends

_getBackendNameByProject($prj_id)   X-Ref
Returns the name of the workflow backend for the specified project.

param: integer $prj_id The id of the project to lookup.
return: string The name of the customer backend.

_getBackend($prj_id)   X-Ref
Includes the appropriate workflow backend class associated with the
given project ID, instantiates it and returns the class.

param: integer $prj_id The project ID
return: boolean

hasWorkflowIntegration($prj_id)   X-Ref
Checks whether the given project ID is setup to use workflow integration
or not.

param: integer integer $prj_id The project ID
return: boolean

handleIssueUpdated($prj_id, $issue_id, $usr_id, $old_details, $changes)   X-Ref
Is called when an issue is updated.

param: integer $prj_id The project ID.
param: integer $issue_id The ID of the issue.
param: integer $usr_id The ID of the user.
param: array $old_details The old details of the issues.
param: array $changes The changes that were applied to this issue (the $_POST)

handleAssignment($prj_id, $issue_id, $usr_id)   X-Ref
Called when an issue is assigned.

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue.
param: integer $usr_id The id of the user who assigned the issue.

handleAttachment($prj_id, $issue_id, $usr_id)   X-Ref
Called when a file is attached to an issue..

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue.
param: integer $usr_id The id of the user who locked the issue.

handlePriorityChange($prj_id, $issue_id, $usr_id, $old_details, $changes)   X-Ref
Called when the priority of an issue changes.

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue.
param: integer $usr_id The id of the user who locked the issue.
param: array $old_details The old details of the issue.
param: array $changes The changes that were applied to this issue (the $_POST)

handleBlockedEmail($prj_id, $issue_id, $email_details, $type)   X-Ref
Called when an email is blocked.

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue.
param: array $email_details Details of the issue
param: string $type What type of blocked email this is.

handleAssignmentChange($prj_id, $issue_id, $usr_id, $issue_details, $new_assignees, $remote_assignment = false)   X-Ref
Called when the assignment on an issue changes.

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue.
param: integer $usr_id The id of the user who locked the issue.
param: array $issue_details The old details of the issue.
param: array $new_assignees The new assignees of this issue.
param: boolean $remote_assignment If this issue was remotely assigned.

handleNewIssue($prj_id, $issue_id, $has_TAM, $has_RR)   X-Ref
Called when a new issue is created.

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue.
param: boolean $has_TAM If this issue has a technical account manager.
param: boolean $has_RR If Round Robin was used to assign this issue.

handleNewEmail($prj_id, $issue_id, $message, $row = FALSE, $closing = false)   X-Ref
Called when an email is recieved.

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue.
param: object $message An object containing the new email
param: array $row The array of data that was inserted into the database.
param: boolean $closing If we are closing the issue.

handleManualEmailAssociation($prj_id, $issue_id)   X-Ref
Called when an email is manually associated with an existing issue.

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue.

handleNewNote($prj_id, $issue_id, $usr_id, $closing = false, $note_id = false)   X-Ref
Called when a note is routed.

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue.
param: integer $usr_id The user ID of the person posting this new note
param: boolean $closing If the issue is being closed
param: integer $note_id The ID of the new note

getAllowedStatuses($prj_id, $issue_id)   X-Ref
Method is called to return the list of statuses valid for a specific issue.

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue.
return: array An associative array of statuses valid for this issue.

handleIssueClosed($prj_id, $issue_id, $send_notification, $resolution_id, $status_id, $reason)   X-Ref
Called when issue is closed.

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue.
param: boolean $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
return: void

handleCustomFieldsUpdated($prj_id, $issue_id, $old, $new)   X-Ref
Called when custom fields are updated

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue
param: array $old The custom fields before the update.
param: array $new The custom fields after the update.

handleSubscription($prj_id, $issue_id, &$subscriber_usr_id, &$email, &$types)   X-Ref
Called when an attempt is made to add a user or email address to the
notification list.

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue.
param: integer $subscriber_usr_id The ID of the user to subscribe if this is a real user (false otherwise).
param: string $email The email address  to subscribe (if this is not a real user).
param: array $types The action types.
return: mixed An array of information or true to continue unchanged or false to prevent the user from being added.

handleSCMCheckins($prj_id, $issue_id, $module, $files, $username, $commit_msg)   X-Ref
Called when SCM checkin is associated.

param: integer $prj_id The project ID.
param: integer $issue_id The ID of the issue.
param: string $module The SCM module commit was made.
param: array $files File list with their version numbers changes made on.
param: string $username SCM user doing the checkin.
param: string $commit_msg Message associated with the SCM commit.
return: void

shouldEmailAddress($prj_id, $address, $issue_id = false, $type = false)   X-Ref
Determines if the address should should be emailed.

param: integer $prj_id The project ID.
param: string $address The email address to check
return: boolean

getAdditionalEmailAddresses($prj_id, $issue_id, $event, $extra = false)   X-Ref
Returns additional email addresses that should be notified for a specific event..

param: integer $prj_id The project ID.
param: integer $issue_id The ID of the issue.
param: string  $event The event to return additional email addresses for. Currently only "new_issue" is supported.
param: array   $extra Extra information, contains different info depending on where it is called from
return: array   An array of email addresses to be notified.

canEmailIssue($prj_id, $issue_id, $email)   X-Ref
Indicates if the the specified email address can email the issue. Can be
used to disable email blocking by always returning true.

param: integer $prj_id The project ID.
param: integer $issue_id The ID of the issue
param: string The email address that is trying to send an email
return: boolean true if the sender can email the issue, false if the sender

handleAuthorizedReplierAdded($prj_id, $issue_id, &$email)   X-Ref
Handles when an authorized replier is added

param: integer $prj_id The project ID
param: integer $issue_id The ID of the issue
param: string  $email The email address added
return: boolean

preEmailDownload($prj_id, $info, $mbox, $num, &$message, &$email)   X-Ref
Called at the begining of the email download process. If it returns true, the
rest of the email code will not be executed.

param: integer $prj_id The project ID
param: array $info An array containing the information on the email account.
param: resource $mbox The imap connection resource
param: integer $num The sequential email number
param: string $message The complete email message
param: object $email An object containing the decoded email
return: mixed null by default, -1 if the rest of the email script should not be processed.

shouldAutoAddToNotificationList($prj_id)   X-Ref
Indicates if the email addresses should automatically be added to the NL from notes and emails.

param: integer $prj_id The project ID.
return: boolean



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