3e2653f83b
Move ResourceLoader classes to their own namespace. Strip the
"ResourceLoader" prefix from all except ResourceLoader itself.
Move the tests by analogy.
I used a namespace alias "RL" in some callers since RL\Module is less
ambiguous at the call site than just "Module".
I did not address DependencyStore which continues to have a non-standard
location and namespace.
Revert of a241d83e0a.
Bug: T308718
Change-Id: Id08a220e1d6085e2b33f3f6c9d0e3935a4204659
90 lines
3 KiB
PHP
90 lines
3 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 InvalidArgumentException;
|
|
|
|
/**
|
|
* Allows loading arbitrary sets of OOUI icons.
|
|
*
|
|
* @ingroup ResourceLoader
|
|
* @since 1.34
|
|
*/
|
|
class OOUIIconPackModule extends OOUIImageModule {
|
|
public function __construct( array $options = [], $localBasePath = null ) {
|
|
parent::__construct( $options, $localBasePath );
|
|
|
|
if ( !isset( $this->definition['icons'] ) || !$this->definition['icons'] ) {
|
|
throw new InvalidArgumentException( "Parameter 'icons' must be given." );
|
|
}
|
|
|
|
// A few things check for the "icons" prefix on this value, so specify it even though
|
|
// we don't use it for actually loading the data, like in the other modules.
|
|
$this->definition['themeImages'] = 'icons';
|
|
}
|
|
|
|
private function getIcons(): array {
|
|
// @phan-suppress-next-line PhanTypeArraySuspiciousNullable Checked in the constructor
|
|
return $this->definition['icons'];
|
|
}
|
|
|
|
protected function loadOOUIDefinition( $theme, $unused ): array {
|
|
// This is shared between instances of this class, so we only have to load the JSON files once
|
|
static $data = [];
|
|
|
|
if ( !isset( $data[$theme] ) ) {
|
|
$data[$theme] = [];
|
|
// Load and merge the JSON data for all "icons-foo" modules
|
|
foreach ( self::$knownImagesModules as $module ) {
|
|
if ( substr( $module, 0, 5 ) === 'icons' ) {
|
|
$moreData = $this->readJSONFile( $this->getThemeImagesPath( $theme, $module ) );
|
|
if ( $moreData ) {
|
|
$data[$theme] = array_replace_recursive( $data[$theme], $moreData );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$definition = $data[$theme];
|
|
|
|
// Filter out the data for all other icons, leaving only the ones we want for this module
|
|
$iconsNames = $this->getIcons();
|
|
foreach ( array_keys( $definition['images'] ) as $iconName ) {
|
|
if ( !in_array( $iconName, $iconsNames ) ) {
|
|
unset( $definition['images'][$iconName] );
|
|
}
|
|
}
|
|
|
|
return $definition;
|
|
}
|
|
|
|
public static function extractLocalBasePath( array $options, $localBasePath = null ) {
|
|
global $IP;
|
|
if ( $localBasePath === null ) {
|
|
$localBasePath = $IP;
|
|
}
|
|
// Ignore any 'localBasePath' present in $options, this always refers to files in MediaWiki core
|
|
return $localBasePath;
|
|
}
|
|
}
|
|
|
|
/** @deprecated since 1.39 */
|
|
class_alias( OOUIIconPackModule::class, 'ResourceLoaderOOUIIconPackModule' );
|