ResourceLoader module for generated and embedded images. More...

Inheritance diagram for ResourceLoaderImageModule:

Collaboration diagram for ResourceLoaderImageModule:

Public Member Functions
	__construct ($options=[], $localBasePath=null)
	Constructs a new module from an options array. More...

	getDefinitionSummary (ResourceLoaderContext $context)
	Get the definition summary for this module. More...

	getGlobalVariants (ResourceLoaderContext $context)
	Get list of variants in this module that are 'global', i.e., available for every image regardless of image options. More...

	getImage ($name, ResourceLoaderContext $context)
	Get a ResourceLoaderImage object for given image. More...

	getImages (ResourceLoaderContext $context)
	Get ResourceLoaderImage objects for all images. More...

	getPosition ()

	getPrefix ()
	Get CSS class prefix used by this module. More...

	getSelectors ()
	Get CSS selector templates used by this module. More...

	getStyles (ResourceLoaderContext $context)

	getType ()

	supportsURLLoading ()

Public Member Functions inherited from ResourceLoaderModule
	enableModuleContentVersion ()
	Whether to generate version hash based on module content. More...

	getConfig ()

	getDefinitionMtime (ResourceLoaderContext $context)
	Back-compat dummy for old subclass implementations of getModifiedTime(). More...

	getDefinitionSummary (ResourceLoaderContext $context)
	Get the definition summary for this module. More...

	getDependencies (ResourceLoaderContext $context=null)
	Get a list of modules this module depends on. More...

	getFlip ($context)

	getGroup ()
	Get the group this module is in. More...

	getHashMtime (ResourceLoaderContext $context)
	Back-compat dummy for old subclass implementations of getModifiedTime(). More...

	getMessages ()
	Get the messages needed for this module. 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...

	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...

	getPosition ()
	Where on the HTML page should this module's JS be loaded? More...

	getScript (ResourceLoaderContext $context)
	Get all JS for this module for a given language and skin. More...

	getScriptURLsForDebug (ResourceLoaderContext $context)
	Get the URL or URLs to load for this module's JS in debug mode. More...

	getSkipFunction ()
	Get the skip function. 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...

	getTemplates ()
	Takes named templates by the module and returns an array mapping. More...

	getType ()
	Get the module's load type. 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...

	isRaw ()
	Whether this module's JS expects to work without the client-side ResourceLoader module. 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...

	supportsURLLoading ()
	Whether this module supports URL loading. More...

Static Public Member Functions
static	extractLocalBasePath ($options, $localBasePath=null)
	Extract a local base path 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...

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). More...

	getFileHashes (ResourceLoaderContext $context)
	Helper method for getDefinitionSummary. More...

	loadFromDefinition ()
	Parse definition and external JSON data, if referenced. More...

Protected Member Functions inherited from ResourceLoaderModule
	buildContent (ResourceLoaderContext $context)
	Bundle all resources attached to this module into an array. More...

	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...

	getLessVars (ResourceLoaderContext $context)
	Get module-specific LESS variables, if any. 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...

Protected Attributes
	$definition = null

	$images = []

string	$localBasePath = ''
	Local base path, see __construct() More...

	$origin = self::ORIGIN_CORE_SITEWIDE

string	$position = 'bottom'
	Position on the page to load this module at. More...

	$prefix = null

	$selectorWithoutVariant = '.{prefix}-{name}'

	$selectorWithVariant = '.{prefix}-{name}-{variant}'

	$targets = [ 'desktop', 'mobile' ]

	$variants = []

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 = []

Additional Inherited Members
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'

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...

Detailed Description

ResourceLoader module for generated and embedded images.

Since: 1.25

Definition at line 29 of file ResourceLoaderImageModule.php.

Constructor & Destructor Documentation

