MediaWiki\PoolCounter\PoolWorkArticleView Class Reference

PoolCounter protected work wrapping RenderedRevision->getRevisionParserOutput. More...

Inherits MediaWiki\PoolCounter\PoolCounterWork.

Inherited by MediaWiki\PoolCounter\PoolWorkArticleViewCurrent, and MediaWiki\PoolCounter\PoolWorkArticleViewOld.

Collaboration diagram for MediaWiki\PoolCounter\PoolWorkArticleView:

Public Member Functions
	__construct (string $workKey, RevisionRecord $revision, ParserOptions $parserOptions, RevisionRenderer $revisionRenderer, LoggerSpi $loggerSpi)
	doWork ()
	error ( $status)
	renderRevision ()
	Render the given revision.
Public Member Functions inherited from MediaWiki\PoolCounter\PoolCounterWork
	__construct (string $type, string $key, PoolCounter $poolCounter=null)
	execute ( $skipcache=false)
	Get the result of the work (whatever it is), or the result of the error() function.
	fallback ( $fast)
	A work not so good (eg.
	getCachedWork ()
	Retrieve the work from cache.
	logError ( $status)
	Log an error.

Protected Attributes
LoggerSpi	$loggerSpi
ParserOptions	$parserOptions
RevisionRecord	$revision
Protected Attributes inherited from MediaWiki\PoolCounter\PoolCounterWork
bool	$cacheable = false
string	$type = 'generic'

Additional Inherited Members
Protected Member Functions inherited from MediaWiki\PoolCounter\PoolCounterWork
	isFastStaleEnabled ()
	Should fast stale mode be used?

Detailed Description

PoolCounter protected work wrapping RenderedRevision->getRevisionParserOutput.

Caching behavior may be defined by subclasses.

Note

No audience checks are applied.

Access: internal

Definition at line 38 of file PoolWorkArticleView.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\PoolCounter\PoolWorkArticleView::__construct	(	string	$workKey,
		RevisionRecord	$revision,
		ParserOptions	$parserOptions,
		RevisionRenderer	$revisionRenderer,
		LoggerSpi	$loggerSpi )

Parameters

string	$workKey
RevisionRecord	$revision	Revision to render
ParserOptions	$parserOptions	ParserOptions to use for the parse
RevisionRenderer	$revisionRenderer
LoggerSpi	$loggerSpi

Definition at line 55 of file PoolWorkArticleView.php.

References MediaWiki\PoolCounter\PoolWorkArticleView\$loggerSpi, MediaWiki\PoolCounter\PoolWorkArticleView\$parserOptions, and MediaWiki\PoolCounter\PoolWorkArticleView\$revision.

Member Function Documentation

doWork()

MediaWiki\PoolCounter\PoolWorkArticleView::doWork

(

)

Returns

Status

Reimplemented from MediaWiki\PoolCounter\PoolCounterWork.

Reimplemented in MediaWiki\PoolCounter\PoolWorkArticleViewCurrent, and MediaWiki\PoolCounter\PoolWorkArticleViewOld.

Definition at line 72 of file PoolWorkArticleView.php.

References MediaWiki\PoolCounter\PoolWorkArticleView\renderRevision().

error()

MediaWiki\PoolCounter\PoolWorkArticleView::error

(

$status

)

Parameters

Status

$status

Returns

Status

Reimplemented from MediaWiki\PoolCounter\PoolCounterWork.

Definition at line 100 of file PoolWorkArticleView.php.

renderRevision()

MediaWiki\PoolCounter\PoolWorkArticleView::renderRevision

(

)

Render the given revision.

See also

ParserOutputAccess::renderRevision

Returns

Status with the value being a ParserOutput or null

Definition at line 83 of file PoolWorkArticleView.php.

Referenced by MediaWiki\PoolCounter\PoolWorkArticleView\doWork(), MediaWiki\PoolCounter\PoolWorkArticleViewCurrent\doWork(), and MediaWiki\PoolCounter\PoolWorkArticleViewOld\doWork().

Member Data Documentation

$loggerSpi

LoggerSpi MediaWiki\PoolCounter\PoolWorkArticleView::$loggerSpi

protected

Definition at line 46 of file PoolWorkArticleView.php.

Referenced by MediaWiki\PoolCounter\PoolWorkArticleViewCurrent\__construct(), MediaWiki\PoolCounter\PoolWorkArticleViewOld\__construct(), and MediaWiki\PoolCounter\PoolWorkArticleView\__construct().

$parserOptions

ParserOptions MediaWiki\PoolCounter\PoolWorkArticleView::$parserOptions

protected

Definition at line 40 of file PoolWorkArticleView.php.

Referenced by MediaWiki\PoolCounter\PoolWorkArticleViewCurrent\__construct(), MediaWiki\PoolCounter\PoolWorkArticleViewOld\__construct(), and MediaWiki\PoolCounter\PoolWorkArticleView\__construct().

$revision

RevisionRecord MediaWiki\PoolCounter\PoolWorkArticleView::$revision

protected

Definition at line 42 of file PoolWorkArticleView.php.

Referenced by MediaWiki\PoolCounter\PoolWorkArticleViewCurrent\__construct(), MediaWiki\PoolCounter\PoolWorkArticleViewOld\__construct(), and MediaWiki\PoolCounter\PoolWorkArticleView\__construct().

---

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

• includes/poolcounter/PoolWorkArticleView.php