* Add a void return hint to methods that are not meant to return
anything. This helps catch accidental return statements in the
future, lets Phan better understand how methods are meant to be
used, and might also allow PHP to better optimise the compiled
code form (speculation).
I did not, however, add it to publicly extended methods as that
might mess with strict mode.
* Remove the internal getResourceLoader() method from MessageBlobStore.
This has been redundant since 3edaa0b37c.
The method was protected, and not considered stable to subclass
for extensions. Hence not a breaking change.
* Add Throwable typehint to formatException() and friends.
This is the narrowest one I could add given that the methods
called from here already enforce the same typehint.
Update the doc to match for now. There isn't a reason right now
to limit this only to Exception, and given this is the method
and not the catch statement itself, does not change behaviour.
* Remove unused ResourceLoader->getHookContainer().
Added within 1.35 cycle, safe to remove.
* Remove unexpected `@since` for `@internal` getHookRunner().
* Remove redundant `@internal` from ResourceLoaderMwUrlModule
methods, which itself is already `@internal`.
Change-Id: I68d33ff6feca7ef95282a7ff03eb9332adfde31c
99 lines
3.4 KiB
PHP
99 lines
3.4 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
|
|
*/
|
|
|
|
/**
|
|
* Module which magically loads the right skinScripts and skinStyles for every
|
|
* skin, using the specified OOUI theme for each.
|
|
*
|
|
* @ingroup ResourceLoader
|
|
* @internal
|
|
*/
|
|
class ResourceLoaderOOUIFileModule extends ResourceLoaderFileModule {
|
|
use ResourceLoaderOOUIModule;
|
|
|
|
public function __construct( array $options = [] ) {
|
|
if ( isset( $options['themeScripts'] ) ) {
|
|
$skinScripts = $this->getSkinSpecific( $options['themeScripts'], 'scripts' );
|
|
if ( !isset( $options['skinScripts'] ) ) {
|
|
$options['skinScripts'] = [];
|
|
}
|
|
$this->extendSkinSpecific( $options['skinScripts'], $skinScripts );
|
|
}
|
|
if ( isset( $options['themeStyles'] ) ) {
|
|
$skinStyles = $this->getSkinSpecific( $options['themeStyles'], 'styles' );
|
|
if ( !isset( $options['skinStyles'] ) ) {
|
|
$options['skinStyles'] = [];
|
|
}
|
|
$this->extendSkinSpecific( $options['skinStyles'], $skinStyles );
|
|
}
|
|
|
|
parent::__construct( $options );
|
|
}
|
|
|
|
/**
|
|
* Helper function to generate values for 'skinStyles' and 'skinScripts'.
|
|
*
|
|
* @param string $module Module to generate skinStyles/skinScripts for:
|
|
* 'core', 'widgets', 'toolbars', 'windows'
|
|
* @param string $which 'scripts' or 'styles'
|
|
* @return array
|
|
*/
|
|
private function getSkinSpecific( $module, $which ) : array {
|
|
$themes = self::getSkinThemeMap();
|
|
|
|
return array_combine(
|
|
array_keys( $themes ),
|
|
array_map( function ( $theme ) use ( $module, $which ) {
|
|
if ( $which === 'scripts' ) {
|
|
return $this->getThemeScriptsPath( $theme, $module );
|
|
} else {
|
|
return $this->getThemeStylesPath( $theme, $module );
|
|
}
|
|
}, array_values( $themes ) )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Prepend the $extraSkinSpecific assoc. array to the $skinSpecific assoc. array.
|
|
* Both of them represent a 'skinScripts' or 'skinStyles' definition.
|
|
*
|
|
* @param array &$skinSpecific
|
|
* @param array $extraSkinSpecific
|
|
*/
|
|
private function extendSkinSpecific( array &$skinSpecific, array $extraSkinSpecific ) : void {
|
|
// For each skin where skinStyles/skinScripts are defined, add our ones at the beginning
|
|
foreach ( $skinSpecific as $skin => $files ) {
|
|
if ( !is_array( $files ) ) {
|
|
$files = [ $files ];
|
|
}
|
|
if ( isset( $extraSkinSpecific[$skin] ) ) {
|
|
$skinSpecific[$skin] = array_merge( [ $extraSkinSpecific[$skin] ], $files );
|
|
} elseif ( isset( $extraSkinSpecific['default'] ) ) {
|
|
$skinSpecific[$skin] = array_merge( [ $extraSkinSpecific['default'] ], $files );
|
|
}
|
|
}
|
|
// Add our remaining skinStyles/skinScripts for skins that did not have them defined
|
|
foreach ( $extraSkinSpecific as $skin => $file ) {
|
|
if ( !isset( $skinSpecific[$skin] ) ) {
|
|
$skinSpecific[$skin] = $file;
|
|
}
|
|
}
|
|
}
|
|
}
|