Wikibase
MediaWiki Wikibase extension
Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases Class Reference

Special page for setting label, description and aliases of a Wikibase entity that features labels, descriptions and aliases. More...

+ Inheritance diagram for Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases:
+ Collaboration diagram for Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases:

Public Member Functions

 __construct (SpecialPageCopyrightView $copyrightView, SummaryFormatter $summaryFormatter, EntityTitleLookup $entityTitleLookup, MediawikiEditEntityFactory $editEntityFactory, FingerprintChangeOpFactory $changeOpFactory, ContentLanguages $termsLanguages, EntityPermissionChecker $permissionChecker)
 
 doesWrites ()
 
- Public Member Functions inherited from Wikibase\Repo\Specials\SpecialModifyEntity
 __construct ( $title, SpecialPageCopyrightView $copyrightView, SummaryFormatter $summaryFormatter, EntityTitleLookup $entityTitleLookup, MediawikiEditEntityFactory $editEntityFactory)
 
 execute ( $subPage)
 
- Public Member Functions inherited from Wikibase\Repo\Specials\SpecialWikibaseRepoPage
 __construct ( $title, $restriction, SpecialPageCopyrightView $copyrightView, SummaryFormatter $summaryFormatter, EntityTitleLookup $entityTitleLookup, MediawikiEditEntityFactory $editEntityFactory)
 
- Public Member Functions inherited from Wikibase\Repo\Specials\SpecialWikibasePage
 __construct ( $name='', $restriction='', $listed=true)
 
 getDescription ()
 
 setHeaders ()
 

Static Public Member Functions

static factory (ChangeOpFactoryProvider $changeOpFactoryProvider, MediawikiEditEntityFactory $editEntityFactory, EntityPermissionChecker $entityPermissionChecker, EntityTitleLookup $entityTitleLookup, SettingsArray $repoSettings, SummaryFormatter $summaryFormatter, ContentLanguages $termsLanguages)
 

Protected Member Functions

 validateInput ()
 
 getForm (EntityDocument $entity=null)
 
 processArguments ( $subPage)
 
 modifyEntity (EntityDocument $entity)
 
- Protected Member Functions inherited from Wikibase\Repo\Specials\SpecialModifyEntity
 getEntityId ()
 Returns the ID of the Entity being modified. More...
 
 getBaseRevision ()
 Returns the base revision. More...
 
 getLatestRevision ()
 Returns the current revision. More...
 
 getEntityForModification ()
 Returns the EntityDocument that is to be modified by code in this class (or subclasses). More...
 
 getEntityForDisplay ()
 Returns the EntityDocument that is to be shown by code in this class (or subclasses). More...
 
 getFormElements (EntityDocument $entity=null)
 
 isModificationRequested ()
 Whether the current request is a request for modification (as opposed to a request for showing the input form). More...
 
 applyChangeOp (ChangeOp $changeOp, EntityDocument $entity, Summary $summary=null)
 Applies the given ChangeOp to the given Entity. More...
 
- Protected Member Functions inherited from Wikibase\Repo\Specials\SpecialWikibaseRepoPage
 prepareEditEntity (EntityId $id=null, $baseRev=0)
 
 getEditEntity ()
 Returns the EditEntity interactor. More...
 
 parseEntityId ( $rawId)
 Parses an entity id. More...
 
 parseItemId ( $rawId)
 Parses an item id. More...
 
 getEntityTitle (EntityId $id)
 
 saveEntity (EntityDocument $entity, FormatableSummary $summary, $token, $flags=EDIT_UPDATE)
 Saves the entity using the given summary. More...
 
 getCopyrightHTML ( $saveMessageKey=null)
 
- Protected Member Functions inherited from Wikibase\Repo\Specials\SpecialWikibasePage
 getGroupName ()
 
 checkBlocked ()
 Checks if user is blocked, and if blocked throws a UserBlocked. More...
 
 showErrorHTML ( $error)
 

Private Member Functions

 wasPostedWithLabelDescriptionOrAliases ()
 
 isAllowedToChangeTerms (EntityDocument $entity)
 
 getLabeledInputField ( $termType, $value)
 Returns an HTML label and text input element for a specific term. More...
 
 extractInput ( $subPage)
 
 setFingerprintFields (Fingerprint $fingerprint)
 
 isValidLanguageCode ( $languageCode)
 
 assertNoPipeCharacterInAliases (Fingerprint $fingerprint)
 
 applyChangeOpList (array $changeOps, EntityDocument $entity)
 
 getChangeOps (Fingerprint $fingerprint)
 
 getSummaryForLabelDescriptionAliases ()
 

