MediaWiki master
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MediaWiki\Cache\FileCacheBase Class Reference
BagOStuff

Base class for data storage in the file system. More...

Inherited by HTMLFileCache.

Collaboration diagram for MediaWiki\Cache\FileCacheBase:
Collaboration graph
[legend]

Public Member Functions

 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.
 

Protected Member Functions

 __construct ()
 
 baseCacheDirectory ()
 Get the base file cache directory.
 
 cacheDirectory ()
 Get the base cache directory (not specific to this file)
 
 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

bool null $mCached
 lazy loaded
 
string $mExt = 'cache'
 
string null $mFilePath
 
string $mKey
 
string $mType = 'object'
 
bool $mUseGzip
 
ServiceOptions $options
 

Detailed Description

Base class for data storage in the file system.

Definition at line 39 of file FileCacheBase.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Cache\FileCacheBase::__construct ( )
protected

Definition at line 68 of file FileCacheBase.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\MainConfigNames\UseGzip.

Member Function Documentation

◆ baseCacheDirectory()

MediaWiki\Cache\FileCacheBase::baseCacheDirectory ( )
finalprotected

Get the base file cache directory.

Returns
string

Definition at line 80 of file FileCacheBase.php.

References MediaWiki\MainConfigNames\FileCacheDirectory.

Referenced by HTMLFileCache\cacheDirectory().

◆ cacheDirectory()

MediaWiki\Cache\FileCacheBase::cacheDirectory ( )
abstractprotected

Get the base cache directory (not specific to this file)

Returns
string

Reimplemented in HTMLFileCache.

Referenced by MediaWiki\Cache\FileCacheBase\cachePath().

◆ cacheMissKey()

MediaWiki\Cache\FileCacheBase::cacheMissKey ( BagOStuff $cache)
protected
Parameters
BagOStuff$cacheInstance that the key will be used with
Returns
string

Definition at line 296 of file FileCacheBase.php.

References Wikimedia\ObjectCache\BagOStuff\makeKey().

Referenced by MediaWiki\Cache\FileCacheBase\getMissesRecent(), and MediaWiki\Cache\FileCacheBase\incrMissesRecent().

◆ cachePath()

MediaWiki\Cache\FileCacheBase::cachePath ( )
protected

Get the path to the cache file.

Returns
string

Definition at line 94 of file FileCacheBase.php.

References MediaWiki\Cache\FileCacheBase\$mFilePath, MediaWiki\Cache\FileCacheBase\cacheDirectory(), MediaWiki\Cache\FileCacheBase\hashSubdirectory(), MediaWiki\Cache\FileCacheBase\typeSubdirectory(), and MediaWiki\Cache\FileCacheBase\useGzip().

Referenced by MediaWiki\Cache\FileCacheBase\cacheTimestamp(), MediaWiki\Cache\FileCacheBase\checkCacheDirs(), MediaWiki\Cache\FileCacheBase\clearCache(), MediaWiki\Cache\FileCacheBase\fetchText(), MediaWiki\Cache\FileCacheBase\isCached(), HTMLFileCache\loadFromFileCache(), and MediaWiki\Cache\FileCacheBase\saveText().

◆ cacheTimestamp()

MediaWiki\Cache\FileCacheBase::cacheTimestamp ( )

Get the last-modified timestamp of the cache file.

Returns
string|bool TS_MW timestamp

Definition at line 127 of file FileCacheBase.php.

References MediaWiki\Cache\FileCacheBase\cachePath(), and wfTimestamp().

Referenced by MediaWiki\Cache\FileCacheBase\isCacheGood().

◆ checkCacheDirs()

MediaWiki\Cache\FileCacheBase::checkCacheDirs ( )
protected

Create parent directors of $this->cachePath()

Returns
void

Definition at line 216 of file FileCacheBase.php.

References MediaWiki\Cache\FileCacheBase\cachePath(), and wfMkdirParents().

Referenced by MediaWiki\Cache\FileCacheBase\saveText().

◆ clearCache()

MediaWiki\Cache\FileCacheBase::clearCache ( )

Clear the cache for this page.

Returns
void

Definition at line 205 of file FileCacheBase.php.

References MediaWiki\Cache\FileCacheBase\cachePath().

◆ fetchText()

MediaWiki\Cache\FileCacheBase::fetchText ( )

Get the uncompressed text from the cache.

Returns
string

Definition at line 168 of file FileCacheBase.php.

References MediaWiki\Cache\FileCacheBase\cachePath(), and MediaWiki\Cache\FileCacheBase\useGzip().

◆ getMissesRecent()

MediaWiki\Cache\FileCacheBase::getMissesRecent ( )

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

Returns
int

Definition at line 285 of file FileCacheBase.php.

References MediaWiki\Cache\FileCacheBase\cacheMissKey(), and MediaWiki\MediaWikiServices\getInstance().

◆ hashSubdirectory()

MediaWiki\Cache\FileCacheBase::hashSubdirectory ( )
protected

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

Returns
string

Definition at line 236 of file FileCacheBase.php.

References MediaWiki\MainConfigNames\FileCacheDepth.

Referenced by MediaWiki\Cache\FileCacheBase\cachePath().

◆ incrMissesRecent()

