MediaWiki REL1_37
|
Module for per-user private data that is transmitted on all HTML web responses. More...
Public Member Functions | |
getDependencies (ResourceLoaderContext $context=null) | |
getGroup () | |
getScript (ResourceLoaderContext $context) | |
supportsURLLoading () | |
Public Member Functions inherited from ResourceLoaderModule | |
enableModuleContentVersion () | |
Whether to generate version hash based on module content. | |
getConfig () | |
getDefinitionSummary (ResourceLoaderContext $context) | |
Get the definition summary for this module. | |
getDeprecationInformation (ResourceLoaderContext $context) | |
Get JS representing deprecation information for the current module if available. | |
getFlip (ResourceLoaderContext $context) | |
getHeaders (ResourceLoaderContext $context) | |
Get headers to send as part of a module web response. | |
getMessages () | |
Get the messages needed for this module. | |
getModuleContent (ResourceLoaderContext $context) | |
Get an array of this module's resources. | |
getName () | |
Get this module's name. | |
getOrigin () | |
Get this module's origin. | |
getScriptURLsForDebug (ResourceLoaderContext $context) | |
Get the URL or URLs to load for this module's JS in debug mode. | |
getSkipFunction () | |
Get the skip function. | |
getSource () | |
Get the source of this module. | |
getStyles (ResourceLoaderContext $context) | |
Get all CSS for this module for a given skin. | |
getStyleURLsForDebug (ResourceLoaderContext $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 (ResourceLoaderContext $context) | |
Get a string identifying the current version of this module in a given context. | |
isKnownEmpty (ResourceLoaderContext $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 (ResourceLoaderContext $context, array $paths) | |
Set the indirect dependencies for this module persuant 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 (ResourceLoaderContext $context) | |
Check whether this module should be embeded rather than linked. | |
Protected Attributes | |
$origin = self::ORIGIN_CORE_INDIVIDUAL | |
$targets = [ 'desktop', 'mobile' ] | |
Protected Attributes inherited from ResourceLoaderModule | |
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[] | $targets = [ 'desktop' ] |
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 ResourceLoaderModule | |
static | expandRelativePaths (array $filePaths) |
Expand directories relative to $IP. | |
static | getRelativePaths (array $filePaths) |
Make file paths relative to MediaWiki directory. | |
static | getVary (ResourceLoaderContext $context) |
Get vary string. | |
Protected Member Functions inherited from ResourceLoaderModule | |
buildContent (ResourceLoaderContext $context) | |
Bundle all resources attached to this module into an array. | |
getFileDependencies (ResourceLoaderContext $context) | |
Get the indirect dependencies for this module persuant to the skin/language context. | |
getHookRunner () | |
Get a HookRunner for running core hooks. | |
getLessVars (ResourceLoaderContext $context) | |
Get module-specific LESS variables, if any. | |
getLogger () | |
getMessageBlob (ResourceLoaderContext $context) | |
Get the hash of the message blob. | |
getPreloadLinks (ResourceLoaderContext $context) | |
Get a list of resources that web browsers may preload. | |
saveFileDependencies (ResourceLoaderContext $context, array $curFileRefs) | |
Save the indirect dependencies for this module persuant to the skin/language context. | |
validateScriptFile ( $fileName, $contents) | |
Validate a user-provided JavaScript blob. | |
Static Protected Member Functions inherited from ResourceLoaderModule | |
static | safeFileHash ( $filePath) |
Compute a non-cryptographic string hash of a file's contents. | |
Module for per-user private data that is transmitted on all HTML web responses.
It is send to the browser from the HTML <head>. See OutputPage.
Definition at line 35 of file ResourceLoaderUserOptionsModule.php.
ResourceLoaderUserOptionsModule::getDependencies | ( | ResourceLoaderContext | $context = null | ) |
ResourceLoaderContext | null | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 44 of file ResourceLoaderUserOptionsModule.php.
ResourceLoaderUserOptionsModule::getGroup | ( | ) |
Reimplemented from ResourceLoaderModule.
Definition at line 83 of file ResourceLoaderUserOptionsModule.php.
ResourceLoaderUserOptionsModule::getScript | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 52 of file ResourceLoaderUserOptionsModule.php.
References $userOptionsLookup, ResourceLoaderContext\encodeJson(), MediaWiki\User\UserOptionsLookup\getOptions(), and ResourceLoaderContext\getUserObj().
ResourceLoaderUserOptionsModule::supportsURLLoading | ( | ) |
Reimplemented from ResourceLoaderModule.
Definition at line 76 of file ResourceLoaderUserOptionsModule.php.
|
protected |
Definition at line 36 of file ResourceLoaderUserOptionsModule.php.
|
protected |
Definition at line 38 of file ResourceLoaderUserOptionsModule.php.