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

Collaboration diagram for Page\ParserOutputAccess:

[legend]

Public Member Functions
	__construct (ParserCache $primaryCache, RevisionOutputCache $secondaryCache, RevisionLookup $revisionLookup, RevisionRenderer $revisionRenderer, IBufferingStatsdDataFactory $statsDataFactory, ILBFactory $lbFactory, 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. More...

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

Private Member Functions
	checkPreconditions (PageRecord $page, ?RevisionRecord $revision=null, int $options=0)

	newPoolWorkArticleView (PageRecord $page, ParserOptions $parserOptions, RevisionRecord $revision, int $options)

	shouldUseCache (PageRecord $page, ParserOptions $parserOptions, ?RevisionRecord $rev)
	Use a cache? More...

Private Attributes
ILBFactory	$lbFactory

LoggerSpi	$loggerSpi

ParserCache	$primaryCache

RevisionLookup	$revisionLookup

RevisionRenderer	$revisionRenderer

RevisionOutputCache	$secondaryCache

IBufferingStatsdDataFactory	$statsDataFactory

TitleFormatter	$titleFormatter

WikiPageFactory	$wikiPageFactory

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.

Stability: unstable: Extensions should use WikiPage::getParserOutput until this class has settled down.

Definition at line 50 of file ParserOutputAccess.php.

Constructor & Destructor Documentation

Page\ParserOutputAccess::__construct	(	ParserCache	$primaryCache,
		RevisionOutputCache	$secondaryCache,
		RevisionLookup	$revisionLookup,
		RevisionRenderer	$revisionRenderer,
		IBufferingStatsdDataFactory	$statsDataFactory,
		ILBFactory	$lbFactory,
		LoggerSpi	$loggerSpi,
		WikiPageFactory	$wikiPageFactory,
		TitleFormatter	$titleFormatter
	)

Parameters

ParserCache	$primaryCache
RevisionOutputCache	$secondaryCache
RevisionLookup	$revisionLookup
RevisionRenderer	$revisionRenderer
IBufferingStatsdDataFactory	$statsDataFactory
ILBFactory	$lbFactory
LoggerSpi	$loggerSpi
WikiPageFactory	$wikiPageFactory
TitleFormatter	$titleFormatter

Definition at line 128 of file ParserOutputAccess.php.

Page\ParserOutputAccess::checkPreconditions	(	PageRecord	$page,
		?RevisionRecord	$revision = `null`,
		int	$options = `0`
	)

private

Parameters

Definition at line 325 of file ParserOutputAccess.php.

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 201 of file ParserOutputAccess.php.

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 is 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