ResourceLoader request result caching in the file system. More...

Inheritance diagram for ResourceFileCache:

Collaboration diagram for ResourceFileCache:

[legend]

Public Member Functions
	isCacheWorthy ()
	Item has many recent cache misses.

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	newFromContext (RL\Context $context)
	Construct an ResourceFileCache from a context.

static	useFileCache (RL\Context $context)
	Check if an RL request can be cached.

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

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.

	typeSubdirectory ()
	Get the cache type subdirectory (with trailing slash) An extending class could use that method to alter the type -> directory mapping.

	useGzip ()
	Check if the cache is gzipped.

Protected Attributes
	$mCacheWorthy

Protected Attributes inherited from FileCacheBase
bool null	$mCached
	lazy loaded

	$mExt = 'cache'

	$mFilePath

	$mKey

	$mType = 'object'

	$mUseGzip

ServiceOptions	$options

Detailed Description

ResourceLoader request result caching in the file system.

Definition at line 34 of file ResourceFileCache.php.

Member Function Documentation

◆ cacheDirectory()

ResourceFileCache::cacheDirectory ( )

protected

Get the base file cache directory.

Returns: string

Reimplemented from FileCacheBase.

Definition at line 107 of file ResourceFileCache.php.

References FileCacheBase\baseCacheDirectory().

◆ isCacheWorthy()

ResourceFileCache::isCacheWorthy ( )

Item has many recent cache misses.

Returns: bool

Definition at line 115 of file ResourceFileCache.php.

References FileCacheBase\getMissesRecent(), and FileCacheBase\isCached().

◆ newFromContext()

static ResourceFileCache::newFromContext ( RL\Context $context )

static

Construct an ResourceFileCache from a context.

Parameters

RL\\Context $context

Returns: ResourceFileCache

Definition at line 45 of file ResourceFileCache.php.

References $cache, and $modules.

Referenced by MediaWiki\ResourceLoader\ResourceLoader\respond().

◆ useFileCache()

static ResourceFileCache::useFileCache ( RL\Context $context )

static

Check if an RL request can be cached.

Caller is responsible for checking if any modules are private.

Parameters

RL\\Context $context

Returns: bool

Definition at line 71 of file ResourceFileCache.php.

Referenced by MediaWiki\ResourceLoader\ResourceLoader\respond().

Member Data Documentation

◆ $mCacheWorthy

ResourceFileCache::$mCacheWorthy

protected

Definition at line 35 of file ResourceFileCache.php.

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

includes/cache/ResourceFileCache.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes