}
/**
- * Gets registration code for all modules, except pre-registered ones listed in
- * self::$preRegisteredModules
+ * Gets registration code for all modules
*
* @param $context ResourceLoaderContext object
* @return String: JavaScript code for registering all modules with the client loader
// Support module loader scripts
if ( ( $loader = $module->getLoaderScript() ) !== false ) {
$deps = FormatJson::encode( $module->getDependencies() );
- $version = wfTimestamp( TS_ISO_8601,
- round( $module->getModifiedTime( $context ), -2 ) );
+ $group = FormatJson::encode( $module->getGroup() );
+ $version = wfTimestamp( TS_ISO_8601, round( $module->getModifiedTime( $context ), -2 ) );
$scripts .= "( function( name, version, dependencies ) { $loader } )\n" .
- "( '$name', '$version', $deps );\n";
+ "( '$name', '$version', $deps, $group );\n";
}
// Automatically register module
else {
- // Modules without dependencies pass two arguments (name, timestamp) to
+ // Modules without dependencies or a group pass two arguments (name, timestamp) to
// mediaWiki.loader.register()
- if ( !count( $module->getDependencies() ) ) {
+ if ( !count( $module->getDependencies() && $module->getGroup() === null ) ) {
$registrations[] = array( $name, $module->getModifiedTime( $context ) );
}
- // Modules with dependencies pass three arguments (name, timestamp, dependencies)
+ // Modules with dependencies but no group pass three arguments (name, timestamp, dependencies)
+ // to mediaWiki.loader.register()
+ else if ( $module->getGroup() === null ) {
+ $registrations[] = array(
+ $name, $module->getModifiedTime( $context ), $module->getDependencies() );
+ }
+ // Modules with dependencies pass four arguments (name, timestamp, dependencies, group)
// to mediaWiki.loader.register()
else {
- $registrations[] = array( $name, $module->getModifiedTime( $context ),
- $module->getDependencies() );
+ $registrations[] = array(
+ $name, $module->getModifiedTime( $context ), $module->getDependencies(), $module->getGroup() );
}
}
}
// Stub, override expected
return array();
}
+
+ /**
+ * Get the group this module is in.
+ *
+ * @return string of group name
+ */
+ public function getGroup() {
+ // Stub, override expected
+ return null;
+ }
/**
* Get the loader JS for this module, if set.
*/
public function getLoaderScript() {
// Stub, override expected
- return '';
+ return false;
}
/**
protected $scripts = array();
protected $styles = array();
protected $messages = array();
+ protected $group;
protected $dependencies = array();
protected $debugScripts = array();
protected $languageScripts = array();
* array(
* // Required module options (mutually exclusive)
* 'scripts' => 'dir/script.js' | array( 'dir/script1.js', 'dir/script2.js' ... ),
- *
+ *
* // Optional module options
* 'languageScripts' => array(
* '[lang name]' => 'dir/lang.js' | '[lang name]' => array( 'dir/lang1.js', 'dir/lang2.js' ... )
* ...
* ),
* 'messages' => array( 'message1', 'message2' ... ),
+ * 'group' => 'stuff',
* )
*/
public function __construct( $options = array() ) {
case 'messages':
$this->messages = (array)$value;
break;
+ case 'group':
+ $this->group = (string)$value;
+ break;
case 'dependencies':
$this->dependencies = (array)$value;
break;
public function addMessages( $messages ) {
$this->messages = array_merge( $this->messages, (array)$messages );
}
-
+
+ /**
+ * Sets the group of this module.
+ *
+ * @param $group string group name
+ */
+ public function setGroup( $group ) {
+ $this->group = $group;
+ }
+
/**
* Add dependencies. Dependency information is taken into account when
* loading a module on the client side. When adding a module on the
return $this->messages;
}
+ public function getGroup() {
+ return $this->group;
+ }
+
public function getDependencies() {
return $this->dependencies;
}
}
return $pages;
}
+
+ /* Methods */
+
+ public function getGroup() {
+ return 'site';
+ }
}
/**
}
return array();
}
+
+ /* Methods */
+
+ public function getGroup() {
+ return 'user';
+ }
}
/**
if ( $user ) {
return $this->modifiedTime[$hash] = $user->getTouched();
} else {
- return 0;
+ return 1;
}
}
return $wgContLang->getDir() !== $context->getDirection();
}
+
+ public function getGroup() {
+ return 'user';
+ }
}
class ResourceLoaderStartUpModule extends ResourceLoaderModule {
return $wgContLang->getDir() !== $context->getDirection();
}
+
+ /* Methods */
+
+ public function getGroup() {
+ return 'startup';
+ }
}
* Registers a module, letting the system know about it and it's dependencies. loader.js files contain calls
* to this function.
*/
- this.register = function( module, version, dependencies, status ) {
+ this.register = function( module, version, dependencies, group ) {
// Allow multiple registration
if ( typeof module === 'object' ) {
for ( var m = 0; m < module.length; m++ ) {
if ( typeof module !== 'string' ) {
throw new Error( 'module must be a string, not a ' + typeof module );
}
- if ( typeof registry[module] !== 'undefined' && typeof status === 'undefined' ) {
+ if ( typeof registry[module] !== 'undefined' ) {
throw new Error( 'module already implemeneted: ' + module );
}
// List the module as registered
registry[module] = {
- 'state': typeof status === 'string' ? status : 'registered',
+ 'state': 'registered',
+ 'group': typeof group === 'string' ? group : null,
'dependencies': [],
'version': typeof version !== 'undefined' ? parseInt( version ) : 0
};