Wikibase
MediaWiki Wikibase extension
Loading...
Searching...
No Matches
Wikibase\Repo\Specials\SpecialSetDescription Class Reference

Special page for setting the description of a Wikibase entity. More...

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

Public Member Functions

 __construct (SpecialPageCopyrightView $copyrightView, SummaryFormatter $summaryFormatter, EntityTitleLookup $entityTitleLookup, MediawikiEditEntityFactory $editEntityFactory, EntityPermissionChecker $entityPermissionChecker)
 
 doesWrites ()
 
- Public Member Functions inherited from Wikibase\Repo\Specials\SpecialModifyTerm
 __construct ( $title, SpecialPageCopyrightView $copyrightView, SummaryFormatter $summaryFormatter, EntityTitleLookup $entityTitleLookup, MediawikiEditEntityFactory $editEntityFactory, EntityPermissionChecker $permissionChecker)
 
- 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 newFromGlobalState ()
 

Protected Member Functions

 validateInput ()
 
 getPostedValue ()
 
 getValue (EntityDocument $entity, $languageCode)
 
 setValue (EntityDocument $entity, $languageCode, $value)
 
- Protected Member Functions inherited from Wikibase\Repo\Specials\SpecialModifyTerm
 processArguments ( $subPage)
 
 modifyEntity (EntityDocument $entity)
 
 getForm (EntityDocument $entity=null)
 
- Protected Member Functions inherited from Wikibase\Repo\Specials\SpecialModifyEntity
 getEntityId ()
 Returns the ID of the Entity being modified.
 
 getBaseRevision ()
 Returns the base revision.
 
 getLatestRevision ()
 Returns the current revision.
 
 getEntityForModification ()
 Returns the EntityDocument that is to be modified by code in this class (or subclasses).
 
 getEntityForDisplay ()
 Returns the EntityDocument that is to be shown by code in this class (or subclasses).
 
 getFormElements (EntityDocument $entity=null)
 
 isModificationRequested ()
 Whether the current request is a request for modification (as opposed to a request for showing the input form).
 
 applyChangeOp (ChangeOp $changeOp, EntityDocument $entity, Summary $summary=null)
 Applies the given ChangeOp to the given Entity.
 
- Protected Member Functions inherited from Wikibase\Repo\Specials\SpecialWikibaseRepoPage
 prepareEditEntity (EntityId $id=null, $baseRev=0)
 
 getEditEntity ()
 Returns the EditEntity interactor.
 
 parseEntityId ( $rawId)
 Parses an entity id.
 
 parseItemId ( $rawId)
 Parses an item id.
 
 getEntityTitle (EntityId $id)
 
 saveEntity (EntityDocument $entity, FormatableSummary $summary, $token, $flags=EDIT_UPDATE)
 Saves the entity using the given summary.
 
 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.
 
 showErrorHTML ( $error)
 

Additional Inherited Members

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

Detailed Description

Special page for setting the description of a Wikibase entity.

Author
Bene* < benes.nosp@m.tar..nosp@m.wikim.nosp@m.edia.nosp@m.@gmai.nosp@m.l.co.nosp@m.m >

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Repo\Specials\SpecialSetDescription::__construct ( SpecialPageCopyrightView  $copyrightView,
SummaryFormatter  $summaryFormatter,
EntityTitleLookup  $entityTitleLookup,
MediawikiEditEntityFactory  $editEntityFactory,
EntityPermissionChecker  $entityPermissionChecker 
)

Member Function Documentation

◆ doesWrites()

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

◆ getPostedValue()

Wikibase\Repo\Specials\SpecialSetDescription::getPostedValue ( )
protected
See also
SpecialModifyTerm::getPostedValue()
Returns
string|null

Reimplemented from Wikibase\Repo\Specials\SpecialModifyTerm.

◆ getValue()

Wikibase\Repo\Specials\SpecialSetDescription::getValue ( EntityDocument  $entity,
  $languageCode 
)
protected
See also
SpecialModifyTerm::getValue()
Parameters
EntityDocument$entity
string$languageCode
Exceptions
InvalidArgumentException
Returns
string

Reimplemented from Wikibase\Repo\Specials\SpecialModifyTerm.

◆ newFromGlobalState()

static Wikibase\Repo\Specials\SpecialSetDescription::newFromGlobalState ( )
static

◆ setValue()

Wikibase\Repo\Specials\SpecialSetDescription::setValue ( EntityDocument  $entity,
  $languageCode,
  $value 
)
protected
See also
SpecialModifyTerm::setValue()
Parameters
EntityDocument$entity
string$languageCode
string$value
Returns
Summary

Reimplemented from Wikibase\Repo\Specials\SpecialModifyTerm.

◆ validateInput()

Wikibase\Repo\Specials\SpecialSetDescription::validateInput ( )
protected
See also
SpecialModifyTerm::validateInput
Returns
bool

Reimplemented from Wikibase\Repo\Specials\SpecialModifyTerm.


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