UserOptionsModule.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\ResourceLoader;
 
use MediaWiki\MediaWikiServices;
use MediaWiki\User\UserOptionsLookup;
 
class UserOptionsModule extends Module {
 
    protected $origin = self::ORIGIN_CORE_INDIVIDUAL;
 
    protected $targets = [ 'desktop', 'mobile' ];
 
    public function getScript( Context $context ) {
        $user = $context->getUserObj();
 
        $tokens = [
            // Replacement is tricky - T287542
            'patrolToken' => $user->getEditToken( 'patrol' ),
            'watchToken' => $user->getEditToken( 'watch' ),
            'csrfToken' => $user->getEditToken(),
        ];
        $script = 'mw.user.tokens.set(' . $context->encodeJson( $tokens ) . ');' . "\n";
 
        $userOptionsLookup = MediaWikiServices::getInstance()->getUserOptionsLookup();
 
        // Optimisation: Exclude the defaults, which we load separately and allow the browser
        // to cache across page views. The defaults are loaded before this code executes,
        // as part of the "mediawiki.base" module.
        $options = $userOptionsLookup->getOptions( $user, UserOptionsLookup::EXCLUDE_DEFAULTS );
 
        $keysToExclude = [];
        $this->getHookRunner()->onResourceLoaderExcludeUserOptions( $keysToExclude, $context );
        foreach ( $keysToExclude as $excludedKey ) {
            unset( $options[ $excludedKey ] );
        }
 
        // Optimisation: Only output this function call if the user has non-default settings.
        if ( $options ) {
            $script .= 'mw.user.options.set(' . $context->encodeJson( $options ) . ');' . "\n";
        }
 
        return $script;
    }
 
    public function supportsURLLoading() {
        return false;
    }
 
    public function getGroup() {
        return self::GROUP_PRIVATE;
    }
}
 
class_alias( UserOptionsModule::class, 'ResourceLoaderUserOptionsModule' );