Helper for handling SnakFormatter output formats. More...

Public Member Functions
	getFallbackFormat ( $format)
	Get the format to fallback to, in case a given format is not available. More...

	getFallbackChain ( $format)
	Get the fallback chain for a given format. More...

	getBaseFormat ( $format)
	Get the base output format, for a given format. More...

	isPossibleFormat ( $availableFormat, $targetFormat)
	Can the given target format be served by the available format. More...

Detailed Description

Helper for handling SnakFormatter output formats.

Member Function Documentation

Wikibase\Lib\Formatters\SnakFormat::getBaseFormat ( $format )

Get the base output format, for a given format.

Parameters

string $format

Returns: string One of the SnakFormatter::FORMAT_HTML/FORMAT_WIKI/FORMAT_PLAIN constants.

Wikibase\Lib\Formatters\SnakFormat::getFallbackChain ( $format )

Get the fallback chain for a given format.

The returned array contains the SnakFormatter::FORMAT_* constants to use, from best fitting to worst.

Parameters

string $format Either of the SnakFormatter::FORMAT_* constants.

Returns: string[] SnakFormatter::FORMAT_* constants, starting with the most preferred format

Wikibase\Lib\Formatters\SnakFormat::getFallbackFormat ( $format )

Get the format to fallback to, in case a given format is not available.

Parameters

string $format One of the SnakFormatter::FORMAT_... constants.

Exceptions

InvalidArgumentException

Wikibase\Lib\Formatters\SnakFormat::isPossibleFormat	(	$availableFormat,
		$targetFormat
	)

Can the given target format be served by the available format.

Parameters

string	$availableFormat
string	$targetFormat

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