MediaWiki  REL1_22
MessageContent Class Reference

Wrapper allowing us to handle a system message as a Content object. More...

Inheritance diagram for MessageContent:
Collaboration diagram for MessageContent:

List of all members.

Public Member Functions

 __construct ($msg, $params=null)
 copy ()
 getHtml ()
 Returns the message as rendered HTML.
 getNativeData ()
 Returns the message object, with any parameters already substituted.
 getParserOutput (Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
 getSize ()
 getTextForSearchIndex ()
 getTextForSummary ($maxlength=250)
 getWikitext ()
 Returns the message as rendered HTML.
 getWikitextForTransclusion ()
 isCountable ($hasLinks=null)

Protected Attributes

Message $mMessage

Detailed Description

Wrapper allowing us to handle a system message as a Content object.

Note that this is generally *not* used to represent content from the MediaWiki namespace, and that there is no MessageContentHandler. MessageContent is just intended as glue for wrapping a message programatically.

Definition at line 36 of file MessageContent.php.


Constructor & Destructor Documentation

MessageContent::__construct ( msg,
params = null 
)
Parameters:
Message | String$msgA Message object, or a message key
array | null$paramsAn optional array of message parameters

Definition at line 46 of file MessageContent.php.


Member Function Documentation

See also:
Content::copy
Returns:
Content. A copy of this object

Implements Content.

Definition at line 124 of file MessageContent.php.

Returns the message as rendered HTML.

Returns:
string The message text, parsed into html

Definition at line 66 of file MessageContent.php.

Returns the message object, with any parameters already substituted.

Returns:
Message The message object.

Implements Content.

Definition at line 84 of file MessageContent.php.

MessageContent::getParserOutput ( Title title,
revId = null,
ParserOptions options = null,
generateHtml = true 
)
See also:
Content::getParserOutput
Returns:
ParserOutput

Implements Content.

Definition at line 143 of file MessageContent.php.

See also:
Content::getSize
Returns:
int

Implements Content.

Definition at line 115 of file MessageContent.php.

MessageContent::getTextForSummary ( maxlength = 250)
See also:
Content::getTextForSummary

Implements Content.

Definition at line 106 of file MessageContent.php.

Returns the message as rendered HTML.

Returns:
string The message text, parsed into html

Definition at line 75 of file MessageContent.php.

MessageContent::isCountable ( hasLinks = null)
See also:
Content::isCountable
Returns:
bool false

Implements Content.

Definition at line 134 of file MessageContent.php.


Member Data Documentation

Message MessageContent::$mMessage [protected]

Definition at line 40 of file MessageContent.php.


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