3c2061497e
This patch removes styles from the `@wikimedia/codex` and `@wikimedia/codex-search` modules, and moves them into new, separate modules. This will enable use of CSS-only Codex components within MediaWiki. Additionally, this patch adds a check for theme styles in the CodexModules class to prevent it from breaking if they're not provided. Bug: T330466 Change-Id: I259a706641fcd51787d7492e7ada11db78277659
97 lines
3.1 KiB
PHP
97 lines
3.1 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace MediaWiki\ResourceLoader;
|
|
|
|
use Config;
|
|
use ExtensionRegistry;
|
|
|
|
/**
|
|
* Module for codex that has direction-specific style files and a static helper function for
|
|
* embedding icons in package modules.
|
|
*
|
|
* @ingroup ResourceLoader
|
|
* @internal
|
|
*/
|
|
class CodexModule extends FileModule {
|
|
|
|
protected $themeStyles = [];
|
|
protected $themeStylesAdded = false;
|
|
|
|
protected static $builtinSkinThemeMap = [
|
|
'default' => 'wikimedia-ui'
|
|
];
|
|
|
|
public function __construct( array $options = [], $localBasePath = null, $remoteBasePath = null ) {
|
|
if ( isset( $options['themeStyles'] ) ) {
|
|
$this->themeStyles = $options['themeStyles'];
|
|
}
|
|
|
|
parent::__construct( $options, $localBasePath, $remoteBasePath );
|
|
}
|
|
|
|
public function getStyleFiles( Context $context ) {
|
|
if ( $this->themeStyles && !$this->themeStylesAdded ) {
|
|
// Add theme styles
|
|
$themeMap = static::$builtinSkinThemeMap +
|
|
ExtensionRegistry::getInstance()->getAttribute( 'SkinCodexThemes' );
|
|
$theme = $themeMap[ $context->getSkin() ] ?? $themeMap[ 'default' ];
|
|
$dir = $context->getDirection();
|
|
$styles = $this->themeStyles[ $theme ][ $dir ];
|
|
$this->styles = array_merge( $this->styles, (array)$styles );
|
|
// Remember we added the theme styles so we don't add them twice if getStyleFiles() is called twice
|
|
$this->themeStylesAdded = true;
|
|
}
|
|
return parent::getStyleFiles( $context );
|
|
}
|
|
|
|
/**
|
|
* Retrieve the specified icon definitions from codex-icons.json. Intended as a convenience
|
|
* function to be used in packageFiles definitions.
|
|
*
|
|
* Example:
|
|
* "packageFiles": [
|
|
* {
|
|
* "name": "icons.json",
|
|
* "callback": "MediaWiki\\ResourceLoader\\CodexModule::getIcons",
|
|
* "callbackParam": [
|
|
* "cdxIconClear",
|
|
* "cdxIconTrash"
|
|
* ]
|
|
* }
|
|
* ]
|
|
*
|
|
* @param Context $context
|
|
* @param Config $config
|
|
* @param string[] $iconNames Names of icons to fetch
|
|
* @return array
|
|
*/
|
|
public static function getIcons( Context $context, Config $config, array $iconNames = [] ) {
|
|
global $IP;
|
|
static $allIcons = null;
|
|
if ( $allIcons === null ) {
|
|
$allIcons = json_decode( file_get_contents( "$IP/resources/lib/codex-icons/codex-icons.json" ), true );
|
|
}
|
|
return array_intersect_key( $allIcons, array_flip( $iconNames ) );
|
|
}
|
|
}
|
|
|
|
/** @deprecated since 1.39 */
|
|
class_alias( CodexModule::class, 'ResourceLoaderCodexModule' );
|