File: ITextFormatter.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (35 lines) | stat: -rw-r--r-- 948 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<?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;
}