MediaWiki
master
|
Cache for article titles (prefixed DB keys) and ids linked from one source. More...
Public Member Functions | |
__construct (TitleFormatter $titleFormatter, WANObjectCache $cache, NamespaceInfo $nsInfo, ILoadBalancer $loadBalancer=null) | |
addBadLinkObj ( $page, int $queryFlags=IDBAccessObject::READ_NORMAL) | |
Add information about a missing page to the process cache. More... | |
addGoodLinkObj ( $id, $page, $len=-1, $redir=null, $revision=0, $model=null, $lang=null) | |
Add information about an existing page to the process cache. More... | |
addGoodLinkObjFromRow ( $page, stdClass $row, int $queryFlags=IDBAccessObject::READ_NORMAL) | |
Add information about an existing page to the process cache. More... | |
addLinkObj ( $page, int $queryFlags=IDBAccessObject::READ_NORMAL) | |
Add a title to the link cache, return the page_id or zero if non-existent. More... | |
clear () | |
Clears cache. More... | |
clearBadLink ( $page) | |
Clear information about a page being missing from the process cache. More... | |
clearLink ( $page) | |
Clear information about a page from the process cache. More... | |
getGoodLinkFieldObj ( $page, string $field) | |
Get the field of a page known to the process cache. More... | |
getGoodLinkID ( $page) | |
Get the ID of a page known to the process cache. More... | |
getGoodLinkRow (int $ns, string $dbkey, callable $fetchCallback=null, int $queryFlags=IDBAccessObject::READ_NORMAL) | |
Returns the row for the page if the page exists (subject to race conditions). More... | |
invalidateTitle ( $page) | |
Purge the persistent link cache for a title. More... | |
isBadLink ( $page) | |
Check if a page is known to be missing based on the process cache. More... | |
setLogger (LoggerInterface $logger) | |
Static Public Member Functions | |
static | getSelectFields () |
Fields that LinkCache needs to select. More... | |
Cache for article titles (prefixed DB keys) and ids linked from one source.
Definition at line 42 of file LinkCache.php.
LinkCache::__construct | ( | TitleFormatter | $titleFormatter, |
WANObjectCache | $cache, | ||
NamespaceInfo | $nsInfo, | ||
ILoadBalancer | $loadBalancer = null |
||
) |
TitleFormatter | $titleFormatter | |
WANObjectCache | $cache | |
NamespaceInfo | $nsInfo | |
ILoadBalancer | null | $loadBalancer | Use null when no database is set up, for example on installation |
Definition at line 70 of file LinkCache.php.
LinkCache::addBadLinkObj | ( | $page, | |
int | $queryFlags = IDBAccessObject::READ_NORMAL |
||
) |
Add information about a missing page to the process cache.
Callers must set the READ_LATEST flag if the row came from a DB_PRIMARY source. However, the use of such data is highly discouraged; most callers rely on seeing consistent DB_REPLICA data (e.g. REPEATABLE-READ point-in-time snapshots) and the accidental use of DB_PRIMARY data via LinkCache is prone to causing anomalies.
LinkTarget | PageReference | array | $page | The page to set cached info for. Can be given as an object or an associative array containing the page_namespace and page_title fields. In MediaWiki 1.36 and earlier, only LinkTarget was accepted. |
int | $queryFlags | The query flags used to retrieve the row, IDBAccessObject::READ_* |
Definition at line 324 of file LinkCache.php.
LinkCache::addGoodLinkObj | ( | $id, | |
$page, | |||
$len = -1 , |
|||
$redir = null , |
|||
$revision = 0 , |
|||
$model = null , |
|||
$lang = null |
|||
) |
Add information about an existing page to the process cache.
int | $id | Page's ID |
LinkTarget | PageReference | $page | The page to set cached info for. In MediaWiki 1.36 and earlier, only LinkTarget was accepted. |
int | $len | Text's length |
int | null | $redir | Whether the page is a redirect |
int | $revision | Latest revision's ID |
string | null | $model | Latest revision's content model ID |
string | null | $lang | Language code of the page, if not the content language |
Definition at line 257 of file LinkCache.php.
References $lang, addGoodLinkObjFromRow(), and wfDeprecated().
LinkCache::addGoodLinkObjFromRow | ( | $page, | |
stdClass | $row, | ||
int | $queryFlags = IDBAccessObject::READ_NORMAL |
||
) |
Add information about an existing page to the process cache.
Callers must set the READ_LATEST flag if the row came from a DB_PRIMARY source. However, the use of such data is highly discouraged; most callers rely on seeing consistent DB_REPLICA data (e.g. REPEATABLE-READ point-in-time snapshots) and the accidental use of DB_PRIMARY data via LinkCache is prone to causing anomalies.
LinkTarget | PageReference | array | $page | The page to set cached info for. Can be given as an object or an associative array containing the page_namespace and page_title fields. In MediaWiki 1.36 and earlier, only LinkTarget was accepted. |
stdClass | $row | Object which has all fields returned by getSelectFields(). |
int | $queryFlags | The query flags used to retrieve the row, IDBAccessObject::READ_* |
Definition at line 291 of file LinkCache.php.
Referenced by addGoodLinkObj().
LinkCache::addLinkObj | ( | $page, | |
int | $queryFlags = IDBAccessObject::READ_NORMAL |
||
) |
Add a title to the link cache, return the page_id or zero if non-existent.
This causes the link to be looked up in the database if it is not yet cached.
LinkTarget | PageReference | array | $page | The page to load. Can be given as an object or an associative array containing the page_namespace and page_title fields. In MediaWiki 1.36 and earlier, only LinkTarget was accepted. |
int | $queryFlags | IDBAccessObject::READ_XXX |
Definition at line 407 of file LinkCache.php.
References getGoodLinkRow().
LinkCache::clear | ( | ) |
Clears cache.
Definition at line 606 of file LinkCache.php.
LinkCache::clearBadLink | ( | $page | ) |
Clear information about a page being missing from the process cache.
LinkTarget | PageReference | array | string | $page | The page to clear cached info for, as an object, an array containing the page_namespace and page_title fields, or a prefixed DB key. In MediaWiki 1.36 and earlier, only a string was accepted. In MediaWiki 1.36 and earlier, only a string was accepted. |
Definition at line 341 of file LinkCache.php.
LinkCache::clearLink | ( | $page | ) |
Clear information about a page from the process cache.
LinkTarget | PageReference | array | $page | The page to clear cached info for. Can be given as an object or an associative array containing the page_namespace and page_title fields. In MediaWiki 1.36 and earlier, only LinkTarget was accepted. |
Definition at line 361 of file LinkCache.php.
LinkCache::getGoodLinkFieldObj | ( | $page, | |
string | $field | ||
) |
Get the field of a page known to the process cache.
If this link is not a cached good title, it will return NULL.
LinkTarget | PageReference | array | $page | The page to get cached info for. Can be given as an object or an associative array containing the page_namespace and page_title fields. In MediaWiki 1.36 and earlier, only LinkTarget was accepted. |
string | $field | ( 'id', 'length', 'redirect', 'revision', 'model', 'lang' ) |
Definition at line 184 of file LinkCache.php.
LinkCache::getGoodLinkID | ( | $page | ) |
Get the ID of a page known to the process cache.
LinkTarget | PageReference | array | string | $page | The page to get the ID for, as an object, an array containing the page_namespace and page_title fields, or a prefixed DB key. In MediaWiki 1.36 and earlier, only a string was accepted. |
Definition at line 156 of file LinkCache.php.
LinkCache::getGoodLinkRow | ( | int | $ns, |
string | $dbkey, | ||
callable | $fetchCallback = null , |
||
int | $queryFlags = IDBAccessObject::READ_NORMAL |
||
) |
Returns the row for the page if the page exists (subject to race conditions).
The row will be returned from local cache or WAN cache if possible, or it will be looked up using the callback provided.
int | $ns | |
string | $dbkey | |
callable | null | $fetchCallback | A callback that will retrieve the link row with the signature ( IDatabase $db, int $ns, string $dbkey, array $queryOptions ): ?stdObj. |
int | $queryFlags | IDBAccessObject::READ_XXX |
Definition at line 493 of file LinkCache.php.
Referenced by addLinkObj().
|
static |
Fields that LinkCache needs to select.
Definition at line 374 of file LinkCache.php.
Referenced by OutputPage\addCategoryLinksToLBAndGetResult(), MediaWiki\Category\CategoryViewer\doCategoryQuery(), LinkBatch\doQuery(), LinkHolderArray\doVariants(), MediaWiki\Title\Title\getLinksTo(), ApiPageSet\getPageTableFields(), LinkHolderArray\replaceInternal(), and SpecialPrefixindex\showPrefixChunk().
LinkCache::invalidateTitle | ( | $page | ) |
Purge the persistent link cache for a title.
LinkTarget | PageReference | $page | In MediaWiki 1.36 and earlier, only LinkTarget was accepted. |
Definition at line 594 of file LinkCache.php.
LinkCache::isBadLink | ( | $page | ) |
Check if a page is known to be missing based on the process cache.
LinkTarget | PageReference | array | string | $page | The page to get cached info for, as an object, an array containing the page_namespace and page_title fields, or a prefixed DB key. In MediaWiki 1.36 and earlier, only a string was accepted. In MediaWiki 1.36 and earlier, only a string was accepted. |
Definition at line 231 of file LinkCache.php.
LinkCache::setLogger | ( | LoggerInterface | $logger | ) |
LoggerInterface | $logger |
Definition at line 87 of file LinkCache.php.