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

Class for aliases change operation. More...

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

Public Member Functions

 __construct ( $languageCode, array $aliases, $action, TermValidatorFactory $termValidatorFactory)
 
 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)
 
 getActions ()
 

Private Member Functions

 updateAliases (AliasGroupList $aliases)
 Applies the change to the aliases.
 

Private Attributes

 $languageCode
 
 $aliases
 
 $action
 
 $termValidatorFactory
 

Additional Inherited Members

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

Detailed Description

Class for aliases change operation.

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

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Repo\ChangeOp\ChangeOpAliases::__construct ( $languageCode,
array $aliases,
$action,
TermValidatorFactory $termValidatorFactory )
Parameters
string$languageCode
string[]$aliases
string$actionshould be set|add|remove
TermValidatorFactory$termValidatorFactory
Exceptions
InvalidArgumentException

Member Function Documentation

◆ apply()

Wikibase\Repo\ChangeOp\ChangeOpAliases::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.

◆ getActions()

Wikibase\Repo\ChangeOp\ChangeOpAliases::getActions ( )
See also
ChangeOp::getActions
Returns
string[]

Reimplemented from Wikibase\Repo\ChangeOp\ChangeOpBase.

◆ updateAliases()

Wikibase\Repo\ChangeOp\ChangeOpAliases::updateAliases ( AliasGroupList $aliases)
private

Applies the change to the aliases.

Parameters
AliasGroupList$aliases
Exceptions
ChangeOpException

◆ validate()

Wikibase\Repo\ChangeOp\ChangeOpAliases::validate ( EntityDocument $entity)
See also
ChangeOp::validate
Parameters
EntityDocument$entity
Exceptions
ChangeOpException
Returns
Result

Implements Wikibase\Repo\ChangeOp\ChangeOp.

Member Data Documentation

◆ $action

Wikibase\Repo\ChangeOp\ChangeOpAliases::$action
private

◆ $aliases

Wikibase\Repo\ChangeOp\ChangeOpAliases::$aliases
private

◆ $languageCode

Wikibase\Repo\ChangeOp\ChangeOpAliases::$languageCode
private

◆ $termValidatorFactory

Wikibase\Repo\ChangeOp\ChangeOpAliases::$termValidatorFactory
private

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