Page view caching in the file system. More...
Public Member Functions | |
| loadFromFileCache (IContextSource $context) | |
| Read from cache to context output. | |
| saveToFileCache ($text) | |
| Save this cache object with the given text. | |
Static Public Member Functions | |
| static | clearFileCache (Title $title) |
| Clear the file caches for a page for all actions. | |
| static | newFromTitle ($title, $action) |
| Construct an ObjectFileCache from a Title and an action. | |
| static | useFileCache (IContextSource $context) |
| Check if pages can be cached for this request/user. | |
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. | |
Static Protected Member Functions | |
| static | cacheablePageActions () |
| Cacheable actions. | |
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
| static HTMLFileCache::cacheablePageActions | ( | ) | [static, protected] |
Cacheable actions.
- Returns:
- array
Definition at line 59 of file HTMLFileCache.php.
References array().
Referenced by newFromTitle().
| 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().
| 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 as, global, and newFromTitle().
Referenced by HTMLCacheUpdateJob\invalidateTitles().
| 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().
| 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(), and MediaWiki\main().
| 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().
| 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.
| 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 MediaWiki\main().
The documentation for this class was generated from the following file:
- includes/cache/HTMLFileCache.php
