MediaWiki master
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
MediaWiki\Cache\LinkBatch Class Reference
BagOStuff

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 (iterable $arr, LinkCache $linkCache, TitleFormatter $titleFormatter, Language $contentLanguage, GenderCache $genderCache, IConnectionProvider $dbProvider, LinksMigration $linksMigration, TempUserDetailsLookup $tempUserDetailsLookup, LoggerInterface $logger)
 
 add ( $ns, $dbkey)
 
 addObj ( $link)
 
 addResultToCache ( $cache, $res)
 Add a result wrapper containing IDs and titles to a LinkCache object.
 
 addUser (UserIdentity $user)
 Convenience function to add user and user talk pages for a given user to this batch.
 
 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 ProperPageIdentity 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)
 Set the function name to attribute database queries to, in debug logs.
 

Public Attributes

array< int, array< string, mixed > > $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.
 

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

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Cache\LinkBatch::__construct ( iterable $arr,
LinkCache $linkCache,
TitleFormatter $titleFormatter,
Language $contentLanguage,
GenderCache $genderCache,
IConnectionProvider $dbProvider,
LinksMigration $linksMigration,
TempUserDetailsLookup $tempUserDetailsLookup,
LoggerInterface $logger )
See also
\MediaWiki\BagOStuff\LinkBatchFactory
Access: internal
Parameters
iterable<LinkTarget>|iterable<PageReference>$arr Initial items to be added to the batch
LinkCache$linkCache
TitleFormatter$titleFormatter
Language$contentLanguage
GenderCache$genderCache
IConnectionProvider$dbProvider
LinksMigration$linksMigration
TempUserDetailsLookup$tempUserDetailsLookup
LoggerInterface$logger

Definition at line 118 of file LinkBatch.php.

References MediaWiki\Cache\LinkBatch\addObj().

Member Function Documentation

◆ add()

MediaWiki\Cache\LinkBatch::add ( $ns,
$dbkey )
Parameters
int$ns
string$dbkey

Definition at line 200 of file LinkBatch.php.

◆ addObj()

MediaWiki\Cache\LinkBatch::addObj ( $link)
Parameters
LinkTarget | PageReference$link

Definition at line 174 of file LinkBatch.php.

References MediaWiki\Linker\LinkTarget\isExternal().

Referenced by MediaWiki\Cache\LinkBatch\__construct().

◆ addResultToCache()

MediaWiki\Cache\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 290 of file LinkBatch.php.

◆ addUser()

MediaWiki\Cache\LinkBatch::addUser ( UserIdentity $user)

Convenience function to add user and user talk pages for a given user to this batch.

Calling execute will also prefetch the expiration status of temporary accounts added this way, which is needed for the efficient rendering of user links via UserLinkRenderer.

Since
1.44

Definition at line 164 of file LinkBatch.php.

◆ constructSet()

MediaWiki\Cache\LinkBatch::constructSet ( $prefix,
$db )

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

It is the caller's responsibility to only call this if the LinkBatch is not empty, because there is no safe way to represent a SQL conditional for the empty set.

Parameters
string$prefixThe appropriate table's field name prefix ('page', 'pl', etc)
ISQLPlatform$dbDB object to use
Returns
string String with SQL where clause fragment

Definition at line 403 of file LinkBatch.php.

◆ doGenderQuery()

MediaWiki\Cache\LinkBatch::doGenderQuery ( )

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

Returns
bool Whether the query was successful

Definition at line 382 of file LinkBatch.php.

◆ doQuery()

MediaWiki\Cache\LinkBatch::doQuery ( )

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

Returns
IResultWrapper|false

Definition at line 357 of file LinkBatch.php.

◆ execute()

MediaWiki\Cache\LinkBatch::execute ( )

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

Returns
int[] Mapping PDBK to ID

Definition at line 241 of file LinkBatch.php.

◆ executeInto()

MediaWiki\Cache\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 267 of file LinkBatch.php.

◆ getPageIdentities()

MediaWiki\Cache\LinkBatch::getPageIdentities ( )

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

Since
1.37
Returns
ProperPageIdentity[] A list of ProperPageIdentities

Definition at line 252 of file LinkBatch.php.

◆ getSize()

MediaWiki\Cache\LinkBatch::getSize ( )

Returns the size of the batch.

Returns
int

Definition at line 232 of file LinkBatch.php.

◆ isEmpty()

MediaWiki\Cache\LinkBatch::isEmpty ( )

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

Returns
bool

Definition at line 223 of file LinkBatch.php.

◆ setArray()

MediaWiki\Cache\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<int,array<string,mixed>>$array

Definition at line 214 of file LinkBatch.php.

◆ setCaller()

MediaWiki\Cache\LinkBatch::setCaller ( $caller)

Set the function name to attribute database queries to, in debug logs.

See also
Wikimedia\Rdbms\SelectQueryBuilder::caller
Since
1.17
Parameters
string$caller
Returns
self (since 1.32)

Definition at line 151 of file LinkBatch.php.

Member Data Documentation

◆ $caller

string null MediaWiki\Cache\LinkBatch::$caller
protected

For debugging which method is using this class.

Definition at line 69 of file LinkBatch.php.

◆ $data

array<int,array<string,mixed> > MediaWiki\Cache\LinkBatch::$data = []

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

Definition at line 54 of file LinkBatch.php.

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