Base class for API modules modifying a single entity identified based on id xor a combination of site and page title. More...

Inheritance diagram for Wikibase\Repo\Api\ModifyEntity:

Collaboration diagram for Wikibase\Repo\Api\ModifyEntity:

Public Member Functions
	__construct (ApiMain $mainModule, $moduleName, bool $federatedPropertiesEnabled, $modulePrefix='')

	setServices (SiteLinkTargetProvider $siteLinkTargetProvider)

	execute ()

Protected Member Functions
	getTitleLookup ()

	getResultBuilder ()

	createSummary (array $params)
	Create a new Summary instance suitable for representing the action performed by this module.

	modifyEntity (EntityDocument &$entity, ChangeOp $changeOp, array $preparedParameters)
	Actually modify the entity.

	applyChangeOp (ChangeOp $changeOp, EntityDocument $entity, Summary $summary=null)
	Applies the given ChangeOp to the given Entity.

	prepareParameters (array $params)

	validateEntitySpecificParameters (array $preparedParameters, EntityDocument $entity, $baseRevId)

	validateParameters (array $params)
	Make sure the required parameters are provided and that they are valid.

	getChangeOp (array $preparedParameters, EntityDocument $entity)

	getAllowedParams ()

Protected Attributes
	$stringNormalizer

	$siteLinkTargetProvider

	$siteLinkGroups

	$badgeItems

	$errorReporter

	$enabledEntityTypes

Private Member Functions
	loadEntityFromSavingHelper (?EntityId $entityId)
	Try to find the entity or fail and create it, or die in the process.

	checkPermissions (EntityDocument $entity, User $user, ChangeOp $changeOp)
	Check the rights for the user accessing the module.

	addToOutput (EntityDocument $entity, Status $status, $oldRevId=null)

	getAllowedParamsForId ()
	Get allowed params for the identification of the entity Lookup through an id is common for all entities.

	getAllowedParamsForSiteLink ()
	Get allowed params for the identification by a sitelink pair Lookup through the sitelink object is not used in every subclasses.

	getAllowedParamsForEntity ()
	Get allowed params for the entity in general.

Private Attributes
	$titleLookup

	$permissionChecker

	$revisionLookup

	$resultBuilder

	$entitySavingHelper

Detailed Description

Base class for API modules modifying a single entity identified based on id xor a combination of site and page title.

Copyright: GPL-2.0-or-later

Author: John Erling Blad < jebla.nosp@m.d@gm.nosp@m.ail.c.nosp@m.om >; Daniel Kinzler; Michał Łazowik

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Repo\Api\ModifyEntity::__construct	(	ApiMain	$mainModule,
			$moduleName,
		bool	$federatedPropertiesEnabled,
			$modulePrefix = `''`
	)

Parameters

ApiMain	$mainModule
string	$moduleName
bool	$federatedPropertiesEnabled
string	$modulePrefix

See also: ApiBase::__construct

Member Function Documentation

◆ addToOutput()

Wikibase\Repo\Api\ModifyEntity::addToOutput	(	EntityDocument	$entity,
		Status	$status,
			$oldRevId = `null`
	)

private

◆ applyChangeOp()

Wikibase\Repo\Api\ModifyEntity::applyChangeOp	(	ChangeOp	$changeOp,
		EntityDocument	$entity,
		Summary	$summary = `null`
	)

protected

Applies the given ChangeOp to the given Entity.

Any ChangeOpException is converted into an ApiUsageException with the code 'modification-failed'.

Parameters

ChangeOp	$changeOp
EntityDocument	$entity
Summary \| null	$summary	The summary object to update with information about the change.

Returns: ChangeOpResult

◆ checkPermissions()

Wikibase\Repo\Api\ModifyEntity::checkPermissions	(	EntityDocument	$entity,
		User	$user,
		ChangeOp	$changeOp
	)

private

Check the rights for the user accessing the module.

Parameters

EntityDocument	$entity	the entity to check
User	$user	User doing the action
ChangeOp	$changeOp

Returns: Status the check's result

◆ createSummary()

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

protected

Create a new Summary instance suitable for representing the action performed by this module.

Parameters

array $params

Returns: Summary

Reimplemented in Wikibase\Repo\Api\ModifyTerm.

◆ execute()

Wikibase\Repo\Api\ModifyEntity::execute ( )

