Wikibase\Repo\Api\SetAliases Class Reference

API module to set the aliases for a Wikibase entity. More...

Inheritance diagram for Wikibase\Repo\Api\SetAliases:

Collaboration diagram for Wikibase\Repo\Api\SetAliases:

Public Member Functions
	__construct (ApiMain $mainModule, string $moduleName, FingerprintChangeOpFactory $termChangeOpFactory, StatsFactory $statsFactory, bool $federatedPropertiesEnabled, EntityFactory $entityFactory, array $sandboxEntityIds)
	needsToken ()
	isWriteMode ()
Public Member Functions inherited from Wikibase\Repo\Api\ModifyEntity
	__construct (ApiMain $mainModule, string $moduleName, bool $federatedPropertiesEnabled, string $modulePrefix='')
	setServices (SiteLinkGlobalIdentifiersProvider $siteLinkGlobalIdentifiersProvider)
	execute ()
	isFreshIdAssigned ()
	Return whether a fresh id is assigned or not.

Static Public Member Functions
static	factory (ApiMain $mainModule, string $moduleName, StatsFactory $statsFactory, ChangeOpFactoryProvider $changeOpFactoryProvider, EntityFactory $entityFactory, SettingsArray $repoSettings)

Protected Member Functions
	validateParameters (array $params)
	modifyEntity (EntityDocument $entity, ChangeOp $changeOp, array $preparedParameters)
	Actually modify the entity.
	getChangeOp (array $preparedParameters, EntityDocument $entity)
	getAllowedParams ()
	getEntityTypesWithAliases ()
	getExamplesMessages ()
Protected Member Functions inherited from Wikibase\Repo\Api\ModifyEntity
	getTitleLookup ()
	getResultBuilder ()
	createSummary (array $params)
	Create a new Summary instance suitable for representing the action performed by this module.
	applyChangeOp (ChangeOp $changeOp, EntityDocument $entity, ?Summary $summary=null)
	Applies the given ChangeOp to the given Entity.
	prepareParameters (array $params)
	validateEntitySpecificParameters (array $preparedParameters, EntityDocument $entity, int $baseRevId)

Private Member Functions
	adjustSummary (Summary $summary, array $params, AliasesProvider $entity)
	normalizeAliases (array $aliases)

Private Attributes
	$termChangeOpFactory
	$statsFactory
	$entityFactory
	$sandboxEntityIds

Additional Inherited Members
Public Attributes inherited from Wikibase\Repo\Api\ModifyEntity
const	PARAM_SUMMARY = 'summary'
Protected Attributes inherited from Wikibase\Repo\Api\ModifyEntity
	$stringNormalizer
	$siteLinkGlobalIdentifiersProvider
	$badgeItems
	$errorReporter
	$enabledEntityTypes

Detailed Description

API module to set the aliases for a Wikibase entity.

Requires API write mode to be enabled.

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\Api\SetAliases::__construct	(	ApiMain	$mainModule,
		string	$moduleName,
		FingerprintChangeOpFactory	$termChangeOpFactory,
		StatsFactory	$statsFactory,
		bool	$federatedPropertiesEnabled,
		EntityFactory	$entityFactory,
		array	$sandboxEntityIds )

Member Function Documentation

adjustSummary()

Wikibase\Repo\Api\SetAliases::adjustSummary ( Summary $summary, array $params, AliasesProvider $entity )

private

factory()

static Wikibase\Repo\Api\SetAliases::factory ( ApiMain $mainModule, string $moduleName, StatsFactory $statsFactory, ChangeOpFactoryProvider $changeOpFactoryProvider, EntityFactory $entityFactory, SettingsArray $repoSettings )

static

getAllowedParams()

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

protected

Reimplemented from Wikibase\Repo\Api\ModifyEntity.

getChangeOp()

Wikibase\Repo\Api\SetAliases::getChangeOp ( array $preparedParameters, EntityDocument $entity )

protected

Parameters

array	$preparedParameters
EntityDocument	$entity

Returns

ChangeOp

Reimplemented from Wikibase\Repo\Api\ModifyEntity.

getEntityTypesWithAliases()

Wikibase\Repo\Api\SetAliases::getEntityTypesWithAliases ( )

protected

getExamplesMessages()

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

protected

isWriteMode()

Wikibase\Repo\Api\SetAliases::isWriteMode

(

)

See also

ApiBase::isWriteMode()

Returns

bool Always true.

modifyEntity()

Wikibase\Repo\Api\SetAliases::modifyEntity ( EntityDocument $entity, ChangeOp $changeOp, array $preparedParameters )

protected

Actually modify the entity.

Parameters

EntityDocument	$entity
ChangeOp	$changeOp
array	$preparedParameters

Returns

Summary|null a summary of the modification, or null to indicate failure.

Reimplemented from Wikibase\Repo\Api\ModifyEntity.

needsToken()

Wikibase\Repo\Api\SetAliases::needsToken

(

)

See also

ApiBase::needsToken

Returns

string

normalizeAliases()

Wikibase\Repo\Api\SetAliases::normalizeAliases ( array $aliases )

private

Parameters

string[]

$aliases

Returns

string[]

validateParameters()

Wikibase\Repo\Api\SetAliases::validateParameters ( array $params )

protected

See also

ModifyEntity::validateParameters

Parameters

array

$params

Exceptions

ApiUsageException

Reimplemented from Wikibase\Repo\Api\ModifyEntity.

Member Data Documentation

$entityFactory

Wikibase\Repo\Api\SetAliases::$entityFactory

private

$sandboxEntityIds

Wikibase\Repo\Api\SetAliases::$sandboxEntityIds

private

$statsFactory

Wikibase\Repo\Api\SetAliases::$statsFactory

private

$termChangeOpFactory

Wikibase\Repo\Api\SetAliases::$termChangeOpFactory

private

---

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

• repo/includes/Api/SetAliases.php