MediaWiki  1.34.0
GadgetResourceLoaderModule Class Reference

Class representing a list of resources for one gadget, basically a wrapper around the Gadget class. More...

Inheritance diagram for GadgetResourceLoaderModule:
Collaboration diagram for GadgetResourceLoaderModule:

Public Member Functions

 __construct (array $options)
 
 getDependencies (ResourceLoaderContext $context=null)
 Overrides ResourceLoaderModule::getDependencies() More...
 
 getGroup ()
 Get group name. More...
 
 getMessages ()
 Get the messages needed for this module. More...
 
 getTargets ()
 Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']. More...
 
 getType ()
 Overrides ResourceLoaderWikiModule::getType() More...
 
- Public Member Functions inherited from ResourceLoaderWikiModule
 enableModuleContentVersion ()
 Disable module content versioning. More...
 
 getDefinitionSummary (ResourceLoaderContext $context)
 
 getScript (ResourceLoaderContext $context)
 
 getStyles (ResourceLoaderContext $context)
 
 isKnownEmpty (ResourceLoaderContext $context)
 
 shouldEmbedModule (ResourceLoaderContext $context)
 
- Public Member Functions inherited from ResourceLoaderModule
 getConfig ()
 
 getDeprecationInformation (ResourceLoaderContext $context=null)
 Get JS representing deprecation information for the current module if available. More...
 
 getFlip (ResourceLoaderContext $context)
 
 getHeaders (ResourceLoaderContext $context)
 Get headers to send as part of a module web response. More...
 
 getModuleContent (ResourceLoaderContext $context)
 Get an array of this module's resources. More...
 
 getName ()
 Get this module's name. More...
 
 getOrigin ()
 Get this module's origin. More...
 
 getScriptURLsForDebug (ResourceLoaderContext $context)
 Get the URL or URLs to load for this module's JS in debug mode. More...
 
 getSkipFunction ()
 Get the skip function. More...
 
 getSource ()
 Get the source of this module. More...
 
 getStyleURLsForDebug (ResourceLoaderContext $context)
 Get the URL or URLs to load for this module's CSS in debug mode. More...
 
 getTemplates ()
 Takes named templates by the module and returns an array mapping. More...
 
 getVersionHash (ResourceLoaderContext $context)
 Get a string identifying the current version of this module in a given context. More...
 
 setConfig (Config $config)
 
 setFileDependencies (ResourceLoaderContext $context, $files)
 Set in-object cache for file dependencies. More...
 
 setLogger (LoggerInterface $logger)
 
 setMessageBlob ( $blob, $lang)
 Set in-object cache for message blobs. More...
 
 setName ( $name)
 Set this module's name. More...
 
 supportsURLLoading ()
 Whether this module supports URL loading. More...
 

Protected Member Functions

 getPages (ResourceLoaderContext $context)
 Overrides the function from ResourceLoaderWikiModule class. More...
 
- Protected Member Functions inherited from ResourceLoaderWikiModule
 getContent ( $titleText, ResourceLoaderContext $context)
 
 getContentObj (Title $title, ResourceLoaderContext $context, $maxRedirects=null)
 
 getDB ()
 Get the Database handle used for computing the module version. More...
 
 getTitleInfo (ResourceLoaderContext $context)
 Get the information about the wiki pages for a given context. More...
 
- Protected Member Functions inherited from ResourceLoaderModule
 buildContent (ResourceLoaderContext $context)
 Bundle all resources attached to this module into an array. More...
 
 getFileDependencies (ResourceLoaderContext $context)
 Get the files this module depends on indirectly for a given skin. More...
 
 getLessVars (ResourceLoaderContext $context)
 Get module-specific LESS variables, if any. More...
 
 getLogger ()
 
 getMessageBlob (ResourceLoaderContext $context)
 Get the hash of the message blob. More...
 
 getPreloadLinks (ResourceLoaderContext $context)
 Get a list of resources that web browsers may preload. More...
 
 saveFileDependencies (ResourceLoaderContext $context, $localFileRefs)
 Set the files this module depends on indirectly for a given skin. More...
 
 validateScriptFile ( $fileName, $contents)
 Validate a given script file; if valid returns the original source. More...
 

Private Member Functions

 getGadget ()
 

Private Attributes

Gadget $gadget
 
string $id
 

Additional Inherited Members

- Static Public Member Functions inherited from ResourceLoaderWikiModule
static invalidateModuleCache (Title $title, Revision $old=null, Revision $new=null, $domain)
 Clear the preloadTitleInfo() cache for all wiki modules on this wiki on page change if it was a JS or CSS page. More...
 
static preloadTitleInfo (ResourceLoaderContext $context, IDatabase $db, array $moduleNames)
 
- Static Public Member Functions inherited from ResourceLoaderModule
static expandRelativePaths (array $filePaths)
 Expand directories relative to $IP. More...
 
static getRelativePaths (array $filePaths)
 Make file paths relative to MediaWiki directory. More...
 
