Wikibase\DataModel\SiteLink Class Reference

Immutable value object representing a link to a page on another site. More...

Public Member Functions
	__construct ( $siteId, $pageName, $badges=null)
	getSiteId ()
	getPageName ()
	getBadges ()
	Badges are not order dependent.
	equals ( $target)

Private Member Functions
	setBadges ( $badges)

Private Attributes
	$siteId
	$pageName
	$badges

Detailed Description

Immutable value object representing a link to a page on another site.

A set of badges, represented as ItemId objects, acts as flags describing attributes of the linked to page.

Since

0.4

Copyright

GPL-2.0-or-later

Author

Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Michał Łazowik

Thiemo Kreuz

Constructor & Destructor Documentation

__construct()

Wikibase\DataModel\SiteLink::__construct	(		$siteId,
			$pageName,
			$badges = null )

Parameters

string	$siteId
string	$pageName
ItemIdSet | ItemId[] | null	$badges

Exceptions

InvalidArgumentException

Member Function Documentation

equals()

Wikibase\DataModel\SiteLink::equals

(

$target

)

Since

0.7.4

Parameters

mixed

$target

Returns

bool

getBadges()

Wikibase\DataModel\SiteLink::getBadges

(

)

Badges are not order dependent.

Since

0.5

Returns

ItemId[]

getPageName()

Wikibase\DataModel\SiteLink::getPageName

(

)

Since

0.4

Returns

string

getSiteId()

Wikibase\DataModel\SiteLink::getSiteId

(

)

Since

0.4

Returns

string

setBadges()

Wikibase\DataModel\SiteLink::setBadges ( $badges )

private

Parameters

ItemIdSet | ItemId[] | null

$badges

Exceptions

InvalidArgumentException

Member Data Documentation

$badges

Wikibase\DataModel\SiteLink::$badges

private

$pageName

Wikibase\DataModel\SiteLink::$pageName

private

$siteId

Wikibase\DataModel\SiteLink::$siteId

private

---

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

• lib/packages/wikibase/data-model/src/SiteLink.php