LanguageConverterFactory.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Languages;
 
use BanConverter;
use CrhConverter;
use EnConverter;
use GanConverter;
use ILanguageConverter;
use IuConverter;
use KuConverter;
use Language;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
use MediaWiki\StubObject\StubUserLang;
use ShConverter;
use ShiConverter;
use SrConverter;
use TgConverter;
use TlyConverter;
use TrivialLanguageConverter;
use UzConverter;
use Wikimedia\ObjectFactory\ObjectFactory;
use WuuConverter;
use ZghConverter;
use ZhConverter;
 
class LanguageConverterFactory {
 
    private $cache = [];
    private $converterList = [
        'ban' => [
            'class' => BanConverter::class,
        ],
        'crh' => [
            'class' => CrhConverter::class,
        ],
        'gan' => [
            'class' => GanConverter::class,
        ],
        'iu' => [
            'class' => IuConverter::class,
        ],
        'ku' => [
            'class' => KuConverter::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,
    ];
 
    public const CONSTRUCTOR_OPTIONS = [
        MainConfigNames::UsePigLatinVariant,
        MainConfigNames::DisableLangConversion,
        MainConfigNames::DisableTitleConversion,
    ];
 
    private ServiceOptions $options;
    private ObjectFactory $objectFactory;
 
    private $defaultLanguage;
 
    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;
    }
 
    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 ],
            ]
        );
    }
 
    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;
    }
 
    public function isConversionDisabled() {
        return $this->options->get( MainConfigNames::DisableLangConversion );
    }
 
    public function isLinkConversionDisabled() {
        return $this->options->get( MainConfigNames::DisableLangConversion ) ||
            // Note that this configuration option is misnamed.
            $this->options->get( MainConfigNames::DisableTitleConversion );
    }
}