Wikibase\Lib\Modules\DataTypesModule Class Reference

Resource loader module for defining resources that will create a MW config var in JavaScript holding information about all data types known to a given DataTypeFactory. More...

Inheritance diagram for Wikibase\Lib\Modules\DataTypesModule:

Collaboration diagram for Wikibase\Lib\Modules\DataTypesModule:

Public Member Functions
	__construct (array $resourceDefinition)
	getConfigVarName ()
	Returns the name of the config var key under which the data type definition will be available in JavaScript using "mw.config.get( '...' )". More...
	getDataTypeFactory ()
	Returns the data types factory providing the data type information. More...
	getScript (RL\Context $context)
	Used to propagate available data type ids to JavaScript. More...
	getDefinitionSummary (RL\Context $context)

Static Public Member Functions
static	extractDataTypesConfigVarNameFromResourceDefinition (array $resourceDefinition)
static	extractDataTypeFactoryFromResourceDefinition (array $resourceDefinition)

Protected Attributes
	$targets = [ 'desktop', 'mobile' ]
	$dataTypes
	$dataTypesConfigVarName
	$dataTypeFactory

Detailed Description

Resource loader module for defining resources that will create a MW config var in JavaScript holding information about all data types known to a given DataTypeFactory.

The resource definition requires the following additional keys:

• (string) datatypesconfigvarname: Name of the "mw.config.get( '...' )" config variable.
• (Function|DataTypeFactory) datatypefactory: Provider for the data types. Can be a callback returning a DataTypeFactory instance.

Copyright

GPL-2.0-or-later

Author

Daniel Werner < danie.nosp@m.l.a..nosp@m.r.wer.nosp@m.ner@.nosp@m.gmail.nosp@m..com >

Constructor & Destructor Documentation

__construct()

Wikibase\Lib\Modules\DataTypesModule::__construct

(

array

$resourceDefinition

)

Since

0.1

Parameters

array

$resourceDefinition

Member Function Documentation

extractDataTypeFactoryFromResourceDefinition()

static Wikibase\Lib\Modules\DataTypesModule::extractDataTypeFactoryFromResourceDefinition ( array  $resourceDefinition )

static

Since

0.1

Parameters

array

$resourceDefinition

Returns

DataTypeFactory

Exceptions

Exception

If the given resource definition is not sufficient

extractDataTypesConfigVarNameFromResourceDefinition()

static Wikibase\Lib\Modules\DataTypesModule::extractDataTypesConfigVarNameFromResourceDefinition ( array  $resourceDefinition )

static

Since

0.1

Parameters

array

$resourceDefinition

Returns

string

Exceptions

Exception

If the given resource definition is not sufficient

getConfigVarName()

Wikibase\Lib\Modules\DataTypesModule::getConfigVarName

(

)

Returns the name of the config var key under which the data type definition will be available in JavaScript using "mw.config.get( '...' )".

Since

0.1

Returns

string

getDataTypeFactory()

Wikibase\Lib\Modules\DataTypesModule::getDataTypeFactory

(

)

Returns the data types factory providing the data type information.

Since

0.1

Returns

DataTypeFactory

getDefinitionSummary()

Wikibase\Lib\Modules\DataTypesModule::getDefinitionSummary

(

RL\Context

$context

)

See also

RL\Module::getDefinitionSummary

Parameters

RL\Context

$context

Returns

array

getScript()

Wikibase\Lib\Modules\DataTypesModule::getScript

(

RL\Context

$context

)

Used to propagate available data type ids to JavaScript.

Data type ids will be available in 'wbDataTypeIds' config var.

See also

RL\Module::getScript

Since

0.1

Parameters

RL\Context

$context

Returns

string

Member Data Documentation

$dataTypeFactory

Wikibase\Lib\Modules\DataTypesModule::$dataTypeFactory

protected

$dataTypes

Wikibase\Lib\Modules\DataTypesModule::$dataTypes

protected

$dataTypesConfigVarName

Wikibase\Lib\Modules\DataTypesModule::$dataTypesConfigVarName

protected

$targets

Wikibase\Lib\Modules\DataTypesModule::$targets = [ 'desktop', 'mobile' ]

protected

---

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

• lib/includes/Modules/DataTypesModule.php