Service for getting rendered output of a given page. More...

Public Member Functions
	__construct (ParserCacheFactory $parserCacheFactory, RevisionLookup $revisionLookup, RevisionRenderer $revisionRenderer, IBufferingStatsdDataFactory $statsDataFactory, ILBFactory $lbFactory, ChronologyProtector $chronologyProtector, LoggerSpi $loggerSpi, WikiPageFactory $wikiPageFactory, TitleFormatter $titleFormatter)

	getCachedParserOutput (PageRecord $page, ParserOptions $parserOptions, ?RevisionRecord $revision=null, int $options=0)
	Returns the rendered output for the given page if it is present in the cache.

	getParserOutput (PageRecord $page, ParserOptions $parserOptions, ?RevisionRecord $revision=null, int $options=0)
	Returns the rendered output for the given page.

Detailed Description

Service for getting rendered output of a given page.

This is a high level service, encapsulating concerns like caching and stampede protection via PoolCounter.

Definition at line 53 of file ParserOutputAccess.php.

Constructor & Destructor Documentation

MediaWiki\Page\ParserOutputAccess::__construct	(	ParserCacheFactory	$parserCacheFactory,
		RevisionLookup	$revisionLookup,
		RevisionRenderer	$revisionRenderer,
		IBufferingStatsdDataFactory	$statsDataFactory,
		ILBFactory	$lbFactory,
		ChronologyProtector	$chronologyProtector,
		LoggerSpi	$loggerSpi,
		WikiPageFactory	$wikiPageFactory,
		TitleFormatter	$titleFormatter
	)

Parameters

ParserCacheFactory	$parserCacheFactory
RevisionLookup	$revisionLookup
RevisionRenderer	$revisionRenderer
IBufferingStatsdDataFactory	$statsDataFactory
ILBFactory	$lbFactory
ChronologyProtector	$chronologyProtector
LoggerSpi	$loggerSpi
WikiPageFactory	$wikiPageFactory
TitleFormatter	$titleFormatter

Definition at line 138 of file ParserOutputAccess.php.

MediaWiki\Page\ParserOutputAccess::getCachedParserOutput	(	PageRecord	$page,
		ParserOptions	$parserOptions,
		?RevisionRecord	$revision = `null`,
		int	$options = `0`
	)

Returns the rendered output for the given page if it is present in the cache.

Parameters

PageRecord	$page
ParserOptions	$parserOptions
RevisionRecord \| null	$revision
int	$options	Bitfield using the OPT_XXX constants

Definition at line 211 of file ParserOutputAccess.php.

MediaWiki\Page\ParserOutputAccess::getParserOutput	(	PageRecord	$page,
		ParserOptions	$parserOptions,
		?RevisionRecord	$revision = `null`,
		int	$options = `0`
	)

Returns the rendered output for the given page.

Caching and concurrency control is applied.

Parameters

PageRecord	$page
ParserOptions	$parserOptions
RevisionRecord \| null	$revision
int	$options	Bitfield using the OPT_XXX constants

Returns

Status containing a ParserOutput if no error occurred. Well known errors and warnings include the following messages:

'view-pool-dirty-output' (warning) The output is dirty (from a stale cache entry).
'view-pool-contention' (warning) Dirty output was returned immediately instead of waiting to acquire a work lock (when "fast stale" mode is enabled in PoolCounter).
'view-pool-timeout' (warning) Dirty output was returned after failing to acquire a work lock (got QUEUE_FULL or TIMEOUT from PoolCounter).
'pool-queuefull' (error) unable to acquire work lock, and no cached content found.
'pool-timeout' (error) unable to acquire work lock, and no cached content found.
'pool-servererror' (error) PoolCounterWork failed due to a lock service error.
'pool-unknownerror' (error) PoolCounterWork failed for an unknown reason.
'nopagetext' (error) The page does not exist

Definition at line 269 of file ParserOutputAccess.php.

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