BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
HTMLFileCache Class Reference
Inheritance diagram for HTMLFileCache:
Collaboration diagram for HTMLFileCache:

Public Member Functions

 __construct ($title, $action)
 
 loadFromFileCache (IContextSource $context)
 
 saveToFileCache ($text)
 
- Public Member Functions inherited from FileCacheBase
 isCached ()
 
 cacheTimestamp ()
 
 isCacheGood ($timestamp= '')
 
 fetchText ()
 
 saveText ($text)
 
 clearCache ()
 
 incrMissesRecent (WebRequest $request)
 
 getMissesRecent ()
 

Static Public Member Functions

static newFromTitle ($title, $action)
 
static useFileCache (IContextSource $context)
 
static clearFileCache (Title $title)
 

Protected Member Functions

 cacheDirectory ()
 
 typeSubdirectory ()
 
- Protected Member Functions inherited from FileCacheBase
 baseCacheDirectory ()
 
 cacheDirectory ()
 
 cachePath ()
 
 useGzip ()
 
 checkCacheDirs ()
 
 typeSubdirectory ()
 
 hashSubdirectory ()
 
 cacheMissKey ()
 

Static Protected Member Functions

static cacheablePageActions ()
 

Additional Inherited Members

- Public Attributes inherited from FileCacheBase
const MISS_FACTOR = 15
 
const MISS_TTL_SEC = 3600
 
- Protected Attributes inherited from FileCacheBase
 $mKey
 
 $mType = 'object'
 
 $mExt = 'cache'
 
 $mFilePath
 
 $mUseGzip
 
 $mCached
 

Detailed Description

Page view caching in the file system. The only cacheable actions are "view" and "history". Also special pages will not be cached.

Constructor & Destructor Documentation

HTMLFileCache::__construct (   $title,
  $action 
)
Parameters
Title | string$titleTitle object or prefixed DB key string
string$action
Exceptions
MWException

Member Function Documentation

static HTMLFileCache::cacheablePageActions ( )
staticprotected

Cacheable actions

Returns
array
HTMLFileCache::cacheDirectory ( )
protected

Get the base file cache directory

Returns
string
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
HTMLFileCache::loadFromFileCache ( IContextSource  $context)

Read from cache to context output

Parameters
IContextSource$context
Returns
void
static HTMLFileCache::newFromTitle (   $title,
  $action 
)
static

Construct an ObjectFileCache from a Title and an action

Parameters
Title | string$titleTitle object or prefixed DB key string
string$action
Exceptions
MWException
Returns
HTMLFileCache
Deprecated:
Since 1.24, instantiate this class directly
HTMLFileCache::saveToFileCache (   $text)

Save this cache object with the given text. Use this as an ob_start() handler.

Parameters
string$text
Returns
bool Whether $wgUseFileCache is enabled
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
static HTMLFileCache::useFileCache ( IContextSource  $context)
static

Check if pages can be cached for this request/user

Parameters
IContextSource$context
Returns
bool

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