* r109659: actually return the exact type we say we do

[lhc/web/wiklou.git] / includes / Message.php

diff --git a/includes/Message.php b/includes/Message.php
index 5f6e9af..ed39d5c 100644 (file)
--- a/includes/Message.php
+++ b/includes/Message.php
@@ -11,7 +11,7 @@
  *    $button = Xml::button( wfMessage( 'submit' )->text() );
  * </pre>
  * Messages can have parameters:
- *    wfMessage( 'welcome-to' )->params( $wgSitename )->text(); 
+ *    wfMessage( 'welcome-to' )->params( $wgSitename )->text();
  *        {{GRAMMAR}} and friends work correctly
  *    wfMessage( 'are-friends', $user, $friend );
  *    wfMessage( 'bad-message' )->rawParams( '<script>...</script>' )->escaped();
@@ -60,7 +60,7 @@ class Message {
         * means the current interface language, false content language.
         */
        protected $interface = true;
-       
+
        /**
         * In which language to get this message. Overrides the $interface
         * variable.
@@ -68,7 +68,7 @@ class Message {
         * @var Language
         */
        protected $language = null;
-       
+
        /**
         * The message key.
         */
@@ -100,6 +100,11 @@ class Message {
         */
        protected $title = null;
 
+       /**
+        * @var string
+        */
+       protected $message;
+
        /**
         * Constructor.
         * @param $key: message key, or array of message keys to try and use the first non-empty message for
@@ -131,7 +136,7 @@ class Message {
         * Factory function accepting multiple message keys and returning a message instance
         * for the first message which is non-empty. If all messages are empty then an
         * instance of the first message key is returned.
-        * @param Varargs: message keys
+        * @param Varargs: message keys (or first arg as an array of all the message keys)
         * @return Message: $this
         */
        public static function newFallbackSequence( /*...*/ ) {
@@ -150,7 +155,7 @@ class Message {
 
        /**
         * Adds parameters to the parameter list of this message.
-        * @param Varargs: parameters as Strings
+        * @param Varargs: parameters as Strings, or a single argument that is an array of Strings
         * @return Message: $this
         */
        public function params( /*...*/ ) {
@@ -168,7 +173,7 @@ class Message {
         * 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
+        * @param Varargs: raw parameters as Strings (or single argument that is an array of raw parameters)
         * @return Message: $this
         */
        public function rawParams( /*...*/ ) {
@@ -181,11 +186,11 @@ class Message {
                }
                return $this;
        }
-       
+
        /**
         * Add parameters that are numeric and will be passed through
         * Language::formatNum before substitution
-        * @param Varargs: numeric parameters
+        * @param Varargs: numeric parameters (or single argument that is array of numeric parameters)
         * @return Message: $this
         */
        public function numParams( /*...*/ ) {
@@ -198,7 +203,20 @@ class Message {
                }
                return $this;
        }
-       
+
+       /**
+        * Set the language and the title from a context object
+        *
+        * @param $context IContextSource
+        * @return Message: $this
+        */
+       public function setContext( IContextSource $context ) {
+               $this->inLanguage( $context->getLanguage() );
+               $this->title( $context->getTitle() );
+
+               return $this;
+       }
+
        /**
         * Request the message in any language that is supported.
         * As a side effect interface message status is unconditionally
@@ -216,7 +234,7 @@ class Message {
                } else {
                        $type = gettype( $lang );
                        throw new MWException( __METHOD__ . " must be "
-                               . "passed a String or Language object; $type given" 
+                               . "passed a String or Language object; $type given"
                        );
                }
                $this->interface = false;
@@ -224,10 +242,17 @@ class Message {
        }
 
        /**
-        * Request the message in the wiki's content language.
+        * Request the message in the wiki's content language,
+        * unless it is disabled for this message.
+        * @see $wgForceUIMsgAsContentMsg
         * @return Message: $this
         */
        public function inContentLanguage() {
+               global $wgForceUIMsgAsContentMsg;
+               if ( in_array( $this->key, (array)$wgForceUIMsgAsContentMsg ) ) {
+                       return $this;
+               }
+
                global $wgContLang;
                $this->interface = false;
                $this->language = $wgContLang;
@@ -261,10 +286,10 @@ class Message {
         */
        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 );
@@ -280,10 +305,10 @@ class Message {
                        $string = $this->transformText( $string );
                        $string = htmlspecialchars( $string, ENT_QUOTES, 'UTF-8', false );
                }
-               
+
                # Raw parameter replacement
                $string = $this->replaceParameters( $string, 'after' );
-               
+
                return $string;
        }
 
@@ -296,7 +321,7 @@ class Message {
        public function __toString() {
                return $this->toString();
        }
-       
+
        /**
         * Fully parse the text from wikitext to HTML
         * @return String parsed HTML