CiteCSSFileModule Class Reference
ResourceLoaderFileModule for adding the content language Cite CSS. More...
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 (ResourceLoaderContext $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... | |
| getPackageFiles (ResourceLoaderContext $context) | |
| Resolves the package files defintion and generates the content of each package file. 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... | |
| readStyleFiles (array $styles, $flip, ResourceLoaderContext $context) | |
| Get the contents of a list of CSS files. More... | |
| supportsURLLoading () | |
| Public Member Functions inherited from ResourceLoaderModule | |
| getConfig () | |
| getDeprecationInformation (ResourceLoaderContext $context=null) | |
| Get JS representing deprecation information for the current module if available. More... | |
| getHeaders (ResourceLoaderContext $context) | |
| Get headers to send as part of a module web response. More... | |
| getModuleContent (ResourceLoaderContext $context) | |
| Get an array of this module's resources. More... | |
| getName () | |
| Get this module's name. More... | |
| getOrigin () | |
| Get this module's origin. More... | |
| getSource () | |
| Get the source of this module. More... | |
| getVersionHash (ResourceLoaderContext $context) | |
| Get a string identifying the current version of this module in a given context. 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 | getPackageFileType ( $path) |
| Infer the file type from a package file path. 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... | |
| static | getVary (ResourceLoaderContext $context) |
| Get vary string. More... | |
| 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... | |
| getLocalPath ( $path) | |
| getPath ( $path) | |
| getRemotePath ( $path) | |
| getSkinStyleFiles ( $skinName) | |
| Gets a list of file paths for all skin styles in the module used by the skin. More... | |
| readStyleFile ( $path, $flip, ResourceLoaderContext $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 | |
| buildContent (ResourceLoaderContext $context) | |
| Bundle all resources attached to this module into an array. More... | |
| getFileDependencies (ResourceLoaderContext $context) | |
| Get the files this module depends on indirectly for a given skin. More... | |
| getLessVars (ResourceLoaderContext $context) | |
| Get module-specific LESS variables, if any. More... | |
| getLogger () | |
| getMessageBlob (ResourceLoaderContext $context) | |
| Get the hash of the message blob. More... | |
| getPreloadLinks (ResourceLoaderContext $context) | |
| Get a list of resources that web browsers may preload. 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... | |
| array | $packageFiles = null |
| List of packaged files to make available through require() 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 |
| 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[] | $targets = [ 'desktop' ] |
| What client platforms the module targets (e.g. More... | |
| array | $versionHash = [] |
| Map of (context hash => cached module version hash) More... | |
Detailed Description
ResourceLoaderFileModule for adding the content language Cite CSS.
- Note
- 2011-2018 VisualEditor Team's Cite sub-team and others; see AUTHORS.txt
- MIT
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 | null $localBasePath Base path to prepend to all local paths in $options. Defaults to $IP string | null $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 (cannot be set if 'packageFiles' is also set, see below)'scripts' => [file path string or array of file path strings],// Scripts to include in specific language contexts'languageScripts' => [[language code] => [file path string or array of file path strings],],// Scripts to include in specific skin contexts'skinScripts' => [[skin name] => [file path string or array of file path strings],],// Scripts to include in debug contexts'debugScripts' => [file path string or array of file path strings],// For package modules: files to be made available for internal require() do not// need to have 'type' defined; it will be inferred from the file name extension// if omitted. 'config' can only be used when 'type' is 'data'; the variables are// resolved with Config::get(). The first entry in 'packageFiles' is always the// module entry point. If 'packageFiles' is set, 'scripts' cannot also be set.'packageFiles' => [[file path string], // or:[ 'name' => [file name], 'file' => [file path], 'type' => 'script'|'data' ], // or:[ 'name' => [name], 'content' => [string], 'type' => 'script'|'data' ], // or:[ 'name' => [name], 'callback' => [callable], 'type' => 'script'|'data' ],[ 'name' => [name], 'config' => [ [config var name], ... ], 'type' => 'data' ],[ 'name' => [name], 'config' => [ [JS name] => [PHP name] ], 'type' => 'data' ],],// Modules which must be loaded before this module'dependencies' => [module name string or array of module name strings],'templates' => [[template alias with file.ext] => [file path to a template file],],// Styles to always load'styles' => [file path string or array of file path strings],// Styles to include in specific skin contexts'skinStyles' => [[skin name] => [file path string or array of file path strings],],// Messages to always load'messages' => [array of message key strings],// Group which this module should be loaded together with'group' => [group name string],// 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 13 of file CiteCSSFileModule.php.
References $lang, ResourceLoaderFileModule\$localBasePath, ResourceLoaderFileModule\$remoteBasePath, and ResourceLoaderFileModule\getLocalPath().
The documentation for this class was generated from the following file:
- extensions/Cite/includes/CiteCSSFileModule.php
