class PrivateMessage extends ConcreteObject implements SubjectInterface (View source)

Properties

$error from  ConcreteObject
protected $authorName
protected $mailbox
protected $attachments
$uID
$msgIsUnread
$msgIsNew
$msgIsReplied
$msgID
$uAuthorID
$uToID
$msgDateCreated
$msgSubject
$msgBody

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

getNotificationDate()

Get the date of this notification

User[]
getUsersToExcludeFromNotification()

Get the users that should be excluded from notifications Expected return value would be users involved in the creation of the notification, they may not need to be notified.

getMessageDelimiter()

No description

static 
getByID($msgID, $mailbox = false)

No description

getMessageStatus()

No description

markAsRead()

No description

getMessageAuthorID()

No description

getMessageID()

No description

getMessageUserID()

No description

getMessageAuthorObject()

No description

getMessageUserToID()

No description

getMessageUserToObject()

No description

getMessageRelevantUserID()

No description

getFormattedMessageBody()

Responsible for converting line breaks to br tags, perhaps running bbcode, as well as making the older replied-to messages gray.

isMessageUnread()

No description

isMessageReplied()

No description

isMessageNew()

No description

delete()

No description

getMessageRelevantUserObject()

No description

getMessageRelevantUserName()

No description

getMessageAuthorName()

No description

getMessageDateAdded()

No description

getMessageSubject()

No description

getFormattedMessageSubject()

No description

getMessageBody()

No description

File[]
getAttachments()

No description

Details

loadError($error)

No description

Parameters

$error

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

Parameters

$arr

static camelcase($file)

No description

Parameters

$file

static uncamelcase($string)

No description

Parameters

$string

DateTime getNotificationDate()

Get the date of this notification

Return Value

DateTime

User[] getUsersToExcludeFromNotification()

Get the users that should be excluded from notifications Expected return value would be users involved in the creation of the notification, they may not need to be notified.

Return Value

User[]

getMessageDelimiter()

No description

static getByID($msgID, $mailbox = false)

No description

Parameters

$msgID
$mailbox

getMessageStatus()

No description

markAsRead()

No description

getMessageAuthorID()

No description

getMessageID()

No description

getMessageUserID()

No description

getMessageAuthorObject()

No description

getMessageUserToID()

No description

getMessageUserToObject()

No description

getMessageRelevantUserID()

No description

getFormattedMessageBody()

Responsible for converting line breaks to br tags, perhaps running bbcode, as well as making the older replied-to messages gray.

isMessageUnread()

No description

isMessageReplied()

No description

isMessageNew()

No description

delete()

No description

getMessageRelevantUserObject()

No description

getMessageRelevantUserName()

No description

getMessageAuthorName()

No description

getMessageDateAdded()

No description

getMessageSubject()

No description

getFormattedMessageSubject()

No description

getMessageBody()

No description

File[] getAttachments()

No description

Return Value

File[]