MediaWiki master
LanguageConverterFactory.php
Go to the documentation of this file.
1<?php
21namespace MediaWiki\Languages;
22
23use BanConverter;
24use CrhConverter;
25use EnConverter;
26use GanConverter;
27use IuConverter;
28use KuConverter;
34use MniConverter;
35use ShConverter;
36use ShiConverter;
37use SrConverter;
38use TgConverter;
39use TlyConverter;
41use UzConverter;
42use Wikimedia\ObjectFactory\ObjectFactory;
43use WuuConverter;
44use ZghConverter;
45use ZhConverter;
46
54
56 private $cache = [];
61 private $converterList = [
62 'ban' => [
63 'class' => BanConverter::class,
64 ],
65 'crh' => [
66 'class' => CrhConverter::class,
67 ],
68 'gan' => [
69 'class' => GanConverter::class,
70 ],
71 'iu' => [
72 'class' => IuConverter::class,
73 ],
74 'ku' => [
75 'class' => KuConverter::class,
76 ],
77 'mni' => [
78 'class' => MniConverter::class,
79 ],
80 'sh' => [
81 'class' => ShConverter::class,
82 ],
83 'shi' => [
84 'class' => ShiConverter::class,
85 ],
86 'sr' => [
87 'class' => SrConverter::class,
88 ],
89 'tg' => [
90 'class' => TgConverter::class,
91 ],
92 'tly' => [
93 'class' => TlyConverter::class,
94 ],
95 'uz' => [
96 'class' => UzConverter::class,
97 ],
98 'wuu' => [
99 'class' => WuuConverter::class,
100 ],
101 'zgh' => [
102 'class' => ZghConverter::class,
103 ],
104 'zh' => [
105 'class' => ZhConverter::class,
106 ],
107 ];
108
109 private const DEFAULT_CONVERTER = [
110 'class' => TrivialLanguageConverter::class,
111 'services' => [
112 'TitleFormatter',
113 ]
114 ];
115
116 private const EN_CONVERTER = [
117 'class' => EnConverter::class,
118 ];
119
123 public const CONSTRUCTOR_OPTIONS = [
127 ];
128
129 private ServiceOptions $options;
130 private ObjectFactory $objectFactory;
131
135 private $defaultLanguage;
136
145 public function __construct(
146 ServiceOptions $options,
147 ObjectFactory $objectFactory,
148 callable $defaultLanguage
149 ) {
150 $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
151 $this->options = $options;
152 $this->objectFactory = $objectFactory;
153 if ( $options->get( MainConfigNames::UsePigLatinVariant ) ) {
154 $this->converterList['en'] = self::EN_CONVERTER;
155 }
156 $this->defaultLanguage = $defaultLanguage;
157 }
158
165 private function instantiateConverter( $lang ): ILanguageConverter {
166 $code = mb_strtolower( $lang->getCode() );
167 $spec = $this->converterList[$code] ?? self::DEFAULT_CONVERTER;
168 // ObjectFactory::createObject accepts an array, not just a callable (phan bug)
169 // @phan-suppress-next-line PhanTypeInvalidCallableArrayKey, PhanTypeInvalidCallableArraySize
170 return $this->objectFactory->createObject(
171 $spec,
172 [
173 'assertClass' => ILanguageConverter::class,
174 'extraArgs' => [ $lang ],
175 ]
176 );
177 }
178
188 public function getLanguageConverter( $language = null ): ILanguageConverter {
189 $lang = $language ?? ( $this->defaultLanguage )();
190 if ( isset( $this->cache[$lang->getCode()] ) ) {
191 return $this->cache[$lang->getCode()];
192 }
193 // @phan-suppress-next-line PhanTypeMismatchArgumentNullable False positive
194 $converter = $this->instantiateConverter( $lang );
195 $this->cache[$lang->getCode()] = $converter;
196 return $converter;
197 }
198
204 public function isConversionDisabled() {
205 return $this->options->get( MainConfigNames::DisableLangConversion );
206 }
207
213 public function isLinkConversionDisabled() {
214 return $this->options->get( MainConfigNames::DisableLangConversion ) ||
215 // Note that this configuration option is misnamed.
216 $this->options->get( MainConfigNames::DisableTitleConversion );
217 }
218}
Balinese specific code.
Crimean Tatar (Qırımtatarca) converter routines.
English specific converter routines.
Gan Chinese specific code.
Inuktitut specific code.
Kurdish converter routines.
A class for passing options to services.
assertRequiredOptions(array $expectedKeys)
Assert that the list of options provided in this instance exactly match $expectedKeys,...
Base class for language-specific code.
Definition Language.php:82
An interface for creating language converters.
isLinkConversionDisabled()
Whether to disable language variant conversion for links.
isConversionDisabled()
Whether to disable language variant conversion.
getLanguageConverter( $language=null)
Provide a LanguageConverter for given language.
__construct(ServiceOptions $options, ObjectFactory $objectFactory, callable $defaultLanguage)
A class containing constants representing the names of configuration variables.
const UsePigLatinVariant
Name constant for the UsePigLatinVariant setting, for use with Config::get()
const DisableLangConversion
Name constant for the DisableLangConversion setting, for use with Config::get()
const DisableTitleConversion
Name constant for the DisableTitleConversion setting, for use with Config::get()
Stub object for the user language.
Meitei specific converter routines.
Converts Serbo-Croatian from Latin script to Cyrillic script.
Shilha specific code.
Serbian (Српски / Srpski) specific code.
Tajik (Тоҷикӣ) specific code, converting Tajiki to Latin orthography.
Talysh specific code.
A trivial language converter.
Uzbek specific code.
Wu language specific code.
Standard Moroccan Amazigh specific code.
Chinese converter routine.
The shared interface for all language converters.