MediaWiki  1.23.12
LinkBatch Class Reference

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. More...
 
 constructSet ( $prefix, $db)
 Construct a WHERE clause which will match all the given titles. More...
 
 doGenderQuery ()
 Do (and cache) {{GENDER:...}} information for userpages in this LinkBatch. More...
 
 doQuery ()
 Perform the existence test query, return a ResultWrapper with page_id fields. More...
 
 execute ()
 Do the query and add the results to the LinkCache object. More...
 
 getSize ()
 Returns the size of the batch. More...
 
 isEmpty ()
 Returns true if no pages have been added, false otherwise. More...
 
 setArray ( $array)
 Set the link list to a given 2-d array First key is the namespace, second is the DB key, value arbitrary. More...
 
 setCaller ( $caller)
 Use ->setCaller( METHOD ) to indicate which code is using this class. More...
 

Public Attributes

 $data = array()
 2-d array, first index namespace, second index dbkey, value arbitrary More...
 

Protected Member Functions

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

Protected Attributes

 $caller
 For debugging which method is using this class. More...
 

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

◆ __construct()

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

Definition at line 41 of file LinkBatch.php.

References addObj(), and as.

Member Function Documentation

◆ add()

LinkBatch::add (   $ns,
  $dbkey 
)
Parameters
$nsint
$dbkeystring
Returns
mixed

Definition at line 74 of file LinkBatch.php.

References array(), and data.

Referenced by addObj().

◆ addObj()

LinkBatch::addObj (   $title)
Parameters
$titleTitle

Definition at line 61 of file LinkBatch.php.

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

Referenced by __construct().

◆ addResultToCache()

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
$cacheLinkCache
$res
Returns
Array of remaining titles

Definition at line 151 of file LinkBatch.php.

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

Referenced by executeInto().

◆ constructSet()

LinkBatch::constructSet (   $prefix,
  $db 
)

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

Parameters
string$prefixthe appropriate table's field name prefix ('page', 'pl', etc)
$dbDatabaseBase object to use
Returns
mixed string with SQL where clause fragment, or false if no items.

Definition at line 235 of file LinkBatch.php.

References data.

Referenced by doQuery().

◆ doGenderQuery()

LinkBatch::doGenderQuery ( )

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

Returns
bool whether the query was successful

Definition at line 212 of file LinkBatch.php.

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

Referenced by executeInto().

◆ doQuery()

LinkBatch::doQuery ( )

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

Returns
Bool|ResultWrapper

Definition at line 183 of file LinkBatch.php.

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

Referenced by executeInto().

◆ execute()

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

◆ 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
$cacheLinkCache
Returns
Array remaining IDs

Definition at line 131 of file LinkBatch.php.

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

Referenced by execute().

◆ getSize()

LinkBatch::getSize ( )

Returns the size of the batch.

Returns
int

Definition at line 109 of file LinkBatch.php.

References data.

Referenced by isEmpty().

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

◆ 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
$arrayarray

Definition at line 91 of file LinkBatch.php.

References data.

◆ setCaller()

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

◆ $caller

LinkBatch::$caller
protected

For debugging which method is using this class.

Definition at line 39 of file LinkBatch.php.

Referenced by doQuery(), and setCaller().

◆ $data

LinkBatch::$data = array()

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

Definition at line 34 of file LinkBatch.php.

Referenced by addResultToCache().


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