includes/content/MessageContent.php

   1 <?php
   2 /**
   3  * Wrapper content object allowing to handle a system message as a Content object.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @since 1.21
  21  *
  22  * @file
  23  * @ingroup Content
  24  *
  25  * @author Daniel Kinzler
  26  */
  27
  28 /**
  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 programatically.
  33  *
  34  * @ingroup Content
  35  */
  36 class MessageContent extends AbstractContent {
  37
  38         /**
  39          * @var Message
  40          */
  41         protected $mMessage;
  42
  43         /**
  44          * @param Message|String $msg    A Message object, or a message key
  45          * @param array|null     $params An optional array of message parameters
  46          */
  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 );
  50
  51                 if ( is_string( $msg ) ) {
  52                         $this->mMessage = wfMessage( $msg );
  53                 } else {
  54                         $this->mMessage = clone $msg;
  55                 }
  56
  57                 if ( $params ) {
  58                         $this->mMessage = $this->mMessage->params( $params );
  59                 }
  60         }
  61
  62         /**
  63          * Returns the message as rendered HTML
  64          *
  65          * @return string The message text, parsed into html
  66          */
  67         public function getHtml() {
  68                 return $this->mMessage->parse();
  69         }
  70
  71         /**
  72          * Returns the message as rendered HTML
  73          *
  74          * @return string The message text, parsed into html
  75          */
  76         public function getWikitext() {
  77                 return $this->mMessage->text();
  78         }
  79
  80         /**
  81          * Returns the message object, with any parameters already substituted.
  82          *
  83          * @return Message The message object.
  84          */
  85         public function getNativeData() {
  86                 //NOTE: Message objects are mutable. Cloning here makes MessageContent immutable.
  87                 return clone $this->mMessage;
  88         }
  89
  90         /**
  91          * @see Content::getTextForSearchIndex
  92          */
  93         public function getTextForSearchIndex() {
  94                 return $this->mMessage->plain();
  95         }
  96
  97         /**
  98          * @see Content::getWikitextForTransclusion
  99          */
 100         public function getWikitextForTransclusion() {
 101                 return $this->getWikitext();
 102         }
 103
 104         /**
 105          * @see Content::getTextForSummary
 106          */
 107         public function getTextForSummary( $maxlength = 250 ) {
 108                 return substr( $this->mMessage->plain(), 0, $maxlength );
 109         }
 110
 111         /**
 112          * @see Content::getSize
 113          *
 114          * @return int
 115          */
 116         public function getSize() {
 117                 return strlen( $this->mMessage->plain() );
 118         }
 119
 120         /**
 121          * @see Content::copy
 122          *
 123          * @return Content. A copy of this object
 124          */
 125         public function copy() {
 126                 // MessageContent is immutable (because getNativeData() returns a clone of the Message object)
 127                 return $this;
 128         }
 129
 130         /**
 131          * @see Content::isCountable
 132          *
 133          * @return bool false
 134          */
 135         public function isCountable( $hasLinks = null ) {
 136                 return false;
 137         }
 138
 139         /**
 140          * @see Content::getParserOutput
 141          *
 142          * @return ParserOutput
 143          */
 144         public function getParserOutput(
 145                 Title $title, $revId = null,
 146                 ParserOptions $options = null, $generateHtml = true
 147         ) {
 148
 149                 if ( $generateHtml ) {
 150                         $html = $this->getHtml();
 151                 } else {
 152                         $html = '';
 153                 }
 154
 155                 $po = new ParserOutput( $html );
 156                 return $po;
 157         }
 158 }