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

Collaboration diagram for LinkCache:

[legend]

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

	addBadLinkObj (LinkTarget $target)

	addGoodLinkObj ( $id, LinkTarget $target, $len=-1, $redir=null, $revision=0, $model=null, $lang=null)
	Add a link for the title to the link cache. More...

	addGoodLinkObjFromRow (LinkTarget $target, $row)
	Same as above with better interface. More...

	addLinkObj (LinkTarget $nt)
	Add a title to the link cache, return the page_id or zero if non-existent. More...

	clear ()
	Clears cache. More...

	clearBadLink ( $title)

	clearLink (LinkTarget $target)

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

	getGoodLinkFieldObj (LinkTarget $target, $field)
	Get a field of a title object from cache. More...

	getGoodLinkID ( $title)

	getMutableCacheKeys (WANObjectCache $cache, LinkTarget $t)

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

	isBadLink ( $title)

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

static	singleton ()
	Get an instance of this class. More...

Private Member Functions
	fetchPageRow (IDatabase $db, LinkTarget $nt)

	isCacheable (LinkTarget $title)

Private Attributes
MapCacheLRU	$badLinks

MapCacheLRU	$goodLinks

ILoadBalancer null	$loadBalancer

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 35 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 67 of file LinkCache.php.

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

Member Function Documentation

◆ addBadLinkObj()

LinkCache::addBadLinkObj ( LinkTarget $target )

Parameters

LinkTarget $target

Definition at line 204 of file LinkCache.php.

References isBadLink().

Referenced by addLinkObj().

◆ addGoodLinkObj()

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

Add a link for the title to the link cache.

Parameters

int	$id	Page's ID
LinkTarget	$target
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 160 of file LinkCache.php.

References $lang.

◆ addGoodLinkObjFromRow()

LinkCache::addGoodLinkObjFromRow	(	LinkTarget	$target,
			$row
	)

Same as above with better interface.

Since: 1.19

Parameters

LinkTarget	$target
stdClass	$row	Object which has the fields page_id, page_is_redirect, page_latest and page_content_model

Definition at line 182 of file LinkCache.php.

Referenced by addLinkObj().

◆ addLinkObj()

LinkCache::addLinkObj ( LinkTarget $nt )

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

Parameters

LinkTarget $nt LinkTarget object to add

Returns: int Page ID or zero

Definition at line 258 of file LinkCache.php.

References $cache, $dbr, $wanCache, addBadLinkObj(), addGoodLinkObjFromRow(), DB_PRIMARY, DB_REPLICA, fetchPageRow(), MediaWiki\Linker\LinkTarget\getDBkey(), getGoodLinkID(), MediaWiki\Linker\LinkTarget\getNamespace(), isBadLink(), isCacheable(), MediaWiki\Linker\LinkTarget\isExternal(), and wfTimestamp().

◆ clear()

LinkCache::clear ( )

Clears cache.

Definition at line 372 of file LinkCache.php.

◆ clearBadLink()

LinkCache::clearBadLink ( $title )

Parameters

string $title Prefixed DB key

Definition at line 214 of file LinkCache.php.

References $title.

◆ clearLink()

LinkCache::clearLink ( LinkTarget $target )

Parameters

LinkTarget $target

Definition at line 221 of file LinkCache.php.

◆ fetchPageRow()

LinkCache::fetchPageRow	(	IDatabase	$db,
		LinkTarget	$nt
	)

private

Definition at line 340 of file LinkCache.php.

References MediaWiki\Linker\LinkTarget\getDBkey(), MediaWiki\Linker\LinkTarget\getNamespace(), getSelectFields(), isCacheable(), and Wikimedia\Rdbms\IDatabase\selectRow().

Referenced by addLinkObj().

◆ forUpdate()

LinkCache::forUpdate ( $update = null )

General accessor to get/set whether the master 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

Definition at line 108 of file LinkCache.php.

References wfSetVar().

