MediaWiki  1.23.6
ResourceLoaderUserTokensModule Class Reference

Module for user tokens. More...

Inheritance diagram for ResourceLoaderUserTokensModule:
Collaboration diagram for ResourceLoaderUserTokensModule:

Public Member Functions

 getGroup ()
 
 getScript (ResourceLoaderContext $context)
 
 supportsURLLoading ()
 
- Public Member Functions inherited from ResourceLoaderModule
 getDefinitionMtime (ResourceLoaderContext $context)
 Helper method for calculating when this module's definition summary was last changed. More...
 
 getDefinitionSummary (ResourceLoaderContext $context)
 Get the definition summary for this module. More...
 
 getDependencies ()
 Get a list of modules this module depends on. More...
 
 getFileDependencies ( $skin)
 Get the files this module depends on indirectly for a given skin. More...
 
 getFlip ( $context)
 
 getHashMtime (ResourceLoaderContext $context)
 Helper method for calculating when the module's hash (if it has one) changed. More...
 
 getLoaderScript ()
 Get the loader JS for this module, if set. More...
 
 getMessages ()
 Get the messages needed for this module. More...
 
 getModifiedHash (ResourceLoaderContext $context)
 Get the hash for whatever this module may contain. More...
 
 getModifiedTime (ResourceLoaderContext $context)
 Get this module's last modification timestamp for a given combination of language, skin and debug mode flag. More...
 
 getMsgBlobMtime ( $lang)
 Get the last modification timestamp of the message blob for this module in a given language. More...
 
 getName ()
 Get this module's name. More...
 
 getOrigin ()
 Get this module's origin. More...
 
 getPosition ()
 Where on the HTML page should this module's JS be loaded? More...
 
 getScriptURLsForDebug (ResourceLoaderContext $context)
 Get the URL or URLs to load for this module's JS in debug mode. More...
 
 getSource ()
 Get the origin of this module. More...
 
 getStyles (ResourceLoaderContext $context)
 Get all CSS for this module for a given skin. More...
 
 getStyleURLsForDebug (ResourceLoaderContext $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...
 
 isKnownEmpty (ResourceLoaderContext $context)
 Check whether this module is known to be empty. More...
 
 isRaw ()
 Whether this module's JS expects to work without the client-side ResourceLoader module. More...
 
 setFileDependencies ( $skin, $deps)
 Set preloaded file dependency information. More...
 
 setMsgBlobMtime ( $lang, $mtime)
 Set a preloaded message blob last modification timestamp. More...
 
 setName ( $name)
 Set this module's name. More...
 
 setOrigin ( $origin)
 Set this module's origin. More...
 

Protected Member Functions

 contextUserTokens ()
 Fetch the tokens for the current user. More...
 
- Protected Member Functions inherited from ResourceLoaderModule
 validateScriptFile ( $fileName, $contents)
 Validate a given script file; if valid returns the original source. More...
 

Protected Attributes

 $origin = self::ORIGIN_CORE_INDIVIDUAL
 
 $targets = array( 'desktop', 'mobile' )
 
- Protected Attributes inherited from ResourceLoaderModule
 $fileDeps = array()
 
 $msgBlobMtime = array()
 
 $name = null
 
 $origin = self::ORIGIN_CORE_SITEWIDE
 
 $targets = array( 'desktop' )
 

Additional Inherited Members

- Public Attributes inherited from ResourceLoaderModule
const ORIGIN_ALL = 10
 
const ORIGIN_CORE_INDIVIDUAL = 2
 
const ORIGIN_CORE_SITEWIDE = 1
 
const ORIGIN_USER_INDIVIDUAL = 4
 
const ORIGIN_USER_SITEWIDE = 3
 
const TYPE_COMBINED = 'combined'
 
const TYPE_MESSAGES = 'messages'
 
const TYPE_SCRIPTS = 'scripts'
 
const TYPE_STYLES = 'styles'
 
- Static Protected Member Functions inherited from ResourceLoaderModule
static javaScriptParser ()
 
static safeFilemtime ( $filename)
 Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist but returns 1 instead. More...
 

Detailed Description

Module for user tokens.

Definition at line 27 of file ResourceLoaderUserTokensModule.php.

Member Function Documentation

◆ contextUserTokens()

ResourceLoaderUserTokensModule::contextUserTokens ( )
protected

Fetch the tokens for the current user.

Returns
array: List of tokens keyed by token type

Definition at line 42 of file ResourceLoaderUserTokensModule.php.

References $wgUser, array(), ApiQueryRecentChanges\getPatrolToken(), ApiQueryInfo\getWatchToken(), and global.

Referenced by getScript().

◆ getGroup()

ResourceLoaderUserTokensModule::getGroup ( )
Returns
string

Reimplemented from ResourceLoaderModule.

Definition at line 73 of file ResourceLoaderUserTokensModule.php.

◆ getScript()

ResourceLoaderUserTokensModule::getScript ( ResourceLoaderContext  $context)
Parameters
$contextResourceLoaderContext
Returns
string

Reimplemented from ResourceLoaderModule.

Definition at line 56 of file ResourceLoaderUserTokensModule.php.

References array(), contextUserTokens(), Xml\encodeJsCall(), and ResourceLoader\inDebugMode().

◆ supportsURLLoading()

ResourceLoaderUserTokensModule::supportsURLLoading ( )
Returns
bool

Reimplemented from ResourceLoaderModule.

Definition at line 66 of file ResourceLoaderUserTokensModule.php.

Member Data Documentation

◆ $origin

ResourceLoaderUserTokensModule::$origin = self::ORIGIN_CORE_INDIVIDUAL
protected

Definition at line 31 of file ResourceLoaderUserTokensModule.php.

◆ $targets

ResourceLoaderUserTokensModule::$targets = array( 'desktop', 'mobile' )
protected

Definition at line 33 of file ResourceLoaderUserTokensModule.php.


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