X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FMessage.php;h=3a87a001fcf48f3be0074d529cf020d7b72f1844;hb=c75d18824ce04598348b6ebd16edcb873ad51b9a;hp=3ddbdcb684457ec486d4f6a7e5ebb452a734ad67;hpb=21813a563cb9b8850d8e080a9a796e5bb1773de8;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/Message.php b/includes/Message.php index 3ddbdcb684..3a87a001fc 100644 --- a/includes/Message.php +++ b/includes/Message.php @@ -1,59 +1,160 @@ text() ); - * - * Messages can have parameters: - * wfMessage( 'welcome-to' )->params( $wgSitename )->text(); - * {{GRAMMAR}} and friends work correctly - * wfMessage( 'are-friends', $user, $friend ); - * wfMessage( 'bad-message' )->rawParams( '' )->escaped(); - * - * Sometimes the message text ends up in the database, so content language is needed. - * wfMessage( 'file-log', $user, $filename )->inContentLanguage()->text() - * - * Checking if message exists: + * Fetching and processing of interface messages. + * + * 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 + * @author Niklas Laxström + */ + +/** + * The Message class provides methods which fullfil two basic services: + * - fetching interface messages + * - processing messages into a variety of formats + * + * First implemented with MediaWiki 1.17, the Message class is intented to + * replace the old wfMsg* functions that over time grew unusable. + * @see https://www.mediawiki.org/wiki/New_messages_API for equivalences + * between old and new functions. + * + * You should use the wfMessage() global function which acts as a wrapper for + * the Message class. The wrapper let you pass parameters as arguments. + * + * The most basic usage cases would be: + * + * @code + * // Initialize a Message object using the 'some_key' message key + * $message = wfMessage( 'some_key' ); + * + * // Using two parameters those values are strings 'value1' and 'value2': + * $message = wfMessage( 'some_key', + * 'value1', 'value2' + * ); + * @endcode + * + * @section message_global_fn Global function wrapper: + * + * Since wfMessage() returns a Message instance, you can chain its call with + * a method. Some of them return a Message instance too so you can chain them. + * You will find below several examples of wfMessage() usage. + * + * Fetching a message text for interface message: + * + * @code + * $button = Xml::button( + * wfMessage( 'submit' )->text() + * ); + * @endcode + * + * A Message instance can be passed parameters after it has been constructed, + * use the params() method to do so: + * + * @code + * wfMessage( 'welcome-to' ) + * ->params( $wgSitename ) + * ->text(); + * @endcode + * + * {{GRAMMAR}} and friends work correctly: + * + * @code + * wfMessage( 'are-friends', + * $user, $friend + * ); + * wfMessage( 'bad-message' ) + * ->rawParams( '' ) + * ->escaped(); + * @endcode + * + * @section message_language Changing language: + * + * Messages can be requested in a different language or in whatever current + * content language is being used. The methods are: + * - Message->inContentLanguage() + * - Message->inLanguage() + * + * Sometimes the message text ends up in the database, so content language is + * needed: + * + * @code + * wfMessage( 'file-log', + * $user, $filename + * )->inContentLanguage()->text(); + * @endcode + * + * Checking whether a message exists: + * + * @code * wfMessage( 'mysterious-message' )->exists() - * + * // returns a boolean whether the 'mysterious-message' key exist. + * @endcode + * * 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 - * * + * @code + * $userLanguage = $user->getOption( 'language' ); + * wfMessage( 'email-header' ) + * ->inLanguage( $userLanguage ) + * ->plain(); + * @endcode * - * Comparison with old wfMsg* functions: + * @note You can parse the text only in the content or interface languages * - * Use full parsing. + * @section message_compare_old Comparison with old wfMsg* functions: + * + * Use full parsing: + * + * @code + * // old style: * wfMsgExt( 'key', array( 'parseinline' ), 'apple' ); - * === wfMessage( 'key', 'apple' )->parse(); - * - * Parseinline is used because it is more useful when pre-building html. + * // new style: + * wfMessage( 'key', 'apple' )->parse(); + * @endcode + * + * 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. + * Places where HTML cannot be used. {{-transformation is done. + * @code + * // old style: * wfMsgExt( 'key', array( 'parsemag' ), 'apple', 'pear' ); - * === wfMessage( 'key', 'apple', 'pear' )->text(); - * + * // new style: + * wfMessage( 'key', 'apple', 'pear' )->text(); + * @endcode * - * Shortcut for escaping the message too, similar to wfMsgHTML, but + * Shortcut for escaping the message too, similar to wfMsgHTML(), but * parameters are not replaced after escaping by default. - * $escaped = wfMessage( 'key' )->rawParams( 'apple' )->escaped(); - * + * @code + * $escaped = wfMessage( 'key' ) + * ->rawParams( 'apple' ) + * ->escaped(); + * @endcode * - * TODO: + * @section message_appendix Appendix: + * + * @todo * - test, can we have tests? - * - sort out the details marked with fixme + * - this documentation needs to be extended + * + * @see https://www.mediawiki.org/wiki/WfMessage() + * @see https://www.mediawiki.org/wiki/New_messages_API + * @see https://www.mediawiki.org/wiki/Localisation * * @since 1.17 - * @author Niklas Laxström */ class Message { /** @@ -61,7 +162,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. @@ -69,7 +170,7 @@ class Message { * @var Language */ protected $language = null; - + /** * The message key. */ @@ -101,6 +202,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 @@ -132,7 +238,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( /*...*/ ) { @@ -151,7 +257,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( /*...*/ ) { @@ -169,7 +275,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( /*...*/ ) { @@ -182,11 +288,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( /*...*/ ) { @@ -199,7 +305,21 @@ 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() ); + $this->interface = true; + + return $this; + } + /** * Request the message in any language that is supported. * As a side effect interface message status is unconditionally @@ -217,7 +337,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; @@ -225,16 +345,35 @@ 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; return $this; } + /** + * Allows manipulating the interface message flag directly. + * Can be used to restore the flag after setting a language. + * @param $value bool + * @return Message: $this + * @since 1.20 + */ + public function setInterfaceMessageFlag( $value ) { + $this->interface = (bool) $value; + return $this; + } + /** * Enable or disable database use. * @param $value Boolean @@ -261,11 +400,19 @@ class Message { * @return String: HTML */ public function toString() { - $string = $this->getMessageText(); - + $string = $this->fetchMessage(); + + if ( $string === false ) { + $key = htmlspecialchars( is_array( $this->key ) ? $this->key[0] : $this->key ); + if ( $this->format === 'plain' ) { + return '<' . $key . '>'; + } + return '<' . $key . '>'; + } + # Replace parameters before text parsing $string = $this->replaceParameters( $string, 'before' ); - + # Maybe transform using the full parser if( $this->format === 'parse' ) { $string = $this->parseText( $string ); @@ -281,10 +428,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; } @@ -297,7 +444,7 @@ class Message { public function __toString() { return $this->toString(); } - + /** * Fully parse the text from wikitext to HTML * @return String parsed HTML @@ -355,7 +502,7 @@ class Message { /** * 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()? + * @todo FIXME: Merge with isDisabled()? */ public function isBlank() { $message = $this->fetchMessage(); @@ -443,19 +590,6 @@ class Message { return MessageCache::singleton()->transform( $string, $this->interface, $this->language, $this->title ); } - /** - * Returns the textual value for the message. - * @return Message contents or placeholder - */ - protected function getMessageText() { - $message = $this->fetchMessage(); - if ( $message === false ) { - return '<' . htmlspecialchars( is_array($this->key) ? $this->key[0] : $this->key ) . '>'; - } else { - return $message; - } - } - /** * Wrapper for what ever method we use to get message contents * @@ -464,7 +598,10 @@ class Message { protected function fetchMessage() { if ( !isset( $this->message ) ) { $cache = MessageCache::singleton(); - if ( is_array($this->key) ) { + if ( is_array( $this->key ) ) { + if ( !count( $this->key ) ) { + throw new MWException( "Given empty message key array." ); + } foreach ( $this->key as $key ) { $message = $cache->get( $key, $this->useDatabase, $this->language ); if ( $message !== false && $message !== '' ) {