Page view caching in the file system. More...

Inheritance diagram for HTMLFileCache:

Collaboration diagram for HTMLFileCache:

Public Member Functions
	__construct ( $title, $action)

	loadFromFileCache (IContextSource $context, $mode=self::MODE_NORMAL)
	Read from cache to context output.

	saveToFileCache ( $text)
	Save this cache object with the given text.

Public Member Functions inherited from FileCacheBase
	cacheTimestamp ()
	Get the last-modified timestamp of the cache file.

	clearCache ()
	Clear the cache for this page.

	fetchText ()
	Get the uncompressed text from the cache.

	getMissesRecent ()
	Roughly gets the cache misses in the last hour by unique visitors.

	incrMissesRecent (WebRequest $request)
	Roughly increments the cache misses in the last hour by unique visitors.

	isCached ()
	Check if the cache file exists.

	isCacheGood ( $timestamp='')
	Check if up to date cache file exists.

	saveText ( $text)
	Save and compress text to the cache.

Static Public Member Functions
static	clearFileCache (Title $title)
	Clear the file caches for a page for all actions.

static	newFromTitle ( $title, $action)
	Construct an HTMLFileCache object from a Title and an action.

static	useFileCache (IContextSource $context, $mode=self::MODE_NORMAL)
	Check if pages can be cached for this request/user.

Public Attributes
const	MODE_NORMAL = 0

const	MODE_OUTAGE = 1

const	MODE_REBUILD = 2

Public Attributes inherited from FileCacheBase
const	MISS_FACTOR = 15

const	MISS_TTL_SEC = 3600

Protected Member Functions
	cacheDirectory ()
	Get the base file cache directory.

	typeSubdirectory ()
	Get the cache type subdirectory (with the trailing slash) or the empty string Alter the type -> directory mapping to put action=view cache at the root.

Protected Member Functions inherited from FileCacheBase
	__construct ()

	baseCacheDirectory ()
	Get the base file cache directory.

	cacheMissKey ()

	cachePath ()
	Get the path to the cache file.

	checkCacheDirs ()
	Create parent directors of $this->cachePath()

	hashSubdirectory ()
	Return relative multi-level hash subdirectory (with trailing slash) or the empty string if not $wgFileCacheDepth.

	useGzip ()
	Check if the cache is gzipped.

Static Protected Member Functions
static	cacheablePageActions ()
	Cacheable actions.

Additional Inherited Members
Protected Attributes inherited from FileCacheBase
	$mCached

	$mExt = 'cache'

	$mFilePath

	$mKey

	$mType = 'object'

	$mUseGzip

Detailed Description

Page view caching in the file system.

The only cacheable actions are "view" and "history". Also special pages will not be cached.

Definition at line 33 of file HTMLFileCache.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLFileCache::__construct	(	$title,
		$action
	)

Parameters

Title \| string	$title	Title object or prefixed DB key string
string	$action

Exceptions

MWException

Definition at line 56 of file HTMLFileCache.php.

References $title, cacheablePageActions(), and string.

Member Function Documentation

◆ cacheablePageActions()

static HTMLFileCache::cacheablePageActions ( )

staticprotected

Cacheable actions.

Returns: array

Definition at line 74 of file HTMLFileCache.php.

Referenced by __construct().

◆ cacheDirectory()

HTMLFileCache::cacheDirectory ( )

protected

Get the base file cache directory.

Returns: string

Reimplemented from FileCacheBase.

Definition at line 82 of file HTMLFileCache.php.

References FileCacheBase\baseCacheDirectory().

◆ clearFileCache()

static HTMLFileCache::clearFileCache ( Title $title )

static

Clear the file caches for a page for all actions.

Parameters

Title $title

Returns: bool Whether $wgUseFileCache is enabled

Definition at line 245 of file HTMLFileCache.php.

References $title, $type, and as.

Referenced by WikiPage\doPurge(), HTMLCacheUpdateJob\invalidateTitles(), WikiPage\onArticleDelete(), and WikiPage\onArticleEdit().

◆ loadFromFileCache()

HTMLFileCache::loadFromFileCache	(	IContextSource	$context,
			$mode = `self::MODE_NORMAL`
	)

Read from cache to context output.

Parameters

IContextSource	$context
integer	$mode	One of the HTMLFileCache::MODE_* constants

Returns: void

Definition at line 159 of file HTMLFileCache.php.

References $context, $wgContLang, FileCacheBase\cachePath(), global, FileCacheBase\useGzip(), wfClientAcceptsGzip(), and wfDebug().

◆ newFromTitle()

static HTMLFileCache::newFromTitle	(	$title,
		$action
	)

static

Construct an HTMLFileCache object from a Title and an action.

Deprecated:: since 1.24, instantiate this class directly

Parameters

Title \| string	$title	Title object or prefixed DB key string
string	$action

Exceptions

MWException

Returns: HTMLFileCache

Definition at line 47 of file HTMLFileCache.php.

References $title.

◆ saveToFileCache()

HTMLFileCache::saveToFileCache ( $text )

Save this cache object with the given text.

Use this as an ob_start() handler.

Normally this is only registed as a handler if $wgUseFileCache is on. If can be explicitly called by rebuildFileCache.php when it takes over handling file caching itself, disabling any automatic handling the the process.

Parameters

string $text

Returns: string|bool The annotated $text or false on error

Definition at line 202 of file HTMLFileCache.php.

References FileCacheBase\saveText(), FileCacheBase\useGzip(), wfClientAcceptsGzip(), wfDebug(), and wfTimestampNow().

◆ typeSubdirectory()

HTMLFileCache::typeSubdirectory ( )

protected

Get the cache type subdirectory (with the trailing slash) or the empty string Alter the type -> directory mapping to put action=view cache at the root.

Returns: string

Reimplemented from FileCacheBase.

Definition at line 92 of file HTMLFileCache.php.

◆ useFileCache()

static HTMLFileCache::useFileCache	(	IContextSource	$context,
			$mode = `self::MODE_NORMAL`
	)

static

Check if pages can be cached for this request/user.

Parameters

IContextSource	$context
integer	$mode	One of the HTMLFileCache::MODE_* constants (since 1.28)

Returns: bool

Definition at line 106 of file HTMLFileCache.php.

References $context, $query, $user, as, and wfDebug().

Referenced by Article\isFileCacheable(), MediaWiki\main(), HistoryAction\onView(), and MediaWiki\run().

Member Data Documentation

◆ MODE_NORMAL

const HTMLFileCache::MODE_NORMAL = 0

Definition at line 34 of file HTMLFileCache.php.

◆ MODE_OUTAGE

const HTMLFileCache::MODE_OUTAGE = 1

Definition at line 35 of file HTMLFileCache.php.

Referenced by MediaWiki\run().

◆ MODE_REBUILD

const HTMLFileCache::MODE_REBUILD = 2

Definition at line 36 of file HTMLFileCache.php.

Referenced by RebuildFileCache\execute().

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

includes/cache/HTMLFileCache.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cacheablePageActions()

◆ cacheDirectory()

◆ clearFileCache()

◆ loadFromFileCache()

◆ newFromTitle()

◆ saveToFileCache()

◆ typeSubdirectory()

◆ useFileCache()

Member Data Documentation

◆ MODE_NORMAL

◆ MODE_OUTAGE

◆ MODE_REBUILD