◆ getAllowedParams()

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

protected

Reimplemented in Wikibase\Repo\Api\EditEntity, Wikibase\Repo\Api\ModifyTerm, Wikibase\Repo\Api\SetAliases, Wikibase\Repo\Api\SetDescription, Wikibase\Repo\Api\SetLabel, and Wikibase\Repo\Api\SetSiteLink.

◆ getAllowedParamsForEntity()

Wikibase\Repo\Api\ModifyEntity::getAllowedParamsForEntity ( )

private

Get allowed params for the entity in general.

Returns: array

◆ getAllowedParamsForId()

Wikibase\Repo\Api\ModifyEntity::getAllowedParamsForId ( )

private

Get allowed params for the identification of the entity Lookup through an id is common for all entities.

Returns: array[]

◆ getAllowedParamsForSiteLink()

Wikibase\Repo\Api\ModifyEntity::getAllowedParamsForSiteLink ( )

private

Get allowed params for the identification by a sitelink pair Lookup through the sitelink object is not used in every subclasses.

Returns: array[]

◆ getChangeOp()

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

abstractprotected

Parameters

array	$preparedParameters
EntityDocument	$entity

Returns: ChangeOp

Reimplemented in Wikibase\Repo\Api\EditEntity, Wikibase\Repo\Api\SetAliases, Wikibase\Repo\Api\SetDescription, Wikibase\Repo\Api\SetLabel, and Wikibase\Repo\Api\SetSiteLink.

◆ getResultBuilder()

Wikibase\Repo\Api\ModifyEntity::getResultBuilder ( )

protected

Returns: ResultBuilder

◆ getTitleLookup()

Wikibase\Repo\Api\ModifyEntity::getTitleLookup ( )

protected

Returns: EntityTitleStoreLookup

◆ loadEntityFromSavingHelper()

Wikibase\Repo\Api\ModifyEntity::loadEntityFromSavingHelper ( ?EntityId $entityId )

private

Try to find the entity or fail and create it, or die in the process.

Parameters

EntityId | null $entityId

Returns: EntityDocument

Exceptions

ApiUsageException

◆ modifyEntity()

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

abstractprotected

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 in Wikibase\Repo\Api\EditEntity, Wikibase\Repo\Api\SetAliases, Wikibase\Repo\Api\SetDescription, Wikibase\Repo\Api\SetLabel, and Wikibase\Repo\Api\SetSiteLink.

◆ prepareParameters()

Wikibase\Repo\Api\ModifyEntity::prepareParameters ( array $params )

protected

Parameters

array $params

Returns: array

Reimplemented in Wikibase\Repo\Api\EditEntity.

◆ setServices()

Wikibase\Repo\Api\ModifyEntity::setServices ( SiteLinkTargetProvider $siteLinkTargetProvider )

◆ validateEntitySpecificParameters()

Wikibase\Repo\Api\ModifyEntity::validateEntitySpecificParameters	(	array	$preparedParameters,
		EntityDocument	$entity,
			$baseRevId
	)

protected

Reimplemented in Wikibase\Repo\Api\EditEntity.

◆ validateParameters()

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

protected

Make sure the required parameters are provided and that they are valid.

Parameters

array $params

Wikibase\Repo\Api\ModifyEntity::$stringNormalizer

protected

◆ $titleLookup

Wikibase\Repo\Api\ModifyEntity::$titleLookup

private

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

repo/includes/Api/ModifyEntity.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addToOutput()

◆ applyChangeOp()

◆ checkPermissions()

◆ createSummary()

◆ execute()

◆ getAllowedParams()

◆ getAllowedParamsForEntity()

◆ getAllowedParamsForId()

◆ getAllowedParamsForSiteLink()

◆ getChangeOp()

◆ getResultBuilder()

◆ getTitleLookup()

◆ loadEntityFromSavingHelper()

◆ modifyEntity()

◆ prepareParameters()

◆ setServices()

◆ validateEntitySpecificParameters()

◆ validateParameters()

Member Data Documentation

◆ $badgeItems

◆ $enabledEntityTypes

◆ $entitySavingHelper

◆ $errorReporter

◆ $permissionChecker

◆ $resultBuilder

◆ $revisionLookup

◆ $siteLinkGroups

◆ $siteLinkTargetProvider

◆ $stringNormalizer

◆ $titleLookup