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)
	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 InvalidArgumentException when called with an unexpected entity type. ChangeOpException when 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 ()

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.

Copyright

GPL-2.0-or-later

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 )

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

InvalidArgumentException	when called with an unexpected entity type.
ChangeOpException	when 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.

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:

• repo/includes/ChangeOp/ChangeOpReferenceRemove.php