DefaultOptionsLookup.php

Go to the documentation of this file.

<?php
namespace MediaWiki\User;
 
use Language;
use LanguageConverter;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
use Skin;
use Wikimedia\Assert\Assert;
 
class DefaultOptionsLookup extends UserOptionsLookup {
 
    public const CONSTRUCTOR_OPTIONS = [
        'DefaultSkin',
        'DefaultUserOptions',
        'NamespacesToBeSearchedDefault'
    ];
 
    private $serviceOptions;
 
    private $contentLang;
 
    private $defaultOptions = null;
 
    private $hookRunner;
 
    public function __construct(
        ServiceOptions $options,
        Language $contentLang,
        HookContainer $hookContainer
    ) {
        $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
        $this->serviceOptions = $options;
        $this->contentLang = $contentLang;
        $this->hookRunner = new HookRunner( $hookContainer );
    }
 
    public function getDefaultOptions(): array {
        if ( $this->defaultOptions !== null ) {
            return $this->defaultOptions;
        }
 
        $this->defaultOptions = $this->serviceOptions->get( 'DefaultUserOptions' );
 
        // Default language setting
        $this->defaultOptions['language'] = $this->contentLang->getCode();
        foreach ( LanguageConverter::$languagesWithVariants as $langCode ) {
            if ( $langCode === $this->contentLang->getCode() ) {
                $this->defaultOptions['variant'] = $langCode;
            } else {
                $this->defaultOptions["variant-$langCode"] = $langCode;
            }
        }
 
        // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
        // since extensions may change the set of searchable namespaces depending
        // on user groups/permissions.
        foreach ( $this->serviceOptions->get( 'NamespacesToBeSearchedDefault' ) as $nsnum => $val ) {
            $this->defaultOptions['searchNs' . $nsnum] = (bool)$val;
        }
        $this->defaultOptions['skin'] = Skin::normalizeKey( $this->serviceOptions->get( 'DefaultSkin' ) );
 
        $this->hookRunner->onUserGetDefaultOptions( $this->defaultOptions );
 
        return $this->defaultOptions;
    }
 
    public function getDefaultOption( string $opt ) {
        $defOpts = $this->getDefaultOptions();
        return $defOpts[$opt] ?? null;
    }
 
    public function getOption(
        UserIdentity $user,
        string $oname,
        $defaultOverride = null,
        bool $ignoreHidden = false,
        int $queryFlags = self::READ_NORMAL
    ) {
        $this->verifyUsable( $user, __METHOD__ );
        return $this->getDefaultOption( $oname ) ?? $defaultOverride;
    }
 
    public function getOptions(
        UserIdentity $user,
        int $flags = 0,
        int $queryFlags = self::READ_NORMAL
    ): array {
        $this->verifyUsable( $user, __METHOD__ );
        if ( $flags & self::EXCLUDE_DEFAULTS ) {
            return [];
        }
        return $this->getDefaultOptions();
    }
 
    private function verifyUsable( UserIdentity $user, string $fname ) {
        Assert::precondition( !$user->isRegistered(), "$fname called on a registered user " );
    }
}