UNB Components Code Reference

UnbMessageRevision::Create method

Creates a new message revision instance for a message.

public static function UnbMessageRevision::Create ($messageId, $subject, $content, $summary = null, $data = null, $dataFileName = null, $writeToFile = null);

Parameters

messageId
(int/UnbMessage) Message to add the revision to
subject
(string) Subject of the message's first revision or null (max. 255 characters)
content
(string) Content of the message's first revision or null (max. 16,777,215 characters)
summary  –  optional, default: null
(string) Summary of the changes in the new revivion to the previous one or null (max. 255 characters)
data  –  optional, default: null
(string) Attached file data contents or null
dataFileName  –  optional, default: null
(string) Local file name for attached file data or null (do not use together with date)
writeToFile  –  optional, default: null
(bool) Write the attached file data into a file instead of the database or null for automatic decision

Return value

The newly created UnbMessageRevision object, if successful, null otherwise.

Remarks

The newly created message revision instance is also stored in the database. If the session user is a moderator, the new message revision is automatically approved.

Exceptions thrown

InvalidArgumentException No description available.
LengthException No description available.

Privileges required

Must be logged in and need read and alter access on the message

Member of class: UnbMessageRevision

Implementation file: messagerevision.class.php, line 107

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