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

Inheritance diagram for Wikibase\Repo\Specials\SpecialSetSiteLink:

Collaboration diagram for Wikibase\Repo\Specials\SpecialSetSiteLink:

Public Member Functions
	__construct (array $tags, SpecialPageCopyrightView $copyrightView, SummaryFormatter $summaryFormatter, EntityTitleLookup $entityTitleLookup, MediaWikiEditEntityFactory $editEntityFactory, SiteLinkPageNormalizer $siteLinkPageNormalizer, SiteLinkTargetProvider $siteLinkTargetProvider, array $siteLinkGroups, array $badgeItems, FallbackLabelDescriptionLookupFactory $labelDescriptionLookupFactory, SiteLinkChangeOpFactory $siteLinkChangeOpFactory)

	doesWrites ()

Public Member Functions inherited from Wikibase\Repo\Specials\SpecialModifyEntity
	__construct ( $title, array $tags, SpecialPageCopyrightView $copyrightView, SummaryFormatter $summaryFormatter, EntityTitleLookup $entityTitleLookup, MediaWikiEditEntityFactory $editEntityFactory)

	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 (ChangeOpFactoryProvider $changeOpFactoryProvider, MediaWikiEditEntityFactory $editEntityFactory, EntityTitleLookup $entityTitleLookup, FallbackLabelDescriptionLookupFactory $labelDescriptionLookupFactory, SettingsArray $repoSettings, SiteLinkPageNormalizer $siteLinkPageNormalizer, SiteLinkTargetProvider $siteLinkTargetProvider, SummaryFormatter $summaryFormatter)

Protected Member Functions
	processArguments ( $subPage)

	validateInput ()

	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.

	getSubmitKey (EntityDocument $entity=null)

	showCopyrightNotice (EntityDocument $entity=null)

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)

Private Member Functions
	isValidSiteId ( $siteId)
	Checks if the site id is valid.

	getSiteLink (?Item $item, $siteId)
	Returning the site page of the entity.

	getBadges (?Item $item, $siteId)
	Returning the badges of the entity.

	parseBadges (array $badges, Status $status)
	Validates badges from params and turns them into an array of ItemIds.

	setSiteLink (EntityDocument $item, $siteId, $pageName, array $badgeIds, Summary &$summary=null)
	Setting the sitepage of the entity.

	removeSiteLink (Item $item, string $siteId, Summary $summary)

	getSiteLinkTargetSite (string $siteId)

Private Attributes
	$siteLinkPageNormalizer

	$siteLinkTargetProvider

	$siteLinkGroups

	$badgeItems

	$labelDescriptionLookupFactory

	$siteLinkChangeOpFactory

	$site

	$page

	$badges

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 the sitepage of a Wikibase entity.

Copyright: GPL-2.0-or-later

Author: Bene* < benes.nosp@m.tar..nosp@m.wikim.nosp@m.edia.nosp@m.@goog.nosp@m.lema.nosp@m.il.co.nosp@m.m >

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Repo\Specials\SpecialSetSiteLink::__construct	(	array	$tags,
		SpecialPageCopyrightView	$copyrightView,
		SummaryFormatter	$summaryFormatter,
		EntityTitleLookup	$entityTitleLookup,
		MediaWikiEditEntityFactory	$editEntityFactory,
		SiteLinkPageNormalizer	$siteLinkPageNormalizer,
		SiteLinkTargetProvider	$siteLinkTargetProvider,
		array	$siteLinkGroups,
		array	$badgeItems,
		FallbackLabelDescriptionLookupFactory	$labelDescriptionLookupFactory,
		SiteLinkChangeOpFactory	$siteLinkChangeOpFactory )

Parameters

string[]	$tags	List of tags to add to edits
SpecialPageCopyrightView	$copyrightView
SummaryFormatter	$summaryFormatter
EntityTitleLookup	$entityTitleLookup
MediaWikiEditEntityFactory	$editEntityFactory
SiteLinkPageNormalizer	$siteLinkPageNormalizer
SiteLinkTargetProvider	$siteLinkTargetProvider
string[]	$siteLinkGroups
string[]	$badgeItems
FallbackLabelDescriptionLookupFactory	$labelDescriptionLookupFactory
SiteLinkChangeOpFactory	$siteLinkChangeOpFactory

Member Function Documentation

◆ doesWrites()

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

Reimplemented from Wikibase\Repo\Specials\SpecialModifyEntity.

◆ factory()

static Wikibase\Repo\Specials\SpecialSetSiteLink::factory	(	ChangeOpFactoryProvider	$changeOpFactoryProvider,
		MediaWikiEditEntityFactory	$editEntityFactory,
		EntityTitleLookup	$entityTitleLookup,
		FallbackLabelDescriptionLookupFactory	$labelDescriptionLookupFactory,
		SettingsArray	$repoSettings,
		SiteLinkPageNormalizer	$siteLinkPageNormalizer,
		SiteLinkTargetProvider	$siteLinkTargetProvider,
		SummaryFormatter	$summaryFormatter )

static

