MediaWiki master
|
Class for fetching backlink lists, approximate backlink counts and partitions. More...
Public Member Functions | |
__construct (ServiceOptions $options, LinksMigration $linksMigration, WANObjectCache $wanCache, HookContainer $hookContainer, IConnectionProvider $dbProvider, PageReference $page) | |
Create a new BacklinkCache. | |
getCascadeProtectedLinkPages () | |
Get a PageIdentity iterator for cascade-protected template/file use backlinks. | |
getLinkPages (string $table, $startId=false, $endId=false, $max=INF) | |
Get the backlinks for a given table. | |
getNumLinks ( $table, $max=INF) | |
Get the approximate number of backlinks. | |
getPage () | |
hasLinks ( $table) | |
Check if there are any backlinks. | |
partition ( $table, $batchSize) | |
Partition the backlinks into batches. | |
Public Attributes | |
const | CONSTRUCTOR_OPTIONS |
Protected Member Functions | |
getDB () | |
Get the replica DB connection to the database. | |
getPrefix ( $table) | |
Get the field name prefix for a given table. | |
partitionResult ( $res, $batchSize, $isComplete=true) | |
Partition a DB result with backlinks in it into batches. | |
queryLinks ( $table, $startId, $endId, $max, $select='all') | |
Get the backlinks for a given table. | |
Protected Attributes | |
IResultWrapper[] | $fullResultCache = [] |
Contains the whole links from a database result. | |
PageReference | $page |
Local copy of a PageReference object. | |
array[] | $partitionCache = [] |
Multi dimensions array representing batches. | |
WANObjectCache | $wanCache |
Class for fetching backlink lists, approximate backlink counts and partitions.
This is a shared cache.
Instances of this class should typically be fetched with the method ::getBacklinkCache() from the BacklinkCacheFactory service.
Ideally you should only get your backlinks from here when you think there is some advantage in caching them. Otherwise, it's just a waste of memory.
Introduced by r47317
Definition at line 64 of file BacklinkCache.php.
MediaWiki\Cache\BacklinkCache::__construct | ( | ServiceOptions | $options, |
LinksMigration | $linksMigration, | ||
WANObjectCache | $wanCache, | ||
HookContainer | $hookContainer, | ||
IConnectionProvider | $dbProvider, | ||
PageReference | $page ) |
Create a new BacklinkCache.
ServiceOptions | $options | |
LinksMigration | $linksMigration | |
WANObjectCache | $wanCache | |
HookContainer | $hookContainer | |
IConnectionProvider | $dbProvider | |
PageReference | $page | Page to create a backlink cache for |
Definition at line 121 of file BacklinkCache.php.
References MediaWiki\Cache\BacklinkCache\$page, MediaWiki\Cache\BacklinkCache\$wanCache, and MediaWiki\Config\ServiceOptions\assertRequiredOptions().
MediaWiki\Cache\BacklinkCache::getCascadeProtectedLinkPages | ( | ) |
Get a PageIdentity iterator for cascade-protected template/file use backlinks.
Definition at line 506 of file BacklinkCache.php.
|
protected |
Get the replica DB connection to the database.
Definition at line 151 of file BacklinkCache.php.
MediaWiki\Cache\BacklinkCache::getLinkPages | ( | string | $table, |
$startId = false, | |||
$endId = false, | |||
$max = INF ) |
Get the backlinks for a given table.
Cached in process memory only.
string | $table | |
int | bool | $startId | |
int | bool | $endId | |
int | float | $max | Integer, or INF for no max |
Definition at line 164 of file BacklinkCache.php.
MediaWiki\Cache\BacklinkCache::getNumLinks | ( | $table, | |
$max = INF ) |
Get the approximate number of backlinks.
string | $table | |
int | float | $max | Only count up to this many backlinks, or INF for no max |
Definition at line 348 of file BacklinkCache.php.
References getDB().
MediaWiki\Cache\BacklinkCache::getPage | ( | ) |
|
protected |
Get the field name prefix for a given table.
string | $table |
Definition at line 227 of file BacklinkCache.php.
MediaWiki\Cache\BacklinkCache::hasLinks | ( | $table | ) |
Check if there are any backlinks.
string | $table |
Definition at line 338 of file BacklinkCache.php.
MediaWiki\Cache\BacklinkCache::partition | ( | $table, | |
$batchSize ) |
Partition the backlinks into batches.
Returns an array giving the start and end of each range. The first batch has a start of false, and the last batch has an end of false.
string | $table | The links table name |
int | $batchSize |
Definition at line 400 of file BacklinkCache.php.
|
protected |
Partition a DB result with backlinks in it into batches.
IResultWrapper | $res | Database result |
int | $batchSize | |
bool | $isComplete | Whether $res includes all the backlinks |
Definition at line 465 of file BacklinkCache.php.
|
protected |
Get the backlinks for a given table.
Cached in process memory only.
string | $table | |
int | bool | $startId | |
int | bool | $endId | |
int | $max | |
string | $select | 'all' or 'ids' |
Definition at line 182 of file BacklinkCache.php.
|
protected |
Contains the whole links from a database result.
This is raw data that will be partitioned in $partitionCache
Initialized with BacklinkCache::queryLinks()
Definition at line 92 of file BacklinkCache.php.
|
protected |
Local copy of a PageReference object.
Definition at line 104 of file BacklinkCache.php.
Referenced by MediaWiki\Cache\BacklinkCache\__construct().
|
protected |
Multi dimensions array representing batches.
Keys are:
(string) links table name (int) batch size 'numRows' : Number of rows for this link table 'batches' : [ $start, $end ]
Definition at line 82 of file BacklinkCache.php.
|
protected |
Definition at line 95 of file BacklinkCache.php.
Referenced by MediaWiki\Cache\BacklinkCache\__construct().
const MediaWiki\Cache\BacklinkCache::CONSTRUCTOR_OPTIONS |
Definition at line 68 of file BacklinkCache.php.