Resource loader module providing extra data from the server to Cite. More...

Inheritance diagram for CiteDataModule:

[legend]

Collaboration diagram for CiteDataModule:

[legend]

Public Member Functions

getDefinitionSummary (ResourceLoaderContext $context)

Get the definition summary for this module.This is the method subclasses are recommended to use to track values in their version hash. Call this in getVersionHash() and pass it to e.g. json_encode.Subclasses must call the parent getDefinitionSummary() and build on that. It is recommended that each subclass appends its own new array. This prevents clashes or accidental overwrites of existing keys and gives each subclass its own scope for simple array keys.

$summary = parent::getDefinitionSummary( $context );
$summary[] = [
    'foo' => 123,
    'bar' => 'quux',
];
return $summary;

Return an array containing values from all significant properties of this module's definition.Be careful not to normalise too much. Especially preserve the order of things that carry significance in getScript and getStyles (T39812).Avoid including things that are insiginificant (e.g. order of message keys is insignificant and should be sorted to avoid unnecessary cache invalidation).This data structure must exclusively contain arrays and scalars as values (avoid object instances) to allow simple serialisation using json_encode.If modules have a hash or timestamp from another source, that may be incuded as-is.A number of utility methods are available to help you gather data. These are not called by default and must be included by the subclass' getDefinitionSummary().

getMessageBlob()

Since: 1.23

Parameters

ResourceLoaderContext $context

Returns: array|null

getDependencies (ResourceLoaderContext $context=null)

Get a list of modules this module depends on.Dependency information is taken into account when loading a module on the client side.Note: It is expected that $context will be made non-optional in the near future.

Parameters

ResourceLoaderContext | null $context

Returns: array List of module names as strings

getScript (ResourceLoaderContext $context)

Get all JS for this module for a given language and skin.Includes all relevant JS except loader scripts.For "plain" script modules, this should return a string with JS code. For multi-file modules where require() is used to load one file from another file, this should return an array structured as follows: [ 'files' => [ 'file1.js' => [ 'type' => 'script', 'content' => 'JS code' ], 'file2.js' => [ 'type' => 'script', 'content' => 'JS code' ], 'data.json' => [ 'type' => 'data', 'content' => array ] ], 'main' => 'file1.js' ]

Parameters

ResourceLoaderContext $context

Returns: string|array JavaScript code (string), or multi-file structure described above (array)

Public Member Functions inherited from ResourceLoaderModule

enableModuleContentVersion ()

Whether to generate version hash based on module content.

getConfig ()

getDeprecationInformation (ResourceLoaderContext $context=null)

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.

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.

getStyles (ResourceLoaderContext $context)

Get all CSS for this module for a given skin.

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.

getType ()

Get the module's load type.

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)

setFileDependencies (ResourceLoaderContext $context, $files)

Set in-object cache for file dependencies.

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.

supportsURLLoading ()

Whether this module supports URL loading.

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

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)

Additional Inherited Members
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 inherited from ResourceLoaderModule
	buildContent (ResourceLoaderContext $context)
	Bundle all resources attached to this module into an array.

	getFileDependencies (ResourceLoaderContext $context)
	Get the files this module depends on indirectly for a given skin.

	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, $localFileRefs)
	Set the files this module depends on indirectly for a given skin.

	validateScriptFile ( $fileName, $contents)
	Validate a given script file; if valid returns the original source.

Static Protected Member Functions inherited from ResourceLoaderModule
static	javaScriptParser ()

static	safeFileHash ( $filePath)
	Compute a non-cryptographic string hash of a file's contents.

static	safeFilemtime ( $filePath)
	Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist.

Detailed Description

Resource loader module providing extra data from the server to Cite.

Temporary hack for T93800

Note: 2011-2018 VisualEditor Team's Cite sub-team and others; see AUTHORS.txt; MIT

Definition at line 11 of file CiteDataModule.php.

Member Function Documentation

◆ getDefinitionSummary()

CiteDataModule::getDefinitionSummary ( ResourceLoaderContext $context )

Get the definition summary for this module.This is the method subclasses are recommended to use to track values in their version hash. Call this in getVersionHash() and pass it to e.g. json_encode.Subclasses must call the parent getDefinitionSummary() and build on that. It is recommended that each subclass appends its own new array. This prevents clashes or accidental overwrites of existing keys and gives each subclass its own scope for simple array keys.

$summary = parent::getDefinitionSummary( $context );
$summary[] = [
    'foo' => 123,
    'bar' => 'quux',
];
return $summary;

Return an array containing values from all significant properties of this module's definition.Be careful not to normalise too much. Especially preserve the order of things that carry significance in getScript and getStyles (T39812).Avoid including things that are insiginificant (e.g. order of message keys is insignificant and should be sorted to avoid unnecessary cache invalidation).This data structure must exclusively contain arrays and scalars as values (avoid object instances) to allow simple serialisation using json_encode.If modules have a hash or timestamp from another source, that may be incuded as-is.A number of utility methods are available to help you gather data. These are not called by default and must be included by the subclass' getDefinitionSummary().

getMessageBlob()

Since: 1.23

Parameters

ResourceLoaderContext $context

Returns: array|null

Reimplemented from ResourceLoaderModule.

Definition at line 59 of file CiteDataModule.php.

References $context, and getScript().

◆ getDependencies()

CiteDataModule::getDependencies ( ResourceLoaderContext $context = null )

Get a list of modules this module depends on.Dependency information is taken into account when loading a module on the client side.Note: It is expected that $context will be made non-optional in the near future.

Parameters

ResourceLoaderContext | null $context

Returns: array List of module names as strings

Reimplemented from ResourceLoaderModule.

Definition at line 51 of file CiteDataModule.php.

◆ getScript()

CiteDataModule::getScript ( ResourceLoaderContext $context )

Get all JS for this module for a given language and skin.Includes all relevant JS except loader scripts.For "plain" script modules, this should return a string with JS code. For multi-file modules where require() is used to load one file from another file, this should return an array structured as follows: [ 'files' => [ 'file1.js' => [ 'type' => 'script', 'content' => 'JS code' ], 'file2.js' => [ 'type' => 'script', 'content' => 'JS code' ], 'data.json' => [ 'type' => 'data', 'content' => array ] ], 'main' => 'file1.js' ]

Parameters

ResourceLoaderContext $context

Returns: string|array JavaScript code (string), or multi-file structure described above (array)

Reimplemented from ResourceLoaderModule.

Definition at line 16 of file CiteDataModule.php.

References $context.

Referenced by getDefinitionSummary().

Member Data Documentation

◆ $targets

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

protected

Definition at line 13 of file CiteDataModule.php.

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

extensions/Cite/includes/CiteDataModule.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDefinitionSummary()

◆ getDependencies()

◆ getScript()

Member Data Documentation

◆ $targets