Wikibase
MediaWiki Wikibase extension
Loading...
Searching...
No Matches
Wikibase\Lib\Store\EntityByLinkedTitleLookup Interface Reference

Service interface to find Entities by a (somehow) linked page title that is not identical to the page where the entity is stored. More...

+ Inheritance diagram for Wikibase\Lib\Store\EntityByLinkedTitleLookup:

Public Member Functions

 getEntityIdForLinkedTitle ( $globalSiteId, $pageTitle)
 Returns the ID of an Entity associated to the given page title.
 

Detailed Description

Service interface to find Entities by a (somehow) linked page title that is not identical to the page where the entity is stored.

Not meant as a replacement for EntityIdLookup!

Author
Daniel Kinzler
Thiemo Kreuz

Member Function Documentation

◆ getEntityIdForLinkedTitle()

Wikibase\Lib\Store\EntityByLinkedTitleLookup::getEntityIdForLinkedTitle (   $globalSiteId,
  $pageTitle 
)

Returns the ID of an Entity associated to the given page title.

How the Entity is associated is not specified by this interface. A typical mechanism is the mapping provided via SiteLinks on Items.

Parameters
string$globalSiteIdAn empty string refers to the local wiki.
string$pageTitle
Exceptions
InvalidArgumentExceptionif a parameter does not have the expected type
Returns
EntityId|null

Implemented in Wikibase\Lib\Store\HashSiteLinkStore, and Wikibase\Lib\Store\Sql\SiteLinkTable.


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