1	<?php
2	/**
3	* This program is free software; you can redistribute it and/or modify
4	* it under the terms of the GNU General Public License as published by
5	* the Free Software Foundation; either version 2 of the License, or
6	* (at your option) any later version.
7	*
8	* This program is distributed in the hope that it will be useful,
9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11	* GNU General Public License for more details.
12	*
13	* You should have received a copy of the GNU General Public License along
14	* with this program; if not, write to the Free Software Foundation, Inc.,
15	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16	* http://www.gnu.org/copyleft/gpl.html
17	*
18	* @file
19	*/
20
21	namespace Wikimedia\Message;
22
23	/**
24	* Converts MessageSpecifier objects to localized plain text in a certain language.
25	*
26	* The caller cannot modify the details of message translation, such as which
27	* of multiple sources the message is taken from. Any such flags may be injected
28	* into the factory constructor.
29	*
30	* Implementations of TextFormatter are not required to perfectly format
31	* any message in any language. Implementations should make a best effort to
32	* produce human-readable text.
33	*
34	*/
35	interface ITextFormatter {
36	/**
37	* Get the internal language code in which format() is
38	* @return string
39	*/
40	public function getLangCode(): string;
41
42	/**
43	* Convert a MessageSpecifier to text.
44	*
45	* The result is not safe for use as raw HTML.
46	*
47	* @param MessageSpecifier $message
48	* @return string
49	* @return-taint tainted
50	*/
51	public function format( MessageSpecifier $message ): string;
52	}