MediaWiki\ResourceLoader\UserOptionsModule Class Reference
Module for per-user private data that is transmitted on all HTML web responses. More...
Inherits MediaWiki\ResourceLoader\Module.
Collaboration diagram for MediaWiki\ResourceLoader\UserOptionsModule:
Public Member Functions | |
| getGroup () | |
| getScript (Context $context) | |
| supportsURLLoading () | |
 Public Member Functions inherited from MediaWiki\ResourceLoader\Module | |
| enableModuleContentVersion () | |
| Whether to generate version hash based on module content. | |
| getConfig () | |
| getDefinitionSummary (Context $context) | |
| Get the definition summary for this module. | |
| getDependencies (Context $context=null) | |
| Get a list of modules this module depends on. | |
| 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. | |
| getStyles (Context $context) | |
| Get all CSS for this module for a given skin. | |
| 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. | |
| getType () | |
| Get the module's load type. | |
| getVersionHash (Context $context) | |
| Get a string identifying the current version of this module in a given context. | |
| isKnownEmpty (Context $context) | |
| Check whether this module is known to be empty. | |
| 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. | |
| shouldEmbedModule (Context $context) | |
| Check whether this module should be embedded rather than linked. | |
Protected Attributes | |
| $origin = self::ORIGIN_CORE_INDIVIDUAL | |
| 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\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\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\Module | |
| static | safeFileHash ( $filePath) |
| Compute a non-cryptographic string hash of a file's contents. | |
Detailed Description
Module for per-user private data that is transmitted on all HTML web responses.
This module is embedded by ClientHtml and sent to the browser by OutputPage as part of the HTML <head>.
- Access: internal
Definition at line 38 of file UserOptionsModule.php.
Member Function Documentation
◆ getGroup()
| MediaWiki\ResourceLoader\UserOptionsModule::getGroup | ( | ) |
- Returns
- string
Reimplemented from MediaWiki\ResourceLoader\Module.
Definition at line 88 of file UserOptionsModule.php.
◆ getScript()
| MediaWiki\ResourceLoader\UserOptionsModule::getScript | ( | Context | $context | ) |
- Parameters
-
Context $context
- Returns
- string JavaScript code
Reimplemented from MediaWiki\ResourceLoader\Module.
Definition at line 46 of file UserOptionsModule.php.
References MediaWiki\ResourceLoader\Context\encodeJson(), MediaWiki\ResourceLoader\Module\getHookRunner(), MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\ResourceLoader\Context\getUserObj().
◆ supportsURLLoading()
| MediaWiki\ResourceLoader\UserOptionsModule::supportsURLLoading | ( | ) |
- Returns
- bool
Reimplemented from MediaWiki\ResourceLoader\Module.
Definition at line 81 of file UserOptionsModule.php.
Member Data Documentation
◆ $origin
|
protected |
Definition at line 40 of file UserOptionsModule.php.
The documentation for this class was generated from the following file:
- includes/ResourceLoader/UserOptionsModule.php
