[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

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

(no description)

File Size: 876 lines (33 kb)
Included or required: 11 times
Referenced: 0 times
Includes or requires: 10 files
 include/class.authorized_replier.php
 include/class.user.php
 include/class.history.php
 include/class.validation.php
 include/class.draft.php
 include/class.misc.php
 include/class.date.php
 include/class.auth.php
 include/class.error_handler.php
 include/class.issue.php

Defines 1 class

Note:: (21 methods):
  getSideLinks()
  getDetails()
  getNoteSequenceNumber()
  getBlockedMessage()
  getIssueID()
  getNoteBySequence()
  getUnknownUser()
  saveRoutedNote()
  insert()
  removeByIssues()
  remove()
  getListing()
  convertNote()
  getCountByUser()
  setAttachmentFlag()
  getTotalNotesByIssue()
  getIssueByMessageID()
  getParentMessageIDbyMessageID()
  getIDByMessageID()
  getMessageIDbyID()
  exists()


Class: Note  - X-Ref

Class to handle the business logic related to adding, updating or
deleting notes from the application.

getSideLinks($issue_id, $not_id)   X-Ref
Returns the next and previous notes associated with the given issue ID
and the currently selected note.

param: integer $issue_id The issue ID
param: integer $not_id The currently selected note ID
return: array The next and previous note ID

getDetails($note_id)   X-Ref
Retrieves the details about a given note.

param: integer $note_id The note ID
return: array The note details

getNoteSequenceNumber($issue_id, $note_id)   X-Ref
Returns the sequensial note identification number for the given issue.
This is only for display purposes, but has become relied upon by users
as a valid reference number.  It is simply a sequence, starting with the
first note created as #1, and each increasing by 1 there after.


getBlockedMessage($note_id)   X-Ref
Returns the blocked email message body associated with the given note ID.

param: integer $note_id The note ID
return: string The blocked email message body

getIssueID($note_id)   X-Ref
Returns the issue ID associated with the given note ID.

param: integer $note_id The note ID
return: integer The issue ID

getNoteBySequence($issue_id, $sequence)   X-Ref
Returns the nth note for the specific issue. Sequence starts at 1.

param: integer $issue_id The id of the issue.
param: integer $sequence The sequential number of the note.
return: array An array of data containing details about the note.

getUnknownUser($note_id)   X-Ref
Method used to get the unknown_user from the note table for the specified note id.

param: integer $note_id The note ID

saveRoutedNote($message)   X-Ref
Method used to save the routed note into a backup directory.

param: string $message The full body of the note

insert($usr_id, $issue_id, $unknown_user = FALSE, $log = true, $closing = false, $send_notification = true)   X-Ref
Method used to add a note using the user interface form
available in the application.

param: integer $usr_id The user ID
param: integer $issue_id The issue ID
param: string  $unknown_user The email address of a user that sent the blocked email that was turned into this note. Default is false.
param: boolean $log If adding this note should be logged. Default true.
param: boolean $closing If The issue is being closed. Default false
param: boolean $send_notification Whether to send a notification about this note or not
return: integer the new note id if the insert worked, -1 or -2 otherwise

removeByIssues($ids)   X-Ref
Method used to remove all notes associated with a specific set
of issues.

param: array $ids The list of issues
return: boolean

remove($note_id, $log = true)   X-Ref
Method used to remove a specific note from the application.

param: integer $note_id The note ID
param: boolean $log If this event should be logged or not. Default true
return: integer 1 if the removal worked, -1 or -2 otherwise

getListing($issue_id)   X-Ref
Method used to get the full listing of notes associated with
a specific issue.

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

convertNote($note_id, $target, $authorize_sender = false)   X-Ref
Converts a note to a draft or an email

param: $note_id The id of the note
param: $target What the not should be converted too
param: $authorize_sender If the sender should be added to authorized senders list.

getCountByUser($usr_id, $start, $end)   X-Ref
Returns the number of notes by a user in a time range.

param: string $usr_id The ID of the user
param: integer $start The timestamp of the start date
param: integer $end The timestanp of the end date
return: integer The number of notes by the user

setAttachmentFlag($note_id)   X-Ref
Method used to mark a note as having attachments associated with it.

param: integer $note_id The note ID
return: boolean

getTotalNotesByIssue($issue_id)   X-Ref
Returns the total number of notes associated to the given issue ID.

param: string $issue_id The issue ID
return: integer The number of notes

getIssueByMessageID($message_id)   X-Ref
Method used to get the issue ID associated with a given note
message-id.

param: string $message_id The message ID
return: integer The issue ID

getParentMessageIDbyMessageID($msg_id)   X-Ref
Returns the message-id of the parent note.

param: string $msg_id The message ID
return: string The message id of the parent note or false

getIDByMessageID($message_id)   X-Ref
Method used to get the note ID associated with a given note
message-id.

param: string $message_id The message ID
return: integer The note ID

getMessageIDbyID($id)   X-Ref
Method used to get the message-ID associated with a given note
id.

param: integer $id The ID
return: string The Message-ID

exists($message_id)   X-Ref
Checks if a message already is downloaded..

param: string $message_id The Message-ID header
return: boolean



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