MediaWiki\Cache\FileCacheBase::incrMissesRecent ( WebRequest $request)

Roughly increments the cache misses in the last hour by unique visitors.

Parameters
WebRequest$request
Returns
void

Definition at line 255 of file FileCacheBase.php.

References MediaWiki\Cache\FileCacheBase\cacheMissKey(), MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Request\WebRequest\getIP().

◆ isCached()

MediaWiki\Cache\FileCacheBase::isCached ( )

Check if the cache file exists.

Returns
bool

Definition at line 117 of file FileCacheBase.php.

References MediaWiki\Cache\FileCacheBase\$mCached, and MediaWiki\Cache\FileCacheBase\cachePath().

Referenced by MediaWiki\Cache\FileCacheBase\isCacheGood().

◆ isCacheGood()

MediaWiki\Cache\FileCacheBase::isCacheGood ( $timestamp = '')

Check if up to date cache file exists.

Parameters
string$timestampMW_TS timestamp
Returns
bool

Definition at line 141 of file FileCacheBase.php.

References MediaWiki\MainConfigNames\CacheEpoch, MediaWiki\Cache\FileCacheBase\cacheTimestamp(), MediaWiki\Cache\FileCacheBase\isCached(), wfBoolToStr(), and wfDebug().

◆ saveText()

MediaWiki\Cache\FileCacheBase::saveText ( $text)

Save and compress text to the cache.

Parameters
string$text
Returns
string|false Compressed text

Definition at line 183 of file FileCacheBase.php.

References MediaWiki\Cache\FileCacheBase\cachePath(), MediaWiki\Cache\FileCacheBase\checkCacheDirs(), MediaWiki\Cache\FileCacheBase\useGzip(), and wfDebug().

Referenced by HTMLFileCache\saveToFileCache().

◆ typeSubdirectory()

MediaWiki\Cache\FileCacheBase::typeSubdirectory ( )
protected

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

See also
HTMLFileCache::typeSubdirectory() for an example.
Returns
string

Reimplemented in HTMLFileCache.

Definition at line 227 of file FileCacheBase.php.

Referenced by MediaWiki\Cache\FileCacheBase\cachePath().

◆ useGzip()

MediaWiki\Cache\FileCacheBase::useGzip ( )
protected

Check if the cache is gzipped.

Returns
bool

Definition at line 160 of file FileCacheBase.php.

References MediaWiki\Cache\FileCacheBase\$mUseGzip.

Referenced by MediaWiki\Cache\FileCacheBase\cachePath(), MediaWiki\Cache\FileCacheBase\fetchText(), HTMLFileCache\loadFromFileCache(), MediaWiki\Cache\FileCacheBase\saveText(), and HTMLFileCache\saveToFileCache().

Member Data Documentation

◆ $mCached

bool null MediaWiki\Cache\FileCacheBase::$mCached
protected

lazy loaded

Definition at line 60 of file FileCacheBase.php.

Referenced by MediaWiki\Cache\FileCacheBase\isCached().

◆ $mExt

string MediaWiki\Cache\FileCacheBase::$mExt = 'cache'
protected

Definition at line 54 of file FileCacheBase.php.

◆ $mFilePath

string null MediaWiki\Cache\FileCacheBase::$mFilePath
protected

Definition at line 56 of file FileCacheBase.php.

Referenced by MediaWiki\Cache\FileCacheBase\cachePath().

◆ $mKey

string MediaWiki\Cache\FileCacheBase::$mKey
protected
Initial value:
=[,,,,,]
private const CONSTRUCTOR_OPTIONS
MainConfigNames::CacheEpoch
MainConfigNames::FileCacheDepth
MainConfigNames::FileCacheDirectory
MainConfigNames::MimeType
MainConfigNames::UseGzip
MediaWiki\MainConfigNames\FileCacheDirectory
const FileCacheDirectory
Name constant for the FileCacheDirectory setting, for use with Config::get()
Definition MainConfigNames.php:172
MediaWiki\MainConfigNames\MimeType
const MimeType
Name constant for the MimeType setting, for use with Config::get()
Definition MainConfigNames.php:1950
MediaWiki\MainConfigNames\CacheEpoch
const CacheEpoch
Name constant for the CacheEpoch setting, for use with Config::get()
Definition MainConfigNames.php:1626
MediaWiki\MainConfigNames\FileCacheDepth
const FileCacheDepth
Name constant for the FileCacheDepth setting, for use with Config::get()
Definition MainConfigNames.php:1644
MediaWiki\MainConfigNames\UseGzip
const UseGzip
Name constant for the UseGzip setting, for use with Config::get()
Definition MainConfigNames.php:1668

Definition at line 50 of file FileCacheBase.php.

◆ $mType

string MediaWiki\Cache\FileCacheBase::$mType = 'object'
protected

Definition at line 52 of file FileCacheBase.php.

◆ $mUseGzip

bool MediaWiki\Cache\FileCacheBase::$mUseGzip
protected

Definition at line 58 of file FileCacheBase.php.

Referenced by MediaWiki\Cache\FileCacheBase\useGzip().

◆ $options

ServiceOptions MediaWiki\Cache\FileCacheBase::$options
protected

Definition at line 62 of file FileCacheBase.php.

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