HTMLFileCache Class Reference

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

Inherits FileCacheBase.

Collaboration diagram for HTMLFileCache:

Public Member Functions
	__construct ( $page, $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 ( $page)
	Clear the file caches for a page for all actions.
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

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 (BagOStuff $cache)
	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.

Additional Inherited Members
Protected Attributes inherited from FileCacheBase
bool null	$mCached
	lazy loaded
	$mExt = 'cache'
	$mFilePath
	$mKey
	$mType = 'object'
	$mUseGzip
ServiceOptions	$options

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

Constructor & Destructor Documentation

__construct()

HTMLFileCache::__construct	(		$page,
			$action )

Parameters

PageIdentity | string	$page	PageIdentity object or prefixed DB key string
string	$action

Definition at line 51 of file HTMLFileCache.php.

Member Function Documentation

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 ( $page )

static

Clear the file caches for a page for all actions.

Parameters

PageIdentity | string

$page

PageIdentity object or prefixed DB key string

Returns

bool Whether $wgUseFileCache is enabled

Definition at line 225 of file HTMLFileCache.php.

Referenced by HtmlFileCacheUpdate\doUpdate().

loadFromFileCache()

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

Read from cache to context output.

Parameters

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

Returns

void

Definition at line 144 of file HTMLFileCache.php.

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

saveToFileCache()

HTMLFileCache::saveToFileCache

(

$text

)

Save this cache object with the given text.

Use this as an ob_start() handler.

Normally this is only registered 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 process.

Parameters

string

$text

Returns

string|bool The annotated $text or false on error

Definition at line 185 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 77 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
int	$mode	One of the HTMLFileCache::MODE_* constants (since 1.28)

Returns

bool

Definition at line 91 of file HTMLFileCache.php.

References IContextSource\getLanguage(), IContextSource\getRequest(), and IContextSource\getUser().

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

Member Data Documentation

MODE_NORMAL

const HTMLFileCache::MODE_NORMAL = 0

Definition at line 38 of file HTMLFileCache.php.

MODE_OUTAGE

const HTMLFileCache::MODE_OUTAGE = 1

Definition at line 39 of file HTMLFileCache.php.

Referenced by MediaWiki\run().

MODE_REBUILD

const HTMLFileCache::MODE_REBUILD = 2

Definition at line 40 of file HTMLFileCache.php.

Referenced by RebuildFileCache\execute().

---

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

• includes/cache/HTMLFileCache.php