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

Inheritance diagram for HTMLFileCache:

Collaboration diagram for HTMLFileCache:

Public Member Functions
	loadFromFileCache (IContextSource $context)
	Read from cache to context output. More...

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

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

	clearCache ()
	Clear the cache for this page. More...

	fetchText ()
	Get the uncompressed text from the cache. More...

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

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

	isCached ()
	Check if the cache file exists. More...

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

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

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

static	newFromTitle ( $title, $action)
	Construct an ObjectFileCache from a Title and an action. More...

static	useFileCache (IContextSource $context)
	Check if pages can be cached for this request/user. More...

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

	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. More...

Protected Member Functions inherited from FileCacheBase
	__construct ()

	baseCacheDirectory ()
	Get the base file cache directory. More...

	cacheMissKey ()

	cachePath ()
	Get the path to the cache file. More...

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

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

	useGzip ()
	Check if the cache is gzipped. More...

Static Protected Member Functions
static	cacheablePageActions ()
	Cacheable actions. More...

Additional Inherited Members
Public Attributes inherited from FileCacheBase
const	MISS_FACTOR = 15

const	MISS_TTL_SEC = 3600

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 31 of file HTMLFileCache.php.

Member Function Documentation

◆ cacheablePageActions()

static HTMLFileCache::cacheablePageActions ( )

staticprotected

Cacheable actions.

Returns: array

Definition at line 59 of file HTMLFileCache.php.

References array().

Referenced by newFromTitle().

◆ cacheDirectory()

HTMLFileCache::cacheDirectory ( )

protected

Get the base file cache directory.

Returns: string

Reimplemented from FileCacheBase.

Definition at line 67 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 206 of file HTMLFileCache.php.

References $title, $type, as, global, and newFromTitle().

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

◆ loadFromFileCache()

HTMLFileCache::loadFromFileCache ( IContextSource $context )

Read from cache to context output.

Parameters

$context IContextSource

Returns: void

Definition at line 131 of file HTMLFileCache.php.

References FileCacheBase\cachePath(), IContextSource\getOutput(), global, FileCacheBase\useGzip(), wfClientAcceptsGzip(), and wfDebug().

◆ newFromTitle()

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

static

Construct an ObjectFileCache from a Title and an action.

Parameters

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

Exceptions

MWException

Returns: HTMLFileCache

Definition at line 39 of file HTMLFileCache.php.

References $cache, $title, and cacheablePageActions().

Referenced by clearFileCache(), RebuildFileCache\execute(), MediaWiki\main(), HistoryAction\onView(), and Article\tryFileCache().

◆ saveToFileCache()

HTMLFileCache::saveToFileCache ( $text )

Save this cache object with the given text.

Use this as an ob_start() handler.

Parameters

$text string

Returns: bool Whether $wgUseFileCache is enabled

Definition at line 161 of file HTMLFileCache.php.

References global, 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 77 of file HTMLFileCache.php.

◆ useFileCache()

static HTMLFileCache::useFileCache ( IContextSource $context )

static

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

Parameters

$context IContextSource

Returns: bool

Definition at line 90 of file HTMLFileCache.php.

References $query, $user, $wgContLang, as, IContextSource\getLanguage(), IContextSource\getRequest(), IContextSource\getUser(), global, and wfDebug().

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

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

includes/cache/HTMLFileCache.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ cacheablePageActions()

◆ cacheDirectory()

◆ clearFileCache()

◆ loadFromFileCache()

◆ newFromTitle()

◆ saveToFileCache()

◆ typeSubdirectory()

◆ useFileCache()