* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
+ * @file
* @author Roan Kattouw
* @author Trevor Parscal
*/
-/*
+/**
* Dynamic JavaScript and CSS resource loading system
*
* @example
* ResourceLoader::register( 'foo', array(
* // Script or list of scripts to include when implementating the module (required)
* 'script' => 'resources/foo/foo.js',
- * // List of scripts or lists of scripts to include based on the current language
- * 'locales' => array(
- * 'en-gb' => 'resources/foo/locales/en-gb.js',
- * ),
+ * // List of scripts or lists of scripts to include based on the current language
+ * 'locales' => array(
+ * 'en-gb' => 'resources/foo/locales/en-gb.js',
+ * ),
* // Script or list of scripts to include only when in debug mode
* 'debug' => 'resources/foo/debug.js',
* // If this module is going to be loaded before the mediawiki module is ready such as jquery or the mediawiki
* 'loader' => 'resources/foo/loader.js',
* // Style-sheets or list of style-sheets to include
* 'style' => 'resources/foo/foo.css',
- * // List of style-sheets or lists of style-sheets to include based on the skin - if no match is found for current
- * // skin, 'default' is used - if default doesn't exist nothing is added
- * 'themes' => array(
- * 'default' => 'resources/foo/themes/default/foo.css',
- * 'vector' => 'resources/foo/themes/vector.foo.css',
- * ),
+ * // List of style-sheets or lists of style-sheets to include based on the skin - if no match is found for current
+ * // skin, 'default' is used - if default doesn't exist nothing is added
+ * 'themes' => array(
+ * 'default' => 'resources/foo/themes/default/foo.css',
+ * 'vector' => 'resources/foo/themes/vector.foo.css',
+ * ),
* // List of keys of messages to include
* 'messages' => array( 'foo-hello', 'foo-goodbye' ),
* // Subclass of ResourceLoaderModule to use for custom modules
- * 'class' => 'ResourceLoaderSiteJSModule',
+ * 'class' => 'ResourceLoaderSiteJSModule',
* ) );
* @example
* // Responds to a resource loading request
/**
* Runs text through a filter, caching the filtered result for future calls
*
- * @param {string} $filter name of filter to run
- * @param {string} $data text to filter, such as JavaScript or CSS text
- * @param {string} $file path to file being filtered, (optional: only required for CSS to resolve paths)
- * @return {string} filtered data
+ * @param $filter String: name of filter to run
+ * @param $data String: text to filter, such as JavaScript or CSS text
+ * @param $file String: path to file being filtered, (optional: only required for CSS to resolve paths)
+ * @return String: filtered data
*/
protected static function filter( $filter, $data ) {
global $wgMemc;
* Note that registering the same object under multiple names is not supported and may silently fail in all
* kinds of interesting ways.
*
- * @param {mixed} $name string of name of module or array of name/object pairs
- * @param {ResourceLoaderModule} $object module object (optional when using multiple-registration calling style)
- * @return {boolean} false if there were any errors, in which case one or more modules were not registered
+ * @param $name Mixed: string of name of module or array of name/object pairs
+ * @param $object ResourceLoaderModule: module object (optional when using multiple-registration calling style)
+ * @return Boolean: false if there were any errors, in which case one or more modules were not registered
*
* @todo We need much more clever error reporting, not just in detailing what happened, but in bringing errors to
* the client in a way that they can easily see them if they want to, such as by using FireBug
/**
* Gets a map of all modules and their options
*
- * @return {array} array( modulename => ResourceLoaderModule )
+ * @return Array: array( modulename => ResourceLoaderModule )
*/
public static function getModules() {
return self::$modules;
/**
* Get the ResourceLoaderModule object for a given module name
- * @param $name string Module name
+ *
+ * @param $name String: module name
* @return mixed ResourceLoaderModule or null if not registered
*/
public static function getModule( $name ) {
/**
* Gets registration code for all modules, except pre-registered ones listed in self::$preRegisteredModules
*
- * The $lang, $skin and $debug parameters are used to calculate the last modified timestamps for each
- * module.
- * @param $lang string Language code
- * @param $skin string Skin name
- * @param $debug bool Debug mode flag
- * @return {string} JavaScript code for registering all modules with the client loader
+ * @param $context ResourceLoaderContext object
+ * @return String: JavaScript code for registering all modules with the client loader
*/
public static function getModuleRegistrations( ResourceLoaderContext $context ) {
$scripts = '';
/**
* Get the highest modification time of all modules, based on a given combination of language code,
* skin name and debug mode flag.
- * @param $lang string Language code
- * @param $skin string Skin name
- * @param $debug bool Debug mode flag
- * @return int UNIX timestamp
+ *
+ * @param $context ResourceLoaderContext object
+ * @return Integer: UNIX timestamp
*/
public static function getHighestModifiedTime( ResourceLoaderContext $context ) {
$time = 1; // wfTimestamp() treats 0 as 'now', so that's not a suitable choice
return $time;
}
- /* Methods */
-
- /*
+ /**
* Outputs a response to a resource load-request, including a content-type header
*
- * @param {WebRequest} $request web request object to respond to
- * @param {string} $server web-accessible path to script server
- *
- * $options format:
- * array(
- * 'lang' => [string: language code, optional, code of default language by default],
- * 'skin' => [string: name of skin, optional, name of default skin by default],
- * 'dir' => [string: 'ltr' or 'rtl', optional, direction of lang by default],
- * 'debug' => [boolean: true to include debug-only scripts, optional, false by default],
- * 'only' => [string: 'scripts', 'styles' or 'messages', optional, if set only get part of the requested module]
- * )
+ * @param $context ResourceLoaderContext object
*/
public static function respond( ResourceLoaderContext $context ) {
// Split requested modules into two groups, modules and missing
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
+ * @file
* @author Trevor Parscal
* @author Roan Kattouw
*/
/**
* Get this module's name. This is set when the module is registered
* with ResourceLoader::register()
- * @return mixed Name (string) or null if no name was set
+ *
+ * @return Mixed: name (string) or null if no name was set
*/
public function getName() {
return $this->name;
/**
* Set this module's name. This is called by ResourceLodaer::register()
* when registering the module. Other code should not call this.
- * @param $name string Name
+ *
+ * @param $name String: name
*/
public function setName( $name ) {
$this->name = $name;
* The maximum number of seconds to cache this module for in the
* client-side (browser) cache. Override this only if you have a good
* reason not to use $wgResourceLoaderClientMaxage.
- * @return int Cache maxage in seconds
+ *
+ * @return Integer: cache maxage in seconds
*/
public function getClientMaxage() {
global $wgResourceLoaderClientMaxage;
* The maximum number of seconds to cache this module for in the
* server-side (Squid / proxy) cache. Override this only if you have a
* good reason not to use $wgResourceLoaderServerMaxage.
- * @return int Cache maxage in seconds
+ *
+ * @return Integer: cache maxage in seconds
*/
public function getServerMaxage() {
global $wgResourceLoaderServerMaxage;
/**
* Get all JS for this module for a given language and skin.
* Includes all relevant JS except loader scripts.
- * @param $lang string Language code
- * @param $skin string Skin name
- * @param $debug bool Whether to include debug scripts
- * @return string JS
+ *
+ * @param $context ResourceLoaderContext object
+ * @return String: JS
*/
public abstract function getScript( ResourceLoaderContext $context );
/**
* Get all CSS for this module for a given skin.
- * @param $skin string Skin name
- * @return string CSS
+ *
+ * @param $context ResourceLoaderContext object
+ * @return String: CSS
*/
public abstract function getStyle( ResourceLoaderContext $context );
* Get the messages needed for this module.
*
* To get a JSON blob with messages, use MessageBlobStore::get()
+ *
* @return array of message keys. Keys may occur more than once
*/
public abstract function getMessages();
/**
* Get the loader JS for this module, if set.
- * @return mixed Loader JS (string) or false if no custom loader set
+ *
+ * @return Mixed: loader JS (string) or false if no custom loader set
*/
public abstract function getLoaderScript();
*
* To add dependencies dynamically on the client side, use a custom
* loader script, see getLoaderScript()
- * @return array Array of module names (strings)
+ * @return Array of module names (strings)
*/
public abstract function getDependencies();
* the highest of each of the relevant components' modification
* timestamps. Whenever anything happens that changes the module's
* contents for these parameters, the mtime should increase.
- * @param $lang string Language code
- * @param $skin string Skin name
- * @param $debug bool Debug mode flag
+ *
+ * @param $context ResourceLoaderContext object
* @return int UNIX timestamp
*/
public abstract function getModifiedTime( ResourceLoaderContext $context );
/**
* Add script files to this module. In order to be valid, a module
* must contain at least one script file.
- * @param $scripts mixed Path to script file (string) or array of paths
+ *
+ * @param $scripts Mixed: path to script file (string) or array of paths
*/
public function addScripts( $scripts ) {
$this->scripts = array_merge( $this->scripts, (array)$scripts );
/**
* Add style (CSS) files to this module.
- * @param $styles mixed Path to CSS file (string) or array of paths
+ *
+ * @param $styles Mixed: path to CSS file (string) or array of paths
*/
public function addStyles( $styles ) {
$this->styles = array_merge( $this->styles, (array)$styles );
/**
* Add messages to this module.
- * @param $messages mixed Message key (string) or array of message keys
+ *
+ * @param $messages Mixed: message key (string) or array of message keys
*/
public function addMessages( $messages ) {
$this->messages = array_merge( $this->messages, (array)$messages );
* To add dependencies dynamically on the client side, use a custom
* loader (see addLoaders())
*
- * @param $dependencies mixed Module name (string) or array of module names
+ * @param $dependencies Mixed: module name (string) or array of module names
*/
public function addDependencies( $dependencies ) {
$this->dependencies = array_merge( $this->dependencies, (array)$dependencies );
/**
* Add debug scripts to the module. These scripts are only included
* in debug mode.
- * @param $scripts mixed Path to script file (string) or array of paths
+ *
+ * @param $scripts Mixed: path to script file (string) or array of paths
*/
public function addDebugScripts( $scripts ) {
$this->debugScripts = array_merge( $this->debugScripts, (array)$scripts );
/**
* Add language-specific scripts. These scripts are only included for
* a given language.
- * @param $lang string Language code
- * @param $scripts mixed Path to script file (string) or array of paths
+ *
+ * @param $lang String: language code
+ * @param $scripts Mixed: path to script file (string) or array of paths
*/
public function addLanguageScripts( $lang, $scripts ) {
$this->languageScripts = array_merge_recursive(
/**
* Add skin-specific scripts. These scripts are only included for
* a given skin.
- * @param $skin string Skin name, or 'default'
- * @param $scripts mixed Path to script file (string) or array of paths
+ *
+ * @param $skin String: skin name, or 'default'
+ * @param $scripts Mixed: path to script file (string) or array of paths
*/
public function addSkinScripts( $skin, $scripts ) {
$this->skinScripts = array_merge_recursive(
* Add skin-specific CSS. These CSS files are only included for a
* given skin. If there are no skin-specific CSS files for a skin,
* the files defined for 'default' will be used, if any.
- * @param $skin string Skin name, or 'default'
- * @param $scripts mixed Path to CSS file (string) or array of paths
+ *
+ * @param $skin String: skin name, or 'default'
+ * @param $scripts Mixed: path to CSS file (string) or array of paths
*/
public function addSkinStyles( $skin, $scripts ) {
$this->skinStyles = array_merge_recursive(
* Note that loader scripts are included on every page, so they should
* be lightweight and use mediaWiki.loader.register()'s callback
* feature to defer dependency calculation.
- * @param $scripts mixed Path to script file (string) or array of paths
+ *
+ * @param $scripts Mixed: path to script file (string) or array of paths
*/
public function addLoaders( $scripts ) {
$this->loaders = array_merge( $this->loaders, (array)$scripts );
* relevant to the given language and skin are taken into account, and
* files only relevant in debug mode are not taken into account when
* debug mode is off.
- * @param $lang string Language code
- * @param $skin string Skin name
- * @param $debug bool Debug mode flag
- * @return int UNIX timestamp
+ *
+ * @param $context ResourceLoaderContext object
+ * @return Integer: UNIX timestamp
*/
public function getModifiedTime( ResourceLoaderContext $context ) {
if ( isset( $this->modifiedTime[$context->getHash()] ) ) {
/**
* Get the primary JS for this module. This is pulled from the
* script files added through addScripts()
- * @return string JS
+ *
+ * @return String: JS
*/
protected function getPrimaryScript() {
return self::concatScripts( $this->scripts );
/**
* Get the primary CSS for this module. This is pulled from the CSS
* files added through addStyles()
- * @return string JS
+ *
+ * @return String: JS
*/
protected function getPrimaryStyle() {
return self::concatStyles( $this->styles );
/**
* Get the debug JS for this module. This is pulled from the script
* files added through addDebugScripts()
- * @return string JS
+ *
+ * @return String: JS
*/
protected function getDebugScript() {
return self::concatScripts( $this->debugScripts );
/**
* Get the language-specific JS for a given language. This is pulled
* from the language-specific script files added through addLanguageScripts()
- * @return string JS
+ *
+ * @return String: JS
*/
protected function getLanguageScript( $lang ) {
if ( !isset( $this->languageScripts[$lang] ) ) {
/**
* Get the skin-specific JS for a given skin. This is pulled from the
* skin-specific JS files added through addSkinScripts()
- * @return string JS
+ *
+ * @return String: JS
*/
protected function getSkinScript( $skin ) {
return self::concatScripts( self::getSkinFiles( $skin, $this->skinScripts ) );
/**
* Get the skin-specific CSS for a given skin. This is pulled from the
* skin-specific CSS files added through addSkinStyles()
- * @return string CSS
+ *
+ * @return String: CSS
*/
protected function getSkinStyle( $skin ) {
return self::concatStyles( self::getSkinFiles( $skin, $this->skinStyles ) );
/**
* Helper function to get skin-specific data from an array.
- * @param $skin string Skin name
- * @param $map array Map of skin names to arrays
+ *
+ * @param $skin String: skin name
+ * @param $map Array: map of skin names to arrays
* @return $map[$skin] if set and non-empty, or $map['default'] if set, or an empty array
*/
protected static function getSkinFiles( $skin, $map ) {
/**
* Get the files this module depends on indirectly for a given skin.
* Currently these are only image files referenced by the module's CSS.
- * @param $skin string Skin name
+ *
+ * @param $skin String: skin name
* @return array of files
*/
protected function getFileDependencies( $skin ) {
/**
* Get the contents of a set of files and concatenate them, with
* newlines in between. Each file is used only once.
- * @param $files array Array of file names
- * @return string Concatenated contents of $files
+ *
+ * @param $files Array of file names
+ * @return String: concatenated contents of $files
*/
protected static function concatScripts( $files ) {
return implode( "\n", array_map( 'file_get_contents', array_map( array( __CLASS__, 'remapFilename' ), array_unique( (array) $files ) ) ) );
/**
* Get the contents of a set of CSS files, remap then and concatenate
* them, with newlines in between. Each file is used only once.
- * @param $files array Array of file names
- * @return string Concatenated and remapped contents of $files
+ *
+ * @param $files Array of file names
+ * @return String: concatenated and remapped contents of $files
*/
protected static function concatStyles( $files ) {
return implode( "\n", array_map( array( __CLASS__, 'remapStyle' ), array_unique( (array) $files ) ) );
/**
* Remap a relative to $IP. Used as a callback for array_map()
- * @param $file string File name
+ *
+ * @param $file String: file name
* @return string $IP/$file
*/
protected static function remapFilename( $file ) {
/**
* Get the contents of a CSS file and run it through CSSMin::remap().
* This wrapper is needed so we can use array_map() in concatStyles()
- * @param $file string File name
+ *
+ * @param $file String: file name
* @return string Remapped CSS
*/
protected static function remapStyle( $file ) {
dépôts / lhc / web / wiklou.git / commitdiff