<?php
/**
- * This class provides methods for fetching interface messages and
- * processing them into variety of formats that are needed in MediaWiki.
+ * The Message class provides methods which fullfil two basic services:
+ * - fetching interface messages
+ * - processing messages into a variety of formats
*
- * It is intented to replace the old wfMsg* functions that over time grew
- * unusable.
- * @see https://www.mediawiki.org/wiki/New_messages_API for
- * equivalence between old and new functions.
+ * 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.
*
- * Below, you will find several examples of wfMessage() usage.
+ * 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:
*
- * Fetching a message text for interface message
* @code
- * $button = Xml::button( wfMessage( 'submit' )->text() );
+ * // 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
*
- * Messages can have parameters:
+ * 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();
+ * wfMessage( 'welcome-to' )
+ * ->params( $wgSitename )
+ * ->text();
* @endcode
*
- * {{GRAMMAR}} and friends work correctly
+ * {{GRAMMAR}} and friends work correctly:
+ *
* @code
- * wfMessage( 'are-friends', $user, $friend );
- * wfMessage( 'bad-message' )->rawParams( '<script>...</script>' )->escaped();
+ * wfMessage( 'are-friends',
+ * $user, $friend
+ * );
+ * wfMessage( 'bad-message' )
+ * ->rawParams( '<script>...</script>' )
+ * ->escaped();
* @endcode
*
- * Sometimes the message text ends up in the database, so content language is needed.
+ * @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()
- * </pre>
+ * 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:
+ *
* @code
- * wfMessage( 'email-header' )->inLanguage( $user->getOption( 'language' ) )->plain()
+ * $userLanguage = $user->getOption( 'language' );
+ * wfMessage( 'email-header' )
+ * ->inLanguage( $userLanguage )
+ * ->plain();
* @endcode
*
- * @note You cannot parse the text except in the content or interface
- * @note languages
+ * @note You can parse the text only in the content or interface languages
*
- * Comparison with old wfMsg* functions:
+ * @section message_compare_old Comparison with old wfMsg* functions:
*
- * Use full parsing.
+ * Use full parsing:
*
* @code
+ * // old style:
* wfMsgExt( 'key', array( 'parseinline' ), 'apple' );
- * === wfMessage( 'key', 'apple' )->parse();
+ * // new style:
+ * wfMessage( 'key', 'apple' )->parse();
* @endcode
*
- * Parseinline is used because it is more useful when pre-building html.
+ * 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.
* @code
- * $escaped = wfMessage( 'key' )->rawParams( 'apple' )->escaped();
+ * $escaped = wfMessage( 'key' )
+ * ->rawParams( 'apple' )
+ * ->escaped();
* @endcode
*
+ * @section message_appendix Appendix:
+ *
* @todo
* - test, can we have tests?
+ * - this documentation needs to be extended
*
* @see https://www.mediawiki.org/wiki/WfMessage()
* @see https://www.mediawiki.org/wiki/New_messages_API
public function setContext( IContextSource $context ) {
$this->inLanguage( $context->getLanguage() );
$this->title( $context->getTitle() );
+ $this->interface = true;
return $this;
}
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
* @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' );
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
*
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 !== '' ) {
dépôts / lhc / web / wiklou.git / blobdiff