ResourceLoaderUserOptionsModule.php

Go to the documentation of this file.

<?php
 
use MediaWiki\MediaWikiServices;
use MediaWiki\User\UserOptionsLookup;
 
class ResourceLoaderUserOptionsModule extends ResourceLoaderModule {
    protected $origin = self::ORIGIN_CORE_INDIVIDUAL;
 
    protected $targets = [ 'desktop', 'mobile' ];
 
    public function getDependencies( ResourceLoaderContext $context = null ) {
        return [ 'user.defaults' ];
    }
 
    public function getScript( ResourceLoaderContext $context ) {
        $user = $context->getUserObj();
 
        $tokens = [
            'patrolToken' => $user->getEditToken( 'patrol' ),
            'watchToken' => $user->getEditToken( 'watch' ),
            'csrfToken' => $user->getEditToken(),
        ];
        $script = 'mw.user.tokens.set(' . $context->encodeJson( $tokens ) . ');';
 
        $userOptionsLookup = MediaWikiServices::getInstance()->getUserOptionsLookup();
        $options = $userOptionsLookup->getOptions( $user, UserOptionsLookup::EXCLUDE_DEFAULTS );
        // Optimisation: Only output this function call if the user has non-default settings.
        if ( $options ) {
            $script .= 'mw.user.options.set(' . $context->encodeJson( $options ) . ');';
        }
 
        // Use FILTER_NOMIN annotation to prevent needless minification and caching (T84960).
        return ResourceLoader::FILTER_NOMIN . $script;
    }
 
    public function supportsURLLoading() {
        return false;
    }
 
    public function getGroup() {
        return 'private';
    }
}