HtmlCacheUpdater Class Reference

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

Collaboration diagram for HtmlCacheUpdater:

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.
	purgeTitleUrls ( $pages, $flags=self::PURGE_PRESEND, array $unless=[])
	Purge the CDN/HTMLFileCache for a title or the titles yielded by an iterator.
	purgeUrls ( $urls, $flags=self::PURGE_PRESEND, array $unless=[])
	Purge the CDN for a URL or list of URLs.

Private Member Functions
	fieldHasFlag ( $flags, $flag)

Private Attributes
int	$cdnMaxAge
	Max seconds for CDN to served cached objects without revalidation.
HookRunner	$hookRunner
int	$reboundDelay
	Seconds between initial and rebound purges; 0 if disabled.
TitleFactory	$titleFactory
int	$useFileCache
	Whether filesystem-based HTML output caching is enabled.

Detailed Description

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

Since

1.35

Definition at line 32 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 97 of file HtmlCacheUpdater.php.

Member Function Documentation

fieldHasFlag()

HtmlCacheUpdater::fieldHasFlag (   $flags,   $flag  )

private

Parameters

int	$flags	Bit field
int	$flag	Constant to check for

Returns

bool If $flags contains $flag

Definition at line 116 of file HtmlCacheUpdater.php.

Referenced by purgeTitleUrls(), and purgeUrls().

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	$flags	Bit field of PURGE_URLS_* class constants (optional).

Returns

string[] URLs

Definition at line 204 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	$pages	PageReference or iterator yielding PageReference instances
int	$flags	Bit field of class PURGE_* constants [Default: HtmlCacheUpdater::PURGE_PRESEND]
mixed[]	$unless	Optional map of (HtmlCacheUpdater::UNLESS_* constant => value)

Definition at line 160 of file HtmlCacheUpdater.php.

References $title, fieldHasFlag(), 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	$urls	URL or list of URLs
int	$flags	Bit field of class PURGE_* constants [Default: HtmlCacheUpdater::PURGE_PRESEND]
mixed[]	$unless	Optional map of (HtmlCacheUpdater::UNLESS_* constant => value)

Definition at line 128 of file HtmlCacheUpdater.php.

References fieldHasFlag().

Referenced by purgeTitleUrls().

Member Data Documentation

$cdnMaxAge

int HtmlCacheUpdater::$cdnMaxAge

private

Max seconds for CDN to served cached objects without revalidation.

Definition at line 38 of file HtmlCacheUpdater.php.

$hookRunner

HookRunner HtmlCacheUpdater::$hookRunner

private

Definition at line 41 of file HtmlCacheUpdater.php.

$reboundDelay

int HtmlCacheUpdater::$reboundDelay

private

Seconds between initial and rebound purges; 0 if disabled.

Definition at line 34 of file HtmlCacheUpdater.php.

$titleFactory

TitleFactory HtmlCacheUpdater::$titleFactory

private

Initial value:

=
    public const UNLESS_CACHE_MTIME_AFTER  'unless-timestamp-exceeds'

Definition at line 86 of file HtmlCacheUpdater.php.

$useFileCache

int HtmlCacheUpdater::$useFileCache

private

Whether filesystem-based HTML output caching is enabled.

Definition at line 36 of file HtmlCacheUpdater.php.

---

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

• includes/cache/HtmlCacheUpdater.php