Wikibase
MediaWiki Wikibase extension
Loading...
Searching...
No Matches
Wikibase\Repo\ChangeOp\ChangeOpRemoveStatement Class Reference

Class for statement remove operation. More...

+ Inheritance diagram for Wikibase\Repo\ChangeOp\ChangeOpRemoveStatement:
+ Collaboration diagram for Wikibase\Repo\ChangeOp\ChangeOpRemoveStatement:

Public Member Functions

 getGuid ()
 
 __construct ( $guid)
 Constructs a new mainsnak change operation.
 
 apply (EntityDocument $entity, Summary $summary=null)
 Applies the change represented by this ChangeOp to the given Entity.As ChangeOp does not yet know whether it is going to change the entity or not, and since expensive validations should be run only on ChangeOps that will change the entity, ChangeOpResult::validate is recommended for such validations.
Parameters
EntityDocument$entity
Summary | null$summary
Exceptions
InvalidArgumentExceptionwhen called with an unexpected entity type.
ChangeOpExceptionwhen the change can not be applied to the entity, e.g. because the same data was edited in the meantime.
Returns
ChangeOpResult

 
 validate (EntityDocument $entity)
 
- Public Member Functions inherited from Wikibase\Repo\ChangeOp\ChangeOpBase
 getActions ()
 

Private Member Functions

 getSummaryArgs (Snak $mainSnak)
 

Private Attributes

 $guid
 

Additional Inherited Members

- Protected Member Functions inherited from Wikibase\Repo\ChangeOp\ChangeOpBase
 updateSummary (?Summary $summary, $action, $language='', $args='')
 

Detailed Description

Class for statement remove operation.

Author
Addshore
Thiemo Kreuz

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Repo\ChangeOp\ChangeOpRemoveStatement::__construct (   $guid)

Constructs a new mainsnak change operation.

Parameters
string$guid
Exceptions
InvalidArgumentException

Member Function Documentation

◆ apply()

Wikibase\Repo\ChangeOp\ChangeOpRemoveStatement::apply ( EntityDocument  $entity,
Summary  $summary = null 
)

Applies the change represented by this ChangeOp to the given Entity.As ChangeOp does not yet know whether it is going to change the entity or not, and since expensive validations should be run only on ChangeOps that will change the entity, ChangeOpResult::validate is recommended for such validations.

Parameters
EntityDocument$entity
Summary | null$summary
Exceptions
InvalidArgumentExceptionwhen called with an unexpected entity type.
ChangeOpExceptionwhen the change can not be applied to the entity, e.g. because the same data was edited in the meantime.
Returns
ChangeOpResult

Implements Wikibase\Repo\ChangeOp\ChangeOp.

◆ getGuid()

Wikibase\Repo\ChangeOp\ChangeOpRemoveStatement::getGuid ( )
Returns
string

◆ getSummaryArgs()

Wikibase\Repo\ChangeOp\ChangeOpRemoveStatement::getSummaryArgs ( Snak  $mainSnak)
private
Parameters
Snak$mainSnak
Returns
array

◆ validate()

Wikibase\Repo\ChangeOp\ChangeOpRemoveStatement::validate ( EntityDocument  $entity)
See also
ChangeOp::validate
Parameters
EntityDocument$entity
Returns
Result Always successful.

Implements Wikibase\Repo\ChangeOp\ChangeOp.

Member Data Documentation

◆ $guid

Wikibase\Repo\ChangeOp\ChangeOpRemoveStatement::$guid
private

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