YaBB3::Entities::Message - Private Message Class


Name

YaBB3::Entities::Message - Private Message Class


Synopsis

Synopsis


Overview

An object of this class represents a private message (PM).


Description

The class provides all required backend methods to work with a message. You have to seperatly load the author and recipients of a message if you need this information. If it is not required we save DB queries.


Reference

Use Packages

YaBB3::Base YaBB3::Entities::User YaBB3::Entities::Recipient

Exports

  Default   $VERSION
  Optional
  Tags

Package Fields

  $VERSION  The package version number as a float.

Package Subroutines

Object Super Classes

YaBB3::Base

Object Fields

id

Unique ID of the message

author

User object representing the message's author. Loaded by loadAuthor.

body

Body field of message

from_uid

Author user ID

to_uid

Recipient user ID???? huh?

from_folder_id

Folder ID where this message is stored by the author

mark_as_read

?? replaced by status??

message_date

Date when message was send.

recipients

List of recipient objects.

status

Indicates if message was read by at least one recipient.

Record Fields

Object Methods

create

  Returns
  $        The ID of the new message.
  
Creates a new message in the database with the values provided by the object field newvalues.

delete

loadData

loadDataById

  $id    Message ID.
  Returns
  $      True if message successfully loaded.
  
Load data for the specified ID from the DB.

storeData

storeDataForAllReader

loadAuthor

loadMessagesForUser

loadMessagesInFolderCount

loadRecipients

loadRecipientCount

loadRecipientsMessagesCount

markAsRead

getRecipients_FolderId

isRecipient

doBBC

createFolder

deleteFolder

loadFolderData

storeFolderData

updateFrontend

Getter and Setter methods for object fields


Author

Torsten Mrotz (tmrotz@yabbforum.com)

Copyright ©2002-2005, YaBB 3 Development Team. All Rights Reserved.
You may distribute this module under the terms of YaBB 3.
 YaBB3::Entities::Message - Private Message Class