MessageContent Class Reference

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

Inheritance diagram for MessageContent:

Collaboration diagram for MessageContent:

Public Member Functions
	__construct ( $msg, $params=null)
	copy ()
	getHtml ()
	Fully parse the text from wikitext to 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 text.
	getWikitextForTransclusion ()
	isCountable ( $hasLinks=null)
Public Member Functions inherited from AbstractContent
	__construct ( $modelId=null)
	addSectionHeader ( $header)
	convert ( $toModel, $lossy='')
	This base implementation calls the hook ConvertContent to enable custom conversions.
	equals (Content $that=null)
	getContentHandler ()
	getDefaultFormat ()
	getDeletionUpdates (WikiPage $page, ParserOutput $parserOutput=null)
	getModel ()
	getRedirectChain ()
	getRedirectTarget ()
	Subclasses that implement redirects should override this.
	getSecondaryDataUpdates (Title $title, Content $old=null, $recursive=true, ParserOutput $parserOutput=null)
	Returns a list of DataUpdate objects for recording information about this Content in some secondary data store.
	getSection ( $sectionId)
	getSupportedFormats ()
	getUltimateRedirectTarget ()
	isEmpty ()
	isRedirect ()
	isSupportedFormat ( $format)
	isValid ()
	Subclasses may override this to implement (light weight) validation.
	matchMagicWord (MagicWord $word)
	This default implementation always returns false.
	preloadTransform (Title $title, ParserOptions $popts, $params=[])
	prepareSave (WikiPage $page, $flags, $parentRevId, User $user)
	preSaveTransform (Title $title, User $user, ParserOptions $popts)
	replaceSection ( $sectionId, Content $with, $sectionTitle='')
	serialize ( $format=null)
	updateRedirect (Title $target)
	This default implementation always returns $this.

Protected Attributes
Message	$mMessage
Protected Attributes inherited from AbstractContent
	$model_id
	Name of the content model this Content object represents.

Additional Inherited Members
Protected Member Functions inherited from AbstractContent
	checkFormat ( $format)
	checkModelID ( $modelId)
	fillParserOutput (Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
	Fills the provided ParserOutput with information derived from the content.

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 programmatically.

Definition at line 36 of file MessageContent.php.

Constructor & Destructor Documentation

__construct()

MessageContent::__construct	(		$msg,
			$params = null
	)

Parameters

Message | string	$msg	A Message object, or a message key.
string[]	$params	An optional array of message parameters.

Definition at line 47 of file MessageContent.php.

References $params, CONTENT_MODEL_WIKITEXT, and wfMessage().

Member Function Documentation

copy()

MessageContent::copy

(

)

Returns

Content A copy of this object

See also

Content::copy

Implements Content.

Definition at line 133 of file MessageContent.php.

getHtml()

MessageContent::getHtml

(

)

Fully parse the text from wikitext to HTML.

Returns

string Parsed HTML.

Definition at line 67 of file MessageContent.php.

Referenced by getParserOutput().

getNativeData()

MessageContent::getNativeData

(

)

Returns the message object, with any parameters already substituted.

Returns

Message The message object.

Implements Content.

Definition at line 85 of file MessageContent.php.

References $mMessage.

getParserOutput()

MessageContent::getParserOutput	(	Title	$title,
			$revId = null,
		ParserOptions	$options = null,
			$generateHtml = true
	)

Parameters

Title	$title	Unused.
int	$revId	Unused.
ParserOptions	$options	Unused.
bool	$generateHtml	Whether to generate HTML (default: true).

Returns

ParserOutput

See also

Content::getParserOutput

Reimplemented from AbstractContent.

Definition at line 159 of file MessageContent.php.

References $generateHtml, $html, and getHtml().

getSize()

MessageContent::getSize

(

)

Returns

int

See also

Content::getSize

Implements Content.

Definition at line 124 of file MessageContent.php.

getTextForSearchIndex()

MessageContent::getTextForSearchIndex

(

)

Returns

string

See also

Content::getTextForSearchIndex

Implements Content.

Definition at line 95 of file MessageContent.php.

getTextForSummary()

MessageContent::getTextForSummary

(

$maxlength = 250

)

Parameters

int

$maxlength

Maximum length of the summary text, defaults to 250.

Returns

string The summary text.

See also

Content::getTextForSummary

Implements Content.

Definition at line 115 of file MessageContent.php.

getWikitext()

MessageContent::getWikitext

(

)

Returns the message text.

{{-transformation is done.

Returns

string Unescaped message text.

Definition at line 76 of file MessageContent.php.

Referenced by getWikitextForTransclusion().

getWikitextForTransclusion()

MessageContent::getWikitextForTransclusion

(

)

Returns

string

See also

Content::getWikitextForTransclusion

Implements Content.

Definition at line 104 of file MessageContent.php.

References getWikitext().

isCountable()

MessageContent::isCountable

(

$hasLinks = null

)

Parameters

bool | null

$hasLinks

Returns

bool Always false.

See also

Content::isCountable

Implements Content.

Definition at line 145 of file MessageContent.php.

Member Data Documentation

$mMessage

Message MessageContent::$mMessage

protected

Definition at line 41 of file MessageContent.php.

Referenced by getNativeData().

---

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

• includes/content/MessageContent.php