[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

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

(no description)

File Size: 299 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 include/workflow/class.abstract_workflow_backend.php

Defines 1 class

Example_Workflow_Backend:: (15 methods):
  handleIssueUpdated()
  handleAssignment()
  handleAttachment()
  handlePriorityChange()
  handleBlockedEmail()
  handleNewNote()
  handleAssignmentChange()
  handleNewIssue()
  handleManualEmailAssociation()
  handleNewEmail()
  getAllowedStatuses()
  handleSubscription()
  handleIssueClosed()
  handleCustomFieldsUpdated()
  shouldEmailAddress()


Class: Example_Workflow_Backend  - X-Ref

Example workflow backend class. For example purposes it will print what
method is called.

handleIssueUpdated($prj_id, $issue_id, $usr_id, $old_details, $changes)   X-Ref
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 projectID
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 projectID
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 projectID
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 projectID
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.

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

param: integer $prj_id The projectID
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

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

param: integer $prj_id The projectID
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 projectID
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.

handleManualEmailAssociation($prj_id, $issue_id)   X-Ref
Updates the existing issue to a different status when an email is
manually associated to an existing issue.

param: integer $prj_id The projectID
param: integer $issue_id The issue ID

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

param: integer $prj_id The projectID
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.

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 projectID
param: integer $issue_id The ID of the issue.
return: array An associative array of statuses valid for this issue.

handleSubscription($prj_id, $issue_id, &$subscriber_usr_id, &$email, &$actions)   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 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.

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.

shouldEmailAddress($prj_id, $address)   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



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