◆ getBadges()

Wikibase\Repo\Specials\SpecialSetSiteLink::getBadges	(	?Item	$item,
			$siteId )

private

Returning the badges of the entity.

Parameters

Item \| null	$item
string	$siteId

Exceptions

OutOfBoundsException

Returns: string[]

◆ getForm()

Wikibase\Repo\Specials\SpecialSetSiteLink::getForm ( EntityDocument $entity = null )

protected

See also: SpecialModifyEntity::getForm()

Parameters

EntityDocument | null $entity

Returns: HTMLForm

Reimplemented from Wikibase\Repo\Specials\SpecialModifyEntity.

◆ getSiteLink()

Wikibase\Repo\Specials\SpecialSetSiteLink::getSiteLink	(	?Item	$item,
			$siteId )

private

Returning the site page of the entity.

Parameters

Item \| null	$item
string	$siteId

Exceptions

OutOfBoundsException

Returns: string

◆ getSiteLinkTargetSite()

Wikibase\Repo\Specials\SpecialSetSiteLink::getSiteLinkTargetSite ( string $siteId )

private

◆ isValidSiteId()

Wikibase\Repo\Specials\SpecialSetSiteLink::isValidSiteId ( $siteId )

private

Checks if the site id is valid.

Parameters

string $siteId

Returns: bool

◆ modifyEntity()

Wikibase\Repo\Specials\SpecialSetSiteLink::modifyEntity ( EntityDocument $entity )

protected

See also: SpecialModifyEntity::modifyEntity()

Parameters

EntityDocument $entity

Returns: Summary|false

Reimplemented from Wikibase\Repo\Specials\SpecialModifyEntity.

◆ parseBadges()

Wikibase\Repo\Specials\SpecialSetSiteLink::parseBadges	(	array	$badges,
		Status	$status )

private

Validates badges from params and turns them into an array of ItemIds.

Parameters

string[]	$badges
Status	$status

Returns: ItemId[]|false

◆ processArguments()

Wikibase\Repo\Specials\SpecialSetSiteLink::processArguments ( $subPage )

protected

See also: SpecialModifyEntity::processArguments()

Parameters

string | null $subPage

Reimplemented from Wikibase\Repo\Specials\SpecialModifyEntity.

◆ removeSiteLink()

Wikibase\Repo\Specials\SpecialSetSiteLink::removeSiteLink	(	Item	$item,
		string	$siteId,
		Summary	$summary )

private

◆ setSiteLink()

Wikibase\Repo\Specials\SpecialSetSiteLink::setSiteLink	(	EntityDocument	$item,
			$siteId,
			$pageName,
		array	$badgeIds,
		Summary &	$summary = null )

private

Setting the sitepage of the entity.

Parameters

EntityDocument	$item
string	$siteId
string	$pageName
string[]	$badgeIds
Summary \| null	&$summary	The summary for this edit will be saved here.

Exceptions

InvalidArgumentException

Returns: Status

◆ validateInput()

Wikibase\Repo\Specials\SpecialSetSiteLink::validateInput ( )

protected

See also: SpecialModifyEntity::validateInput()

Returns: bool

Reimplemented from Wikibase\Repo\Specials\SpecialModifyEntity.

Member Data Documentation

◆ $badgeItems

Wikibase\Repo\Specials\SpecialSetSiteLink::$badgeItems

private

◆ $badges

Wikibase\Repo\Specials\SpecialSetSiteLink::$badges

private

◆ $labelDescriptionLookupFactory

Wikibase\Repo\Specials\SpecialSetSiteLink::$labelDescriptionLookupFactory

private

◆ $page

Wikibase\Repo\Specials\SpecialSetSiteLink::$page

private

◆ $site

Wikibase\Repo\Specials\SpecialSetSiteLink::$site

private

◆ $siteLinkChangeOpFactory

Wikibase\Repo\Specials\SpecialSetSiteLink::$siteLinkChangeOpFactory

private

◆ $siteLinkGroups

Wikibase\Repo\Specials\SpecialSetSiteLink::$siteLinkGroups

private

◆ $siteLinkPageNormalizer

Wikibase\Repo\Specials\SpecialSetSiteLink::$siteLinkPageNormalizer

private

◆ $siteLinkTargetProvider

Wikibase\Repo\Specials\SpecialSetSiteLink::$siteLinkTargetProvider

private

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

repo/includes/Specials/SpecialSetSiteLink.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doesWrites()

◆ factory()

◆ getBadges()

◆ getForm()

◆ getSiteLink()

◆ getSiteLinkTargetSite()

◆ isValidSiteId()

◆ modifyEntity()

◆ parseBadges()

◆ processArguments()

◆ removeSiteLink()

◆ setSiteLink()

◆ validateInput()

Member Data Documentation

◆ $badgeItems

◆ $badges

◆ $labelDescriptionLookupFactory

◆ $page

◆ $site

◆ $siteLinkChangeOpFactory

◆ $siteLinkGroups

◆ $siteLinkPageNormalizer

◆ $siteLinkTargetProvider