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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Languages;
use BanConverter;
use CrhConverter;
use EnConverter;
use GanConverter;
use IuConverter;
use KuConverter;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Language\ILanguageConverter;
use MediaWiki\Language\Language;
use MediaWiki\MainConfigNames;
use MediaWiki\StubObject\StubUserLang;
use MniConverter;
use ShConverter;
use ShiConverter;
use SrConverter;
use TgConverter;
use TlyConverter;
use TrivialLanguageConverter;
use UzConverter;
use Wikimedia\ObjectFactory\ObjectFactory;
use WuuConverter;
use ZghConverter;
use ZhConverter;
/**
* An interface for creating language converters.
*
* @since 1.35
* @ingroup Language
*/
class LanguageConverterFactory {
/** @var ILanguageConverter[] */
private $cache = [];
/**
* @var array
*/
private $converterList = [
'ban' => [
'class' => BanConverter::class,
],
'crh' => [
'class' => CrhConverter::class,
],
'gan' => [
'class' => GanConverter::class,
],
'iu' => [
'class' => IuConverter::class,
],
'ku' => [
'class' => KuConverter::class,
],
'mni' => [
'class' => MniConverter::class,
],
'shi' => [
'class' => ShiConverter::class,
],
'sh' => [
'class' => ShConverter::class,
],
'sr' => [
'class' => SrConverter::class,
],
'tg' => [
'class' => TgConverter::class,
],
'tly' => [
'class' => TlyConverter::class,
],
'uz' => [
'class' => UzConverter::class,
],
'wuu' => [
'class' => WuuConverter::class,
],
'zgh' => [
'class' => ZghConverter::class,
],
'zh' => [
'class' => ZhConverter::class,
],
];
private const DEFAULT_CONVERTER = [
'class' => TrivialLanguageConverter::class,
'services' => [
'TitleFormatter',
]
];
private const EN_CONVERTER = [
'class' => EnConverter::class,
];
/**
* @internal For use by ServiceWiring
*/
public const CONSTRUCTOR_OPTIONS = [
MainConfigNames::UsePigLatinVariant,
MainConfigNames::DisableLangConversion,
MainConfigNames::DisableTitleConversion,
];
private ServiceOptions $options;
private ObjectFactory $objectFactory;
/**
* @var callable callback of "() : Language"
*/
private $defaultLanguage;
/**
* @param ServiceOptions $options
* @param ObjectFactory $objectFactory
* @param callable $defaultLanguage callback of "() : Language", should return
* default language. Used in getLanguageConverter when $language is null.
*
* @internal Should be called from MediaWikiServices only.
*/
public function __construct(
ServiceOptions $options,
ObjectFactory $objectFactory,
callable $defaultLanguage
) {
$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
$this->options = $options;
$this->objectFactory = $objectFactory;
if ( $options->get( MainConfigNames::UsePigLatinVariant ) ) {
$this->converterList['en'] = self::EN_CONVERTER;
}
$this->defaultLanguage = $defaultLanguage;
}
/**
* Returns Converter instance for a given language object
*
* @param Language|StubUserLang $lang
* @return ILanguageConverter
*/
private function instantiateConverter( $lang ): ILanguageConverter {
$code = mb_strtolower( $lang->getCode() );
$spec = $this->converterList[$code] ?? self::DEFAULT_CONVERTER;
// ObjectFactory::createObject accepts an array, not just a callable (phan bug)
// @phan-suppress-next-line PhanTypeInvalidCallableArrayKey, PhanTypeInvalidCallableArraySize
return $this->objectFactory->createObject(
$spec,
[
'assertClass' => ILanguageConverter::class,
'extraArgs' => [ $lang ],
]
);
}
/**
* Provide a LanguageConverter for given language
*
* @param Language|StubUserLang|null $language for which a LanguageConverter should be provided.
* If it is null, then the LanguageConverter provided for current content language as returned
* by the callback provided to the constructor.
*
* @return ILanguageConverter
*/
public function getLanguageConverter( $language = null ): ILanguageConverter {
$lang = $language ?? ( $this->defaultLanguage )();
if ( isset( $this->cache[$lang->getCode()] ) ) {
return $this->cache[$lang->getCode()];
}
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable False positive
$converter = $this->instantiateConverter( $lang );
$this->cache[$lang->getCode()] = $converter;
return $converter;
}
/**
* Whether to disable language variant conversion.
*
* @return bool
*/
public function isConversionDisabled() {
return $this->options->get( MainConfigNames::DisableLangConversion );
}
/**
* Whether to disable language variant conversion for links.
*
* @return bool
*/
public function isLinkConversionDisabled() {
return $this->options->get( MainConfigNames::DisableLangConversion ) ||
// Note that this configuration option is misnamed.
$this->options->get( MainConfigNames::DisableTitleConversion );
}
}
|