X-Git-Url: http://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/exercices/modifier.php?a=blobdiff_plain;f=includes%2FMessage.php;h=78b9ec2044384dd28f656e06ff1ff98ce983b1d3;hb=c546fae8ed67279d21daf0652349975fa034f7d1;hp=86d36096b4ed9401fde184d53ce7ab31ad7b8405;hpb=b801fa8b3b3b42fb6db9129d4642f6e583b56879;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/Message.php b/includes/Message.php index 86d36096b4..787ea421c5 100644 --- a/includes/Message.php +++ b/includes/Message.php @@ -28,7 +28,7 @@ * * 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 + * @see https://www.mediawiki.org/wiki/Manual:Messages_API for equivalences * between old and new functions. * * You should use the wfMessage() global function which acts as a wrapper for @@ -214,6 +214,7 @@ class Message { /** * Constructor. + * @since 1.17 * @param $key: message key, or array of message keys to try and use the first non-empty message for * @param $params Array message parameters * @return Message: $this @@ -229,6 +230,7 @@ class Message { * 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. + * @since 1.17 * @param $key String: message key * @param Varargs: parameters as Strings * @return Message: $this @@ -243,6 +245,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. + * @since 1.18 * @param Varargs: message keys (or first arg as an array of all the message keys) * @return Message: $this */ @@ -262,6 +265,7 @@ class Message { /** * Adds parameters to the parameter list of this message. + * @since 1.17 * @param Varargs: parameters as Strings, or a single argument that is an array of Strings * @return Message: $this */ @@ -280,6 +284,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. + * @since 1.17 * @param Varargs: raw parameters as Strings (or single argument that is an array of raw parameters) * @return Message: $this */ @@ -297,6 +302,7 @@ class Message { /** * Add parameters that are numeric and will be passed through * Language::formatNum before substitution + * @since 1.18 * @param Varargs: numeric parameters (or single argument that is array of numeric parameters) * @return Message: $this */ @@ -313,7 +319,7 @@ class Message { /** * Set the language and the title from a context object - * + * @since 1.19 * @param $context IContextSource * @return Message: $this */ @@ -329,6 +335,7 @@ class Message { * Request the message in any language that is supported. * As a side effect interface message status is unconditionally * turned off. + * @since 1.17 * @param $lang Mixed: language code or Language object. * @return Message: $this */ @@ -352,6 +359,7 @@ class Message { /** * Request the message in the wiki's content language, * unless it is disabled for this message. + * @since 1.17 * @see $wgForceUIMsgAsContentMsg * @return Message: $this */ @@ -381,6 +389,7 @@ class Message { /** * Enable or disable database use. + * @since 1.17 * @param $value Boolean * @return Message: $this */ @@ -391,7 +400,7 @@ class Message { /** * Set the Title object to use as context when transforming the message - * + * @since 1.18 * @param $title Title object * @return Message: $this */ @@ -414,6 +423,7 @@ class Message { /** * Returns the message parsed from wikitext to HTML. + * @since 1.17 * @return String: HTML */ public function toString() { @@ -456,6 +466,7 @@ class Message { * Magic method implementation of the above (for PHP >= 5.2.0), so we can do, eg: * $foo = Message::get($key); * $string = "$foo"; + * @since 1.18 * @return String */ public function __toString() { @@ -464,6 +475,7 @@ class Message { /** * Fully parse the text from wikitext to HTML + * @since 1.17 * @return String parsed HTML */ public function parse() { @@ -473,6 +485,7 @@ class Message { /** * Returns the message text. {{-transformation is done. + * @since 1.17 * @return String: Unescaped message text. */ public function text() { @@ -482,6 +495,7 @@ class Message { /** * Returns the message text as-is, only parameters are subsituted. + * @since 1.17 * @return String: Unescaped untransformed message text. */ public function plain() { @@ -491,6 +505,7 @@ class Message { /** * Returns the parsed message text which is always surrounded by a block element. + * @since 1.17 * @return String: HTML */ public function parseAsBlock() { @@ -501,6 +516,7 @@ class Message { /** * Returns the message text. {{-transformation is done and the result * is escaped excluding any raw parameters. + * @since 1.17 * @return String: Escaped message text. */ public function escaped() { @@ -510,6 +526,7 @@ class Message { /** * Check whether a message key has been defined currently. + * @since 1.17 * @return Bool: true if it is and false if not. */ public function exists() { @@ -518,6 +535,7 @@ class Message { /** * Check whether a message does not exist, or is an empty string + * @since 1.18 * @return Bool: true if is is and false if not * @todo FIXME: Merge with isDisabled()? */ @@ -528,7 +546,8 @@ class Message { /** * Check whether a message does not exist, is an empty string, or is "-" - * @return Bool: true if is is and false if not + * @since 1.18 + * @return Bool: true if it is and false if not */ public function isDisabled() { $message = $this->fetchMessage(); @@ -536,6 +555,7 @@ class Message { } /** + * @since 1.17 * @param $value * @return array */ @@ -544,6 +564,7 @@ class Message { } /** + * @since 1.18 * @param $value * @return array */ @@ -553,6 +574,7 @@ class Message { /** * Substitutes any paramaters into the message text. + * @since 1.17 * @param $message String: the message text * @param $type String: either before or after * @return String @@ -571,6 +593,7 @@ class Message { /** * Extracts the parameter type and preprocessed the value if needed. + * @since 1.18 * @param $param String|Array: Parameter as defined in this class. * @return Tuple(type, value) * @throws MWException @@ -591,6 +614,7 @@ class Message { /** * Wrapper for what ever method we use to parse wikitext. + * @since 1.17 * @param $string String: Wikitext message contents * @return string Wikitext parsed into HTML */ @@ -600,6 +624,7 @@ class Message { /** * Wrapper for what ever method we use to {{-transform wikitext. + * @since 1.17 * @param $string String: Wikitext message contents * @return string Wikitext with {{-constructs replaced with their values. */ @@ -609,7 +634,7 @@ class Message { /** * Wrapper for what ever method we use to get message contents - * + * @since 1.17 * @return string */ protected function fetchMessage() {