3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
22 * Allows loading arbitrary sets of OOUI icons.
24 * @ingroup ResourceLoader
27 class ResourceLoaderOOUIIconPackModule
extends ResourceLoaderOOUIImageModule
{
28 public function __construct( $options = [], $localBasePath = null ) {
29 parent
::__construct( $options, $localBasePath );
31 if ( !isset( $this->definition
['icons'] ) ||
!$this->definition
['icons'] ) {
32 throw new InvalidArgumentException( "Parameter 'icons' must be given." );
35 // A few things check for the "icons" prefix on this value, so specify it even though
36 // we don't use it for actually loading the data, like in the other modules.
37 $this->definition
['themeImages'] = 'icons';
40 private function getIcons() {
41 return $this->definition
['icons'];
44 protected function loadOOUIDefinition( $theme, $unused ) {
45 // This is shared between instances of this class, so we only have to load the JSON files once
48 if ( !isset( $data[$theme] ) ) {
50 // Load and merge the JSON data for all "icons-foo" modules
51 foreach ( self
::$knownImagesModules as $module ) {
52 if ( substr( $module, 0, 5 ) === 'icons' ) {
53 $moreData = $this->readJSONFile( $this->getThemeImagesPath( $theme, $module ) );
55 $data[$theme] = array_replace_recursive( $data[$theme], $moreData );
61 $definition = $data[$theme];
63 // Filter out the data for all other icons, leaving only the ones we want for this module
64 $iconsNames = $this->getIcons();
65 foreach ( array_keys( $definition['images'] ) as $iconName ) {
66 if ( !in_array( $iconName, $iconsNames ) ) {
67 unset( $definition['images'][$iconName] );
74 public static function extractLocalBasePath( $options, $localBasePath = null ) {
76 if ( $localBasePath === null ) {
79 // Ignore any 'localBasePath' present in $options, this always refers to files in MediaWiki core
80 return $localBasePath;