static getVary (ResourceLoaderContext $context)
 Get vary string. More...
 
- Static Protected Member Functions inherited from ResourceLoaderWikiModule
static fetchTitleInfo (IDatabase $db, array $pages, $fname=__METHOD__)
 
- Static Protected Member Functions inherited from ResourceLoaderModule
static javaScriptParser ()
 
static safeFileHash ( $filePath)
 Compute a non-cryptographic string hash of a file's contents. More...
 
static safeFilemtime ( $filePath)
 Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist. More...
 
- Protected Attributes inherited from ResourceLoaderWikiModule
 $group
 
 $origin = self::ORIGIN_USER_SITEWIDE
 
 $scripts = []
 
 $styles = []
 
 $titleInfo = []
 
- Protected Attributes inherited from ResourceLoaderModule
Config $config
 
array $contents = []
 Map of (context hash => cached module content) More...
 
string bool $deprecated = false
 Deprecation string or true if deprecated; false otherwise. More...
 
array $fileDeps = []
 Map of (variant => indirect file dependencies) More...
 
LoggerInterface $logger
 
array $msgBlobs = []
 Map of (language => in-object cache for message blob) More...
 
string null $name = null
 Module name. More...
 
int $origin = self::ORIGIN_CORE_SITEWIDE
 Script and style modules form a hierarchy of trustworthiness, with core modules like skins and jQuery as most trustworthy, and user scripts as least trustworthy. More...
 
string[] $targets = [ 'desktop' ]
 What client platforms the module targets (e.g. More...
 
array $versionHash = []
 Map of (context hash => cached module version hash) More...
 

Detailed Description

Class representing a list of resources for one gadget, basically a wrapper around the Gadget class.

Definition at line 7 of file GadgetResourceLoaderModule.php.

Constructor & Destructor Documentation

◆ __construct()

GadgetResourceLoaderModule::__construct ( array  $options)
Parameters
array$options

Reimplemented from ResourceLoaderWikiModule.

Definition at line 21 of file GadgetResourceLoaderModule.php.

Member Function Documentation

◆ getDependencies()

GadgetResourceLoaderModule::getDependencies ( ResourceLoaderContext  $context = null)

Overrides ResourceLoaderModule::getDependencies()

Parameters
ResourceLoaderContext | null$context
Returns
string[] Names of resources this module depends on

Reimplemented from ResourceLoaderModule.

Definition at line 68 of file GadgetResourceLoaderModule.php.

References getGadget().

◆ getGadget()

GadgetResourceLoaderModule::getGadget ( )
private
Returns
Gadget instance this module is about

Definition at line 28 of file GadgetResourceLoaderModule.php.

References $gadget, Gadget\newEmptyGadget(), and GadgetRepo\singleton().

Referenced by getDependencies(), getMessages(), getPages(), getTargets(), and getType().

◆ getGroup()

GadgetResourceLoaderModule::getGroup ( )

Get group name.

Returns
string

Reimplemented from ResourceLoaderWikiModule.

Definition at line 90 of file GadgetResourceLoaderModule.php.

◆ getMessages()

GadgetResourceLoaderModule::getMessages ( )

Get the messages needed for this module.

To get a JSON blob with messages, use MessageBlobStore::get()

Returns
array List of message keys. Keys may occur more than once

Reimplemented from ResourceLoaderModule.

Definition at line 82 of file GadgetResourceLoaderModule.php.

References getGadget().

◆ getPages()

GadgetResourceLoaderModule::getPages ( ResourceLoaderContext  $context)
protected

Overrides the function from ResourceLoaderWikiModule class.

Parameters
ResourceLoaderContext$context
Returns
array

Reimplemented from ResourceLoaderWikiModule.

Definition at line 46 of file GadgetResourceLoaderModule.php.

References $gadget, getGadget(), Gadget\getScripts(), Gadget\getStyles(), and Gadget\supportsResourceLoader().

◆ getTargets()

GadgetResourceLoaderModule::getTargets ( )

Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile'].

Returns
array Array of strings

Reimplemented from ResourceLoaderModule.

Definition at line 86 of file GadgetResourceLoaderModule.php.

References getGadget().

◆ getType()

GadgetResourceLoaderModule::getType ( )

Overrides ResourceLoaderWikiModule::getType()

Returns
string ResourceLoaderModule::LOAD_STYLES or ResourceLoaderModule::LOAD_GENERAL

Reimplemented from ResourceLoaderWikiModule.

Definition at line 76 of file GadgetResourceLoaderModule.php.

References getGadget().

Member Data Documentation

◆ $gadget

Gadget GadgetResourceLoaderModule::$gadget
private

Definition at line 16 of file GadgetResourceLoaderModule.php.

Referenced by getGadget(), and getPages().

◆ $id

string GadgetResourceLoaderModule::$id
private

Definition at line 11 of file GadgetResourceLoaderModule.php.


The documentation for this class was generated from the following file: