3 * Wrapper content object allowing to handle a system message as a Content object.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * @author Daniel Kinzler
29 * Wrapper allowing us to handle a system message as a Content object.
30 * Note that this is generally *not* used to represent content from the
31 * MediaWiki namespace, and that there is no MessageContentHandler.
32 * MessageContent is just intended as glue for wrapping a message programmatically.
36 class MessageContent
extends AbstractContent
{
44 * @param Message|string $msg A Message object, or a message key.
45 * @param string[]|null $params An optional array of message parameters.
47 public function __construct( $msg, $params = null ) {
48 # XXX: messages may be wikitext, html or plain text! and maybe even something else entirely.
49 parent
::__construct( CONTENT_MODEL_WIKITEXT
);
51 if ( is_string( $msg ) ) {
52 $this->mMessage
= wfMessage( $msg );
54 $this->mMessage
= clone $msg;
58 $this->mMessage
= $this->mMessage
->params( $params );
63 * Fully parse the text from wikitext to HTML.
65 * @return string Parsed HTML.
67 public function getHtml() {
68 return $this->mMessage
->parse();
72 * Returns the message text. {{-transformation is done.
74 * @return string Unescaped message text.
76 public function getWikitext() {
77 return $this->mMessage
->text();
81 * Returns the message object, with any parameters already substituted.
83 * @deprecated since 1.33 use getMessage() instead.
85 * @return Message The message object.
87 public function getNativeData() {
88 return $this->getMessage();
92 * Returns the message object, with any parameters already substituted.
96 * @return Message The message object.
98 public function getMessage() {
99 // NOTE: Message objects are mutable. Cloning here makes MessageContent immutable.
100 return clone $this->mMessage
;
106 * @see Content::getTextForSearchIndex
108 public function getTextForSearchIndex() {
109 return $this->mMessage
->plain();
115 * @see Content::getWikitextForTransclusion
117 public function getWikitextForTransclusion() {
118 return $this->getWikitext();
122 * @param int $maxlength Maximum length of the summary text, defaults to 250.
124 * @return string The summary text.
126 * @see Content::getTextForSummary
128 public function getTextForSummary( $maxlength = 250 ) {
129 return substr( $this->mMessage
->plain(), 0, $maxlength );
135 * @see Content::getSize
137 public function getSize() {
138 return strlen( $this->mMessage
->plain() );
142 * @return Content A copy of this object
146 public function copy() {
147 // MessageContent is immutable (because getNativeData() and getMessage()
148 // returns a clone of the Message object)
153 * @param bool|null $hasLinks
155 * @return bool Always false.
157 * @see Content::isCountable
159 public function isCountable( $hasLinks = null ) {
164 * @param Title $title Unused.
165 * @param int|null $revId Unused.
166 * @param ParserOptions|null $options Unused.
167 * @param bool $generateHtml Whether to generate HTML (default: true).
169 * @return ParserOutput
171 * @see Content::getParserOutput
173 public function getParserOutput( Title
$title, $revId = null,
174 ParserOptions
$options = null, $generateHtml = true ) {
175 if ( $generateHtml ) {
176 $html = $this->getHtml();
181 $po = new ParserOutput( $html );
182 // Message objects are in the user language.
183 $po->recordOption( 'userlang' );