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

Class for reference removal change operation. More...

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

Public Member Functions

 __construct ( $statementGuid, $referenceHash)
 Constructs a new reference removal change operation.
 
 apply (EntityDocument $entity, Summary $summary=null)
 
 validate (EntityDocument $entity)
 
- Public Member Functions inherited from Wikibase\Repo\ChangeOp\ChangeOpBase
 getActions ()
 

Protected Member Functions

 removeReference (ReferenceList $references, Summary $summary=null)
 
 getSnakSummaryArgs (Snak $snak)
 
- Protected Member Functions inherited from Wikibase\Repo\ChangeOp\ChangeOpBase
 updateSummary (?Summary $summary, $action, $language='', $args='')
 

Private Attributes

 $statementGuid
 
 $referenceHash
 

Detailed Description

Class for reference removal change operation.

Author
Addshore

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Repo\ChangeOp\ChangeOpReferenceRemove::__construct (   $statementGuid,
  $referenceHash 
)

Constructs a new reference removal change operation.

Parameters
string$statementGuid
string$referenceHash
Exceptions
InvalidArgumentException

Member Function Documentation

◆ apply()

Wikibase\Repo\ChangeOp\ChangeOpReferenceRemove::apply ( EntityDocument  $entity,
Summary  $summary = null 
)
See also
ChangeOp::apply()
Parameters
EntityDocument$entity
Summary | null$summary
Exceptions
InvalidArgumentException
ChangeOpException

Implements Wikibase\Repo\ChangeOp\ChangeOp.

◆ getSnakSummaryArgs()

Wikibase\Repo\ChangeOp\ChangeOpReferenceRemove::getSnakSummaryArgs ( Snak  $snak)
protected
Parameters
Snak$snak
Returns
array

◆ removeReference()

Wikibase\Repo\ChangeOp\ChangeOpReferenceRemove::removeReference ( ReferenceList  $references,
Summary  $summary = null 
)
protected
Parameters
ReferenceList$references
Summary | null$summary
Exceptions
ChangeOpException

◆ validate()

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

Implements Wikibase\Repo\ChangeOp\ChangeOp.

Member Data Documentation

◆ $referenceHash

Wikibase\Repo\ChangeOp\ChangeOpReferenceRemove::$referenceHash
private

◆ $statementGuid

Wikibase\Repo\ChangeOp\ChangeOpReferenceRemove::$statementGuid
private

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