◆ getGoodLinkFieldObj()

LinkCache::getGoodLinkFieldObj	(	LinkTarget	$target,
			$field
	)

Get a field of a title object from cache.

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

Parameters

LinkTarget	$target
string	$field	('length','redirect','revision','model')

Returns: string|int|null

Definition at line 131 of file LinkCache.php.

◆ getGoodLinkID()

LinkCache::getGoodLinkID ( $title )

Parameters

string $title Prefixed DB key

Returns: int Page ID or zero

Definition at line 116 of file LinkCache.php.

References $title.

Referenced by addLinkObj().

◆ getMutableCacheKeys()

LinkCache::getMutableCacheKeys	(	WANObjectCache	$cache,
		LinkTarget	$t
	)

Parameters

WANObjectCache	$cache
LinkTarget	$t

Returns: string[]

Since: 1.28

Definition at line 319 of file LinkCache.php.

References $cache, $t, and isCacheable().

◆ getSelectFields()

static LinkCache::getSelectFields ( )

static

Fields that LinkCache needs to select.

Since: 1.28

Returns: array

Definition at line 233 of file LinkCache.php.

References $wgPageLanguageUseDB.

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

◆ invalidateTitle()

LinkCache::invalidateTitle ( LinkTarget $title )

Purge the link cache for a title.

Parameters

LinkTarget $title

Since: 1.28

Definition at line 360 of file LinkCache.php.

References $cache, $title, $wanCache, and isCacheable().

◆ isBadLink()

LinkCache::isBadLink ( $title )

Parameters

string $title Prefixed DB key

Returns: bool

Definition at line 144 of file LinkCache.php.

References $title.

Referenced by addBadLinkObj(), and addLinkObj().

◆ isCacheable()

LinkCache::isCacheable ( LinkTarget $title )

private

Definition at line 327 of file LinkCache.php.

References $title, NS_CATEGORY, NS_FILE, NS_MEDIAWIKI, and NS_TEMPLATE.

Referenced by addLinkObj(), fetchPageRow(), getMutableCacheKeys(), and invalidateTitle().

◆ singleton()

static LinkCache::singleton ( )

static

Get an instance of this class.

Returns: LinkCache

Deprecated:: since 1.28, hard deprecated since 1.37 Use MediaWikiServices::getLinkCache instead

Definition at line 92 of file LinkCache.php.

References wfDeprecated().

Member Data Documentation

◆ $badLinks

MapCacheLRU LinkCache::$badLinks

private

Definition at line 39 of file LinkCache.php.

◆ $goodLinks

MapCacheLRU LinkCache::$goodLinks

private

Definition at line 37 of file LinkCache.php.

◆ $loadBalancer

ILoadBalancer null LinkCache::$loadBalancer

private

Definition at line 53 of file LinkCache.php.

Referenced by __construct().

◆ $mForUpdate

bool LinkCache::$mForUpdate = false

private

Definition at line 44 of file LinkCache.php.

◆ $nsInfo

NamespaceInfo LinkCache::$nsInfo

private

Definition at line 50 of file LinkCache.php.

Referenced by __construct().

◆ $titleFormatter

TitleFormatter LinkCache::$titleFormatter

private

Definition at line 47 of file LinkCache.php.

Referenced by __construct().

◆ $wanCache

WANObjectCache LinkCache::$wanCache

private

Definition at line 41 of file LinkCache.php.

Referenced by addLinkObj(), and invalidateTitle().

◆ 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 59 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()

◆ getGoodLinkFieldObj()

◆ getGoodLinkID()

◆ getMutableCacheKeys()

◆ getSelectFields()

◆ invalidateTitle()

◆ isBadLink()

◆ isCacheable()

◆ singleton()

Member Data Documentation

◆ $badLinks

◆ $goodLinks

◆ $loadBalancer

◆ $mForUpdate

◆ $nsInfo

◆ $titleFormatter

◆ $wanCache

◆ MAX_SIZE