CiteCSSFileModule Class Reference
Inheritance diagram for CiteCSSFileModule:
Collaboration diagram for CiteCSSFileModule:
Public Member Functions | |
| __construct ( $options=[], $localBasePath=null, $remoteBasePath=null) | |
| Constructs a new module from an options array. More... | |
 Public Member Functions inherited from ResourceLoaderFileModule | |
| enableModuleContentVersion () | |
| Disable module content versioning. More... | |
| getAllStyleFiles () | |
| Returns all style files and all skin style files used by this module. More... | |
| getDefinitionSummary (ResourceLoaderContext $context) | |
| Get the definition summary for this module. More... | |
| getDependencies (ResourceLoaderContext $context=null) | |
| Gets list of names of modules this module depends on. More... | |
| getFlip ( $context) | |
| Get whether CSS for this module should be flipped. More... | |
| getGroup () | |
| Gets the name of the group this module should be loaded in. More... | |
| getMessages () | |
| Gets list of message keys used by this module. More... | |
| getScript (ResourceLoaderContext $context) | |
| Gets all scripts for a given context concatenated together. More... | |
| getScriptURLsForDebug (ResourceLoaderContext $context) | |
| getSkipFunction () | |
| Get the skip function. More... | |
| getStyleFiles (ResourceLoaderContext $context) | |
| Get a list of file paths for all styles in this module, in order of proper inclusion. More... | |
| getStyles (ResourceLoaderContext $context) | |
| Get all styles for a given context. More... | |
| getStyleSheetLang ( $path) | |
| Infer the stylesheet language from a stylesheet file path. More... | |
| getStyleURLsForDebug (ResourceLoaderContext $context) | |
| 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... | |
| getType () | |
| Get the module's load type. More... | |
| isRaw () | |
| readStyleFiles (array $styles, $flip, $context=null) | |
| Gets the contents of a list of CSS files. More... | |
| supportsURLLoading () | |
| Public Member Functions inherited from ResourceLoaderModule | |
| getConfig () | |
| getDefinitionMtime (ResourceLoaderContext $context) | |
| Back-compat dummy for old subclass implementations of getModifiedTime(). More... | |
| getHashMtime (ResourceLoaderContext $context) | |
| Back-compat dummy for old subclass implementations of getModifiedTime(). More... | |
| getHeaders (ResourceLoaderContext $context) | |
| Get headers to send as part of a module web response. More... | |
| getModifiedHash (ResourceLoaderContext $context) | |
| Helper method for providing a version hash to getVersionHash(). More... | |
| getModifiedTime (ResourceLoaderContext $context) | |
| Get this module's last modification timestamp for a given context. More... | |
| getName () | |
| Get this module's name. More... | |
| getOrigin () | |
| Get this module's origin. More... | |
| getPosition () | |
| From where in the page HTML should this module be loaded? More... | |
| getSource () | |
| Get the origin of this module. More... | |
| isKnownEmpty (ResourceLoaderContext $context) | |
| Check whether this module is known to be empty. More... | |
| setConfig (Config $config) | |
| setFileDependencies (ResourceLoaderContext $context, $files) | |
| Set in-object cache for file dependencies. More... | |
| setLogger (LoggerInterface $logger) | |
| setMessageBlob ( $blob, $lang) | |
| Set in-object cache for message blobs. More... | |
| setName ( $name) | |
| Set this module's name. More... | |
| shouldEmbedModule (ResourceLoaderContext $context) | |
| Check whether this module should be embeded rather than linked. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ResourceLoaderFileModule | |
| static | extractBasePaths ( $options=[], $localBasePath=null, $remoteBasePath=null) |
| Extract a pair of local and remote base paths from module definition information. More... | |
| Static Public Member Functions inherited from ResourceLoaderModule | |
| static | expandRelativePaths (array $filePaths) |
| Expand directories relative to $IP. More... | |
| static | getRelativePaths (array $filePaths) |
| Make file paths relative to MediaWiki directory. More... | |
| Public Attributes inherited from ResourceLoaderModule | |
| const | LOAD_GENERAL = 'general' |
| const | LOAD_STYLES = 'styles' |
| 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_SCRIPTS = 'scripts' |
| const | TYPE_STYLES = 'styles' |
| Protected Member Functions inherited from ResourceLoaderFileModule | |
| compileLessFile ( $fileName, ResourceLoaderContext $context) | |
| Compile a LESS file into CSS. More... | |
| getAllSkinStyleFiles () | |
| Gets a list of file paths for all skin style files in the module, for all available skins. More... | |
| getFileHashes (ResourceLoaderContext $context) | |
| Helper method to gather file hashes for getDefinitionSummary. More... | |
| getLocalPath ( $path) | |
| getRemotePath ( $path) | |
| getScriptFiles (ResourceLoaderContext $context) | |
| Get a list of file paths for all scripts in this module, in order of proper execution. More... | |
| getSkinStyleFiles ( $skinName) | |
| Gets a list of file paths for all skin styles in the module used by the skin. More... | |
| readScriptFiles (array $scripts) | |
| Gets the contents of a list of JavaScript files. More... | |
| readStyleFile ( $path, $flip, $context) | |
| Reads a style file. More... | |
| stripBom ( $input) | |
| Takes an input string and removes the UTF-8 BOM character if present. More... | |
| Protected Member Functions inherited from ResourceLoaderModule | |
| getDeprecationInformation () | |
| Get JS representing deprecation information for the current module if available. More... | |
| getFileDependencies (ResourceLoaderContext $context) | |
| Get the files this module depends on indirectly for a given skin. More... | |
| getLogger () | |
| getMessageBlob (ResourceLoaderContext $context) | |
| Get the hash of the message blob. More... | |
| saveFileDependencies (ResourceLoaderContext $context, $localFileRefs) | |
| Set the files this module depends on indirectly for a given skin. More... | |
| validateScriptFile ( $fileName, $contents) | |
| Validate a given script file; if valid returns the original source. More... | |
| Static Protected Member Functions inherited from ResourceLoaderFileModule | |
| static | collateFilePathListByOption (array $list, $option, $default) |
| Collates file paths by option (where provided). More... | |
| static | tryForKey (array $list, $key, $fallback=null) |
| Get a list of element that match a key, optionally using a fallback key. More... | |
| Static Protected Member Functions inherited from ResourceLoaderModule | |
| static | javaScriptParser () |
| static | safeFileHash ( $filePath) |
| Compute a non-cryptographic string hash of a file's contents. More... | |
| static | safeFilemtime ( $filePath) |
| Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist. More... | |
| Protected Attributes inherited from ResourceLoaderFileModule | |
| bool | $debugRaw = true |
| Link to raw files in debug mode. More... | |
| array | $debugScripts = [] |
| List of paths to JavaScript files to include in debug mode. More... | |
| array | $dependencies = [] |
| List of modules this module depends on. More... | |
| string | $group |
| Name of group to load this module in. More... | |
| bool | $hasGeneratedStyles = false |
| Whether getStyleURLsForDebug should return raw file paths, or return load.php urls. More... | |
| array | $languageScripts = [] |
| List of JavaScript files to include when using a specific language. More... | |
| string | $localBasePath = '' |
| Local base path, see __construct() More... | |
| array | $localFileRefs = [] |
| Place where readStyleFile() tracks file dependencies. More... | |
| array | $messages = [] |
| List of message keys used by this module. More... | |
| array | $missingLocalFileRefs = [] |
| Place where readStyleFile() tracks file dependencies for non-existent files. More... | |
| bool | $noflip = false |
| Whether CSSJanus flipping should be skipped for this module. More... | |
| bool | $raw = false |
| Whether mw.loader.state() call should be omitted. More... | |
| string | $remoteBasePath = '' |
| Remote base path, see __construct() More... | |
| array | $scripts = [] |
| List of paths to JavaScript files to always include. More... | |
| array | $skinScripts = [] |
| List of JavaScript files to include when using a specific skin. More... | |
| array | $skinStyles = [] |
| List of paths to CSS files to include when using specific skins. More... | |
| string | $skipFunction = null |
| File name containing the body of the skip function. More... | |
| array | $styles = [] |
| List of paths to CSS files to always include. More... | |
| $targets = [ 'desktop' ] | |
| array | $templates = [] |
| Saves a list of the templates named by the modules. More... | |
| Protected Attributes inherited from ResourceLoaderModule | |
| Config | $config |
| $contents = [] | |
| array bool | $deprecated = false |
| $fileDeps = [] | |
| LoggerInterface | $logger |
| $msgBlobs = [] | |
| $name = null | |
| $origin = self::ORIGIN_CORE_SITEWIDE | |
| $targets = [ 'desktop' ] | |
| $versionHash = [] | |
Detailed Description
Definition at line 11 of file CiteCSSFileModule.php.
Constructor & Destructor Documentation
◆ __construct()
| CiteCSSFileModule::__construct | ( | $options = [], |
|
$localBasePath = null, |
|||
$remoteBasePath = null |
|||
| ) |
Constructs a new module from an options array.
- Parameters
-
array $options List of options; if not given or empty, an empty module will be constructed string $localBasePath Base path to prepend to all local paths in $options. Defaults to $IP string $remoteBasePath Base path to prepend to all remote paths in $options. Defaults to $wgResourceBasePath
Below is a description for the $options array:
- Exceptions
-
InvalidArgumentException
- Construction options:
- [// Base path to prepend to all local paths in $options. Defaults to $IP'localBasePath' => [base path],// Base path to prepend to all remote paths in $options. Defaults to $wgResourceBasePath'remoteBasePath' => [base path],// Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath'remoteExtPath' => [base path],// Equivalent of remoteBasePath, but relative to $wgStylePath'remoteSkinPath' => [base path],// Scripts to always include// Scripts to include in specific language contexts'languageScripts' => [],// Scripts to include in specific skin contexts'skinScripts' => [],// Scripts to include in debug contexts// Modules which must be loaded before this module'templates' => [],// Styles to always load// Styles to include in specific skin contexts'skinStyles' => [],// Messages to always load// Group which this module should be loaded together with// Function that, if it returns true, makes the loader skip this module.// The file must contain valid JavaScript for execution in a private function.// The file must not contain the "function () {" and "}" wrapper though.'skipFunction' => [file path]]
Reimplemented from ResourceLoaderFileModule.
Definition at line 12 of file CiteCSSFileModule.php.
References $lang, ResourceLoaderFileModule\$localBasePath, $options, ResourceLoaderFileModule\$remoteBasePath, $wgContLang, as, ResourceLoaderFileModule\getLocalPath(), and global.
The documentation for this class was generated from the following file:
- extensions/Cite/includes/CiteCSSFileModule.php
