Class representing a list of titles The execute() method checks them all for existence and adds them to a LinkCache object. More...

Collaboration diagram for LinkBatch:

[legend]

Public Member Functions
	__construct (iterable $arr=[], ?LinkCache $linkCache=null, ?TitleFormatter $titleFormatter=null, ?Language $contentLanguage=null, ?GenderCache $genderCache=null, ?ILoadBalancer $loadBalancer=null)

	add ( $ns, $dbkey)

	addObj ( $link)

	addResultToCache ( $cache, $res)
	Add a result wrapper containing IDs and titles to a LinkCache object.

	constructSet ( $prefix, $db)
	Construct a WHERE clause which will match all the given titles.

	doGenderQuery ()
	Do (and cache) {{GENDER:...}} information for userpages in this LinkBatch.

	doQuery ()
	Perform the existence test query, return a result wrapper with page_id fields.

	execute ()
	Do the query and add the results to the LinkCache object.

	getPageIdentities ()
	Do the query, add the results to the LinkCache object, and return PageIdentity instances corresponding to the pages in the batch.

	getSize ()
	Returns the size of the batch.

	isEmpty ()
	Returns true if no pages have been added, false otherwise.

	setArray ( $array)
	Set the link list to a given 2-d array First key is the namespace, second is the DB key, value arbitrary.

	setCaller ( $caller)
	Use ->setCaller( METHOD ) to indicate which code is using this class.

Public Attributes
array[]	$data = []
	2-d array, first index namespace, second index dbkey, value arbitrary

Protected Member Functions
	executeInto ( $cache)
	Do the query and add the results to a given LinkCache object Return an array mapping PDBK to ID.

Protected Attributes
string null	$caller
	For debugging which method is using this class.

Private Attributes
Language	$contentLanguage

GenderCache	$genderCache

LinkCache	$linkCache

ILoadBalancer	$loadBalancer

PageIdentity[] null	$pageIdentities = null
	PageIdentity objects corresponding to the links in the batch.

TitleFormatter	$titleFormatter

Detailed Description

Class representing a list of titles The execute() method checks them all for existence and adds them to a LinkCache object.

Definition at line 42 of file LinkBatch.php.

Constructor & Destructor Documentation

◆ __construct()

LinkBatch::__construct	(	iterable	$arr = `[]`,
		?LinkCache	$linkCache = `null`,
		?TitleFormatter	$titleFormatter = `null`,
		?Language	$contentLanguage = `null`,
		?GenderCache	$genderCache = `null`,
		?ILoadBalancer	$loadBalancer = `null`
	)

Parameters

	iterable<LinkTarget>\|iterable<PageReference>	$arr Initial items to be added to the batch
LinkCache \| null	$linkCache
TitleFormatter \| null	$titleFormatter
Language \| null	$contentLanguage
GenderCache \| null	$genderCache
ILoadBalancer \| null	$loadBalancer

Deprecated:: 1.35 Use makeLinkBatch of the LinkBatchFactory service instead

Definition at line 92 of file LinkBatch.php.

References addObj().

Member Function Documentation

◆ add()

LinkBatch::add	(	$ns,
		$dbkey
	)

Parameters

int	$ns
string	$dbkey

Definition at line 152 of file LinkBatch.php.

Referenced by addObj().

◆ addObj()

LinkBatch::addObj ( $link )

Parameters

LinkTarget | PageReference $link

Definition at line 133 of file LinkBatch.php.

References add(), and wfBacktrace().

Referenced by __construct(), and MediaWiki\Cache\LinkBatchFactory\newLinkBatch().

◆ addResultToCache()

LinkBatch::addResultToCache	(	$cache,
		$res
	)

Add a result wrapper containing IDs and titles to a LinkCache object.

As normal, titles will go into the static Title cache field. This function also stores extra fields of the title used for link parsing to avoid extra DB queries.

Parameters

LinkCache	$cache
IResultWrapper	$res

Returns: int[] Array of remaining titles

Definition at line 240 of file LinkBatch.php.

References $cache, $res, and $title.

◆ constructSet()

LinkBatch::constructSet	(	$prefix,
		$db
	)

Construct a WHERE clause which will match all the given titles.

Parameters

string	$prefix	The appropriate table's field name prefix ('page', 'pl', etc)
IDatabase	$db	DB object to use

Returns: string|bool String with SQL where clause fragment, or false if no items.

Definition at line 360 of file LinkBatch.php.

◆ doGenderQuery()

LinkBatch::doGenderQuery ( )

Do (and cache) {{GENDER:...}} information for userpages in this LinkBatch.

Returns: bool Whether the query was successful

Definition at line 339 of file LinkBatch.php.

◆ doQuery()

LinkBatch::doQuery ( )

Perform the existence test query, return a result wrapper with page_id fields.

Returns: bool|IResultWrapper

Definition at line 309 of file LinkBatch.php.

References $dbr, $res, and DB_REPLICA.

◆ execute()

LinkBatch::execute ( )

Do the query and add the results to the LinkCache object.

Returns: int[] Mapping PDBK to ID

Definition at line 196 of file LinkBatch.php.

References executeInto().

Referenced by getPageIdentities().

◆ executeInto()

LinkBatch::executeInto ( $cache )

protected

Do the query and add the results to a given LinkCache object Return an array mapping PDBK to ID.

Parameters

LinkCache $cache

Returns: int[] Remaining IDs

Definition at line 222 of file LinkBatch.php.

References $cache, and $res.

Referenced by execute().

◆ getPageIdentities()

LinkBatch::getPageIdentities ( )

Do the query, add the results to the LinkCache object, and return PageIdentity instances corresponding to the pages in the batch.

Since: 1.37

Returns: PageIdentity[] A list of PageIdentities

Definition at line 207 of file LinkBatch.php.

References execute().

◆ getSize()

LinkBatch::getSize ( )

Returns the size of the batch.

Returns: int

Definition at line 187 of file LinkBatch.php.

Referenced by isEmpty().

◆ isEmpty()

LinkBatch::isEmpty ( )

Returns true if no pages have been added, false otherwise.

Returns: bool

Definition at line 178 of file LinkBatch.php.

References getSize().

◆ setArray()

LinkBatch::setArray ( $array )

Set the link list to a given 2-d array First key is the namespace, second is the DB key, value arbitrary.

Parameters

array $array

Definition at line 169 of file LinkBatch.php.

◆ setCaller()

LinkBatch::setCaller ( $caller )

Use ->setCaller( METHOD ) to indicate which code is using this class.

Only used in debugging output.

Since: 1.17

Parameters

string $caller

Returns: self (since 1.32)

Definition at line 124 of file LinkBatch.php.

References $caller.

Member Data Documentation

◆ $caller

string null LinkBatch::$caller

protected

For debugging which method is using this class.

Definition at line 56 of file LinkBatch.php.

Referenced by setCaller().

◆ $contentLanguage

Language LinkBatch::$contentLanguage

private

Definition at line 71 of file LinkBatch.php.

◆ $data

array [] LinkBatch::$data = []

2-d array, first index namespace, second index dbkey, value arbitrary

Definition at line 46 of file LinkBatch.php.

◆ $genderCache

GenderCache LinkBatch::$genderCache

private

Definition at line 76 of file LinkBatch.php.

◆ $linkCache

LinkCache LinkBatch::$linkCache

private

Definition at line 61 of file LinkBatch.php.

◆ $loadBalancer

ILoadBalancer LinkBatch::$loadBalancer

private

Definition at line 81 of file LinkBatch.php.

◆ $pageIdentities

PageIdentity [] null LinkBatch::$pageIdentities = null

private

PageIdentity objects corresponding to the links in the batch.

Definition at line 51 of file LinkBatch.php.

◆ $titleFormatter

TitleFormatter LinkBatch::$titleFormatter

private

Definition at line 66 of file LinkBatch.php.

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

includes/cache/LinkBatch.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ addObj()

◆ addResultToCache()

◆ constructSet()

◆ doGenderQuery()

◆ doQuery()

◆ execute()

◆ executeInto()

◆ getPageIdentities()

◆ getSize()

◆ isEmpty()

◆ setArray()

◆ setCaller()

Member Data Documentation

◆ $caller

◆ $contentLanguage

◆ $data

◆ $genderCache

◆ $linkCache

◆ $loadBalancer

◆ $pageIdentities

◆ $titleFormatter