Cache for article titles (prefixed DB keys) and ids linked from one source. More...

Inheritance diagram for LinkCache:

Collaboration diagram for LinkCache:

[legend]

Public Member Functions
	__construct (TitleFormatter $titleFormatter, WANObjectCache $cache, NamespaceInfo $nsInfo=null, ILoadBalancer $loadBalancer=null)

	addBadLinkObj ( $page)

	addGoodLinkObj ( $id, $page, $len=-1, $redir=null, $revision=0, $model=null, $lang=null)
	Add information about an existing page to the cache. More...

	addGoodLinkObjFromRow ( $page, stdClass $row, int $queryFlags=IDBAccessObject::READ_NORMAL)
	Same as above with better interface. More...

	addLinkObj ( $page, int $queryFlags=IDBAccessObject::READ_NORMAL)
	Add a title to the link cache, return the page_id or zero if non-existent. More...

	clear ()
	Clears cache. More...

	clearBadLink ( $page)

	clearLink ( $page)

	forUpdate ( $update=null)
	General accessor to get/set whether the primary DB should be used. More...

	getGoodLinkFieldObj ( $page, string $field)
	Get a field of a page from the cache. More...

	getGoodLinkID ( $page)
	Returns the ID of the given page, if information about this page has been cached. More...

	getGoodLinkRow (int $ns, string $dbkey, callable $fetchCallback=null, int $queryFlags=IDBAccessObject::READ_NORMAL)
	Returns the row for the page if the page exists (subject to race conditions). More...

	getMutableCacheKeys (WANObjectCache $cache, $page)

	invalidateTitle ( $page)
	Purge the persistent link cache for a title. More...

	isBadLink ( $page)
	Returns true if the fact that this page does not exist had been added to the cache. More...

	setLogger (LoggerInterface $logger)

Static Public Member Functions
static	getSelectFields ()
	Fields that LinkCache needs to select. More...

Private Member Functions
	fetchPageRow (IDatabase $db, int $ns, string $dbkey, $options=[])

	getCacheKey ( $page, $passThrough=false)

	getGoodLinkRowInternal (?TitleValue $link, callable $fetchCallback=null, int $queryFlags=IDBAccessObject::READ_NORMAL)

	usePersistentCache ( $pageOrNamespace)

Private Attributes
MapCacheLRU	$badLinks

MapCacheLRU	$goodLinks

ILoadBalancer null	$loadBalancer

LoggerInterface	$logger

bool	$mForUpdate = false

NamespaceInfo	$nsInfo

TitleFormatter	$titleFormatter

WANObjectCache	$wanCache

const	MAX_SIZE = 10000
	How many Titles to store. More...

Detailed Description

Cache for article titles (prefixed DB keys) and ids linked from one source.

Definition at line 42 of file LinkCache.php.

Constructor & Destructor Documentation

◆ __construct()

LinkCache::__construct	(	TitleFormatter	$titleFormatter,
		WANObjectCache	$cache,
		NamespaceInfo	$nsInfo = `null`,
		ILoadBalancer	$loadBalancer = `null`
	)

Parameters

TitleFormatter	$titleFormatter
WANObjectCache	$cache
NamespaceInfo \| null	$nsInfo	Null for backward compatibility, but deprecated
ILoadBalancer \| null	$loadBalancer	Use null when no database is set up, for example on installation

Definition at line 77 of file LinkCache.php.

References $cache, $loadBalancer, $nsInfo, $titleFormatter, and wfDeprecated().

Member Function Documentation

◆ addBadLinkObj()

LinkCache::addBadLinkObj ( $page )

Parameters

LinkTarget | PageReference | array $page The page to set cached info for. Can be given as an object or an associative array containing the page_namespace and page_title fields. In MediaWiki 1.36 and earlier, only LinkTarget was accepted.

Definition at line 337 of file LinkCache.php.

References getCacheKey(), and isBadLink().

◆ addGoodLinkObj()

LinkCache::addGoodLinkObj	(	$id,
		$page,
		$len = `-1`,
		$redir = `null`,
		$revision = `0`,
		$model = `null`,
		$lang = `null`
	)

