|
MediaWiki REL1_35
|
Module for generated and embedded images. More...


Public Member Functions | |
| __construct (array $options=[], $localBasePath=null) | |
| Constructs a new module from an options array. | |
| getDefinitionSummary (ResourceLoaderContext $context) | |
| Get the definition summary for this module. | |
| getGlobalVariants (ResourceLoaderContext $context) | |
| Get list of variants in this module that are 'global', i.e., available for every image regardless of image options. | |
| getImage ( $name, ResourceLoaderContext $context) | |
| Get a ResourceLoaderImage object for given image. | |
| getImages (ResourceLoaderContext $context) | |
| Get ResourceLoaderImage objects for all images. | |
| getPrefix () | |
| Get CSS class prefix used by this module. | |
| getSelectors () | |
| Get CSS selector templates used by this module. | |
| getStyles (ResourceLoaderContext $context) | |
| getType () | |
| supportsURLLoading () | |
Public Member Functions inherited from ResourceLoaderModule | |
| enableModuleContentVersion () | |
| Whether to generate version hash based on module content. | |
| getConfig () | |
| getDependencies (ResourceLoaderContext $context=null) | |
| Get a list of modules this module depends on. | |
| getDeprecationInformation (ResourceLoaderContext $context) | |
| Get JS representing deprecation information for the current module if available. | |
| getFlip (ResourceLoaderContext $context) | |
| getGroup () | |
| Get the group this module is in. | |
| 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. | |
| getScript (ResourceLoaderContext $context) | |
| Get all JS for this module for a given language and skin. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| shouldEmbedModule (ResourceLoaderContext $context) | |
| Check whether this module should be embeded rather than linked. | |
Static Public Member Functions | |
| static | extractLocalBasePath (array $options, $localBasePath=null) |
| Extract a local base path from module definition information. | |
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 | |
| getCssDeclarations ( $primary, $fallback) | |
| SVG support using a transparent gradient to guarantee cross-browser compatibility (browsers able to understand gradient syntax support also SVG). | |
| getLocalPath ( $path) | |
| loadFromDefinition () | |
| Parse definition and external JSON data, if referenced. | |
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 given script file; if valid returns the original source. | |
Protected Attributes | |
| string null | $defaultColor = null |
| array | $definition |
| array null | $globalVariants = null |
| ResourceLoaderImage[][] null | $imageObjects = null |
| array | $images = [] |
| string | $localBasePath = '' |
| Local base path, see __construct() | |
| $origin = self::ORIGIN_CORE_SITEWIDE | |
| string null | $prefix = null |
| $selectorWithoutVariant = '.{prefix}-{name}' | |
| $selectorWithVariant = '.{prefix}-{name}-{variant}' | |
| $targets = [ 'desktop', 'mobile' ] | |
| $useDataURI = true | |
| array | $variants = [] |
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) | |
Private Member Functions | |
| getFileHashes (ResourceLoaderContext $context) | |
| Helper method for getDefinitionSummary. | |
| getStyleDeclarations (ResourceLoaderContext $context, ResourceLoaderImage $image, $script, $variant=null) | |
| This method must not be used by getDefinitionSummary as doing so would cause an infinite loop (we use ResourceLoaderImage::getUrl below which calls Module:getVersionHash, which calls Module::getDefinitionSummary). | |
Additional Inherited Members | |
Static Protected Member Functions inherited from ResourceLoaderModule | |
| static | safeFileHash ( $filePath) |
| Compute a non-cryptographic string hash of a file's contents. | |
Module for generated and embedded images.
Definition at line 28 of file ResourceLoaderImageModule.php.
| ResourceLoaderImageModule::__construct | ( | array | $options = [], |
$localBasePath = null |
|||
| ) |
Constructs a new module from an options array.
| 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 |
Below is a description for the $options array:
| InvalidArgumentException |
Reimplemented in ResourceLoaderOOUIIconPackModule.
Definition at line 113 of file ResourceLoaderImageModule.php.
References $localBasePath.
|
static |
Extract a local base path from module definition information.
| array | $options | Module definition |
| string | null | $localBasePath | Path to use if not provided in module definition. Defaults to $IP. |
Reimplemented in ResourceLoaderOOUIIconPackModule.
Definition at line 477 of file ResourceLoaderImageModule.php.
References $IP.
|
protected |
SVG support using a transparent gradient to guarantee cross-browser compatibility (browsers able to understand gradient syntax support also SVG).
http://pauginer.tumblr.com/post/36614680636/invisible-gradient-technique
Keep synchronized with the .background-image-svg LESS mixin in /resources/src/mediawiki.less/mediawiki.mixins.less.
| string | $primary | Primary URI |
| string | $fallback | Fallback URI |
Definition at line 397 of file ResourceLoaderImageModule.php.
| ResourceLoaderImageModule::getDefinitionSummary | ( | ResourceLoaderContext | $context | ) |
Get the definition summary for this module.
| ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 419 of file ResourceLoaderImageModule.php.
|
private |
Helper method for getDefinitionSummary.
| ResourceLoaderContext | $context |
Definition at line 447 of file ResourceLoaderImageModule.php.
| ResourceLoaderImageModule::getGlobalVariants | ( | ResourceLoaderContext | $context | ) |
Get list of variants in this module that are 'global', i.e., available for every image regardless of image options.
| ResourceLoaderContext | $context |
Definition at line 296 of file ResourceLoaderImageModule.php.
| ResourceLoaderImageModule::getImage | ( | $name, | |
| ResourceLoaderContext | $context | ||
| ) |
Get a ResourceLoaderImage object for given image.
| string | $name | Image name |
| ResourceLoaderContext | $context |
Definition at line 237 of file ResourceLoaderImageModule.php.
| ResourceLoaderImageModule::getImages | ( | ResourceLoaderContext | $context | ) |
Get ResourceLoaderImage objects for all images.
| ResourceLoaderContext | $context |
Definition at line 248 of file ResourceLoaderImageModule.php.
|
protected |
| string | ResourceLoaderFilePath | $path |
Definition at line 461 of file ResourceLoaderImageModule.php.
References $path.
Referenced by loadFromDefinition(), and ResourceLoaderOOUIImageModule\readJSONFile().
| ResourceLoaderImageModule::getPrefix | ( | ) |
Get CSS class prefix used by this module.
Definition at line 214 of file ResourceLoaderImageModule.php.
References $prefix, and loadFromDefinition().
| ResourceLoaderImageModule::getSelectors | ( | ) |
Get CSS selector templates used by this module.
Definition at line 223 of file ResourceLoaderImageModule.php.
References $selectorWithoutVariant, $selectorWithVariant, and loadFromDefinition().
|
private |
This method must not be used by getDefinitionSummary as doing so would cause an infinite loop (we use ResourceLoaderImage::getUrl below which calls Module:getVersionHash, which calls Module::getDefinitionSummary).
| ResourceLoaderContext | $context | |
| ResourceLoaderImage | $image | Image to get the style for |
| string | $script | URL to load.php |
| string | null | $variant | Variant to get the style for |
Definition at line 370 of file ResourceLoaderImageModule.php.
References ResourceLoaderImage\getDataUri(), and ResourceLoaderImage\getUrl().
| ResourceLoaderImageModule::getStyles | ( | ResourceLoaderContext | $context | ) |
| ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 321 of file ResourceLoaderImageModule.php.
| ResourceLoaderImageModule::getType | ( | ) |
Reimplemented from ResourceLoaderModule.
Definition at line 494 of file ResourceLoaderImageModule.php.
|
protected |
Parse definition and external JSON data, if referenced.
Reimplemented in ResourceLoaderOOUIImageModule.
Definition at line 122 of file ResourceLoaderImageModule.php.
References $definition, $prefix, $selectorWithoutVariant, $selectorWithVariant, and getLocalPath().
Referenced by getPrefix(), and getSelectors().
| ResourceLoaderImageModule::supportsURLLoading | ( | ) |
Reimplemented from ResourceLoaderModule.
Definition at line 409 of file ResourceLoaderImageModule.php.
|
protected |
Definition at line 45 of file ResourceLoaderImageModule.php.
|
protected |
Definition at line 30 of file ResourceLoaderImageModule.php.
Referenced by loadFromDefinition(), and ResourceLoaderOOUIImageModule\loadFromDefinition().
|
protected |
Definition at line 48 of file ResourceLoaderImageModule.php.
|
protected |
Definition at line 41 of file ResourceLoaderImageModule.php.
|
protected |
Definition at line 43 of file ResourceLoaderImageModule.php.
|
protected |
Local base path, see __construct()
Definition at line 36 of file ResourceLoaderImageModule.php.
Referenced by __construct(), and ResourceLoaderOOUIIconPackModule\__construct().
|
protected |
Definition at line 38 of file ResourceLoaderImageModule.php.
|
protected |
Definition at line 52 of file ResourceLoaderImageModule.php.
Referenced by getPrefix(), and loadFromDefinition().
|
protected |
Definition at line 53 of file ResourceLoaderImageModule.php.
Referenced by getSelectors(), and loadFromDefinition().
|
protected |
Definition at line 54 of file ResourceLoaderImageModule.php.
Referenced by getSelectors(), and loadFromDefinition().
|
protected |
Definition at line 55 of file ResourceLoaderImageModule.php.
|
protected |
Definition at line 46 of file ResourceLoaderImageModule.php.
|
protected |
Definition at line 50 of file ResourceLoaderImageModule.php.