2018-02-12 19:41:44 +00:00
|
|
|
<?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
|
|
|
|
|
*/
|
|
|
|
|
|
2022-05-06 09:09:56 +00:00
|
|
|
namespace MediaWiki\ResourceLoader;
|
|
|
|
|
|
|
|
|
|
use InvalidArgumentException;
|
|
|
|
|
|
2018-02-12 19:41:44 +00:00
|
|
|
/**
|
|
|
|
|
* Allows loading arbitrary sets of OOUI icons.
|
|
|
|
|
*
|
2019-09-14 04:32:54 +00:00
|
|
|
* @ingroup ResourceLoader
|
2018-02-12 19:41:44 +00:00
|
|
|
* @since 1.34
|
|
|
|
|
*/
|
2022-05-06 09:09:56 +00:00
|
|
|
class OOUIIconPackModule extends OOUIImageModule {
|
2019-10-07 05:22:02 +00:00
|
|
|
public function __construct( array $options = [], $localBasePath = null ) {
|
2018-02-12 19:41:44 +00:00
|
|
|
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';
|
|
|
|
|
}
|
|
|
|
|
|
2021-07-22 03:11:47 +00:00
|
|
|
private function getIcons(): array {
|
2020-04-06 09:23:35 +00:00
|
|
|
// @phan-suppress-next-line PhanTypeArraySuspiciousNullable Checked in the constructor
|
2018-02-12 19:41:44 +00:00
|
|
|
return $this->definition['icons'];
|
|
|
|
|
}
|
|
|
|
|
|
2021-07-22 03:11:47 +00:00
|
|
|
protected function loadOOUIDefinition( $theme, $unused ): array {
|
2018-02-12 19:41:44 +00:00
|
|
|
// 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 ) {
|
2023-05-20 12:16:32 +00:00
|
|
|
if ( str_starts_with( $module, 'icons' ) ) {
|
2018-02-12 19:41:44 +00:00
|
|
|
$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();
|
2023-07-08 19:54:11 +00:00
|
|
|
foreach ( $definition['images'] as $iconName => $_ ) {
|
2018-02-12 19:41:44 +00:00
|
|
|
if ( !in_array( $iconName, $iconsNames ) ) {
|
|
|
|
|
unset( $definition['images'][$iconName] );
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return $definition;
|
|
|
|
|
}
|
2019-06-11 22:50:02 +00:00
|
|
|
|
2019-10-05 07:38:41 +00:00
|
|
|
public static function extractLocalBasePath( array $options, $localBasePath = null ) {
|
2019-06-11 22:50:02 +00:00
|
|
|
global $IP;
|
|
|
|
|
// Ignore any 'localBasePath' present in $options, this always refers to files in MediaWiki core
|
2022-12-05 20:37:13 +00:00
|
|
|
return $localBasePath ?? $IP;
|
2019-06-11 22:50:02 +00:00
|
|
|
}
|
2018-02-12 19:41:44 +00:00
|
|
|
}
|