LinkCache Class Reference

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

List of all members.

Public Member Functions
	addBadLinkObj ($title)
	addGoodLinkObj ($id, $title, $len=-1, $redir=null, $revision=false)
	Add a link for the title to the link cache.
	addGoodLinkObjFromRow ($title, $row)
	Same as above with better interface.
	addLink ($title)
	Add a title to the link cache, return the page_id or zero if non-existent.
	addLinkObj ($nt)
	Add a title to the link cache, return the page_id or zero if non-existent.
	clear ()
	Clears cache.
	clearBadLink ($title)
	clearLink ($title)
	forUpdate ($update=null)
	General accessor to get/set whether SELECT FOR UPDATE should be used.
	getBadLinks ()
	getGoodLinkFieldObj ($title, $field)
	Get a field of a title object from cache.
	getGoodLinkID ($title)
	getGoodLinks ()
	isBadLink ($title)
Static Public Member Functions
static &	singleton ()
	Get an instance of this class.
Private Attributes
	$mBadLinks = array()
	$mClassVer = 4
	$mForUpdate = false
	$mGoodLinkFields = array()
	$mGoodLinks = array()

---

Detailed Description

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

Definition at line 29 of file LinkCache.php.

---

Member Function Documentation

LinkCache::addBadLinkObj

(

$

title

)

Parameters:

$title

Title

Definition at line 135 of file LinkCache.php.

References $title, and isBadLink().

Referenced by addLinkObj().

LinkCache::addGoodLinkObj	(	$	id,
		$	title,
		$	len = -1,
		$	redir = null,
		$	revision = false
	)

Add a link for the title to the link cache.

Parameters:

$id	Integer: page's ID
$title	Title object
$len	Integer: text's length
$redir	Integer: whether the page is a redirect
$revision	Integer: latest revision's ID

Definition at line 106 of file LinkCache.php.

References $title.

LinkCache::addGoodLinkObjFromRow	(	$	title,
		$	row
	)

Same as above with better interface.

Since:

1.19

Parameters:

$title	Title
$row	object which has the fields page_id, page_is_redirect, page_latest

Definition at line 122 of file LinkCache.php.

References $title.

Referenced by addLinkObj().

LinkCache::addLink

(

$

title

)

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

Parameters:

$title

String: title to add

Returns:

Integer

Definition at line 165 of file LinkCache.php.

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

LinkCache::addLinkObj

(

$

nt

)

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

Parameters:

$nt	Title object to add

Returns:

Integer

Definition at line 180 of file LinkCache.php.

References $options, $s, addBadLinkObj(), addGoodLinkObjFromRow(), getGoodLinkID(), isBadLink(), wfGetDB(), wfProfileIn(), and wfProfileOut().

Referenced by addLink().

LinkCache::clear

(

)

Clears cache.

Definition at line 233 of file LinkCache.php.

LinkCache::clearBadLink

(

$

title

)

Definition at line 142 of file LinkCache.php.

References $title.

LinkCache::clearLink

(

$

title

)

Parameters:

$title

Title

Definition at line 149 of file LinkCache.php.

References $title.

LinkCache::forUpdate

(

$

update = null

)

General accessor to get/set whether SELECT FOR UPDATE should be used.

Returns:

bool

Definition at line 57 of file LinkCache.php.

References wfSetVar().

LinkCache::getBadLinks

(

)

Definition at line 157 of file LinkCache.php.

LinkCache::getGoodLinkFieldObj	(	$	title,
		$	field
	)

Get a field of a title object from cache.

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

Parameters:

$title	Title
$field	String: ('length','redirect','revision')

Returns:

mixed

Definition at line 80 of file LinkCache.php.

References $title.

LinkCache::getGoodLinkID

(

$

title

)

Parameters:

$title

Returns:

array|int

Definition at line 65 of file LinkCache.php.

References $title.

Referenced by addLinkObj().

LinkCache::getGoodLinks

(

)

Definition at line 156 of file LinkCache.php.

LinkCache::isBadLink

(

$

title

)

Parameters:

$title

Returns:

bool

Definition at line 93 of file LinkCache.php.

References $title.

Referenced by addBadLinkObj(), and addLinkObj().

static& LinkCache::singleton

(

)

[static]

Get an instance of this class.

Returns:

LinkCache

Definition at line 44 of file LinkCache.php.

Referenced by NewParserTest\addDBData(), LinkHolderArray\doVariants(), LinkBatch\execute(), RefreshLinks\fixLinksFromArticle(), Title\getArticleID(), Title\getLatestRevID(), Title\getLength(), Title\getLinksFrom(), Title\getLinksTo(), SearchEngineTest\insertPage(), Title\isRedirect(), TitleCleanup\moveInconsistentPage(), LinkHolderArray\replaceInternal(), Title\resetArticleID(), RefreshLinksJob\run(), RefreshLinksJob2\run(), and NewParserTest\teardownGlobals().

---

Member Data Documentation

LinkCache::$mBadLinks = array() [private]

Definition at line 36 of file LinkCache.php.

LinkCache::$mClassVer = 4 [private]

Definition at line 32 of file LinkCache.php.

LinkCache::$mForUpdate = false [private]

Definition at line 37 of file LinkCache.php.

LinkCache::$mGoodLinkFields = array() [private]

Definition at line 35 of file LinkCache.php.

LinkCache::$mGoodLinks = array() [private]

Definition at line 34 of file LinkCache.php.

---

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

• includes/cache/LinkCache.php