Wikibase\Repo\Api\FormatEntities Class Reference

API module for formatting a set of entity IDs. More...

Inheritance diagram for Wikibase\Repo\Api\FormatEntities:

Collaboration diagram for Wikibase\Repo\Api\FormatEntities:

Public Member Functions
	__construct (ApiMain $mainModule, string $moduleName, EntityIdParser $entityIdParser, EntityIdFormatterFactory $entityIdHtmlFormatterFactory, EntityIdFormatterFactory $entityIdTextFormatterFactory, ResultBuilder $resultBuilder, ApiErrorReporter $errorReporter, StatsFactory $statsFactory)
	execute ()

Static Public Member Functions
static	factory (ApiMain $apiMain, string $moduleName, StatsFactory $statsFactory, ApiHelperFactory $apiHelperFactory, EntityIdFormatterFactory $entityIdHtmlFormatterFactory, EntityIdFormatterFactory $entityIdTextFormatterFactory, EntityIdParser $entityIdParser)

Protected Member Functions
	getAllowedParams ()
	getExamplesMessages ()

Private Member Functions
	getEntityIdsFromIdParam (array $params)

Static Private Member Functions
static	makeLinksAbsolute (string $html)
	Make the href="" attributes of <a> elements in an HTML snippet absolute.

Private Attributes
	$entityIdParser
	$entityIdHtmlFormatterFactory
	$entityIdTextFormatterFactory
	$resultBuilder
	$errorReporter
	$statsFactory

Detailed Description

API module for formatting a set of entity IDs.

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\Api\FormatEntities::__construct	(	ApiMain	$mainModule,
		string	$moduleName,
		EntityIdParser	$entityIdParser,
		EntityIdFormatterFactory	$entityIdHtmlFormatterFactory,
		EntityIdFormatterFactory	$entityIdTextFormatterFactory,
		ResultBuilder	$resultBuilder,
		ApiErrorReporter	$errorReporter,
		StatsFactory	$statsFactory )

Member Function Documentation

execute()

Wikibase\Repo\Api\FormatEntities::execute

(

)

factory()

static Wikibase\Repo\Api\FormatEntities::factory ( ApiMain $apiMain, string $moduleName, StatsFactory $statsFactory, ApiHelperFactory $apiHelperFactory, EntityIdFormatterFactory $entityIdHtmlFormatterFactory, EntityIdFormatterFactory $entityIdTextFormatterFactory, EntityIdParser $entityIdParser )

static

getAllowedParams()

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

protected

getEntityIdsFromIdParam()

Wikibase\Repo\Api\FormatEntities::getEntityIdsFromIdParam ( array $params )

private

Parameters

array

$params

Returns

EntityId[]

getExamplesMessages()

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

protected

makeLinksAbsolute()

static Wikibase\Repo\Api\FormatEntities::makeLinksAbsolute ( string $html )

staticprivate

Make the href="" attributes of <a> elements in an HTML snippet absolute.

URLs are expanded using \MediaWiki\Utils\UrlUtils::expand.

Parameters

string

$html

Returns

string

Member Data Documentation

$entityIdHtmlFormatterFactory

Wikibase\Repo\Api\FormatEntities::$entityIdHtmlFormatterFactory

private

$entityIdParser

Wikibase\Repo\Api\FormatEntities::$entityIdParser

private

$entityIdTextFormatterFactory

Wikibase\Repo\Api\FormatEntities::$entityIdTextFormatterFactory

private

$errorReporter

Wikibase\Repo\Api\FormatEntities::$errorReporter

private

$resultBuilder

Wikibase\Repo\Api\FormatEntities::$resultBuilder

private

$statsFactory

Wikibase\Repo\Api\FormatEntities::$statsFactory

private

---

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

• repo/includes/Api/FormatEntities.php