Wikibase\Repo\Api\RemoveReferences Class Reference

API module for removing one or more references of the same statement. More...

Inheritance diagram for Wikibase\Repo\Api\RemoveReferences:

Collaboration diagram for Wikibase\Repo\Api\RemoveReferences:

Public Member Functions
	__construct (ApiMain $mainModule, string $moduleName, ApiErrorReporter $errorReporter, StatementChangeOpFactory $statementChangeOpFactory, StatementModificationHelper $modificationHelper, StatementGuidParser $guidParser, callable $resultBuilderInstantiator, callable $entitySavingHelperInstantiator, bool $federatedPropertiesEnabled, array $sandboxEntityIds)
	execute ()
	isWriteMode ()
	needsToken ()

Static Public Member Functions
static	factory (ApiMain $mainModule, string $moduleName, ApiHelperFactory $apiHelperFactory, ChangeOpFactoryProvider $changeOpFactoryProvider, EntityIdParser $entityIdParser, SettingsArray $repoSettings, SnakFactory $snakFactory, StatementGuidParser $statementGuidParser, StatementGuidValidator $statementGuidValidator)

Protected Member Functions
	getAllowedParams ()
	getExamplesMessages ()

Protected Attributes
	$errorReporter

Private Member Functions
	validateParameters (array $params)
	getChangeOps (string $guid, array $referenceHashes)
	getReferenceHashesFromParams (array $params, Statement $statement)

Private Attributes
	$statementChangeOpFactory
	$modificationHelper
	$guidParser
	$resultBuilder
	$entitySavingHelper
	$sandboxEntityIds

Detailed Description

API module for removing one or more references of the same statement.

Copyright

GPL-2.0-or-later

Author

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

Tobias Gritschacher < tobia.nosp@m.s.gr.nosp@m.itsch.nosp@m.ache.nosp@m.r@wik.nosp@m.imed.nosp@m.ia.de >

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\Api\RemoveReferences::__construct	(	ApiMain	$mainModule,
		string	$moduleName,
		ApiErrorReporter	$errorReporter,
		StatementChangeOpFactory	$statementChangeOpFactory,
		StatementModificationHelper	$modificationHelper,
		StatementGuidParser	$guidParser,
		callable	$resultBuilderInstantiator,
		callable	$entitySavingHelperInstantiator,
		bool	$federatedPropertiesEnabled,
		array	$sandboxEntityIds
	)

Member Function Documentation

execute()

Wikibase\Repo\Api\RemoveReferences::execute

(

)

factory()

static Wikibase\Repo\Api\RemoveReferences::factory ( ApiMain  $mainModule, string  $moduleName, ApiHelperFactory  $apiHelperFactory, ChangeOpFactoryProvider  $changeOpFactoryProvider, EntityIdParser  $entityIdParser, SettingsArray  $repoSettings, SnakFactory  $snakFactory, StatementGuidParser  $statementGuidParser, StatementGuidValidator  $statementGuidValidator  )

static

getAllowedParams()

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

protected

getChangeOps()

Wikibase\Repo\Api\RemoveReferences::getChangeOps ( string  $guid, array  $referenceHashes  )

private

Parameters

string	$guid
string[]	$referenceHashes

Returns

ChangeOp[]

getExamplesMessages()

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

protected

getReferenceHashesFromParams()

Wikibase\Repo\Api\RemoveReferences::getReferenceHashesFromParams ( array  $params, Statement  $statement  )

private

Parameters

array	$params
Statement	$statement

Returns

string[]

isWriteMode()

Wikibase\Repo\Api\RemoveReferences::isWriteMode

(

)

needsToken()

Wikibase\Repo\Api\RemoveReferences::needsToken

(

)

See also

ApiBase::needsToken

Returns

string

validateParameters()

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

private

Member Data Documentation

$entitySavingHelper

Wikibase\Repo\Api\RemoveReferences::$entitySavingHelper

private

$errorReporter

Wikibase\Repo\Api\RemoveReferences::$errorReporter

protected

$guidParser

Wikibase\Repo\Api\RemoveReferences::$guidParser

private

$modificationHelper

Wikibase\Repo\Api\RemoveReferences::$modificationHelper

private

$resultBuilder

Wikibase\Repo\Api\RemoveReferences::$resultBuilder

private

$sandboxEntityIds

Wikibase\Repo\Api\RemoveReferences::$sandboxEntityIds

private

$statementChangeOpFactory

Wikibase\Repo\Api\RemoveReferences::$statementChangeOpFactory

private

---

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

• repo/includes/Api/RemoveReferences.php