Add information about an existing page to the cache.

Deprecated:: since 1.37, use addGoodLinkObjFromRow() instead. PHPUnit tests must use LinkCacheTestTrait::addGoodLinkObject().

Parameters

int	$id	Page's ID
LinkTarget \| PageReference	$page	The page to set cached info for. In MediaWiki 1.36 and earlier, only LinkTarget was accepted.
int	$len	Text's length
int \| null	$redir	Whether the page is a redirect
int	$revision	Latest revision's ID
string \| null	$model	Latest revision's content model ID
string \| null	$lang	Language code of the page, if not the content language

Definition at line 280 of file LinkCache.php.

References $lang, addGoodLinkObjFromRow(), and wfDeprecated().

◆ addGoodLinkObjFromRow()

LinkCache::addGoodLinkObjFromRow	(		$page,
		stdClass	$row,
		int	$queryFlags = `IDBAccessObject::READ_NORMAL`
	)

Same as above with better interface.

Parameters

LinkTarget \| PageReference \| array	$page	The page to set cached info for. Can be given as an object or an associative array containing the page_namespace and page_title fields. In MediaWiki 1.36 and earlier, only LinkTarget was accepted.
stdClass	$row	Object which has all fields returned by getSelectFields().
int	$queryFlags	The query flags used to retrieve the row, IDBAccessObject::READ_XXX

Since: 1.19

Definition at line 311 of file LinkCache.php.

References getCacheKey().

Referenced by addGoodLinkObj().

◆ addLinkObj()

LinkCache::addLinkObj	(		$page,
		int	$queryFlags = `IDBAccessObject::READ_NORMAL`
	)

Add a title to the link cache, return the page_id or zero if non-existent.

This causes the link to be looked up in the database if it is not yet cached.

Deprecated:: since 1.37, use PageStore::getPageForLink() instead.

Parameters

LinkTarget \| PageReference \| array	$page	The page to load. Can be given as an object or an associative array containing the page_namespace and page_title fields. In MediaWiki 1.36 and earlier, only LinkTarget was accepted.
int	$queryFlags	IDBAccessObject::READ_XXX

Returns: int Page ID or zero

Definition at line 413 of file LinkCache.php.

References getGoodLinkRow().

◆ clear()

LinkCache::clear ( )

Clears cache.

Definition at line 628 of file LinkCache.php.

◆ clearBadLink()

LinkCache::clearBadLink ( $page )

Parameters

LinkTarget | PageReference | array | string $page The page to clear cached info for, as an object, an array containing the page_namespace and page_title fields, or a prefixed DB key. In MediaWiki 1.36 and earlier, only a string was accepted. In MediaWiki 1.36 and earlier, only a string was accepted.

Definition at line 351 of file LinkCache.php.

References getCacheKey().

◆ clearLink()

LinkCache::clearLink ( $page )

Parameters

LinkTarget | PageReference | array $page The page to clear cached info for. Can be given as an object or an associative array containing the page_namespace and page_title fields. In MediaWiki 1.36 and earlier, only LinkTarget was accepted.

Definition at line 365 of file LinkCache.php.

References getCacheKey().

◆ fetchPageRow()

LinkCache::fetchPageRow	(	IDatabase	$db,
		int	$ns,
		string	$dbkey,
			$options = `[]`
	)

private

Parameters

IDatabase	$db
int	$ns
string	$dbkey
array	$options	Query options, see IDatabase::select() for details.

Returns: stdClass|false

Definition at line 592 of file LinkCache.php.

References Wikimedia\Rdbms\IDatabase\selectRow().

◆ forUpdate()

LinkCache::forUpdate ( $update = null )

General accessor to get/set whether the primary DB should be used.

This used to also set the FOR UPDATE option (locking the rows read in order to avoid link table inconsistency), which was later removed for performance on wikis with a high edit rate.

Parameters

bool | null $update

Returns: bool

Deprecated:: Since 1.34. Use PageStore::getPageForLink with IDBAccessObject::READ_LATEST.

