OOUIModule.php

Go to the documentation of this file.

<?php
namespace MediaWiki\ResourceLoader;
 
use InvalidArgumentException;
use MediaWiki\Registration\ExtensionRegistry;
 
trait OOUIModule {
    protected static $knownScriptsModules = [ 'core' ];
    protected static $knownStylesModules = [ 'core', 'widgets', 'toolbars', 'windows' ];
    protected static $knownImagesModules = [
        'indicators',
        // Extra icons
        'icons-accessibility',
        'icons-alerts',
        'icons-content',
        'icons-editing-advanced',
        'icons-editing-citation',
        'icons-editing-functions',
        'icons-editing-core',
        'icons-editing-list',
        'icons-editing-styling',
        'icons-interactions',
        'icons-layout',
        'icons-location',
        'icons-media',
        'icons-moderation',
        'icons-movement',
        'icons-user',
        'icons-wikimedia',
    ];
 
    protected static $builtinSkinThemeMap = [
        'default' => 'WikimediaUI',
    ];
 
    protected static $builtinThemePaths = [
        'WikimediaUI' => [
            'scripts' => 'resources/lib/ooui/oojs-ui-wikimediaui.js',
            'styles' => 'resources/lib/ooui/oojs-ui-{module}-wikimediaui.css',
            'images' => 'resources/lib/ooui/themes/wikimediaui/{module}.json',
        ],
        'Apex' => [
            'scripts' => 'resources/lib/ooui/oojs-ui-apex.js',
            'styles' => 'resources/lib/ooui/oojs-ui-{module}-apex.css',
            'images' => 'resources/lib/ooui/themes/apex/{module}.json',
        ],
    ];
 
    public static function getSkinThemeMap() {
        $themeMap = self::$builtinSkinThemeMap;
        $themeMap += ExtensionRegistry::getInstance()->getAttribute( 'SkinOOUIThemes' );
        return $themeMap;
    }
 
    protected static function getThemePaths() {
        $themePaths = self::$builtinThemePaths;
        $themePaths += ExtensionRegistry::getInstance()->getAttribute( 'OOUIThemePaths' );
 
        [ $defaultLocalBasePath, $defaultRemoteBasePath ] =
            FileModule::extractBasePaths();
 
        // Allow custom themes' paths to be relative to the skin/extension that defines them,
        // like with ResourceModuleSkinStyles
        foreach ( $themePaths as &$paths ) {
            [ $localBasePath, $remoteBasePath ] =
                FileModule::extractBasePaths( $paths );
            if ( $localBasePath !== $defaultLocalBasePath || $remoteBasePath !== $defaultRemoteBasePath ) {
                foreach ( $paths as &$path ) {
                    $path = new FilePath( $path, $localBasePath, $remoteBasePath );
                }
            }
        }
 
        return $themePaths;
    }
 
    protected function getThemePath( $theme, $kind, $module ) {
        $paths = self::getThemePaths();
        $path = $paths[$theme][$kind];
        if ( $path instanceof FilePath ) {
            $path = new FilePath(
                str_replace( '{module}', $module, $path->getPath() ),
                $path->getLocalBasePath(),
                $path->getRemoteBasePath()
            );
        } else {
            $path = str_replace( '{module}', $module, $path );
        }
        return $path;
    }
 
    protected function getThemeScriptsPath( $theme, $module ) {
        if ( !in_array( $module, self::$knownScriptsModules ) ) {
            throw new InvalidArgumentException( "Invalid OOUI scripts module '$module'" );
        }
        return $this->getThemePath( $theme, 'scripts', $module );
    }
 
    protected function getThemeStylesPath( $theme, $module ) {
        if ( !in_array( $module, self::$knownStylesModules ) ) {
            throw new InvalidArgumentException( "Invalid OOUI styles module '$module'" );
        }
        return $this->getThemePath( $theme, 'styles', $module );
    }
 
    protected function getThemeImagesPath( $theme, $module ) {
        if ( !in_array( $module, self::$knownImagesModules ) ) {
            throw new InvalidArgumentException( "Invalid OOUI images module '$module'" );
        }
        return $this->getThemePath( $theme, 'images', $module );
    }
}