includes/RawMessage.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 /**
  22  * Variant of the Message class.
  23  *
  24  * Rather than treating the message key as a lookup
  25  * value (which is passed to the MessageCache and
  26  * translated as necessary), a RawMessage key is
  27  * treated as the actual message.
  28  *
  29  * All other functionality (parsing, escaping, etc.)
  30  * is preserved.
  31  *
  32  * @since 1.21
  33  */
  34 class RawMessage extends Message {
  35
  36         /**
  37          * Call the parent constructor, then store the key as
  38          * the message.
  39          *
  40          * @see Message::__construct
  41          *
  42          * @param string $text Message to use.
  43          * @param array $params Parameters for the message.
  44          *
  45          * @throws InvalidArgumentException
  46          */
  47         public function __construct( $text, $params = [] ) {
  48                 if ( !is_string( $text ) ) {
  49                         throw new InvalidArgumentException( '$text must be a string' );
  50                 }
  51
  52                 parent::__construct( $text, $params );
  53
  54                 // The key is the message.
  55                 $this->message = $text;
  56         }
  57
  58         /**
  59          * Fetch the message (in this case, the key).
  60          *
  61          * @return string
  62          */
  63         public function fetchMessage() {
  64                 // Just in case the message is unset somewhere.
  65                 if ( $this->message === null ) {
  66                         $this->message = $this->key;
  67                 }
  68
  69                 return $this->message;
  70         }
  71
  72 }