Definition at line 114 of file LinkCache.php.

References wfDeprecated(), and wfSetVar().

◆ getCacheKey()

LinkCache::getCacheKey	(	$page,
		$passThrough = `false`
	)

private

Parameters

LinkTarget \| PageReference \| array \| string	$page
bool	$passThrough	Return $page if $page is a string

Returns: ?string the cache key

Definition at line 125 of file LinkCache.php.

References Page\PageIdentity\canExist(), and Page\PageReference\getWikiId().

Referenced by addBadLinkObj(), addGoodLinkObjFromRow(), clearBadLink(), clearLink(), getGoodLinkFieldObj(), getGoodLinkID(), and isBadLink().

◆ getGoodLinkFieldObj()

LinkCache::getGoodLinkFieldObj	(		$page,
		string	$field
	)

Get a field of a page from the cache.

If this link is not a cached good title, it will return NULL.

Parameters

LinkTarget \| PageReference \| array	$page	The page to get cached info for. Can be given as an object or an associative array containing the page_namespace and page_title fields. In MediaWiki 1.36 and earlier, only LinkTarget was accepted.
string	$field	( 'id', 'length', 'redirect', 'revision', 'model', 'lang' )

Returns: string|int|null The field value, or null if the page was not cached or does not exist or is not a proper page (e.g. a special page or interwiki link).

Definition at line 209 of file LinkCache.php.

References getCacheKey(), and isBadLink().

◆ getGoodLinkID()

LinkCache::getGoodLinkID ( $page )

Returns the ID of the given page, if information about this page has been cached.

Parameters

LinkTarget | PageReference | array | string $page The page to get the ID for, as an object, an array containing the page_namespace and page_title fields, or a prefixed DB key. In MediaWiki 1.36 and earlier, only a string was accepted.

Returns: int Page ID, or zero if the page was not cached or does not exist or is not a proper page (e.g. a special page or an interwiki link).

Definition at line 185 of file LinkCache.php.

References getCacheKey().

◆ getGoodLinkRow()

LinkCache::getGoodLinkRow	(	int	$ns,
		string	$dbkey,
		callable	$fetchCallback = `null`,
		int	$queryFlags = `IDBAccessObject::READ_NORMAL`
	)

Returns the row for the page if the page exists (subject to race conditions).

The row will be returned from local cache or WAN cache if possible, or it will be looked up using the callback provided.

Parameters

int	$ns
string	$dbkey
callable \| null	$fetchCallback	A callback that will retrieve the link row with the signature ( IDatabase $db, int $ns, string $dbkey, array $queryOptions ): ?stdObj.
int	$queryFlags	IDBAccessObject::READ_XXX

Returns: stdClass|null

Access: internal: for use by PageStore. Other code should use a PageLookup instead.

Definition at line 507 of file LinkCache.php.

Referenced by addLinkObj().

◆ getGoodLinkRowInternal()

LinkCache::getGoodLinkRowInternal	(	?TitleValue	$link,
		callable	$fetchCallback = `null`,
		int	$queryFlags = `IDBAccessObject::READ_NORMAL`
	)

private

Parameters

TitleValue \| null	$link
callable \| null	$fetchCallback
int	$queryFlags

Returns: array [ $shouldAddGoodLink, $row ], $shouldAddGoodLink is a bool indicating whether addGoodLinkObjFromRow should be called, and $row is the row the caller was looking for (or false, when it was not found).

Definition at line 432 of file LinkCache.php.

◆ getMutableCacheKeys()

LinkCache::getMutableCacheKeys	(	WANObjectCache	$cache,
			$page
	)

Parameters

WANObjectCache	$cache
LinkTarget \| Pagereference	$page	In MediaWiki 1.36 and earlier, only LinkTarget was accepted.

Returns: string[]

Since: 1.28

Definition at line 552 of file LinkCache.php.

References $cache.

◆ getSelectFields()

static LinkCache::getSelectFields ( )

static

Fields that LinkCache needs to select.

Since: 1.28

Returns: array

Definition at line 380 of file LinkCache.php.

