Wikibase\Repo\Api\FormatSnakValue Class Reference

API module for using value formatters. More...

Inheritance diagram for Wikibase\Repo\Api\FormatSnakValue:

Collaboration diagram for Wikibase\Repo\Api\FormatSnakValue:

Public Member Functions
	__construct (ApiMain $mainModule, string $moduleName, OutputFormatValueFormatterFactory $valueFormatterFactory, OutputFormatSnakFormatterFactory $snakFormatterFactory, DataTypeFactory $dataTypeFactory, DataValueFactory $dataValueFactory, ApiErrorReporter $apiErrorReporter, LanguageNameUtils $languageNameUtils, ?StatsFactory $statsFactory, EntityIdParser $entityIdParser, PropertyDataTypeLookup $dataTypeLookup, SnakValueDeserializer $snakValueDeserializer)
	execute ()

Static Public Member Functions
static	factory (ApiMain $mainModule, string $moduleName, LanguageNameUtils $languageNameUtils, StatsFactory $statsFactory, ApiHelperFactory $apiHelperFactory, DataTypeFactory $dataTypeFactory, DataValueFactory $dataValueFactory, EntityIdParser $entityIdParser, PropertyDataTypeLookup $dataTypeLookup, OutputFormatSnakFormatterFactory $snakFormatterFactory, SnakValueDeserializer $snakValueDeserializer, OutputFormatValueFormatterFactory $valueFormatterFactory)

Protected Member Functions
	getAllowedParams ()
	getExamplesMessages ()

Private Member Functions
	formatValue (array $params, DataValue $value, ?string $dataTypeId)
	getValueFormatter (array $params)
	getSnakFormatter (array $params)
	decodeDataValue (array $params)
	getOptionsObject (?string $optionsParam)
	setValidOption (FormatterOptions $options, string $option, $value)
	getDataTypeId (array $params)
	Returns the data type ID specified by the parameters.
	lookUpPropertyDataType (string $id)

Private Attributes
OutputFormatValueFormatterFactory	$valueFormatterFactory
OutputFormatSnakFormatterFactory	$snakFormatterFactory
DataTypeFactory	$dataTypeFactory
DataValueFactory	$dataValueFactory
ApiErrorReporter	$errorReporter
LanguageNameUtils	$languageNameUtils
StatsFactory	$statsFactory
EntityIdParser	$entityIdParser
PropertyDataTypeLookup	$dataTypeLookup
SnakValueDeserializer	$snakValueDeserializer

Detailed Description

API module for using value formatters.

Copyright

GPL-2.0-or-later

Author

Daniel Kinzler

Addshore

Marius Hoch

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\Api\FormatSnakValue::__construct	(	ApiMain	$mainModule,
		string	$moduleName,
		OutputFormatValueFormatterFactory	$valueFormatterFactory,
		OutputFormatSnakFormatterFactory	$snakFormatterFactory,
		DataTypeFactory	$dataTypeFactory,
		DataValueFactory	$dataValueFactory,
		ApiErrorReporter	$apiErrorReporter,
		LanguageNameUtils	$languageNameUtils,
		?StatsFactory	$statsFactory,
		EntityIdParser	$entityIdParser,
		PropertyDataTypeLookup	$dataTypeLookup,
		SnakValueDeserializer	$snakValueDeserializer )

See also

ApiBase::__construct

Member Function Documentation

decodeDataValue()

Wikibase\Repo\Api\FormatSnakValue::decodeDataValue ( array $params )

private

Exceptions

ApiUsageException
LogicException

execute()

Wikibase\Repo\Api\FormatSnakValue::execute

(

)

factory()

static Wikibase\Repo\Api\FormatSnakValue::factory ( ApiMain $mainModule, string $moduleName, LanguageNameUtils $languageNameUtils, StatsFactory $statsFactory, ApiHelperFactory $apiHelperFactory, DataTypeFactory $dataTypeFactory, DataValueFactory $dataValueFactory, EntityIdParser $entityIdParser, PropertyDataTypeLookup $dataTypeLookup, OutputFormatSnakFormatterFactory $snakFormatterFactory, SnakValueDeserializer $snakValueDeserializer, OutputFormatValueFormatterFactory $valueFormatterFactory )

static

formatValue()

Wikibase\Repo\Api\FormatSnakValue::formatValue ( array $params, DataValue $value, ?string $dataTypeId )

private

getAllowedParams()

Wikibase\Repo\Api\FormatSnakValue::getAllowedParams ( )

protected

getDataTypeId()

Wikibase\Repo\Api\FormatSnakValue::getDataTypeId ( array $params )

private

Returns the data type ID specified by the parameters.

Parameters

array

$params

Returns

string|null

getExamplesMessages()

Wikibase\Repo\Api\FormatSnakValue::getExamplesMessages ( )

protected

getOptionsObject()

Wikibase\Repo\Api\FormatSnakValue::getOptionsObject ( ?string $optionsParam )

private

getSnakFormatter()

Wikibase\Repo\Api\FormatSnakValue::getSnakFormatter ( array $params )

private

Exceptions

LogicException

Returns

SnakFormatter

getValueFormatter()

Wikibase\Repo\Api\FormatSnakValue::getValueFormatter ( array $params )

private

Exceptions

LogicException

Returns

ValueFormatter

lookUpPropertyDataType()

Wikibase\Repo\Api\FormatSnakValue::lookUpPropertyDataType ( string $id )

private

setValidOption()

Wikibase\Repo\Api\FormatSnakValue::setValidOption ( FormatterOptions $options, string $option, $value )

private

Parameters

FormatterOptions	$options
string	$option
mixed	$value

Member Data Documentation

$dataTypeFactory

DataTypeFactory Wikibase\Repo\Api\FormatSnakValue::$dataTypeFactory

private

$dataTypeLookup

PropertyDataTypeLookup Wikibase\Repo\Api\FormatSnakValue::$dataTypeLookup

private

$dataValueFactory

DataValueFactory Wikibase\Repo\Api\FormatSnakValue::$dataValueFactory

private

$entityIdParser

EntityIdParser Wikibase\Repo\Api\FormatSnakValue::$entityIdParser

private

$errorReporter

ApiErrorReporter Wikibase\Repo\Api\FormatSnakValue::$errorReporter

private

$languageNameUtils

LanguageNameUtils Wikibase\Repo\Api\FormatSnakValue::$languageNameUtils

private

$snakFormatterFactory

OutputFormatSnakFormatterFactory Wikibase\Repo\Api\FormatSnakValue::$snakFormatterFactory

private

$snakValueDeserializer

SnakValueDeserializer Wikibase\Repo\Api\FormatSnakValue::$snakValueDeserializer

private

$statsFactory

StatsFactory Wikibase\Repo\Api\FormatSnakValue::$statsFactory

private

$valueFormatterFactory

OutputFormatValueFormatterFactory Wikibase\Repo\Api\FormatSnakValue::$valueFormatterFactory

private

---

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

• repo/includes/Api/FormatSnakValue.php