Public Member Functions | |
| get ($article, $popts, $useOutdated=false) | |
| Retrieve the ParserOutput from ParserCache. | |
| getDirty ($article, $popts) | |
| Retrieve the ParserOutput from ParserCache, even if it's outdated. | |
| getETag ($article, $popts) | |
| Provides an E-Tag suitable for the whole page. | |
| getKey ($article, $popts, $useOutdated=true) | |
| Generates a key for caching the given article considering the given parser options. | |
| save ($parserOutput, $page, $popts, $cacheTime=null, $revId=null) | |
Static Public Member Functions | |
| static | singleton () |
| Get an instance of this object. | |
Protected Member Functions | |
| __construct ($memCached) | |
| Setup a cache pathway with a given back-end storage mechanism. | |
| getOptionsKey ($article) | |
| getParserOutputKey ($article, $hash) | |
Private Attributes | |
| MWMemcached | $mMemc |
| * | |
Detailed Description
- Todo:
- document
Definition at line 28 of file ParserCache.php.
Constructor & Destructor Documentation
| ParserCache::__construct | ( | $ | memCached | ) | [protected] |
Setup a cache pathway with a given back-end storage mechanism.
May be a memcached client or a BagOStuff derivative.
- Parameters:
-
MWMemcached $memCached
- Exceptions:
-
MWException
Definition at line 51 of file ParserCache.php.
Member Function Documentation
| ParserCache::get | ( | $ | article, |
| $ | popts, | ||
| $ | useOutdated = false |
||
| ) |
Retrieve the ParserOutput from ParserCache.
false if not found or outdated.
- Parameters:
-
Article $article ParserOptions $popts bool $useOutdated (default false)
- Returns:
- ParserOutput|bool False on failure
Definition at line 184 of file ParserCache.php.
| ParserCache::getDirty | ( | $ | article, |
| $ | popts | ||
| ) |
Retrieve the ParserOutput from ParserCache, even if it's outdated.
- Parameters:
-
Article $article ParserOptions $popts
- Returns:
- ParserOutput|bool False on failure
Definition at line 109 of file ParserCache.php.
| ParserCache::getETag | ( | $ | article, |
| $ | popts | ||
| ) |
Provides an E-Tag suitable for the whole page.
Note that $article is just the main wikitext. The E-Tag has to be unique to the whole page, even if the article itself is the same, so it uses the complete set of user options. We don't want to use the preference of a different user on a message just because it wasn't used in $article. For example give a Chinese interface to a user with English preferences. That's why we take into account *all* user options. (r70809 CR)
- Parameters:
-
Article $article ParserOptions $popts
- Returns:
- string
Definition at line 97 of file ParserCache.php.
| ParserCache::getKey | ( | $ | article, |
| $ | popts, | ||
| $ | useOutdated = true |
||
| ) |
Generates a key for caching the given article considering the given parser options.
- Note:
- Which parser options influence the cache key is controlled via ParserOutput::recordOption() or ParserOptions::addExtraKey().
- Used by Article to provide a unique id for the PoolCounter. It would be preferable to have this code in get() instead of having Article looking in our internals.
- Todo:
- Document parameter $useOutdated
- Parameters:
-
Article $article ParserOptions $popts bool $useOutdated (default true)
- Returns:
- bool|mixed|string
Definition at line 133 of file ParserCache.php.
| ParserCache::getOptionsKey | ( | $ | article | ) | [protected] |
| ParserCache::getParserOutputKey | ( | $ | article, |
| $ | hash | ||
| ) | [protected] |
- Parameters:
-
Article $article string $hash
- Returns:
- mixed|string
Definition at line 63 of file ParserCache.php.
| ParserCache::save | ( | $ | parserOutput, |
| $ | page, | ||
| $ | popts, | ||
| $ | cacheTime = null, |
||
| $ | revId = null |
||
| ) |
- Parameters:
-
ParserOutput $parserOutput WikiPage $page ParserOptions $popts string $cacheTime Time when the cache was generated int $revId Revision ID that was parsed
Definition at line 246 of file ParserCache.php.
| static ParserCache::singleton | ( | ) | [static] |
Get an instance of this object.
- Returns:
- ParserCache
Definition at line 35 of file ParserCache.php.
Referenced by CompareParserCache\execute(), ApiPurge\execute(), and RefreshLinksJob\runForTitle().
Member Data Documentation
MWMemcached ParserCache::$mMemc [private] |
*
Definition at line 29 of file ParserCache.php.
The documentation for this class was generated from the following file:
- includes/parser/ParserCache.php
