MediaWiki\Storage\PageEditStash Class Reference

Manage the pre-emptive page parsing for edits to wiki pages. More...

Public Member Functions
	__construct (BagOStuff $cache, IConnectionProvider $dbProvider, LoggerInterface $logger, StatsdDataFactoryInterface $stats, UserEditTracker $userEditTracker, UserFactory $userFactory, WikiPageFactory $wikiPageFactory, HookContainer $hookContainer, $initiator)
	checkCache (PageIdentity $page, Content $content, UserIdentity $user)
	Check that a prepared edit is in cache and still up-to-date.
	fetchInputText ( $textHash)
	parseAndCache ( $pageUpdater, Content $content, UserIdentity $user, string $summary)
	stashInputText ( $text, $textHash)

Public Attributes
const	ERROR_BUSY = 'busy'
const	ERROR_CACHE = 'error_cache'
const	ERROR_NONE = 'stashed'
const	ERROR_PARSE = 'error_parse'
const	ERROR_UNCACHEABLE = 'uncacheable'
const	INITIATOR_JOB_OR_CLI = 2
const	INITIATOR_USER = 1
const	MAX_CACHE_TTL = 300
const	MAX_SIGNATURE_TTL = 60
const	PRESUME_FRESH_TTL_SEC = 30

Detailed Description

Manage the pre-emptive page parsing for edits to wiki pages.

This is written to by ApiStashEdit, and consumed by ApiEditPage and EditPage (via PageUpdaterFactory and DerivedPageDataUpdater).

See also mediawiki.action.edit/stash.js.

Since

1.34

Definition at line 54 of file PageEditStash.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Storage\PageEditStash::__construct	(	BagOStuff	$cache,
		IConnectionProvider	$dbProvider,
		LoggerInterface	$logger,
		StatsdDataFactoryInterface	$stats,
		UserEditTracker	$userEditTracker,
		UserFactory	$userFactory,
		WikiPageFactory	$wikiPageFactory,
		HookContainer	$hookContainer,
			$initiator
	)

Parameters

BagOStuff	$cache
IConnectionProvider	$dbProvider
LoggerInterface	$logger
StatsdDataFactoryInterface	$stats
UserEditTracker	$userEditTracker
UserFactory	$userFactory
WikiPageFactory	$wikiPageFactory
HookContainer	$hookContainer
int	$initiator	Class INITIATOR__* constant

Definition at line 100 of file PageEditStash.php.

Member Function Documentation

checkCache()

MediaWiki\Storage\PageEditStash::checkCache	(	PageIdentity	$page,
		Content	$content,
		UserIdentity	$user
	)

Check that a prepared edit is in cache and still up-to-date.

This method blocks if the prepared edit is already being rendered, waiting until rendering finishes before doing final validity checks.

The cache is rejected if template or file changes are detected. Note that foreign template or file transclusions are not checked.

This returns an object with the following fields:

• pstContent: the Content after pre-save-transform
• output: the ParserOutput instance
• timestamp: the timestamp of the parse
• edits: author edit count if they are logged in or NULL otherwise

Parameters

PageIdentity	$page
Content	$content
UserIdentity	$user	to get parser options from

Returns

stdClass|false Returns edit stash object or false on cache miss

Definition at line 247 of file PageEditStash.php.

References $content, MediaWiki\User\UserIdentity\getName(), MediaWiki\User\UserIdentity\isRegistered(), and wfTimestamp().

fetchInputText()

MediaWiki\Storage\PageEditStash::fetchInputText

(

$textHash

)

Parameters

string

$textHash

Returns

string|bool Text or false if missing

Definition at line 386 of file PageEditStash.php.

parseAndCache()

MediaWiki\Storage\PageEditStash::parseAndCache	(		$pageUpdater,
		Content	$content,
		UserIdentity	$user,
		string	$summary
	)

Parameters

PageUpdater	$pageUpdater	(a WikiPage instance is also supported but deprecated)
Content	$content	Edit content
UserIdentity	$user
string	$summary	Edit summary

Returns

string Class ERROR_* constant

Definition at line 129 of file PageEditStash.php.

References $content, EDIT_INTERNAL, MediaWiki\Storage\PageEditStash\ERROR_BUSY, MediaWiki\Storage\PageEditStash\ERROR_CACHE, MediaWiki\Storage\PageEditStash\ERROR_NONE, MediaWiki\Storage\PageEditStash\ERROR_PARSE, MediaWiki\Storage\PageEditStash\ERROR_UNCACHEABLE, MediaWiki\Storage\PageEditStash\PRESUME_FRESH_TTL_SEC, wfDeprecated(), and wfTimestamp().

stashInputText()

MediaWiki\Storage\PageEditStash::stashInputText	(		$text,
			$textHash
	)

Parameters

string	$text
string	$textHash

Returns

bool Success

Definition at line 397 of file PageEditStash.php.

Member Data Documentation

ERROR_BUSY

const MediaWiki\Storage\PageEditStash::ERROR_BUSY = 'busy'

Definition at line 78 of file PageEditStash.php.

Referenced by MediaWiki\Storage\PageEditStash\parseAndCache().

ERROR_CACHE

const MediaWiki\Storage\PageEditStash::ERROR_CACHE = 'error_cache'

Definition at line 76 of file PageEditStash.php.

Referenced by MediaWiki\Storage\PageEditStash\parseAndCache().

ERROR_NONE

const MediaWiki\Storage\PageEditStash::ERROR_NONE = 'stashed'

Definition at line 74 of file PageEditStash.php.

Referenced by MediaWiki\Storage\PageEditStash\parseAndCache().

ERROR_PARSE

const MediaWiki\Storage\PageEditStash::ERROR_PARSE = 'error_parse'

Definition at line 75 of file PageEditStash.php.

Referenced by MediaWiki\Storage\PageEditStash\parseAndCache().

ERROR_UNCACHEABLE

const MediaWiki\Storage\PageEditStash::ERROR_UNCACHEABLE = 'uncacheable'

Definition at line 77 of file PageEditStash.php.

Referenced by MediaWiki\Storage\PageEditStash\parseAndCache().

INITIATOR_JOB_OR_CLI

const MediaWiki\Storage\PageEditStash::INITIATOR_JOB_OR_CLI = 2

Definition at line 87 of file PageEditStash.php.

INITIATOR_USER

const MediaWiki\Storage\PageEditStash::INITIATOR_USER = 1

Definition at line 86 of file PageEditStash.php.

MAX_CACHE_TTL

const MediaWiki\Storage\PageEditStash::MAX_CACHE_TTL = 300

Definition at line 81 of file PageEditStash.php.

MAX_SIGNATURE_TTL

const MediaWiki\Storage\PageEditStash::MAX_SIGNATURE_TTL = 60

Definition at line 82 of file PageEditStash.php.

PRESUME_FRESH_TTL_SEC

const MediaWiki\Storage\PageEditStash::PRESUME_FRESH_TTL_SEC = 30

Definition at line 80 of file PageEditStash.php.

Referenced by MediaWiki\Storage\PageEditStash\parseAndCache().

---

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

• includes/Storage/PageEditStash.php