MediaWiki  master
HtmlCacheUpdater Class Reference

Class to invalidate the CDN and HTMLFileCache entries associated with URLs/titles. More...

Public Member Functions

 __construct (HookContainer $hookContainer, TitleFactory $titleFactory, $reboundDelay, $useFileCache, $cdnMaxAge)
 
 getUrls (PageReference $page, int $flags=0)
 Get a list of URLs to purge from the CDN cache when this page changes. More...
 
 purgeTitleUrls ( $pages, $flags=self::PURGE_PRESEND, array $unless=[])
 Purge the CDN/HTMLFileCache for a title or the titles yielded by an iterator. More...
 
 purgeUrls ( $urls, $flags=self::PURGE_PRESEND, array $unless=[])
 Purge the CDN for a URL or list of URLs. More...
 

Detailed Description

Class to invalidate the CDN and HTMLFileCache entries associated with URLs/titles.

Since
1.35

Definition at line 33 of file HtmlCacheUpdater.php.

Constructor & Destructor Documentation

◆ __construct()

HtmlCacheUpdater::__construct ( HookContainer  $hookContainer,
TitleFactory  $titleFactory,
  $reboundDelay,
  $useFileCache,
  $cdnMaxAge 
)
Parameters
HookContainer$hookContainer
TitleFactory$titleFactory
int$reboundDelay$wgCdnReboundPurgeDelay
bool$useFileCache$wgUseFileCache
int$cdnMaxAge$wgCdnMaxAge
Access: internal
For use with MediaWikiServices->getHtmlCacheUpdater()

Definition at line 98 of file HtmlCacheUpdater.php.

Member Function Documentation

◆ getUrls()

HtmlCacheUpdater::getUrls ( PageReference  $page,
int  $flags = 0 
)

Get a list of URLs to purge from the CDN cache when this page changes.

Parameters
PageReference$page
int$flagsBit field of PURGE_URLS_* class constants (optional).
Returns
string[] URLs

Definition at line 207 of file HtmlCacheUpdater.php.

Referenced by purgeTitleUrls().

◆ purgeTitleUrls()

HtmlCacheUpdater::purgeTitleUrls (   $pages,
  $flags = self::PURGE_PRESEND,
array  $unless = [] 
)

Purge the CDN/HTMLFileCache for a title or the titles yielded by an iterator.

All cacheable canonical URLs associated with the titles will be purged from CDN. All cacheable actions associated with the titles will be purged from HTMLFileCache.

Parameters
Traversable | PageReference[] | PageReference$pagesPageReference or iterator yielding PageReference instances
int$flagsBit field of class PURGE_* constants [Default: HtmlCacheUpdater::PURGE_PRESEND]
mixed[]$unlessOptional map of (HtmlCacheUpdater::UNLESS_* constant => value)

Definition at line 161 of file HtmlCacheUpdater.php.

References $title, DeferredUpdates\addUpdate(), getUrls(), HtmlFileCacheUpdate\newFromPages(), and purgeUrls().

◆ purgeUrls()

HtmlCacheUpdater::purgeUrls (   $urls,
  $flags = self::PURGE_PRESEND,
array  $unless = [] 
)

Purge the CDN for a URL or list of URLs.

Parameters
string[] | string$urlsURL or list of URLs
int$flagsBit field of class PURGE_* constants [Default: HtmlCacheUpdater::PURGE_PRESEND]
mixed[]$unlessOptional map of (HtmlCacheUpdater::UNLESS_* constant => value)

Definition at line 129 of file HtmlCacheUpdater.php.

References DeferredUpdates\addUpdate().

Referenced by purgeTitleUrls().


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