Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Internal_Message Class Reference
Inheritance diagram for Internal_Message:
MySource_Object

Public Member Functions

 Internal_Message ()
 
 load ($messageid)
 
 send ()
 
 printBody ()
 
 formatBody (&$user, $isInternalMessage=FALSE)
 
 expandUsersTo ()
 
 delete ()
 
 updateStatus ($status)
 
- Public Member Functions inherited from MySource_Object
 MySource_Object ()
 
 __sleep ()
 
 __wakeup ()
 

Data Fields

 $id = 0
 
 $to = Array()
 
 $from = 0
 
 $type = ''
 
 $sent = 0
 
 $subject = ''
 
 $body = ''
 
 $priority = SQ_MSG_PRIORITY_NORMAL
 
 $status = SQ_MSG_UNREAD
 
 $assetid = NULL
 
 $parameters = Array()
 
 $replacements = Array()
 
- Data Fields inherited from MySource_Object
 $_tmp
 

Detailed Description

Definition at line 29 of file internal_message.inc.

Member Function Documentation

delete ( )

Deletes an internal message FOREVER - be careful

Returns
boolean public

Definition at line 702 of file internal_message.inc.

expandUsersTo ( )

Returns an array of users this message will be sent to

That is, it expands the groups ids and returns a unique array of userids

Returns
array public

Definition at line 608 of file internal_message.inc.

formatBody ( $user,
  $isInternalMessage = FALSE 
)

Replaces keywords in the body of the message

Parameters
object&$userthe user that the message is being sent to
boolean$isInternalMessageDetermine whether this message is internal or to be sent to email.
Returns
boolean public

Definition at line 544 of file internal_message.inc.

Constructor

Definition at line 111 of file internal_message.inc.

load (   $messageid)

Loads the information about this message

Parameters
int$messageidid of the message the you want to get
Returns
boolean public

Definition at line 126 of file internal_message.inc.

printBody ( )

Called by the design to print the body of this message

public

Definition at line 485 of file internal_message.inc.

send ( )

Sends an internal message

Returns
boolean public

Definition at line 170 of file internal_message.inc.

updateStatus (   $status)

Update the status of a message

Parameters
string$statusthe new status (see constants for SQ_MSG_*)
Returns
boolean public

Definition at line 729 of file internal_message.inc.


The documentation for this class was generated from the following file: