7b212efcac
Noticed while reviewing I2e640b9737cb68090a8e1cb70067d1b74037d647. Change-Id: I9b95b56ffd64cc438d5071046a9f038e4d3dc799
109 lines
2.9 KiB
PHP
109 lines
2.9 KiB
PHP
<?php
|
|
/**
|
|
* 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.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace MediaWiki\Language;
|
|
|
|
use MediaWiki\Message\Message;
|
|
|
|
/**
|
|
* Variant of the Message class.
|
|
*
|
|
* Rather than treating the message key as a lookup
|
|
* value (which is passed to the MessageCache and
|
|
* translated as necessary), a RawMessage key is
|
|
* treated as the actual message.
|
|
*
|
|
* All other functionality (parsing, escaping, etc.)
|
|
* is preserved.
|
|
*
|
|
* @newable
|
|
* @since 1.21
|
|
*/
|
|
class RawMessage extends Message {
|
|
|
|
/**
|
|
* Call the parent constructor, then store the key as
|
|
* the message.
|
|
*
|
|
* @stable to call
|
|
* @see Message::__construct
|
|
*
|
|
* @param string $text Message to use.
|
|
* @param array $params Parameters for the message.
|
|
*/
|
|
public function __construct( string $text, $params = [] ) {
|
|
parent::__construct( $text, $params );
|
|
|
|
// The key is the message.
|
|
$this->message = $text;
|
|
}
|
|
|
|
/**
|
|
* Fetch the message (in this case, the key).
|
|
*
|
|
* @return string
|
|
*/
|
|
public function fetchMessage() {
|
|
// Just in case the message is unset somewhere.
|
|
$this->message ??= $this->key;
|
|
|
|
return $this->message;
|
|
}
|
|
|
|
public function getTextOfRawMessage() {
|
|
return $this->key;
|
|
}
|
|
|
|
public function getParamsOfRawMessage() {
|
|
return $this->parameters;
|
|
}
|
|
|
|
/**
|
|
* To conform to the MessageSpecifier interface, always return 'rawmessage',
|
|
* which is a real message key that can be used with MessageValue and other classes.
|
|
* @return string
|
|
*/
|
|
public function getKey() {
|
|
return 'rawmessage';
|
|
}
|
|
|
|
/**
|
|
* To conform to the MessageSpecifier interface, return parameters that are valid with the
|
|
* 'rawmessage' message, and can be used with MessageValue and other classes.
|
|
* @return string[]
|
|
*/
|
|
public function getParams() {
|
|
// If the provided text is equivalent to 'rawmessage', return the provided params.
|
|
if ( $this->key === '$1' ) {
|
|
return $this->parameters;
|
|
}
|
|
// If there are no provided params, return the provided text as the single param.
|
|
if ( !$this->parameters ) {
|
|
return [ $this->key ];
|
|
}
|
|
// As a last resort, substitute the provided params into the single param accepted by
|
|
// 'rawmessage'. This may access global state.
|
|
return [ $this->plain() ];
|
|
}
|
|
|
|
}
|
|
|
|
/** @deprecated class alias since 1.40 */
|
|
class_alias( RawMessage::class, 'RawMessage' );
|