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 (array $tags, ChangeOpFactoryProvider $changeOpFactoryProvider, SpecialPageCopyrightView $copyrightView, SummaryFormatter $summaryFormatter, EntityTitleLookup $entityTitleLookup, MediaWikiEditEntityFactory $editEntityFactory, AnonymousEditWarningBuilder $anonymousEditWarningBuilder, EntityPermissionChecker $entityPermissionChecker, ContentLanguages $termsLanguages, LanguageNameUtils $languageNameUtils)
	doesWrites ()
Public Member Functions inherited from Wikibase\Repo\Specials\SpecialModifyTerm
	__construct (string $title, array $tags, ChangeOpFactoryProvider $changeOpFactoryProvider, SpecialPageCopyrightView $copyrightView, SummaryFormatter $summaryFormatter, EntityTitleLookup $entityTitleLookup, MediaWikiEditEntityFactory $editEntityFactory, AnonymousEditWarningBuilder $anonymousEditWarningBuilder, EntityPermissionChecker $permissionChecker, ContentLanguages $termsLanguages, LanguageNameUtils $languageNameUtils)
Public Member Functions inherited from Wikibase\Repo\Specials\SpecialModifyEntity
	__construct ( $title, array $tags, SpecialPageCopyrightView $copyrightView, SummaryFormatter $summaryFormatter, EntityTitleLookup $entityTitleLookup, MediaWikiEditEntityFactory $editEntityFactory, AnonymousEditWarningBuilder $anonymousEditWarningBuilder)
	execute ( $subPage)
Public Member Functions inherited from Wikibase\Repo\Specials\SpecialWikibaseRepoPage
	__construct ( $title, $restriction, array $tags, 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 (LanguageNameUtils $languageNameUtils, AnonymousEditWarningBuilder $anonymousEditWarningBuilder, ChangeOpFactoryProvider $changeOpFactoryProvider, MediaWikiEditEntityFactory $editEntityFactory, EntityPermissionChecker $entityPermissionChecker, EntityTitleLookup $entityTitleLookup, SettingsArray $repoSettings, SummaryFormatter $summaryFormatter, ContentLanguages $termsLanguages)

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)
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)
	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)
	Applies the given ChangeOp to the given Entity.
	getSubmitKey (?EntityDocument $entity)
	showCopyrightNotice (?EntityDocument $entity)
Protected Member Functions inherited from Wikibase\Repo\Specials\SpecialWikibaseRepoPage
	prepareEditEntity (?EntityId $id=null, int $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.
	redirectToEntityPage (EditEntityStatus $status)
	Redirect to the page of the entity that was successfully edited.
	getCopyrightHTML (?string $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.

Copyright

GPL-2.0-or-later

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	(	array	$tags,
		ChangeOpFactoryProvider	$changeOpFactoryProvider,
		SpecialPageCopyrightView	$copyrightView,
		SummaryFormatter	$summaryFormatter,
		EntityTitleLookup	$entityTitleLookup,
		MediaWikiEditEntityFactory	$editEntityFactory,
		AnonymousEditWarningBuilder	$anonymousEditWarningBuilder,
		EntityPermissionChecker	$entityPermissionChecker,
		ContentLanguages	$termsLanguages,
		LanguageNameUtils	$languageNameUtils )

Member Function Documentation

doesWrites()

Wikibase\Repo\Specials\SpecialSetDescription::doesWrites

(

)

Reimplemented from Wikibase\Repo\Specials\SpecialModifyTerm.

factory()

static Wikibase\Repo\Specials\SpecialSetDescription::factory ( LanguageNameUtils $languageNameUtils, AnonymousEditWarningBuilder $anonymousEditWarningBuilder, ChangeOpFactoryProvider $changeOpFactoryProvider, MediaWikiEditEntityFactory $editEntityFactory, EntityPermissionChecker $entityPermissionChecker, EntityTitleLookup $entityTitleLookup, SettingsArray $repoSettings, SummaryFormatter $summaryFormatter, ContentLanguages $termsLanguages )

static

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.

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:

• repo/includes/Specials/SpecialSetDescription.php