Referenced by OutputPage\addCategoryLinksToLBAndGetResult(), CategoryViewer\doCategoryQuery(), LinkBatch\doQuery(), LinkHolderArray\doVariants(), Title\getLinksTo(), ApiPageSet\getPageTableFields(), LinkHolderArray\replaceInternal(), and SpecialPrefixindex\showPrefixChunk().

◆ invalidateTitle()

LinkCache::invalidateTitle ( $page )

Purge the persistent link cache for a title.

Parameters

LinkTarget | PageReference $page In MediaWiki 1.36 and earlier, only LinkTarget was accepted.

Since: 1.28

Definition at line 614 of file LinkCache.php.

References $cache.

◆ isBadLink()

LinkCache::isBadLink ( $page )

Returns true if the fact that this page does not exist had been added to the cache.

Parameters

LinkTarget | PageReference | array | string $page The page to get cached info for, as an object, an array containing the page_namespace and page_title fields, or a prefixed DB key. In MediaWiki 1.36 and earlier, only a string was accepted. In MediaWiki 1.36 and earlier, only a string was accepted.

Returns: bool True if the page is known to not exist.

Definition at line 256 of file LinkCache.php.

References getCacheKey().

Referenced by addBadLinkObj(), and getGoodLinkFieldObj().

◆ setLogger()

LinkCache::setLogger ( LoggerInterface $logger )

Parameters

LoggerInterface $logger

Definition at line 99 of file LinkCache.php.

References $logger.

◆ usePersistentCache()

LinkCache::usePersistentCache ( $pageOrNamespace )

private

Parameters

LinkTarget | PageReference | int $pageOrNamespace

Returns: bool

Definition at line 571 of file LinkCache.php.

References NS_CATEGORY, NS_FILE, NS_MEDIAWIKI, and NS_TEMPLATE.

Member Data Documentation

◆ $badLinks

MapCacheLRU LinkCache::$badLinks

private

Definition at line 46 of file LinkCache.php.

◆ $goodLinks

MapCacheLRU LinkCache::$goodLinks

private

Definition at line 44 of file LinkCache.php.

◆ $loadBalancer

ILoadBalancer null LinkCache::$loadBalancer

private

Definition at line 60 of file LinkCache.php.

Referenced by __construct().

◆ $logger

LoggerInterface LinkCache::$logger

private

Definition at line 63 of file LinkCache.php.

Referenced by setLogger().

◆ $mForUpdate

bool LinkCache::$mForUpdate = false

private

Definition at line 51 of file LinkCache.php.

◆ $nsInfo

NamespaceInfo LinkCache::$nsInfo

private

Definition at line 57 of file LinkCache.php.

Referenced by __construct().

◆ $titleFormatter

TitleFormatter LinkCache::$titleFormatter

private

Definition at line 54 of file LinkCache.php.

Referenced by __construct().

◆ $wanCache

WANObjectCache LinkCache::$wanCache

private

Definition at line 48 of file LinkCache.php.

◆ MAX_SIZE

const LinkCache::MAX_SIZE = 10000

private

How many Titles to store.

There are two caches, so the amount actually stored in memory can be up to twice this.

Definition at line 69 of file LinkCache.php.

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

includes/cache/LinkCache.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addBadLinkObj()

◆ addGoodLinkObj()

◆ addGoodLinkObjFromRow()

◆ addLinkObj()

◆ clear()

◆ clearBadLink()

◆ clearLink()

◆ fetchPageRow()

◆ forUpdate()

◆ getCacheKey()

◆ getGoodLinkFieldObj()

◆ getGoodLinkID()

◆ getGoodLinkRow()

◆ getGoodLinkRowInternal()

◆ getMutableCacheKeys()

◆ getSelectFields()

◆ invalidateTitle()

◆ isBadLink()

◆ setLogger()

◆ usePersistentCache()

Member Data Documentation

◆ $badLinks

◆ $goodLinks

◆ $loadBalancer

◆ $logger

◆ $mForUpdate

◆ $nsInfo

◆ $titleFormatter

◆ $wanCache

◆ MAX_SIZE