/**
* In which language to get this message. Overrides the $interface
* variable.
+ *
+ * @var Language
*/
protected $language = null;
*/
protected $useDatabase = true;
+ /**
+ * Title object to use as context
+ */
+ protected $title = null;
+
/**
* Constructor.
* @param $key: message key, or array of message keys to try and use the first non-empty message for
* @return Message: $this
*/
public function params( /*...*/ ) {
- $args_values = array_values( func_get_args() );
+ $args = func_get_args();
+ if ( isset( $args[0] ) && is_array( $args[0] ) ) {
+ $args = $args[0];
+ }
+ $args_values = array_values( $args );
$this->parameters = array_merge( $this->parameters, $args_values );
return $this;
}
*/
public function rawParams( /*...*/ ) {
$params = func_get_args();
+ if ( isset( $params[0] ) && is_array( $params[0] ) ) {
+ $params = $params[0];
+ }
foreach( $params as $param ) {
$this->parameters[] = self::rawParam( $param );
}
*/
public function numParams( /*...*/ ) {
$params = func_get_args();
+ if ( isset( $params[0] ) && is_array( $params[0] ) ) {
+ $params = $params[0];
+ }
foreach( $params as $param ) {
$this->parameters[] = self::numParam( $param );
}
* @return Message: $this
*/
public function inLanguage( $lang ) {
- if( $lang instanceof Language ){
+ if ( $lang instanceof Language || $lang instanceof StubContLang || $lang instanceof StubUserLang ) {
$this->language = $lang;
} elseif ( is_string( $lang ) ) {
if( $this->language->getCode() != $lang ) {
return $this;
}
+ /**
+ * Set the Title object to use as context when transforming the message
+ *
+ * @param $title Title object
+ * @return Message: $this
+ */
+ public function title( $title ) {
+ $this->title = $title;
+ return $this;
+ }
+
/**
* Returns the message parsed from wikitext to HTML.
- * TODO: in PHP >= 5.2.0, we can make this a magic method,
- * and then we can do, eg:
- * $foo = Message::get($key);
- * $string = "<abbr>$foo</abbr>";
- * But we shouldn't implement that while MediaWiki still supports
- * PHP < 5.2; or people will start using it...
* @return String: HTML
*/
public function toString() {
return $string;
}
+
+ /**
+ * Magic method implementation of the above (for PHP >= 5.2.0), so we can do, eg:
+ * $foo = Message::get($key);
+ * $string = "<abbr>$foo</abbr>";
+ * @return String
+ */
+ public function __toString() {
+ return $this->toString();
+ }
/**
* Fully parse the text from wikitext to HTML
/**
* Check whether a message does not exist, or is an empty string
* @return Bool: true if is is and false if not
+ * @todo Merge with isDisabled()?
*/
public function isBlank() {
$message = $this->fetchMessage();
return $message === false || $message === '' || $message === '-';
}
+ /**
+ * @param $value
+ * @return array
+ */
public static function rawParam( $value ) {
return array( 'raw' => $value );
}
-
+
+ /**
+ * @param $value
+ * @return array
+ */
public static function numParam( $value ) {
return array( 'num' => $value );
}
/**
* Substitutes any paramaters into the message text.
- * @param $message String, the message text
+ * @param $message String: the message text
* @param $type String: either before or after
* @return String
*/
protected function replaceParameters( $message, $type = 'before' ) {
$replacementKeys = array();
foreach( $this->parameters as $n => $param ) {
- if ( $type === 'before' && !is_array( $param ) ) {
- $replacementKeys['$' . ($n + 1)] = $param;
- } elseif ( $type === 'after' && isset( $param['raw'] ) ) {
- $replacementKeys['$' . ($n + 1)] = $param['raw'];
- } elseif ( isset( $param['num'] ) ) {
- $replacementKeys['$' . ($n + 1)] =
- $this->language->formatNum( $param['num'] );
+ list( $paramType, $value ) = $this->extractParam( $param );
+ if ( $type === $paramType ) {
+ $replacementKeys['$' . ($n + 1)] = $value;
}
}
$message = strtr( $message, $replacementKeys );
return $message;
}
+ /**
+ * Extracts the parameter type and preprocessed the value if needed.
+ * @param $param String|Array: Parameter as defined in this class.
+ * @return Tuple(type, value)
+ * @throws MWException
+ */
+ protected function extractParam( $param ) {
+ if ( is_array( $param ) && isset( $param['raw'] ) ) {
+ return array( 'after', $param['raw'] );
+ } elseif ( is_array( $param ) && isset( $param['num'] ) ) {
+ // Replace number params always in before step for now.
+ // No support for combined raw and num params
+ return array( 'before', $this->language->formatNum( $param['num'] ) );
+ } elseif ( !is_array( $param ) ) {
+ return array( 'before', $param );
+ } else {
+ throw new MWException( "Invalid message parameter" );
+ }
+ }
+
/**
* Wrapper for what ever method we use to parse wikitext.
* @param $string String: Wikitext message contents
- * @return Wikitext parsed into HTML
+ * @return string Wikitext parsed into HTML
*/
protected function parseText( $string ) {
- global $wgOut;
- return $wgOut->parse( $string, /*linestart*/true, $this->interface, $this->language );
+ return MessageCache::singleton()->parse( $string, $this->title, /*linestart*/true, $this->interface, $this->language )->getText();
}
/**
* Wrapper for what ever method we use to {{-transform wikitext.
* @param $string String: Wikitext message contents
- * @return Wikitext with {{-constructs replaced with their values.
+ * @return string Wikitext with {{-constructs replaced with their values.
*/
protected function transformText( $string ) {
- return MessageCache::singleton()->transform( $string, $this->interface, $this->language );
+ return MessageCache::singleton()->transform( $string, $this->interface, $this->language, $this->title );
}
/**
/**
* Wrapper for what ever method we use to get message contents
+ *
+ * @return string
*/
protected function fetchMessage() {
if ( !isset( $this->message ) ) {