Wikibase
MediaWiki Wikibase extension
Loading...
Searching...
No Matches
Wikibase\Repo\Api\RemoveClaims Class Reference

API module for removing claims. More...

+ Inheritance diagram for Wikibase\Repo\Api\RemoveClaims:
+ Collaboration diagram for Wikibase\Repo\Api\RemoveClaims:

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 $settings, SnakFactory $snakFactory, StatementGuidParser $statementGuidParser, StatementGuidValidator $statementGuidValidator)
 

Protected Member Functions

 getAllowedParams ()
 
 getExamplesMessages ()
 

Protected Attributes

 $errorReporter
 

Private Member Functions

 getEntityId (array $params)
 Validates the parameters and returns the EntityId to act upon on success.
 
 getChangeOps (array $params)
 

Private Attributes

 $statementChangeOpFactory
 
 $modificationHelper
 
 $guidParser
 
 $resultBuilder
 
 $entitySavingHelper
 
 $sandboxEntityIds
 

Detailed Description

API module for removing claims.

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\RemoveClaims::__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\RemoveClaims::execute ( )

◆ factory()

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

◆ getAllowedParams()

Wikibase\Repo\Api\RemoveClaims::getAllowedParams ( )
protected

◆ getChangeOps()

Wikibase\Repo\Api\RemoveClaims::getChangeOps ( array  $params)
private
Parameters
array$params
Returns
ChangeOp[]

◆ getEntityId()

Wikibase\Repo\Api\RemoveClaims::getEntityId ( array  $params)
private

Validates the parameters and returns the EntityId to act upon on success.

Parameters
array$params
Returns
EntityId

◆ getExamplesMessages()

Wikibase\Repo\Api\RemoveClaims::getExamplesMessages ( )
protected

◆ isWriteMode()

Wikibase\Repo\Api\RemoveClaims::isWriteMode ( )

◆ needsToken()

Wikibase\Repo\Api\RemoveClaims::needsToken ( )
See also
ApiBase::needsToken
Returns
string

Member Data Documentation

◆ $entitySavingHelper

Wikibase\Repo\Api\RemoveClaims::$entitySavingHelper
private

◆ $errorReporter

Wikibase\Repo\Api\RemoveClaims::$errorReporter
protected

◆ $guidParser

Wikibase\Repo\Api\RemoveClaims::$guidParser
private

◆ $modificationHelper

Wikibase\Repo\Api\RemoveClaims::$modificationHelper
private

◆ $resultBuilder

Wikibase\Repo\Api\RemoveClaims::$resultBuilder
private

◆ $sandboxEntityIds

Wikibase\Repo\Api\RemoveClaims::$sandboxEntityIds
private

◆ $statementChangeOpFactory

Wikibase\Repo\Api\RemoveClaims::$statementChangeOpFactory
private

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