ResourceLoaderImageModule::__construct	(	$options = `[]`,
		$localBasePath = `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

Below is a description for the $options array:

Construction options:: [

// Base path to prepend to all local paths in $options. Defaults to $IP

'localBasePath' => [base path],

// Path to JSON file that contains any of the settings below

'data' => [file path string]

// CSS class prefix to use in all style rules

'prefix' => [CSS class prefix],

// Alternatively: Format of CSS selector to use in all style rules

'selector' => [CSS selector template, variables: {prefix} {name} {variant}],

// Alternatively: When using variants

'selectorWithoutVariant' => [CSS selector template, variables: {prefix} {name}],

'selectorWithVariant' => [CSS selector template, variables: {prefix} {name} {variant}],

// List of variants that may be used for the image files

'variants' => [

[theme name] => [

[variant name] => [

'color' => [color string, e.g. '#ffff00'],

'global' => [boolean, if true, this variant is available

for all images of this type],

],

...

],

...

],

// List of image files and their options

'images' => [

[theme name] => [

[icon name] => [

'file' => [file path string or array whose values are file path strings

and whose keys are 'default', 'ltr', 'rtl', a single

language code like 'en', or a list of language codes like

'en,de,ar'],

'variants' => [array of variant name strings, variants

available for this image],

],

...

],

...

],

]

Exceptions

InvalidArgumentException

Definition at line 105 of file ResourceLoaderImageModule.php.

References $options, and definition.

Member Function Documentation

static ResourceLoaderImageModule::extractLocalBasePath	(	$options,
		$localBasePath = `null`
	)

static

Extract a local base path from module definition information.

Parameters

array	$options	Module definition
string	$localBasePath	Path to use if not provided in module definition. Defaults to $IP

Returns: string Local base path

Definition at line 437 of file ResourceLoaderImageModule.php.

References $IP, $localBasePath, $options, global, and string.

ResourceLoaderImageModule::getCssDeclarations	(	$primary,
		$fallback
	)

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.

Parameters

string	$primary	Primary URI
string	$fallback	Fallback URI

Returns: string[] CSS declarations to use given URIs as background-image

Definition at line 371 of file ResourceLoaderImageModule.php.

Referenced by getStyles().

ResourceLoaderImageModule::getDefinitionSummary ( ResourceLoaderContext $context )

Get the definition summary for this module.

Parameters

ResourceLoaderContext $context

Returns: array

Definition at line 393 of file ResourceLoaderImageModule.php.

References $options, $summary, as, getFileHashes(), and loadFromDefinition().

ResourceLoaderImageModule::getFileHashes ( ResourceLoaderContext $context )

protected

Helper method for getDefinitionSummary.

Definition at line 419 of file ResourceLoaderImageModule.php.

References $files, $image, ResourceLoaderModule\$name, as, getImages(), and loadFromDefinition().

Referenced by getDefinitionSummary().

ResourceLoaderImageModule::getGlobalVariants ( ResourceLoaderContext $context )

Get list of variants in this module that are 'global', i.e., available for every image regardless of image options.

Parameters

ResourceLoaderContext $context

Returns: string[]

Definition at line 286 of file ResourceLoaderImageModule.php.

References ResourceLoaderModule\$config, ResourceLoaderModule\$name, $skin, as, ResourceLoaderContext\getSkin(), and loadFromDefinition().

Referenced by getImages().

ResourceLoaderImageModule::getImage	(		$name,
		ResourceLoaderContext	$context
	)

Get a ResourceLoaderImage object for given image.

Parameters

string	$name	Image name
ResourceLoaderContext	$context

Returns: ResourceLoaderImage|null

Definition at line 226 of file ResourceLoaderImageModule.php.

References $images, ResourceLoaderModule\$name, getImages(), and loadFromDefinition().

ResourceLoaderImageModule::getImages ( ResourceLoaderContext $context )

Get ResourceLoaderImage objects for all images.

Parameters

ResourceLoaderContext $context

Returns: ResourceLoaderImage[] Array keyed by image name

Definition at line 237 of file ResourceLoaderImageModule.php.

References $image, ResourceLoaderModule\$name, $options, $skin, as, getGlobalVariants(), ResourceLoaderModule\getName(), ResourceLoaderContext\getSkin(), and loadFromDefinition().

Referenced by getFileHashes(), getImage(), and getStyles().

ResourceLoaderImageModule::getPosition ( )

Returns: string

Definition at line 454 of file ResourceLoaderImageModule.php.

References $position, and loadFromDefinition().

ResourceLoaderImageModule::getPrefix ( )

Get CSS class prefix used by this module.

Returns: string

Definition at line 203 of file ResourceLoaderImageModule.php.

References $prefix, and loadFromDefinition().

Referenced by getStyles().

ResourceLoaderImageModule::getSelectors ( )

Get CSS selector templates used by this module.

Returns: string

Definition at line 212 of file ResourceLoaderImageModule.php.

References $selectorWithoutVariant, $selectorWithVariant, and loadFromDefinition().

Referenced by getStyles().

ResourceLoaderImageModule::getStyles ( ResourceLoaderContext $context )

Parameters

ResourceLoaderContext $context

Returns: array

Definition at line 313 of file ResourceLoaderImageModule.php.

References $image, ResourceLoaderModule\$name, $selector, as, getCssDeclarations(), getImages(), getPrefix(), ResourceLoaderContext\getResourceLoader(), getSelectors(), ResourceLoaderModule\getSource(), and loadFromDefinition().

ResourceLoaderImageModule::getType ( )

Returns: string

Definition at line 462 of file ResourceLoaderImageModule.php.

ResourceLoaderImageModule::loadFromDefinition ( )

protected

Parse definition and external JSON data, if referenced.

Definition at line 114 of file ResourceLoaderImageModule.php.

References $definition, $options, $prefix, $selector, $selectorWithoutVariant, $selectorWithVariant, $skin, as, definition, and string.

Referenced by getDefinitionSummary(), getFileHashes(), getGlobalVariants(), getImage(), getImages(), getPosition(), getPrefix(), getSelectors(), and getStyles().

ResourceLoaderImageModule::supportsURLLoading ( )

Returns: bool

Definition at line 383 of file ResourceLoaderImageModule.php.

Member Data Documentation

ResourceLoaderImageModule::$definition = null

protected

Definition at line 31 of file ResourceLoaderImageModule.php.

Referenced by ResourceLoaderOOUIImageModule\loadFromDefinition(), and loadFromDefinition().

ResourceLoaderImageModule::$images = []

protected

Definition at line 41 of file ResourceLoaderImageModule.php.

Referenced by getImage().

string ResourceLoaderImageModule::$localBasePath = ''

protected

Local base path, see __construct()

Definition at line 37 of file ResourceLoaderImageModule.php.

Referenced by extractLocalBasePath().

ResourceLoaderImageModule::$origin = self::ORIGIN_CORE_SITEWIDE

protected

Definition at line 39 of file ResourceLoaderImageModule.php.

string ResourceLoaderImageModule::$position = 'bottom'

protected

Position on the page to load this module at.

Definition at line 49 of file ResourceLoaderImageModule.php.

Referenced by getPosition().

ResourceLoaderImageModule::$prefix = null

protected

Definition at line 43 of file ResourceLoaderImageModule.php.

Referenced by getPrefix(), and loadFromDefinition().

ResourceLoaderImageModule::$selectorWithoutVariant = '.{prefix}-{name}'

protected

Definition at line 44 of file ResourceLoaderImageModule.php.

Referenced by getSelectors(), and loadFromDefinition().

ResourceLoaderImageModule::$selectorWithVariant = '.{prefix}-{name}-{variant}'

protected

Definition at line 45 of file ResourceLoaderImageModule.php.

Referenced by getSelectors(), and loadFromDefinition().

ResourceLoaderImageModule::$targets = [ 'desktop', 'mobile' ]

protected

Definition at line 46 of file ResourceLoaderImageModule.php.

ResourceLoaderImageModule::$variants = []

protected

Definition at line 42 of file ResourceLoaderImageModule.php.

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

includes/resourceloader/ResourceLoaderImageModule.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation