File: TextFormatter.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 (58 lines) | stat: -rw-r--r-- 1,315 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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<?php

namespace MediaWiki\Message;

use Wikimedia\Message\ITextFormatter;
use Wikimedia\Message\MessageSpecifier;

/**
 * The MediaWiki-specific implementation of ITextFormatter
 */
class TextFormatter implements ITextFormatter {
	/** @var string */
	private $langCode;

	/** @var string */
	private $format;

	/**
	 * Construct a TextFormatter.
	 *
	 * The type signature may change without notice as dependencies are added
	 * to the constructor. External callers should use
	 * MediaWikiServices::getMessageFormatterFactory()
	 *
	 * @internal
	 * @param string $langCode
	 * @param string $format
	 */
	public function __construct(
		string $langCode,
		string $format = Message::FORMAT_TEXT
	) {
		$this->langCode = $langCode;
		$this->format = $format;
	}

	public function getLangCode() {
		return $this->langCode;
	}

	/**
	 * Allow the Message class to be mocked in tests by constructing objects in
	 * a protected method.
	 *
	 * @internal
	 * @param MessageSpecifier $spec
	 * @return Message
	 */
	protected function createMessage( MessageSpecifier $spec ) {
		return Message::newFromSpecifier( $spec );
	}

	public function format( MessageSpecifier $mv ): string {
		$message = $this->createMessage( $mv );
		$message->inLanguage( $this->langCode );
		return $message->toString( $this->format );
	}
}