Wikibase\Repo\Api\ModifyTerm Class Reference

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

Inheritance diagram for Wikibase\Repo\Api\ModifyTerm:

Collaboration diagram for Wikibase\Repo\Api\ModifyTerm:

Protected Member Functions
	createSummary (array $params)
	Creates a Summary object based on the given API call parameters. More...
	getAllowedParams ()
Protected Member Functions inherited from Wikibase\Repo\Api\ModifyEntity
	getTitleLookup ()
	getResultBuilder ()
	modifyEntity (EntityDocument $entity, ChangeOp $changeOp, array $preparedParameters)
	Actually modify the entity. More...
	applyChangeOp (ChangeOp $changeOp, EntityDocument $entity, Summary $summary=null)
	Applies the given ChangeOp to the given Entity. More...
	prepareParameters (array $params)
	validateEntitySpecificParameters (array $preparedParameters, EntityDocument $entity, int $baseRevId)
	validateParameters (array $params)
	Make sure the required parameters are provided and that they are valid. More...
	getChangeOp (array $preparedParameters, EntityDocument $entity)

Additional Inherited Members
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. More...
Protected Attributes inherited from Wikibase\Repo\Api\ModifyEntity
	$stringNormalizer
	$siteLinkGlobalIdentifiersProvider
	$siteLinkGroups
	$badgeItems
	$errorReporter
	$enabledEntityTypes

Detailed Description

API module to set the terms for a Wikibase entity.

Copyright

GPL-2.0-or-later

Author

Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

John Erling Blad < jebla.nosp@m.d@gm.nosp@m.ail.c.nosp@m.om >

Daniel Kinzler

Member Function Documentation

createSummary()

Wikibase\Repo\Api\ModifyTerm::createSummary ( array  $params )

protected

Creates a Summary object based on the given API call parameters.

The Summary will be initializes with the appropriate action name and target language. It will not have any summary arguments set.

Parameters

array

$params

Returns

Summary

Reimplemented from Wikibase\Repo\Api\ModifyEntity.

getAllowedParams()

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

protected

Reimplemented from Wikibase\Repo\Api\ModifyEntity.

Reimplemented in Wikibase\Repo\Api\SetLabel, and Wikibase\Repo\Api\SetDescription.

---

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

• repo/includes/Api/ModifyTerm.php