9d56257d8c
Fix two problems that made it difficult to convert between Message and MessageValue, or to write code that could accept both of them, as exemplified by the StatusValue class: * Implement a common interface * Use the same internal format for message parameters While these changes should be compatible with most of existing code, where the authors were courteous enough to simply call methods such as Message::numParam() and not look inside the values they return, it is potentially a breaking change for anything that depended on the formatted params being arrays or accessed their keys. Example patches: https://gerrit.wikimedia.org/r/q/topic:message-param Notable changes: * Message and MessageValue now both implement MessageSpecifier (only Message implemented it before). * Message::numParam() and other static methods for encoding params now return MessageParam objects, instead of special arrays. Use these MessageParam objects internally in Message. * Narrow down the return type of MessageSpecifier::getParams() (it was just `array`, allowing any type in the array). Narrow down the types for Message::params() and MessageValue::params() to match. * Deprecate MediaWiki\Message\Converter. As a replacement add MessageValue::newFromSpecifier(), which is analogous to Message::newFromSpecifier(), but without weird legacy edge cases. * Make StatusValue::getMessages() return MessageValues. Remove code that converted between Message and MessageValue, no longer needed. * Update many type declarations and comments to use MessageSpecifier instead of MessageValue, as well as a couple of tests that depended on implementation details. Bug: T358779 Change-Id: I625a48a6ecd3fad5c2ed76b23343a0fef91e1b83
35 lines
948 B
PHP
35 lines
948 B
PHP
<?php
|
|
|
|
namespace Wikimedia\Message;
|
|
|
|
/**
|
|
* Converts MessageSpecifier objects to localized plain text in a certain language.
|
|
*
|
|
* The caller cannot modify the details of message translation, such as which
|
|
* of multiple sources the message is taken from. Any such flags may be injected
|
|
* into the factory constructor.
|
|
*
|
|
* Implementations of TextFormatter are not required to perfectly format
|
|
* any message in any language. Implementations should make a best effort to
|
|
* produce human-readable text.
|
|
*
|
|
* @package MediaWiki\MessageFormatter
|
|
*/
|
|
interface ITextFormatter {
|
|
/**
|
|
* Get the internal language code in which format() is
|
|
* @return string
|
|
*/
|
|
public function getLangCode();
|
|
|
|
/**
|
|
* Convert a MessageSpecifier to text.
|
|
*
|
|
* The result is not safe for use as raw HTML.
|
|
*
|
|
* @param MessageSpecifier $message
|
|
* @return string
|
|
* @return-taint tainted
|
|
*/
|
|
public function format( MessageSpecifier $message ): string;
|
|
}
|