Private Attributes

 $changeOpFactory
 
 $termsLanguages
 
 $permissionChecker
 
 $languageCode
 
 $label = ''
 
 $description = ''
 
 $aliases = []
 

Additional Inherited Members

- Protected Attributes inherited from Wikibase\Repo\Specials\SpecialWikibaseRepoPage
 $summaryFormatter
 
- Protected Attributes inherited from Wikibase\Repo\Specials\SpecialWikibasePage
 $stringNormalizer
 

Detailed Description

Special page for setting label, description and aliases of a Wikibase entity that features labels, descriptions and aliases.

Author
Thiemo Kreuz

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::__construct ( SpecialPageCopyrightView  $copyrightView,
SummaryFormatter  $summaryFormatter,
EntityTitleLookup  $entityTitleLookup,
MediawikiEditEntityFactory  $editEntityFactory,
FingerprintChangeOpFactory  $changeOpFactory,
ContentLanguages  $termsLanguages,
EntityPermissionChecker  $permissionChecker 
)

Member Function Documentation

◆ applyChangeOpList()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::applyChangeOpList ( array  $changeOps,
EntityDocument  $entity 
)
private
Exceptions
ChangeOpException

XXX: The $changeOps array is still used below as it is indexed with the module name to pass to the Summary object.

◆ assertNoPipeCharacterInAliases()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::assertNoPipeCharacterInAliases ( Fingerprint  $fingerprint)
private
Parameters
Fingerprint$fingerprint
Exceptions
UserInputException
Returns
bool

◆ doesWrites()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::doesWrites ( )

◆ extractInput()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::extractInput (   $subPage)
private
Parameters
string | null$subPage

◆ factory()

static Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::factory ( ChangeOpFactoryProvider  $changeOpFactoryProvider,
MediawikiEditEntityFactory  $editEntityFactory,
EntityPermissionChecker  $entityPermissionChecker,
EntityTitleLookup  $entityTitleLookup,
SettingsArray  $repoSettings,
SummaryFormatter  $summaryFormatter,
ContentLanguages  $termsLanguages 
)
static

◆ getChangeOps()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::getChangeOps ( Fingerprint  $fingerprint)
private
Parameters
Fingerprint$fingerprint
Returns
ChangeOp[]

◆ getForm()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::getForm ( EntityDocument  $entity = null)
protected
See also
SpecialModifyEntity::getForm
Parameters
EntityDocument | null$entity
Returns
HTMLForm

Reimplemented from Wikibase\Repo\Specials\SpecialModifyEntity.

◆ getLabeledInputField()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::getLabeledInputField (   $termType,
  $value 
)
private

Returns an HTML label and text input element for a specific term.

Parameters
string$termTypeEither 'label', 'description' or 'aliases'.
string$valueText to fill the input element with
Returns
array[]

◆ getSummaryForLabelDescriptionAliases()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::getSummaryForLabelDescriptionAliases ( )
private
Returns
Summary

◆ isAllowedToChangeTerms()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::isAllowedToChangeTerms ( EntityDocument  $entity)
private
Parameters
EntityDocument$entity
Returns
bool

◆ isValidLanguageCode()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::isValidLanguageCode (   $languageCode)
private
Parameters
string | null$languageCode
Returns
bool

◆ modifyEntity()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::modifyEntity ( EntityDocument  $entity)
protected
See also
SpecialModifyEntity::modifyEntity
Parameters
EntityDocument$entity
Exceptions
InvalidArgumentException
Returns
Summary|bool

Reimplemented from Wikibase\Repo\Specials\SpecialModifyEntity.

◆ processArguments()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::processArguments (   $subPage)
protected
See also
SpecialModifyEntity::processArguments
Parameters
string | null$subPage

Reimplemented from Wikibase\Repo\Specials\SpecialModifyEntity.

◆ setFingerprintFields()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::setFingerprintFields ( Fingerprint  $fingerprint)
private

◆ validateInput()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::validateInput ( )
protected

◆ wasPostedWithLabelDescriptionOrAliases()

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::wasPostedWithLabelDescriptionOrAliases ( )
private
Returns
bool

Member Data Documentation

◆ $aliases

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::$aliases = []
private

◆ $changeOpFactory

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::$changeOpFactory
private

◆ $description

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::$description = ''
private

◆ $label

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::$label = ''
private

◆ $languageCode

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::$languageCode
private

◆ $permissionChecker

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::$permissionChecker
private

◆ $termsLanguages

Wikibase\Repo\Specials\SpecialSetLabelDescriptionAliases::$termsLanguages
private

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