MediaWiki  master
ResourceLoaderOOUIIconPackModule.php
Go to the documentation of this file.
1 <?php
27  public function __construct( $options = [], $localBasePath = null ) {
28  parent::__construct( $options, $localBasePath );
29 
30  if ( !isset( $this->definition['icons'] ) || !$this->definition['icons'] ) {
31  throw new InvalidArgumentException( "Parameter 'icons' must be given." );
32  }
33 
34  // A few things check for the "icons" prefix on this value, so specify it even though
35  // we don't use it for actually loading the data, like in the other modules.
36  $this->definition['themeImages'] = 'icons';
37  }
38 
39  private function getIcons() {
40  return $this->definition['icons'];
41  }
42 
43  protected function loadOOUIDefinition( $theme, $unused ) {
44  // This is shared between instances of this class, so we only have to load the JSON files once
45  static $data = [];
46 
47  if ( !isset( $data[$theme] ) ) {
48  $data[$theme] = [];
49  // Load and merge the JSON data for all "icons-foo" modules
50  foreach ( self::$knownImagesModules as $module ) {
51  if ( substr( $module, 0, 5 ) === 'icons' ) {
52  $moreData = $this->readJSONFile( $this->getThemeImagesPath( $theme, $module ) );
53  if ( $moreData ) {
54  $data[$theme] = array_replace_recursive( $data[$theme], $moreData );
55  }
56  }
57  }
58  }
59 
60  $definition = $data[$theme];
61 
62  // Filter out the data for all other icons, leaving only the ones we want for this module
63  $iconsNames = $this->getIcons();
64  foreach ( array_keys( $definition['images'] ) as $iconName ) {
65  if ( !in_array( $iconName, $iconsNames ) ) {
66  unset( $definition['images'][$iconName] );
67  }
68  }
69 
70  return $definition;
71  }
72 
73  public static function extractLocalBasePath( $options, $localBasePath = null ) {
74  global $IP;
75  if ( $localBasePath === null ) {
77  }
78  // Ignore any 'localBasePath' present in $options, this always refers to files in MediaWiki core
79  return $localBasePath;
80  }
81 }
$IP
Definition: WebStart.php:41
getThemeImagesPath( $theme, $module)
readJSONFile( $dataPath)
Read JSON from a file, and transform all paths in it to be relative to the module&#39;s base path...
static $knownImagesModules
__construct( $options=[], $localBasePath=null)
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1971
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
string $localBasePath
Local base path, see __construct()
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Loads the module definition from JSON files in the format that OOUI uses, converting it to the format...
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
static extractLocalBasePath( $options, $localBasePath=null)
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this definition
Allows loading arbitrary sets of OOUI icons.