MediaWiki  1.28.0
ResourcesOOUI.php
Go to the documentation of this file.
1 <?php
23 if ( !defined( 'MEDIAWIKI' ) ) {
24  die( 'Not an entry point.' );
25 }
26 
27 // WARNING: OOjs-UI is NOT TESTED with older browsers and is likely to break
28 // if loaded in browsers that don't support ES5
29 return call_user_func( function () {
30  $themes = ExtensionRegistry::getInstance()->getAttribute( 'SkinOOUIThemes' );
31  // We only use the theme names for file names, and they are lowercase
32  $themes = array_map( 'strtolower', $themes );
33  $themes['default'] = 'mediawiki';
34 
35  // Helper function to generate paths to files used in 'skinStyles' and 'skinScripts'.
36  $getSkinSpecific = function ( $module, $ext = 'css' ) use ( $themes ) {
37  return array_combine(
38  array_keys( $themes ),
39  array_map( function ( $theme ) use ( $module, $ext ) {
40  $module = $module ? "$module-" : '';
41  // TODO Allow extensions to specify this path somehow
42  return "resources/lib/oojs-ui/oojs-ui-$module$theme.$ext";
43  }, array_values( $themes ) )
44  );
45  };
46 
47  $modules = [];
48 
49  // Omnibus module.
50  $modules['oojs-ui'] = [
51  'dependencies' => [
52  'oojs-ui-core',
53  'oojs-ui-widgets',
54  'oojs-ui-toolbars',
55  'oojs-ui-windows',
56  ],
57  'targets' => [ 'desktop', 'mobile' ],
58  ];
59 
60  // The core JavaScript library.
61  $modules['oojs-ui-core'] = [
62  'scripts' => [
63  'resources/lib/oojs-ui/oojs-ui-core.js',
64  'resources/src/oojs-ui-local.js',
65  ],
66  'skinScripts' => $getSkinSpecific( null, 'js' ),
67  'dependencies' => [
68  'es5-shim',
69  'oojs',
70  'oojs-ui-core.styles',
71  'oojs-ui.styles.icons',
72  'oojs-ui.styles.indicators',
73  'oojs-ui.styles.textures',
74  'mediawiki.language',
75  ],
76  'targets' => [ 'desktop', 'mobile' ],
77  ];
78  // This contains only the styles required by core widgets.
79  $modules['oojs-ui-core.styles'] = [
80  'position' => 'top',
81  'styles' => 'resources/src/oojs-ui-local.css', // HACK, see inside the file
82  'skinStyles' => $getSkinSpecific( 'core' ),
83  'targets' => [ 'desktop', 'mobile' ],
84  ];
85 
86  // Additional widgets and layouts module.
87  $modules['oojs-ui-widgets'] = [
88  'scripts' => 'resources/lib/oojs-ui/oojs-ui-widgets.js',
89  'skinStyles' => $getSkinSpecific( 'widgets' ),
90  'dependencies' => 'oojs-ui-core',
91  'messages' => [
92  'ooui-outline-control-move-down',
93  'ooui-outline-control-move-up',
94  'ooui-outline-control-remove',
95  'ooui-selectfile-button-select',
96  'ooui-selectfile-dragdrop-placeholder',
97  'ooui-selectfile-not-supported',
98  'ooui-selectfile-placeholder',
99  ],
100  'targets' => [ 'desktop', 'mobile' ],
101  ];
102  // Toolbar and tools module.
103  $modules['oojs-ui-toolbars'] = [
104  'scripts' => 'resources/lib/oojs-ui/oojs-ui-toolbars.js',
105  'skinStyles' => $getSkinSpecific( 'toolbars' ),
106  'dependencies' => 'oojs-ui-core',
107  'messages' => [
108  'ooui-toolbar-more',
109  'ooui-toolgroup-collapse',
110  'ooui-toolgroup-expand',
111  ],
112  'targets' => [ 'desktop', 'mobile' ],
113  ];
114  // Windows and dialogs module.
115  $modules['oojs-ui-windows'] = [
116  'scripts' => 'resources/lib/oojs-ui/oojs-ui-windows.js',
117  'skinStyles' => $getSkinSpecific( 'windows' ),
118  'dependencies' => 'oojs-ui-core',
119  'messages' => [
120  'ooui-dialog-message-accept',
121  'ooui-dialog-message-reject',
122  'ooui-dialog-process-continue',
123  'ooui-dialog-process-dismiss',
124  'ooui-dialog-process-error',
125  'ooui-dialog-process-retry',
126  ],
127  'targets' => [ 'desktop', 'mobile' ],
128  ];
129 
130  $imageSets = [
131  // Comments for greppability
132  'icons', // oojs-ui.styles.icons
133  'indicators', // oojs-ui.styles.indicators
134  'textures', // oojs-ui.styles.textures
135  'icons-accessibility', // oojs-ui.styles.icons-accessibility
136  'icons-alerts', // oojs-ui.styles.icons-alerts
137  'icons-content', // oojs-ui.styles.icons-content
138  'icons-editing-advanced', // oojs-ui.styles.icons-editing-advanced
139  'icons-editing-core', // oojs-ui.styles.icons-editing-core
140  'icons-editing-list', // oojs-ui.styles.icons-editing-list
141  'icons-editing-styling', // oojs-ui.styles.icons-editing-styling
142  'icons-interactions', // oojs-ui.styles.icons-interactions
143  'icons-layout', // oojs-ui.styles.icons-layout
144  'icons-location', // oojs-ui.styles.icons-location
145  'icons-media', // oojs-ui.styles.icons-media
146  'icons-moderation', // oojs-ui.styles.icons-moderation
147  'icons-movement', // oojs-ui.styles.icons-movement
148  'icons-user', // oojs-ui.styles.icons-user
149  'icons-wikimedia', // oojs-ui.styles.icons-wikimedia
150  ];
151  $rootPath = 'resources/lib/oojs-ui/themes';
152 
153  foreach ( $imageSets as $name ) {
154  $module = [
155  'position' => 'top',
156  'class' => 'ResourceLoaderOOUIImageModule',
157  'name' => $name,
158  'rootPath' => $rootPath,
159  ];
160 
161  if ( substr( $name, 0, 5 ) === 'icons' ) {
162  $module['selectorWithoutVariant'] = '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before';
163  $module['selectorWithVariant'] = '
164  .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before,
165  /* Hack for Flow, see T110051 */
166  .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before,
167  .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before';
168  }
169 
170  $modules["oojs-ui.styles.$name"] = $module;
171  }
172 
173  return $modules;
174 } );
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$modules
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
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
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300