MediaWiki  master
MediaWiki\ResourceLoader\UserStylesModule Class Reference

Module for user customizations styles. More...

Inheritance diagram for MediaWiki\ResourceLoader\UserStylesModule:
Collaboration diagram for MediaWiki\ResourceLoader\UserStylesModule:

Public Member Functions

 getGroup ()
 Get group name. More...
 
 getType ()
 
- Public Member Functions inherited from MediaWiki\ResourceLoader\WikiModule
 __construct (array $options=null)
 
 enableModuleContentVersion ()
 Disable module content versioning. More...
 
 getDefinitionSummary (Context $context)
 
 getScript (Context $context)
 
 getStyles (Context $context)
 
 isKnownEmpty (Context $context)
 
 shouldEmbedModule (Context $context)
 
 supportsURLLoading ()
 
- Public Member Functions inherited from MediaWiki\ResourceLoader\Module
 getConfig ()
 
 getDependencies (Context $context=null)
 Get a list of modules this module depends on. More...
 
 getDeprecationInformation (Context $context)
 Get JS representing deprecation information for the current module if available. More...
 
 getFlip (Context $context)
 
 getHeaders (Context $context)
 Get headers to send as part of a module web response. More...
 
 getMessages ()
 Get the messages needed for this module. More...
 
 getModuleContent (Context $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 (Context $context)
 Get alternative script URLs for legacy debug mode. More...
 
 getSkins ()
 Get list of skins for which this module must be available to load. More...
 
 getSkipFunction ()
 Get the skip function. More...
 
 getSource ()
 Get the source of this module. More...
 
 getStyleURLsForDebug (Context $context)
 Get the URL or URLs to load for this module's CSS in debug mode. More...
 
 getTargets ()
 Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']. More...
 
 getTemplates ()
 Takes named templates by the module and returns an array mapping. More...
 
 getVersionHash (Context $context)
 Get a string identifying the current version of this module in a given context. More...
 
 requiresES6 ()
 Whether the module requires ES6 support in the client. More...
 
 setConfig (Config $config)
 
 setDependencyAccessCallbacks (callable $loadCallback, callable $saveCallback)
 Inject the functions that load/save the indirect file path dependency list from storage. More...
 
 setFileDependencies (Context $context, array $paths)
 Set the indirect dependencies for this module pursuant to the skin/language context. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLogger (LoggerInterface $logger)
 
 setMessageBlob ( $blob, $lang)
 Set in-object cache for message blobs. More...
 
 setName ( $name)
 Set this module's name. More...
 
 setSkinStylesOverride (array $moduleSkinStyles)
 Provide overrides for skinStyles to modules that support that. More...
 

Protected Member Functions

 getPages (Context $context)
 
- 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. More...
 
 getRequireKey (string $titleText)
 Convert a namespace-formatted page title to a virtual package file name. More...
 
 getTitleInfo (Context $context)
 Get the information about the wiki pages for a given context. More...
 
 isPackaged ()
 Get whether this module is a packaged module. More...
 
- Protected Member Functions inherited from MediaWiki\ResourceLoader\Module
 buildContent (Context $context)
 Bundle all resources attached to this module into an array. More...
 
 getFileDependencies (Context $context)
 Get the indirect dependencies for this module pursuant to the skin/language context. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getLessVars (Context $context)
 Get module-specific LESS variables, if any. More...
 
 getLogger ()
 
 getMessageBlob (Context $context)
 Get the hash of the message blob. More...
 
 getPreloadLinks (Context $context)
 Get a list of resources that web browsers may preload. More...
 
 saveFileDependencies (Context $context, array $curFileRefs)
 Save the indirect dependencies for this module pursuant to the skin/language context. More...
 
 validateScriptFile ( $fileName, $contents)
 Validate a user-provided JavaScript blob. More...
 

Protected Attributes

 $origin = self::ORIGIN_USER_INDIVIDUAL
 
 $targets = [ 'desktop', 'mobile' ]
 
- Protected Attributes inherited from MediaWiki\ResourceLoader\WikiModule
array $datas = []
 List of page names that contain JSON. More...
 
string null $group
 Group of module. More...
 
string $origin = self::ORIGIN_USER_SITEWIDE
 Origin defaults to users with sitewide authority. More...
 
array $scripts = []
 List of page names that contain JavaScript. More...
 
array $styles = []
 List of page names that contain CSS. More...
 
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' => .., ] ] ]. More...
 
- Protected Attributes inherited from MediaWiki\ResourceLoader\Module
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[] null $skins = null
 Skin names. More...
 
string[] $targets = [ 'desktop' ]
 What client platforms the module targets (e.g. More...
 
array $versionHash = []
 Map of (context hash => cached module version hash) More...
 

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. More...
 
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. More...
 
static getRelativePaths (array $filePaths)
 Make file paths relative to MediaWiki directory. More...
 
static getVary (Context $context)
 Get vary string. More...
 
- Static Protected Member Functions inherited from MediaWiki\ResourceLoader\WikiModule
static fetchTitleInfo (IDatabase $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. More...
 

Detailed Description

Module for user customizations styles.

Access: internal

Definition at line 35 of file UserStylesModule.php.

Member Function Documentation

◆ getGroup()

MediaWiki\ResourceLoader\UserStylesModule::getGroup ( )

Get group name.

Returns
string

Reimplemented from MediaWiki\ResourceLoader\WikiModule.

Definition at line 88 of file UserStylesModule.php.

◆ getPages()

◆ getType()

MediaWiki\ResourceLoader\UserStylesModule::getType ( )
Returns
string

Reimplemented from MediaWiki\ResourceLoader\WikiModule.

Definition at line 79 of file UserStylesModule.php.

Member Data Documentation

◆ $origin

MediaWiki\ResourceLoader\UserStylesModule::$origin = self::ORIGIN_USER_INDIVIDUAL
protected

Definition at line 37 of file UserStylesModule.php.

◆ $targets

MediaWiki\ResourceLoader\UserStylesModule::$targets = [ 'desktop', 'mobile' ]
protected

Definition at line 38 of file UserStylesModule.php.


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