ResourceLoaderContext.php

Go to the documentation of this file.

<?php
class ResourceLoaderContext {

    /* Protected Members */

    protected $resourceLoader;
    protected $request;
    protected $modules;
    protected $language;
    protected $direction;
    protected $skin;
    protected $user;
    protected $debug;
    protected $only;
    protected $version;
    protected $hash;
    protected $raw;

    /* Methods */

    public function __construct( $resourceLoader, WebRequest $request ) {
        global $wgDefaultSkin, $wgResourceLoaderDebug;

        $this->resourceLoader = $resourceLoader;
        $this->request = $request;

        // Interpret request
        // List of modules
        $modules = $request->getVal( 'modules' );
        $this->modules = $modules ? self::expandModuleNames( $modules ) : array();
        // Various parameters
        $this->skin = $request->getVal( 'skin' );
        $this->user = $request->getVal( 'user' );
        $this->debug = $request->getFuzzyBool( 'debug', $wgResourceLoaderDebug );
        $this->only = $request->getVal( 'only' );
        $this->version = $request->getVal( 'version' );
        $this->raw = $request->getFuzzyBool( 'raw' );

        $skinnames = Skin::getSkinNames();
        // If no skin is specified, or we don't recognize the skin, use the default skin
        if ( !$this->skin || !isset( $skinnames[$this->skin] ) ) {
            $this->skin = $wgDefaultSkin;
        }
    }

    public static function expandModuleNames( $modules ) {
        $retval = array();
        // For backwards compatibility with an earlier hack, replace ! with .
        $modules = str_replace( '!', '.', $modules );
        $exploded = explode( '|', $modules );
        foreach ( $exploded as $group ) {
            if ( strpos( $group, ',' ) === false ) {
                // This is not a set of modules in foo.bar,baz notation
                // but a single module
                $retval[] = $group;
            } else {
                // This is a set of modules in foo.bar,baz notation
                $pos = strrpos( $group, '.' );
                if ( $pos === false ) {
                    // Prefixless modules, i.e. without dots
                    $retval = array_merge( $retval, explode( ',', $group ) );
                } else {
                    // We have a prefix and a bunch of suffixes
                    $prefix = substr( $group, 0, $pos ); // 'foo'
                    $suffixes = explode( ',', substr( $group, $pos + 1 ) ); // array( 'bar', 'baz' )
                    foreach ( $suffixes as $suffix ) {
                        $retval[] = "$prefix.$suffix";
                    }
                }
            }
        }
        return $retval;
    }

    public static function newDummyContext() {
        return new self( null, new FauxRequest( array() ) );
    }

    public function getResourceLoader() {
        return $this->resourceLoader;
    }

    public function getRequest() {
        return $this->request;
    }

    public function getModules() {
        return $this->modules;
    }

    public function getLanguage() {
        if ( $this->language === null ) {
            global $wgLang;
            $this->language = $this->request->getVal( 'lang' );
            if ( !$this->language ) {
                $this->language = $wgLang->getCode();
            }
        }
        return $this->language;
    }

    public function getDirection() {
        if ( $this->direction === null ) {
            $this->direction = $this->request->getVal( 'dir' );
            if ( !$this->direction ) {
                # directionality based on user language (see bug 6100)
                $this->direction = Language::factory( $this->getLanguage() )->getDir();
            }
        }
        return $this->direction;
    }

    public function getSkin() {
        return $this->skin;
    }

    public function getUser() {
        return $this->user;
    }

    public function getDebug() {
        return $this->debug;
    }

    public function getOnly() {
        return $this->only;
    }

    public function getVersion() {
        return $this->version;
    }

    public function getRaw() {
        return $this->raw;
    }

    public function shouldIncludeScripts() {
        return is_null( $this->only ) || $this->only === 'scripts';
    }

    public function shouldIncludeStyles() {
        return is_null( $this->only ) || $this->only === 'styles';
    }

    public function shouldIncludeMessages() {
        return is_null( $this->only ) || $this->only === 'messages';
    }

    public function getHash() {
        if ( !isset( $this->hash ) ) {
            $this->hash = implode( '|', array(
                $this->getLanguage(), $this->getDirection(), $this->skin, $this->user,
                $this->debug, $this->only, $this->version
            ) );
        }
        return $this->hash;
    }
}