PHPXRef 0.7.1 : MediaWiki-1.24.0 : Detail view of MessageContent.php

[Source view] [Print] [Project Stats]

Wrapper content object allowing to handle a system message as a Content object. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Author:	Daniel Kinzler
File Size:	174 lines (4 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

MessageContent:: (11 methods):
  __construct()
  getHtml()
  getWikitext()
  getNativeData()
  getTextForSearchIndex()
  getWikitextForTransclusion()
  getTextForSummary()
  getSize()
  copy()
  isCountable()
  getParserOutput()

Class: MessageContent - X-Ref

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.

__construct( $msg, $params = null ) X-Ref

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

getHtml() X-Ref

Fully parse the text from wikitext to HTML.

return: string Parsed HTML.

getWikitext() X-Ref

Returns the message text. {{-transformation is done.

return: string Unescaped message text.

getNativeData() X-Ref

Returns the message object, with any parameters already substituted.

return: Message The message object.

getTextForSearchIndex() X-Ref

return: string

getWikitextForTransclusion() X-Ref

return: string

getTextForSummary( $maxlength = 250 ) X-Ref

param: int $maxlength Maximum length of the summary text, defaults to 250.
return: string The summary text.

getSize() X-Ref

return: int

copy() X-Ref

return: Content A copy of this object

isCountable( $hasLinks = null ) X-Ref

param: bool $hasLinks
return: bool Always false.

getParserOutput( Title $title, $revId = null,ParserOptions $options = null, $generateHtml = true ) X-Ref

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

PHP Cross Reference of MediaWiki-1.24.0

/includes/content/ -> MessageContent.php (summary)

Defines 1 class