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

Collaboration diagram for LinkCache:

Public Member Functions
	__construct (TitleFormatter $titleFormatter, WANObjectCache $cache)

	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...

	addLink ($title)
	Add a title to the link cache, return the page_id or zero if non-existent. 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)

	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...

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

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

	isCacheable (LinkTarget $title)

Private Attributes
HashBagOStuff	$mBadLinks

bool	$mForUpdate = false

HashBagOStuff	$mGoodLinks

TitleFormatter	$titleFormatter

WANObjectCache	$wanCache

Detailed Description

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

Definition at line 31 of file LinkCache.php.

Constructor & Destructor Documentation

LinkCache::__construct	(	TitleFormatter	$titleFormatter,
		WANObjectCache	$cache
	)

Definition at line 51 of file LinkCache.php.

References $cache, and $titleFormatter.

Member Function Documentation

LinkCache::addBadLinkObj ( LinkTarget $target )

Parameters

LinkTarget $target

Definition at line 166 of file LinkCache.php.

References isBadLink().

Referenced by addLinkObj().

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	$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 130 of file LinkCache.php.

References $lang.

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

Referenced by addLinkObj().

LinkCache::addLink ( $title )

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

Deprecated:

since 1.27, unused

Parameters

string $title Prefixed DB key

Returns: int Page ID or zero

Definition at line 196 of file LinkCache.php.

References $title, addLinkObj(), and Title\newFromDBkey().

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

References $cache, $dbr, $wanCache, addBadLinkObj(), addGoodLinkObjFromRow(), array(), DB_MASTER, DB_REPLICA, fetchPageRow(), Database\getCacheSetOptions(), MediaWiki\Linker\LinkTarget\getDBkey(), getGoodLinkID(), MediaWiki\Linker\LinkTarget\getNamespace(), MediaWiki\Linker\LinkTarget\inNamespace(), isBadLink(), isCacheable(), MediaWiki\Linker\LinkTarget\isExternal(), NS_SPECIAL, TS_UNIX, use, wfGetDB(), and wfTimestamp().

Referenced by addLink().

LinkCache::clear ( )

Clears cache.

Definition at line 317 of file LinkCache.php.

LinkCache::clearBadLink ( $title )

Parameters

string $title Prefixed DB key

Definition at line 176 of file LinkCache.php.

References $title.

LinkCache::clearLink ( LinkTarget $target )

Parameters

LinkTarget $target

Definition at line 183 of file LinkCache.php.

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

private

Definition at line 285 of file LinkCache.php.

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

Referenced by addLinkObj().

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 $update

Returns: bool

Definition at line 78 of file LinkCache.php.

References wfSetVar().

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

LinkCache::getGoodLinkID ( $title )

Parameters

string $title Prefixed DB key

Returns: int Page ID or zero

Definition at line 86 of file LinkCache.php.

References $title.

Referenced by addLinkObj().

static LinkCache::getSelectFields ( )

static

Fields that LinkCache needs to select.

Since: 1.28

Returns: array

Definition at line 210 of file LinkCache.php.

References global.

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

LinkCache::invalidateTitle ( LinkTarget $title )

Purge the link cache for a title.

Parameters

LinkTarget $title

Since: 1.28

Definition at line 305 of file LinkCache.php.

References $cache, MediaWiki\Linker\LinkTarget\getDBkey(), ObjectCache\getMainWANInstance(), MediaWiki\Linker\LinkTarget\getNamespace(), and isCacheable().

LinkCache::isBadLink ( $title )

Parameters

string $title Prefixed DB key

Returns: bool

Definition at line 114 of file LinkCache.php.

References $title.

Referenced by addBadLinkObj(), and addLinkObj().

LinkCache::isCacheable ( LinkTarget $title )

private

Definition at line 281 of file LinkCache.php.

References MediaWiki\Linker\LinkTarget\inNamespace(), NS_FILE, and NS_TEMPLATE.

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

static LinkCache::singleton ( )

static

Get an instance of this class.

Returns: LinkCache

Deprecated:: since 1.28, use MediaWikiServices instead

Definition at line 64 of file LinkCache.php.

Referenced by OutputPage\addCategoryLinks(), Title\clearCaches(), LinkHolderArray\doVariants(), RefreshLinks\fixLinksFromArticle(), ApiParse\formatCategoryLinks(), Title\getArticleID(), Title\getContentModel(), Title\getDbPageLanguageCode(), Title\getLatestRevID(), Title\getLength(), Title\getLinksFrom(), Title\getLinksTo(), ApiPageSet\initFromQueryResult(), Title\isRedirect(), WikiPage\loadFromRow(), TitleCleanup\moveInconsistentPage(), CoreParserFunctions\pageid(), ApiPageSet\processDbRow(), LinkHolderArray\replaceInternal(), Title\resetArticleID(), MediaWikiTestCase\resetDB(), WikiPageTest\setUp(), ParserTestRunner\setupDatabase(), ParserOptions\setupFakeRevision(), Parser\statelessFetchTemplate(), TitleMethodsTest\testClearCaches(), TitleTest\testExists(), ContentHandlerTest\testGetForTitle(), ContentHandlerTest\testGetPageLanguage(), ContentHandlerTest\testMakeContent(), and WikiPage\updateRevisionOn().

Member Data Documentation

HashBagOStuff LinkCache::$mBadLinks

private

Definition at line 35 of file LinkCache.php.

bool LinkCache::$mForUpdate = false

private

Definition at line 40 of file LinkCache.php.

HashBagOStuff LinkCache::$mGoodLinks

private

Definition at line 33 of file LinkCache.php.

TitleFormatter LinkCache::$titleFormatter

private

Definition at line 43 of file LinkCache.php.

Referenced by __construct().

WANObjectCache LinkCache::$wanCache

private

Definition at line 37 of file LinkCache.php.

Referenced by addLinkObj().

const LinkCache::MAX_SIZE = 10000

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 49 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

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation