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

Public Member Functions
	__construct ($arr=array())
	add ($ns, $dbkey)
	addObj ($title)
	addResultToCache ($cache, $res)
	Add a ResultWrapper 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 ResultWrapper with page_id fields.
	execute ()
	Do the query and add the results to the LinkCache object.
	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
	$data = array()
	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
	$caller
	For debugging which method is using this class.

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 30 of file LinkBatch.php.

Constructor & Destructor Documentation

LinkBatch::__construct ( $ arr = array() )

Definition at line 41 of file LinkBatch.php.

References addObj(), and as.

Member Function Documentation

LinkBatch::add	(	$	ns,
		$	dbkey
	)

Parameters:

$ns	int
$dbkey	string

Returns:: mixed

Definition at line 74 of file LinkBatch.php.

References array(), and data.

Referenced by addObj().

LinkBatch::addObj ( $ title )

Parameters:

$title Title

Definition at line 61 of file LinkBatch.php.

References $title, add(), and wfDebug().

Referenced by __construct().

LinkBatch::addResultToCache	(	$	cache,
		$	res
	)

Add a ResultWrapper 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:

$cache	LinkCache
$res

Returns:: Array of remaining titles

Definition at line 149 of file LinkBatch.php.

References $cache, $res, $title, array(), as, data, and Title\makeTitle().

Referenced by executeInto().

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)
	$db	DatabaseBase object to use

Returns:: mixed string with SQL where clause fragment, or false if no items.

Definition at line 230 of file LinkBatch.php.

References data.

Referenced by doQuery().

LinkBatch::doGenderQuery ( )

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

Returns:: bool whether the query was successful

Definition at line 208 of file LinkBatch.php.

References $wgContLang, data, global, isEmpty(), and GenderCache\singleton().

Referenced by executeInto().

LinkBatch::doQuery ( )

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

Returns:: Bool|ResultWrapper

Definition at line 180 of file LinkBatch.php.

References $caller, $dbr, $res, array(), constructSet(), isEmpty(), wfGetDB(), wfProfileIn(), and wfProfileOut().

Referenced by executeInto().

LinkBatch::execute ( )

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

Returns:: Array mapping PDBK to ID

Definition at line 118 of file LinkBatch.php.

References executeInto(), and LinkCache\singleton().

LinkBatch::executeInto ( &$ cache ) [protected]

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

Parameters:

$cache LinkCache

Returns:: Array remaining IDs

Definition at line 130 of file LinkBatch.php.

References $cache, $res, addResultToCache(), doGenderQuery(), doQuery(), wfProfileIn(), and wfProfileOut().

Referenced by execute().

LinkBatch::getSize ( )

Returns the size of the batch.

Returns:: int

Definition at line 109 of file LinkBatch.php.

References data.

Referenced by isEmpty().

LinkBatch::isEmpty ( )

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

Returns:: bool

Definition at line 100 of file LinkBatch.php.

References getSize().

Referenced by doGenderQuery(), and doQuery().

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 91 of file LinkBatch.php.

References data.

Referenced by TitleListDependency\getLinkBatch().

LinkBatch::setCaller ( $ caller )

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

Only used in debugging output.

Since:: 1.17

Parameters:

$caller

Definition at line 54 of file LinkBatch.php.

References $caller.

Member Data Documentation

LinkBatch::$caller [protected]

For debugging which method is using this class.

Definition at line 39 of file LinkBatch.php.

Referenced by doQuery(), and setCaller().

LinkBatch::$data = array()

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

Definition at line 34 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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation