PoolWorkArticleView Class Reference

Inheritance diagram for PoolWorkArticleView:

Collaboration diagram for PoolWorkArticleView:

Public Member Functions
	__construct (WikiPage $page, ParserOptions $parserOptions, $revid, $useParserCache, $content=null)
	doWork ()
	error ($status)
	fallback ()
	getCachedWork ()
	getError ()
	Get a Status object in case of error or false otherwise. More...
	getIsDirty ()
	Get whether the ParserOutput is a dirty one (i.e. More...
	getParserOutput ()
	Get the ParserOutput from this object, or false in case of failure. More...
Public Member Functions inherited from PoolCounterWork
	__construct ($type, $key)
	doWork ()
	Actually perform the work, caching it if needed. More...
	error ($status)
	Do something with the error, like showing it to the user. More...
	execute ($skipcache=false)
	Get the result of the work (whatever it is), or the result of the error() function. More...
	fallback ()
	A work not so good (eg. More...
	getCachedWork ()
	Retrieve the work from cache. More...
	logError ($status)
	Log an error. More...

Private Attributes
string	$cacheKey
Content null	$content = null
Status bool	$error = false
bool	$isDirty = false
WikiPage	$page
ParserOptions	$parserOptions
ParserOutput bool	$parserOutput = false
int	$revid

Additional Inherited Members
Protected Attributes inherited from PoolCounterWork
bool	$cacheable = false
string	$type = 'generic'

Detailed Description

Definition at line 21 of file PoolWorkArticleView.php.

Constructor & Destructor Documentation

PoolWorkArticleView::__construct	(	WikiPage	$page,
		ParserOptions	$parserOptions,
			$revid,
			$useParserCache,
			$content = null
	)

Parameters

WikiPage	$page
ParserOptions	$parserOptions	ParserOptions to use for the parse
int	$revid	ID of the revision being parsed.
bool	$useParserCache	Whether to use the parser cache. operation.
Content | string	$content	Content to parse or null to load it; may also be given as a wikitext string, for BC.

Definition at line 55 of file PoolWorkArticleView.php.

References $content, $page, $parserOptions, $revid, content, WikiPage\getRevision(), WikiPage\getTitle(), page, ParserCache\singleton(), and wfMemcKey().

Member Function Documentation

PoolWorkArticleView::doWork

(

)

Returns

bool

Definition at line 104 of file PoolWorkArticleView.php.

References $content, $parserOptions, $rev, $revid, $time, $wgUseFileCache, content, MediaWiki\Logger\LoggerFactory\getInstance(), Content\getParserOutput(), global, Revision\newFromTitle(), page, Revision\RAW, ParserCache\singleton(), and wfTimestampNow().

PoolWorkArticleView::error

(

$status

)

Parameters

Status

$status

Returns

bool

Definition at line 210 of file PoolWorkArticleView.php.

References $status.

PoolWorkArticleView::fallback

(

)

Returns

bool

Definition at line 191 of file PoolWorkArticleView.php.

References page, ParserCache\singleton(), wfDebug(), and wfDebugLog().

PoolWorkArticleView::getCachedWork

(

)

Returns

bool

Definition at line 176 of file PoolWorkArticleView.php.

References page, ParserCache\singleton(), and wfDebug().

PoolWorkArticleView::getError

(

)

Get a Status object in case of error or false otherwise.

Returns

Status|bool

Definition at line 97 of file PoolWorkArticleView.php.

References $error.

PoolWorkArticleView::getIsDirty

(

)

Get whether the ParserOutput is a dirty one (i.e.

expired)

Returns

bool

Definition at line 88 of file PoolWorkArticleView.php.

References $isDirty.

PoolWorkArticleView::getParserOutput

(

)

Get the ParserOutput from this object, or false in case of failure.

Returns

ParserOutput

Definition at line 79 of file PoolWorkArticleView.php.

References $parserOutput.

Member Data Documentation

string PoolWorkArticleView::$cacheKey

private

Definition at line 26 of file PoolWorkArticleView.php.

Content null PoolWorkArticleView::$content = null

private

Definition at line 35 of file PoolWorkArticleView.php.

Referenced by __construct(), and doWork().

Status bool PoolWorkArticleView::$error = false

private

Definition at line 44 of file PoolWorkArticleView.php.

Referenced by getError().

bool PoolWorkArticleView::$isDirty = false

private

Definition at line 41 of file PoolWorkArticleView.php.

Referenced by getIsDirty().

WikiPage PoolWorkArticleView::$page

private

Definition at line 23 of file PoolWorkArticleView.php.

Referenced by __construct().

ParserOptions PoolWorkArticleView::$parserOptions

private

Definition at line 32 of file PoolWorkArticleView.php.

Referenced by __construct(), and doWork().

ParserOutput bool PoolWorkArticleView::$parserOutput = false

private

Definition at line 38 of file PoolWorkArticleView.php.

Referenced by getParserOutput().

int PoolWorkArticleView::$revid

private

Definition at line 29 of file PoolWorkArticleView.php.

Referenced by __construct(), and doWork().

---

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

• includes/poolcounter/PoolWorkArticleView.php