MediaWiki\ResourceLoader\SiteModule Class Reference
Module for site customizations. More...
Inherits MediaWiki\ResourceLoader\WikiModule.
Collaboration diagram for MediaWiki\ResourceLoader\SiteModule:
Public Member Functions | |
| getDependencies (Context $context=null) | |
 Public Member Functions inherited from MediaWiki\ResourceLoader\WikiModule | |
| __construct (array $options=null) | |
| enableModuleContentVersion () | |
| Disable module content versioning. | |
| getDefinitionSummary (Context $context) | |
| getGroup () | |
| Get group name. | |
| getScript (Context $context) | |
| getStyles (Context $context) | |
| getType () | |
| isKnownEmpty (Context $context) | |
| shouldEmbedModule (Context $context) | |
| supportsURLLoading () | |
| Public Member Functions inherited from MediaWiki\ResourceLoader\Module | |
| getConfig () | |
| getDeprecationInformation (Context $context) | |
| Get JS representing deprecation information for the current module if available. | |
| getFlip (Context $context) | |
| getHeaders (Context $context) | |
| Get headers to send as part of a module web response. | |
| getMessages () | |
| Get the messages needed for this module. | |
| getModuleContent (Context $context) | |
| Get an array of this module's resources. | |
| getName () | |
| Get this module's name. | |
| getOrigin () | |
| Get this module's origin. | |
| getScriptURLsForDebug (Context $context) | |
| Get alternative script URLs for legacy debug mode. | |
| getSkins () | |
| Get list of skins for which this module must be available to load. | |
| getSkipFunction () | |
| Get the skip function. | |
| getSource () | |
| Get the source of this module. | |
| getStyleURLsForDebug (Context $context) | |
| Get the URL or URLs to load for this module's CSS in debug mode. | |
| getTargets () | |
| Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']. | |
| getTemplates () | |
| Takes named templates by the module and returns an array mapping. | |
| getVersionHash (Context $context) | |
| Get a string identifying the current version of this module in a given context. | |
| requiresES6 () | |
| Whether the module requires ES6 support in the client. | |
| setConfig (Config $config) | |
| setDependencyAccessCallbacks (callable $loadCallback, callable $saveCallback) | |
| Inject the functions that load/save the indirect file path dependency list from storage. | |
| setFileDependencies (Context $context, array $paths) | |
| Set the indirect dependencies for this module pursuant to the skin/language context. | |
| setHookContainer (HookContainer $hookContainer) | |
| setLogger (LoggerInterface $logger) | |
| setMessageBlob ( $blob, $lang) | |
| Set in-object cache for message blobs. | |
| setName ( $name) | |
| Set this module's name. | |
| setSkinStylesOverride (array $moduleSkinStyles) | |
| Provide overrides for skinStyles to modules that support that. | |
Public Attributes | |
| if( $this->getConfig() ->get(MainConfigNames::UseSiteJs)) return | $pages |
Protected Attributes | |
| function getPages Context string[] | $context |
| Get list of pages used by this module. | |
| Protected Attributes inherited from MediaWiki\ResourceLoader\WikiModule | |
| array | $datas = [] |
| List of page names that contain JSON. | |
| string null | $group |
| Group of module. | |
| string | $origin = self::ORIGIN_USER_SITEWIDE |
| Origin defaults to users with sitewide authority. | |
| array | $scripts = [] |
| List of page names that contain JavaScript. | |
| array | $styles = [] |
| List of page names that contain CSS. | |
| array | $titleInfo = [] |
| In-process cache for title info, structured as an array [ <batchKey> // Pipe-separated list of sorted keys from getPages => [ <titleKey> => [ // Normalised title key 'page_len' => .., 'page_latest' => .., 'page_touched' => .., ] ] ]. | |
| Protected Attributes inherited from MediaWiki\ResourceLoader\Module | |
| Config | $config |
| array | $contents = [] |
| Map of (context hash => cached module content) | |
| string bool | $deprecated = false |
| Deprecation string or true if deprecated; false otherwise. | |
| array | $fileDeps = [] |
| Map of (variant => indirect file dependencies) | |
| LoggerInterface | $logger |
| array | $msgBlobs = [] |
| Map of (language => in-object cache for message blob) | |
| string null | $name = null |
| Module name. | |
| 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. | |
| string[] null | $skins = null |
| Skin names. | |
| string[] | $targets = [ 'desktop', 'mobile' ] |
| What client platforms the module targets (e.g. | |
| array | $versionHash = [] |
| Map of (context hash => cached module version hash) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from MediaWiki\ResourceLoader\WikiModule | |
| static | invalidateModuleCache (PageIdentity $page, ?RevisionRecord $old, ?RevisionRecord $new, string $domain) |
| Clear the preloadTitleInfo() cache for all wiki modules on this wiki on page change if it was a JS or CSS page. | |
| static | preloadTitleInfo (Context $context, IDatabase $db, array $moduleNames) |
| Static Public Member Functions inherited from MediaWiki\ResourceLoader\Module | |
| static | expandRelativePaths (array $filePaths) |
| Expand directories relative to $IP. | |
| static | getRelativePaths (array $filePaths) |
| Make file paths relative to MediaWiki directory. | |
| static | getVary (Context $context) |
| Get vary string. | |
| Protected Member Functions inherited from MediaWiki\ResourceLoader\WikiModule | |
| getContent ( $titleText, Context $context) | |
| getContentObj (PageIdentity $page, Context $context, $maxRedirects=1) | |
| getDB () | |
| Get the Database handle used for computing the module version. | |
| getPages (Context $context) | |
| Subclasses should return an associative array of resources in the module. | |
| getRequireKey (string $titleText) | |
| Convert a namespace-formatted page title to a virtual package file name. | |
| getTitleInfo (Context $context) | |
| Get the information about the wiki pages for a given context. | |
| isPackaged () | |
| Get whether this module is a packaged module. | |
| Protected Member Functions inherited from MediaWiki\ResourceLoader\Module | |
| buildContent (Context $context) | |
| Bundle all resources attached to this module into an array. | |
| getFileDependencies (Context $context) | |
| Get the indirect dependencies for this module pursuant to the skin/language context. | |
| getHookRunner () | |
| Get a HookRunner for running core hooks. | |
| getLessVars (Context $context) | |
| Get module-specific LESS variables, if any. | |
| getLogger () | |
| getMessageBlob (Context $context) | |
| Get the hash of the message blob. | |
| getPreloadLinks (Context $context) | |
| Get a list of resources that web browsers may preload. | |
| saveFileDependencies (Context $context, array $curFileRefs) | |
| Save the indirect dependencies for this module pursuant to the skin/language context. | |
| validateScriptFile ( $fileName, $contents) | |
| Validate a user-provided JavaScript blob. | |
| Static Protected Member Functions inherited from MediaWiki\ResourceLoader\WikiModule | |
| static | fetchTitleInfo (IReadableDatabase $db, array $pages, $fname=__METHOD__) |
| Static Protected Member Functions inherited from MediaWiki\ResourceLoader\Module | |
| static | safeFileHash ( $filePath) |
| Compute a non-cryptographic string hash of a file's contents. | |
Detailed Description
Member Function Documentation
◆ getDependencies()
| MediaWiki\ResourceLoader\SiteModule::getDependencies | ( | Context | $context = null | ) |
- Parameters
-
Context | null $context
- Returns
- array
Reimplemented from MediaWiki\ResourceLoader\Module.
Definition at line 57 of file SiteModule.php.
Member Data Documentation
◆ $context
Initial value:
{
$pages = []
if( $this->getConfig() ->get(MainConfigNames::UseSiteJs)) return $pages
Definition SiteModule.php:44
Get list of pages used by this module.
- Parameters
-
Context $context
- Returns
- array[] What client platforms the module targets (e.g. desktop, mobile)
Definition at line 42 of file SiteModule.php.
◆ $pages
| if ($this->getConfig() ->get(MainConfigNames::UseSiteJs)) return MediaWiki\ResourceLoader\SiteModule::$pages |
Definition at line 50 of file SiteModule.php.
The documentation for this class was generated from the following file:
- includes/ResourceLoader/SiteModule.php
