UNB Components Code Reference

UnbMessage class

The message class represents a single message in the UNB system and provides methods to find and manipulate message instances.

It depends on the UnbDatabase class for a database connection. It also uses the class UnbMessageRevision to manage message revisions.

Extends class

UnbEntity

Public methods

   AddAlterAccessKey Adds a key to this message that allows altering it.
   AddReadAccessKey Adds a key to this message that allows reading it.
   AddReference Adds a message reference to this message.
   AddReplyAccessKey Adds a key to this message that allows replying to it.
   AddRevision Adds a new revision to this message.
S ClearAccessCache Clears this message's internal cache of access key lists.
   ClearRating Clears the user's rating for this message.
   CountReplies Gets the number of messages that are directly or indirectly referencing to this message through their primary reference.
S Create Creates a new message instance.
   Delete Deletes this instance of the message with all its references.
S FindByMessageId Finds a message instance by its message ID.
S FindByPageName Finds a message instance by its page name.
   GetAllAlterAccessKeys Gets a list of all keys that allow altering this message, regarding access restrictions imposed through assigned tags.
   GetAllRevisions Gets all revisions of this message, with no content.
   GetAlterAccessKeys Gets a list of all keys that allow altering this message.
   GetCreatedTime Gets the time when the message was created.
   GetEffectiveReadAccessKeys Gets a list of all keys that allow reading this message, regarding access restrictions imposed through assigned tags.
   GetLastBeginEdit Gets the time when a user last began editing this message.
   GetLatestReply Gets the latest message from all messages that are directly or indirectly referencing to this message through their primary reference.
   GetLatestRevision Gets the latest accessible revision of this message by its moderation state.
   GetMessageId Gets the message ID.
   GetModerationFlags Gets the message's moderation flags.
   GetMoreReferences Gets all additional message IDs that this message is referencing.
   GetMyRating Gets the session user's rating for this message.
   GetOwnerUser Gets the UnbUser object of the message's assigned user (owner).
   GetOwnerUserId Gets the user ID of the message's assigned user (owner).
   GetPageName Gets the message's page name.
   GetPrimaryReference Gets the message ID of the message's primary reference.
   GetRating Gets this message's overall rating.
   GetReadAccessKeys Gets a list of all keys that allow reading this message.
   GetRefDEP Gets the last-referenced discussion entry point's message ID.
   GetReplyAccessKeys Gets a list of all keys that allow replying to this message.
   GetRevision Gets a specific revision of this message by its revision number.
   GetSearchOptimisedContent Gets the content of this message that shall be regarded for searching.
   GetSearchOptimisedSubject Gets the subject of this message that shall be regarded for searching.
   GetSearchRevision Gets the revision object that shall be regarded for searching.
   GetSearchRevisionNumber Gets the revision number that shall be regarded for searching.
   IsAlterAllowed Gets a value indicating whether altering this message is allowed to the current session user.
S IsAlterAllowedById Gets a value indicating whether altering a message specified by its message ID is allowed to the current session user.
   IsEntryPoint Gets a value indicating whether this message is a discussion entry point.
   IsReadAllowed Gets a value indicating whether reading this message is allowed to the current session user.
S IsReadAllowedById Gets a value indicating whether reading a message specified by its message ID is allowed to the current session user.
   IsReplyAllowed Gets a value indicating whether replying to this message is allowed to the current session user.
S IsReplyAllowedById Gets a value indicating whether replying to a message specified by its message ID is allowed to the current session user.
   RemoveAlterAccessKey Removes a key from this message that allows altering it.
   RemoveReadAccessKey Removes a key from this message that allows reading it.
   RemoveReference Removes a message reference from this message.
   RemoveReplyAccessKey Removes a key from this message that allows replying to it.
   SetAlterAccessKeys Sets all keys for this message that allow altering it. This removes any keys set before.
   SetEntryPoint Specifies whether this message is a discussion entry point.
   SetLastBeginEdit Sets the time when a user last began editing this message.
   SetModerationFlags Sets the message's moderation flags.
   SetOwner Assigns the message to another user.
   SetPageName Sets the message's page name.
   SetRating Sets the user's rating for this message.
   SetReadAccessKeys Sets all keys for this message that allow reading it. This removes any keys set before.
S SetReadAllowedIds Remember that the specified message IDs are readable by the current session user.
   SetReplyAccessKeys Sets all keys for this message that allow replying to it. This removes any keys set before.
   SetSearchOptimisedContent Sets the content of this message that shall be regarded for searching.
   SetSearchOptimisedSubject Sets the subject of this message that shall be regarded for searching.
   SetSearchRevisionNumber Sets the revision number that shall be regarded for searching.
S UpdateSearchFields Sets the search-optimised fields for content, subject and revision number to the values from the latest approved message revision.

Protected methods

S FromRecord Creates a UnbMessage object from a database record array.

Private methods

   Class constructor No description available.

Private fields

alterAccessCache  –  default: array()
Cached alter access check results
createdTime  –  default: 0
Time when this message was created
db
Cached UnbDatabase instance
entryPoint  –  default: false
Is this message a discussion entry point?
lastBeginEdit  –  default: 0
Time when a user last began editing this message, used for a warning message to potential concurrent editors
messageId  –  default: 0
Message ID
moderationFlags  –  default: 0
Moderation flags of the entire message (see UnbMessage::MF_* constants)
ownerUser  –  default: null
Cached owner UnbUser object
ownerUserId  –  default: 0
User to whom this message is assigned, usually the user who created the message
pageName  –  default: ''
Message's page name for Wiki-like usage
primaryReference  –  default: 0
Message ID on which this message primarily references, used for tree visualisation or replies
readAccessCache  –  default: array()
Cached read access check results
replyAccessCache  –  default: array()
Cached reply access check results
searchOptimisedContent  –  default: ''
Content of this message that shall be regarded for searching, usually a simplified plain-text version of the latest approved message revision
searchOptimisedSubject  –  default: ''
Subject of this message that shall be regarded for searching, usually of the latest approved message revision
searchRevision  –  default: 0
Revision that shall be regarded for searching, usually of the latest approved message revision

Implementation file: message.class.php, line 33

© 2010 Yves Goergen. UNB Components Homepage. Reference generated on 2010-03-07.