<?php
-
/**
- * OBS!!! *EXPERIMENTAL* This class is still under discussion.
- *
* This class provides methods for fetching interface messages and
* processing them into variety of formats that are needed in MediaWiki.
*
* unusable.
*
* Examples:
+ * Fetching a message text for interface message
+ * $button = Xml::button( wfMessage( 'submit' )->text() );
+ * </pre>
+ * Messages can have parameters:
+ * wfMessage( 'welcome-to' )->params( $wgSitename )->text();
+ * {{GRAMMAR}} and friends work correctly
+ * wfMessage( 'are-friends', $user, $friend );
+ * wfMessage( 'bad-message' )->rawParams( '<script>...</script>' )->escaped();
+ * </pre>
+ * Sometimes the message text ends up in the database, so content language is needed.
+ * wfMessage( 'file-log', $user, $filename )->inContentLanguage()->text()
+ * </pre>
+ * Checking if message exists:
+ * wfMessage( 'mysterious-message' )->exists()
+ * </pre>
+ * If you want to use a different language:
+ * wfMessage( 'email-header' )->inLanguage( $user->getOption( 'language' ) )->plain()
+ * Note that you cannot parse the text except in the content or interface
+ * languages
+ * </pre>
+ *
+ *
+ * Comparison with old wfMsg* functions:
*
* Use full parsing.
- * Would correspond to wfMsgExt( 'key', array( 'parseinline' ), 'apple' );
- * $parsed = Message::key( 'key' )->param( 'apple' )->parse();
+ * wfMsgExt( 'key', array( 'parseinline' ), 'apple' );
+ * === wfMessage( 'key', 'apple' )->parse();
+ * </pre>
* Parseinline is used because it is more useful when pre-building html.
* In normal use it is better to use OutputPage::(add|wrap)WikiMsg.
*
* Places where html cannot be used. {{-transformation is done.
- * Would correspond to wfMsgExt( 'key', array( 'parsemag' ), 'apple', 'pear' );
- * $plain = Message::key( 'key' )->params( 'apple', 'pear' )->text();
+ * wfMsgExt( 'key', array( 'parsemag' ), 'apple', 'pear' );
+ * === wfMessage( 'key', 'apple', 'pear' )->text();
+ * </pre>
*
* Shortcut for escaping the message too, similar to wfMsgHTML, but
* parameters are not replaced after escaping by default.
- * $escaped = Message::key( 'key' )->rawParam( 'apple' )->escaped();
+ * $escaped = wfMessage( 'key' )->rawParams( 'apple' )->escaped();
+ * </pre>
*
* TODO:
- * * document everything
- * * test, can we have tests?
- * * sort out the details marked with fixme
- * * should we have _m() or similar global wrapper?
+ * - test, can we have tests?
+ * - sort out the details marked with fixme
*
* @since 1.17
+ * @author Niklas Laxström
*/
class Message {
- // FIXME: public or protected?
+ /**
+ * In which language to get this message. True, which is the default,
+ * means the current interface language, false content language.
+ */
+ protected $interface = true;
+
+ /**
+ * In which language to get this message. Overrides the $interface
+ * variable.
+ */
+ protected $language = null;
+
+ /**
+ * The message key.
+ */
+ protected $key;
- // FIXME: handle language properly
- public $language;
- public $key;
- public $parameters = array();
+ /**
+ * List of parameters which will be substituted into the message.
+ */
+ protected $parameters = array();
+
+ /**
+ * Format for the message.
+ * Supported formats are:
+ * * text (transform)
+ * * escaped (transform+htmlspecialchars)
+ * * block-parse
+ * * parse (default)
+ * * plain
+ */
+ protected $format = 'parse';
+
+ /**
+ * Whether database can be used.
+ */
+ protected $useDatabase = true;
/**
* Constructor.
* @param $key String: message key
+ * @param $params Array message parameters
+ * @return Message: $this
*/
- public function __construct( $key ) {
+ public function __construct( $key, $params = array() ) {
+ global $wgLang;
$this->key = $key;
+ $this->parameters = array_values( $params );
+ $this->language = $wgLang;
}
/**
* Factory function that is just wrapper for the real constructor. It is
* intented to be used instead of the real constructor, because it allows
* chaining method calls, while new objects don't.
- * //FIXME: key or get or something else?
* @param $key String: message key
- * @return Message: reference to the object
+ * @param Varargs: parameters as Strings
+ * @return Message: $this
*/
- public function key( $key ) {
- return new Message( $key );
+ public static function newFromKey( $key /*...*/ ) {
+ $params = func_get_args();
+ array_shift( $params );
+ return new self( $key, $params );
}
/**
- * Adds parameters to the paramater list of this message.
- * @param $value String: parameter
- * @return Message: reference to the object
+ * Adds parameters to the parameter list of this message.
+ * @param Varargs: parameters as Strings
+ * @return Message: $this
*/
- public function param( $value ) {
- $this->parameters[] = $value;
+ public function params( /*...*/ ) {
+ $args_values = array_values( func_get_args() );
+ $this->parameters = array_merge( $this->parameters, $args_values );
return $this;
}
/**
- * Adds parameters to the paramater list of this message.
- * @params Vargars: parameters
- * @return Message: reference to the object
+ * Add parameters that are substituted after parsing or escaping.
+ * In other words the parsing process cannot access the contents
+ * of this type of parameter, and you need to make sure it is
+ * sanitized beforehand. The parser will see "$n", instead.
+ * @param Varargs: raw parameters as Strings
+ * @return Message: $this
*/
- public function params( /*...*/ ) {
- $this->paramList( func_get_args() );
+ public function rawParams( /*...*/ ) {
+ $params = func_get_args();
+ foreach( $params as $param ) {
+ $this->parameters[] = self::rawParam( $param );
+ }
+ return $this;
+ }
+
+ /**
+ * Request the message in any language that is supported.
+ * As a side effect interface message status is unconditionally
+ * turned off.
+ * @param $lang Mixed: language code or Language object.
+ * @return Message: $this
+ */
+ public function inLanguage( $lang ) {
+ if( $lang instanceof Language ){
+ $this->language = $lang;
+ } elseif ( is_string( $lang ) ) {
+ if( $this->language->getCode() != $lang ) {
+ $this->language = Language::factory( $lang );
+ }
+ } else {
+ $type = gettype( $lang );
+ throw new MWException( __METHOD__ . " must be "
+ . "passed a String or Language object; $type given"
+ );
+ }
+ $this->interface = false;
return $this;
}
/**
- * Adds a list of parameters to the parameter list of this message.
- * @param $value Array: list of parameters, array keys will be ignored.
- * @return Message: reference to the object
+ * Request the message in the wiki's content language.
+ * @return Message: $this
*/
- public function paramList( array $values ) {
- $this->parameters += array_values( $values );
+ public function inContentLanguage() {
+ global $wgContLang;
+ $this->interface = false;
+ $this->language = $wgContLang;
return $this;
}
/**
- *
+ * Enable or disable database use.
+ * @param $value Boolean
+ * @return Message: $this
*/
- public function rawParam( $value ) {
- $this->parameters[] = array( 'raw' => $value );
+ public function useDatabase( $value ) {
+ $this->useDatabase = (bool) $value;
return $this;
}
- public function parse() {
- $string = $this->parseAsBlock( $string );
- $m = array();
- if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
- $string = $m[1];
+ /**
+ * 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() {
+ $string = $this->getMessageText();
+
+ # Replace parameters before text parsing
+ $string = $this->replaceParameters( $string, 'before' );
+
+ # Maybe transform using the full parser
+ if( $this->format === 'parse' ) {
+ $string = $this->parseText( $string );
+ $m = array();
+ if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
+ $string = $m[1];
+ }
+ } elseif( $this->format === 'block-parse' ){
+ $string = $this->parseText( $string );
+ } elseif( $this->format === 'text' ){
+ $string = $this->transformText( $string );
+ } elseif( $this->format === 'escaped' ){
+ # FIXME: Sanitizer method here?
+ $string = $this->transformText( $string );
+ $string = htmlspecialchars( $string );
}
+
+ # Raw parameter replacement
+ $string = $this->replaceParameters( $string, 'after' );
+
return $string;
}
+
+ /**
+ * Fully parse the text from wikitext to HTML
+ * @return String parsed HTML
+ */
+ public function parse() {
+ $this->format = 'parse';
+ return $this->toString();
+ }
+ /**
+ * Returns the message text. {{-transformation is done.
+ * @return String: Unescaped message text.
+ */
public function text() {
- $string = $this->getMessageText();
- $string = $this->replaceParameters( 'before' );
- $string = $this->parseText( $string );
- $string = $this->replaceParameters( 'after' );
- $m = array();
- if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
- $string = $m[1];
- }
- return $string;
+ $this->format = 'text';
+ return $this->toString();
}
+ /**
+ * Returns the message text as-is, only parameters are subsituted.
+ * @return String: Unescaped untransformed message text.
+ */
public function plain() {
- $string = $this->getMessageText();
- $string = $this->replaceParameters( 'before' );
- $string = $this->transformText( $string );
- $string = $this->replaceParameters( 'after' );
- return $string;
+ $this->format = 'plain';
+ return $this->toString();
}
+ /**
+ * Returns the parsed message text which is always surrounded by a block element.
+ * @return String: HTML
+ */
public function parseAsBlock() {
- $string = $this->getMessageText();
- $string = $this->replaceParameters( 'before' );
- $string = $this->parseText( $string );
- $string = $this->replaceParameters( 'after' );
- return $string;
+ $this->format = 'block-parse';
+ return $this->toString();
}
+ /**
+ * Returns the message text. {{-transformation is done and the result
+ * is escaped excluding any raw parameters.
+ * @return String: Escaped message text.
+ */
public function escaped() {
- return htmlspecialchars( $this->plain() );
+ $this->format = 'escaped';
+ return $this->toString();
+ }
+
+ /**
+ * Check whether a message key has been defined currently.
+ * @return Bool: true if it is and false if not.
+ */
+ public function exists() {
+ return $this->fetchMessage() !== false;
+ }
+
+ public static function rawParam( $value ) {
+ return array( 'raw' => $value );
}
- protected function replaceParamaters( $type = 'before' ) {
+ /**
+ * Substitutes any paramaters into 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( $args as $n => $param ) {
- if ( $type === 'before' && !isset( $param['raw'] ) ) {
+ 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'];
return $message;
}
- // FIXME: handle properly
- protected function getLanguage() {
- return $this->language === null ? true : $this->language;
- }
-
+ /**
+ * Wrapper for what ever method we use to parse wikitext.
+ * @param $string String: Wikitext message contents
+ * @return Wikitext parsed into HTML
+ */
protected function parseText( $string ) {
- global $wgOut;
- return $wgOut->parse( $string, true, (bool) $this->getLanguage() );
+ global $wgOut, $wgLang, $wgContLang;
+ if ( $this->language !== $wgLang && $this->language !== $wgContLang ) {
+ # FIXME: remove this limitation
+ throw new MWException( 'Can only parse in interface or content language' );
+ }
+ return $wgOut->parse( $string, /*linestart*/true, $this->interface );
}
+ /**
+ * Wrapper for what ever method we use to {{-transform wikitext.
+ * @param $string String: Wikitext message contents
+ * @return Wikitext with {{-constructs replaced with their values.
+ */
protected function transformText( $string ) {
global $wgMessageCache;
- if ( !isset( $wgMessageCache ) ) {
- return $string;
- }
- // FIXME: handle second param correctly
- return $wgMessageCache->transform( $string, true, $this->getLanguage() );
+ return $wgMessageCache->transform( $string, $this->interface, $this->language );
}
+ /**
+ * Returns the textual value for the message.
+ * @return Message contents or placeholder
+ */
protected function getMessageText() {
- return wfMsgGetKey( $this->key, /*DB*/true, $this->getLanguage(), /*Transform*/false );
+ $message = $this->fetchMessage();
+ if ( $message === false ) {
+ return '<' . htmlspecialchars( $this->key ) . '>';
+ } else {
+ return $message;
+ }
+ }
+
+ /**
+ * Wrapper for what ever method we use to get message contents
+ */
+ protected function fetchMessage() {
+ if ( !isset( $this->message ) ) {
+ global $wgMessageCache;
+ $this->message = $wgMessageCache->get( $this->key, $this->useDatabase, $this->language );
+ }
+ return $this->message;
}
}
\ No newline at end of file
dépôts / lhc / web / wiklou.git / blobdiff