wiki.techinc.nl/includes/language/LanguageConverterFactory.php
Umherirrender 171775e07b doc: Cleanup @param documentation
No extra sign needed between variable and description

Change-Id: Iaaaf62a3ffba7967aef8c31b121121b2830b74c4
2021-11-04 22:32:39 +01:00

161 lines
4.5 KiB
PHP

<?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 ILanguageConverter;
use IuConverter;
use KkConverter;
use KuConverter;
use Language;
use ShiConverter;
use SrConverter;
use TgConverter;
use TlyConverter;
use TrivialLanguageConverter;
use UzConverter;
use ZhConverter;
/**
* An interface for creating language converters.
*
* @since 1.35
* @ingroup Language
*/
class LanguageConverterFactory {
private $cache = [];
/**
* @var array
*/
private $converterClasses = [
'ban' => BanConverter::class,
'crh' => CrhConverter::class,
'gan' => GanConverter::class,
'iu' => IuConverter::class,
'kk' => KkConverter::class,
'ku' => KuConverter::class,
'shi' => ShiConverter::class,
'sr' => SrConverter::class,
'tg' => TgConverter::class,
'tly' => TlyConverter::class,
'uz' => UzConverter::class,
'zh' => ZhConverter::class,
];
private $defaultConverterClass = TrivialLanguageConverter::class;
/**
* @var bool Whether to disable language variant conversion.
*/
private $isConversionDisabled;
/**
* @var bool Whether to disable language variant conversion for links.
*/
private $isTitleConversionDisabled;
/**
* @var callable callback of () : Language
*/
private $defaultLanguage;
/**
* @param bool $usePigLatinVariant should pig variant of English be used
* @param bool $isConversionDisabled Whether to disable language variant conversion
* @param bool $isTitleConversionDisabled Whether to disable language variant conversion for links
* @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(
$usePigLatinVariant, $isConversionDisabled, $isTitleConversionDisabled,
callable $defaultLanguage
) {
if ( $usePigLatinVariant ) {
$this->converterClasses['en'] = EnConverter::class;
}
$this->isConversionDisabled = $isConversionDisabled;
$this->isTitleConversionDisabled = $isTitleConversionDisabled;
$this->defaultLanguage = $defaultLanguage;
}
/**
* Returns Converter's class name for given language code
*
* @param string $code code for which class name should be provided
* @return string
*/
private function classFromCode( string $code ): string {
$code = mb_strtolower( $code );
return $this->converterClasses[$code] ?? $this->defaultConverterClass;
}
/**
* Provide a LanguageConverter for given language
*
* @param Language|null $language for which a LanguageConverter should be provided.
* If null then 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()];
}
$class = $this->classFromCode( $lang->getCode() );
$converter = new $class( $lang );
$this->cache[$lang->getCode()] = $converter;
return $converter;
}
/**
* Whether to disable language variant conversion.
* @return bool
*/
public function isConversionDisabled() {
return $this->isConversionDisabled;
}
/**
* Whether to disable language variant conversion for titles.
* @return bool
* @deprecated 1.36 Should use ::isLinkConversionDisabled() instead
*/
public function isTitleConversionDisabled() {
return $this->isTitleConversionDisabled;
}
/**
* Whether to disable language variant conversion for links.
* @return bool
*/
public function isLinkConversionDisabled() {
return $this->isConversionDisabled || $this->isTitleConversionDisabled;
}
}