A handle for managing updates for derived page data on edit, import, purge, etc. More...

Inheritance diagram for MediaWiki\Storage\DerivedPageDataUpdater:

Collaboration diagram for MediaWiki\Storage\DerivedPageDataUpdater:

[legend]

Public Member Functions
	__construct (WikiPage $wikiPage, RevisionStore $revisionStore, RevisionRenderer $revisionRenderer, SlotRoleRegistry $slotRoleRegistry, ParserCache $parserCache, JobQueueGroup $jobQueueGroup, MessageCache $messageCache, Language $contLang, LBFactory $loadbalancerFactory)

	doParserCacheUpdate ()

	doSecondaryDataUpdates (array $options=[])
	Do secondary data updates (such as updating link tables).

	doUpdates ()
	Do standard updates after page edit, purge, or import.

	getCanonicalParserOptions ()

	getCanonicalParserOutput ()

	getModifiedSlotRoles ()
	Returns the role names of the slots modified by the new revision, not including removed roles.

	getPreparedEdit ()

	getRawContent ( $role)
	Returns the content of the given slot, with no audience checks.

	getRawSlot ( $role)
	Returns the slot, modified or inherited, after PST, with no audience checks applied.

	getRemovedSlotRoles ()
	Returns the role names of the slots removed by the new revision.

	getRenderedRevision ()

	getRevision ()
	Returns the update's target revision - that is, the revision that will be the current revision after the update.

	getSecondaryDataUpdates ( $recursive=false)

	getSlotParserOutput ( $role, $generateHtml=true)

	getSlots ()
	Returns the slots of the target revision, after PST.

	getTouchedSlotRoles ()
	Returns the role names of the slots touched by the new revision, including removed roles.

	grabCurrentRevision ()
	Returns the revision that was the page's current revision when grabCurrentRevision() was first called.

	isChange ()
	Whether the edit created, or should create, a new revision (that is, it's not a null-edit).

	isContentDeleted ()
	Whether the content is deleted and thus not visible to the public.

	isContentPrepared ()
	Whether prepareUpdate() or prepareContent() have been called on this instance.

	isCountable ()

	isCreation ()
	Whether the edit creates the page.

	isRedirect ()

	isReusableFor (UserIdentity $user=null, RevisionRecord $revision=null, RevisionSlotsUpdate $slotsUpdate=null, $parentId=null)
	Checks whether this DerivedPageDataUpdater can be re-used for running updates targeting the given revision.

	isUpdatePrepared ()
	Whether prepareUpdate() has been called on this instance.

	pageExisted ()
	Determines whether the page being edited already existed.

	prepareContent (User $user, RevisionSlotsUpdate $slotsUpdate, $useStash=true)
	Prepare updates based on an update which has not yet been saved.

	prepareUpdate (RevisionRecord $revision, array $options=[])
	Prepare derived data updates targeting the given Revision.

	setArticleCountMethod ( $articleCountMethod)

	setRcWatchCategoryMembership ( $rcWatchCategoryMembership)

	wasRedirect ()
	Whether the page was a redirect before the edit.

Private Member Functions
	assertHasPageState ( $method)

	assertHasRevision ( $method)

	assertPrepared ( $method)

	assertTransition ( $newStage)
	Asserts that a transition to the given stage is possible, without performing it.

	doTransition ( $newStage)
	Transition function for managing the life cycle of this instances.

	getContentHandler ( $role)

	getContentModel ( $role)
	Returns the content model of the given slot.

	getPageId ()

	getParentRevision ()
	Returns the parent revision of the new revision wrapped by this update.

	getRevisionSlotsUpdate ()
	Returns the RevisionSlotsUpdate for this updater.

	getTitle ()

	getWikiId ()

	getWikiPage ()

	revisionIsRedirect (RevisionRecord $rev)

	useMaster ()

Private Attributes
string	$articleCountMethod
	see $wgArticleCountMethod

Language	$contLang

JobQueueGroup	$jobQueueGroup

LBFactory	$loadbalancerFactory

MessageCache	$messageCache

	$options
	Stores (most of) the $options parameter of prepareUpdate().

array	$pageState = null
	The state of the relevant row in page table before the edit.

RevisionRecord null	$parentRevision = null

ParserCache	$parserCache

boolean	$rcWatchCategoryMembership = false
	see $wgRCWatchCategoryMembership

RenderedRevision	$renderedRevision = null

RevisionRecord null	$revision = null

RevisionRenderer	$revisionRenderer

RevisionStore	$revisionStore

SlotRoleRegistry	$slotRoleRegistry

RevisionSlotsUpdate null	$slotsUpdate = null

string	$stage = 'new'
	A stage identifier for managing the life cycle of this instance.

UserIdentity null	$user = null

WikiPage	$wikiPage

Static Private Attributes
static array[]	$transitions
	Transition table for managing the life cycle of DerivedPageDateUpdater instances.

Additional Inherited Members
Public Attributes inherited from IDBAccessObject
const	READ_LOCKING = self::READ_LATEST \| 2
	Constants for object loading bitfield flags (higher => higher QoS)

const	READ_NONE = -1

Detailed Description

A handle for managing updates for derived page data on edit, import, purge, etc.

Note: Avoid direct usage of DerivedPageDataUpdater.

Todo: Define interfaces for the different use cases of DerivedPageDataUpdater, particularly providing access to post-PST content and ParserOutput to callbacks during revision creation, which currently use WikiPage::prepareContentForEdit, and allowing updates to be triggered on purge, import, and undeletion, which currently use WikiPage::doEditUpdates() and Content::getSecondaryDataUpdates().

DerivedPageDataUpdater instances are designed to be cached inside a WikiPage instance, and re-used by callback code over the course of an update operation. It's a stepping stone one the way to a more complete refactoring of WikiPage.

When using a DerivedPageDataUpdater, the following life cycle must be observed: grabCurrentRevision (optional), prepareContent (optional), prepareUpdate (required for doUpdates). getCanonicalParserOutput, getSlots, and getSecondaryDataUpdates require prepareContent or prepareUpdate to have been called first, to initialize the DerivedPageDataUpdater.

See also: docs/pageupdater.txt for more information.

MCR migration note: this replaces the relevant methods in WikiPage, and covers the use cases of PreparedEdit.

Definition at line 96 of file DerivedPageDataUpdater.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Storage\DerivedPageDataUpdater::__construct	(	WikiPage	$wikiPage,
		RevisionStore	$revisionStore,
		RevisionRenderer	$revisionRenderer,
		SlotRoleRegistry	$slotRoleRegistry,
		ParserCache	$parserCache,
		JobQueueGroup	$jobQueueGroup,
		MessageCache	$messageCache,
		Language	$contLang,
		LBFactory	$loadbalancerFactory )

Parameters

WikiPage $wikiPage

param RevisionStore $revisionStore

Parameters

RevisionRenderer	$revisionRenderer
SlotRoleRegistry	$slotRoleRegistry
ParserCache	$parserCache
JobQueueGroup	$jobQueueGroup
MessageCache	$messageCache
Language	$contLang
LBFactory	$loadbalancerFactory

Definition at line 272 of file DerivedPageDataUpdater.php.

Member Function Documentation

◆ assertHasPageState()

MediaWiki\Storage\DerivedPageDataUpdater::assertHasPageState ( $method )

private

Definition at line 898 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\pageExisted(), and MediaWiki\Storage\DerivedPageDataUpdater\wasRedirect().

◆ assertHasRevision()

MediaWiki\Storage\DerivedPageDataUpdater::assertHasRevision ( $method )

private

Definition at line 915 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doParserCacheUpdate(), and MediaWiki\Storage\DerivedPageDataUpdater\doSecondaryDataUpdates().

◆ assertPrepared()

MediaWiki\Storage\DerivedPageDataUpdater::assertPrepared ( $method )

private

Definition at line 907 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\getParentRevision(), MediaWiki\Storage\DerivedPageDataUpdater\getPreparedEdit(), MediaWiki\Storage\DerivedPageDataUpdater\getRenderedRevision(), MediaWiki\Storage\DerivedPageDataUpdater\getRevision(), MediaWiki\Storage\DerivedPageDataUpdater\getRevisionSlotsUpdate(), MediaWiki\Storage\DerivedPageDataUpdater\getSlots(), MediaWiki\Storage\DerivedPageDataUpdater\isChange(), and MediaWiki\Storage\DerivedPageDataUpdater\isCreation().

◆ assertTransition()

MediaWiki\Storage\DerivedPageDataUpdater::assertTransition ( $newStage )

private

Asserts that a transition to the given stage is possible, without performing it.

See also: docs/pageupdater.txt for documentation of the life cycle.

Parameters

string $newStage the new stage

Exceptions

LogicException If this instance is not in the expected stage

Definition at line 326 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doTransition(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\grabCurrentRevision(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareContent().

◆ doParserCacheUpdate()

MediaWiki\Storage\DerivedPageDataUpdater::doParserCacheUpdate ( )

Definition at line 1606 of file DerivedPageDataUpdater.php.

References $output, MediaWiki\Storage\DerivedPageDataUpdater\$wikiPage, MediaWiki\Storage\DerivedPageDataUpdater\assertHasRevision(), MediaWiki\Storage\DerivedPageDataUpdater\getCanonicalParserOptions(), MediaWiki\Storage\DerivedPageDataUpdater\getCanonicalParserOutput(), WikiPage\getId(), MediaWiki\Storage\DerivedPageDataUpdater\getWikiPage(), and options().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates().

◆ doSecondaryDataUpdates()

MediaWiki\Storage\DerivedPageDataUpdater::doSecondaryDataUpdates ( array $options = [] )

Do secondary data updates (such as updating link tables).

MCR note: this method is temporarily exposed via WikiPage::doSecondaryDataUpdates.

Parameters

array

$options

recursive: make the update recursive, i.e. also update pages which transclude the current page or otherwise depend on it (default: false)
defer: one of the DeferredUpdates constants, or false to run immediately after waiting for replication of the changes from the SecondaryDataUpdates hooks (default: false)
transactionTicket: a transaction ticket from LBFactory::getEmptyTransactionTicket(), only when defer is false (default: null)

Since: 1.32

Definition at line 1553 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\$options, MediaWiki\Storage\DerivedPageDataUpdater\$user, and(), MediaWiki\Storage\DerivedPageDataUpdater\assertHasRevision(), MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates(), User\newFromIdentity(), and options().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates().

◆ doTransition()

MediaWiki\Storage\DerivedPageDataUpdater::doTransition ( $newStage )

private

Transition function for managing the life cycle of this instances.

See also: docs/pageupdater.txt for documentation of the life cycle.

Parameters

string $newStage the new stage

Returns: string the previous stage

Exceptions

LogicException If a transition to the given stage is not possible in the current stage.

Definition at line 308 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\$stage, and(), and MediaWiki\Storage\DerivedPageDataUpdater\assertTransition().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\grabCurrentRevision(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareUpdate().

◆ doUpdates()

MediaWiki\Storage\DerivedPageDataUpdater::doUpdates ( )

Do standard updates after page edit, purge, or import.

Update links tables, site stats, search index, title cache, message cache, etc. Purges pages that depend on this page when appropriate. With a 10% chance, triggers pruning the recent changes table.

Note: prepareUpdate() must be called before calling this method!

MCR migration note: this replaces WikiPage::doEditUpdates.

Definition at line 1398 of file DerivedPageDataUpdater.php.

◆ getCanonicalParserOptions()

MediaWiki\Storage\DerivedPageDataUpdater::getCanonicalParserOptions ( )

Returns: ParserOptions

Definition at line 1282 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\getRenderedRevision().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doParserCacheUpdate(), and MediaWiki\Storage\DerivedPageDataUpdater\getPreparedEdit().

◆ getCanonicalParserOutput()

MediaWiki\Storage\DerivedPageDataUpdater::getCanonicalParserOutput ( )

Returns: ParserOutput

Definition at line 1275 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\getRenderedRevision().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doParserCacheUpdate(), MediaWiki\Storage\DerivedPageDataUpdater\getPreparedEdit(), MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates(), and MediaWiki\Storage\DerivedPageDataUpdater\isCountable().

◆ getContentHandler()

MediaWiki\Storage\DerivedPageDataUpdater::getContentHandler ( $role )

private

Parameters

string $role slot role name

Returns: ContentHandler

Definition at line 616 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\getContentModel().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates().

◆ getContentModel()

MediaWiki\Storage\DerivedPageDataUpdater::getContentModel ( $role )

private

Returns the content model of the given slot.

Parameters

string $role slot role name

Returns: string

Definition at line 608 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\getRawSlot().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\getContentHandler().

◆ getModifiedSlotRoles()

MediaWiki\Storage\DerivedPageDataUpdater::getModifiedSlotRoles ( )

Returns the role names of the slots modified by the new revision, not including removed roles.

Returns: string[]

Definition at line 1015 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\getRevisionSlotsUpdate().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\isCountable().

◆ getPageId()

MediaWiki\Storage\DerivedPageDataUpdater::getPageId ( )

private

Returns: int

Definition at line 557 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates().

◆ getParentRevision()

MediaWiki\Storage\DerivedPageDataUpdater::getParentRevision ( )

private

Returns the parent revision of the new revision wrapped by this update.

If the update is a null-edit, this will return the parent of the current (and new) revision. This will return null if the revision wrapped by this update created the page. Only defined after calling prepareContent() or prepareUpdate()!

Returns: RevisionRecord|null the parent revision of the new revision, or null if the update created the page.

Definition at line 464 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\$parentRevision, MediaWiki\Storage\DerivedPageDataUpdater\assertPrepared(), MediaWiki\Revision\RevisionRecord\getParentId(), and MediaWiki\Storage\DerivedPageDataUpdater\useMaster().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\getRevisionSlotsUpdate(), and MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates().

◆ getPreparedEdit()

MediaWiki\Storage\DerivedPageDataUpdater::getPreparedEdit ( )

Deprecated: This only exists for B/C, use the getters on DerivedPageDataUpdater directly!

Returns: PreparedEdit

Definition at line 1239 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\$slotsUpdate, and(), MediaWiki\Storage\DerivedPageDataUpdater\assertPrepared(), MediaWiki\Storage\DerivedPageDataUpdater\getCanonicalParserOptions(), MediaWiki\Storage\DerivedPageDataUpdater\getCanonicalParserOutput(), MediaWiki\Storage\RevisionSlotsUpdate\getModifiedSlot(), MediaWiki\Storage\DerivedPageDataUpdater\getRevisionSlotsUpdate(), and MediaWiki\Storage\RevisionSlotsUpdate\isModifiedSlot().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates().

◆ getRawContent()

MediaWiki\Storage\DerivedPageDataUpdater::getRawContent ( $role )

Returns the content of the given slot, with no audience checks.

Exceptions

PageUpdateException If the slot is neither set for update nor inherited from the parent revision.

Parameters

string $role slot role name

Returns: Content

Definition at line 598 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\getRawSlot().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\isCountable(), and MediaWiki\Storage\DerivedPageDataUpdater\isRedirect().

◆ getRawSlot()

MediaWiki\Storage\DerivedPageDataUpdater::getRawSlot ( $role )

Returns the slot, modified or inherited, after PST, with no audience checks applied.

Parameters

string $role slot role name

Exceptions

PageUpdateException If the slot is neither set for update nor inherited from the parent revision.

Returns: SlotRecord

Definition at line 586 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\getSlots().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\getContentModel(), MediaWiki\Storage\DerivedPageDataUpdater\getRawContent(), and MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates().

◆ getRemovedSlotRoles()

MediaWiki\Storage\DerivedPageDataUpdater::getRemovedSlotRoles ( )

Returns the role names of the slots removed by the new revision.

Returns: string[]

Definition at line 1024 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\getRevisionSlotsUpdate().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates().

◆ getRenderedRevision()

MediaWiki\Storage\DerivedPageDataUpdater::getRenderedRevision ( )

Returns: RenderedRevision

Definition at line 892 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\$renderedRevision, and MediaWiki\Storage\DerivedPageDataUpdater\assertPrepared().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\getCanonicalParserOptions(), MediaWiki\Storage\DerivedPageDataUpdater\getCanonicalParserOutput(), MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates(), and MediaWiki\Storage\DerivedPageDataUpdater\getSlotParserOutput().

◆ getRevision()

MediaWiki\Storage\DerivedPageDataUpdater::getRevision ( )

Returns the update's target revision - that is, the revision that will be the current revision after the update.

Note: Callers must treat the returned RevisionRecord's content as immutable, even if it is a MutableRevisionRecord instance. Other aspects of a MutableRevisionRecord returned from here, such as the user or the comment, may be changed, but may not be reflected in ParserOutput until after prepareUpdate() has been called.

Todo: This is currently used by PageUpdater::makeNewRevision() to construct an unsaved MutableRevisionRecord instance. Introduce something like an UnsavedRevisionFactory service for that purpose instead!

Returns: RevisionRecord

Definition at line 884 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\$revision, and MediaWiki\Storage\DerivedPageDataUpdater\assertPrepared().

◆ getRevisionSlotsUpdate()

MediaWiki\Storage\DerivedPageDataUpdater::getRevisionSlotsUpdate ( )

private

Returns the RevisionSlotsUpdate for this updater.

Returns: RevisionSlotsUpdate

Definition at line 986 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\$slotsUpdate, MediaWiki\Storage\DerivedPageDataUpdater\assertPrepared(), MediaWiki\Storage\DerivedPageDataUpdater\getParentRevision(), MediaWiki\Storage\RevisionSlotsUpdate\newFromRevisionSlots(), and null.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\getModifiedSlotRoles(), MediaWiki\Storage\DerivedPageDataUpdater\getPreparedEdit(), MediaWiki\Storage\DerivedPageDataUpdater\getRemovedSlotRoles(), and MediaWiki\Storage\DerivedPageDataUpdater\getTouchedSlotRoles().

◆ getSecondaryDataUpdates()

MediaWiki\Storage\DerivedPageDataUpdater::getSecondaryDataUpdates ( $recursive = false )

Parameters

bool $recursive

Returns: DeferrableUpdate[]

Definition at line 1291 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doSecondaryDataUpdates().

◆ getSlotParserOutput()

MediaWiki\Storage\DerivedPageDataUpdater::getSlotParserOutput	(		$role,
			$generateHtml = true )

Parameters

string	$role
bool	$generateHtml

Returns: ParserOutput

Definition at line 1265 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\getRenderedRevision().

◆ getSlots()

MediaWiki\Storage\DerivedPageDataUpdater::getSlots ( )

Returns the slots of the target revision, after PST.

Note: Callers must treat the returned RevisionSlots instance as immutable, even if it is a MutableRevisionSlots instance.

Returns: RevisionSlots

Definition at line 976 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\assertPrepared().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\getRawSlot(), and MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates().

◆ getTitle()

MediaWiki\Storage\DerivedPageDataUpdater::getTitle ( )

private

Returns: Title

Definition at line 429 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\isCountable(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareContent().

◆ getTouchedSlotRoles()

MediaWiki\Storage\DerivedPageDataUpdater::getTouchedSlotRoles ( )

Returns the role names of the slots touched by the new revision, including removed roles.

Returns: string[]

Definition at line 1005 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\getRevisionSlotsUpdate().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates().

◆ getWikiId()

MediaWiki\Storage\DerivedPageDataUpdater::getWikiId ( )

private

Returns: bool|string

Definition at line 335 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates().

◆ getWikiPage()

MediaWiki\Storage\DerivedPageDataUpdater::getWikiPage ( )

private

Returns: WikiPage

Definition at line 437 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\$wikiPage.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doParserCacheUpdate(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\grabCurrentRevision(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareContent().

◆ grabCurrentRevision()

MediaWiki\Storage\DerivedPageDataUpdater::grabCurrentRevision ( )

Returns the revision that was the page's current revision when grabCurrentRevision() was first called.

During an edit, that revision will act as the logical parent of the new revision.

Some updates are performed based on the difference between the database state at the moment this method is first called, and the state after the edit.

See also: docs/pageupdater.txt for more information on when thie method can and should be called.

Note: After prepareUpdate() was called, grabCurrentRevision() will throw an exception to avoid confusion, since the page's current revision is then the new revision after the edit, which was presumably passed to prepareUpdate() as the $revision parameter. Use getParentRevision() instead to access the revision that is the parent of the new revision.

Returns: RevisionRecord|null the page's current revision, or null if the page does not yet exist.

Definition at line 506 of file DerivedPageDataUpdater.php.

References $rev, MediaWiki\Storage\DerivedPageDataUpdater\$wikiPage, MediaWiki\Storage\DerivedPageDataUpdater\assertTransition(), MediaWiki\Storage\DerivedPageDataUpdater\doTransition(), WikiPage\getRevision(), MediaWiki\Storage\DerivedPageDataUpdater\getWikiPage(), WikiPage\isCountable(), WikiPage\isRedirect(), and WikiPage\loadPageData().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\prepareContent().

◆ isChange()

MediaWiki\Storage\DerivedPageDataUpdater::isChange ( )

Whether the edit created, or should create, a new revision (that is, it's not a null-edit).

Warning: at present, "null-revisions" that do not change content but do have a revision record would return false after prepareContent(), but true after prepareUpdate()! This should probably be fixed.

Returns: bool

Definition at line 942 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\assertPrepared(), and options().

◆ isContentDeleted()

MediaWiki\Storage\DerivedPageDataUpdater::isContentDeleted ( )

Whether the content is deleted and thus not visible to the public.

Returns: bool

Definition at line 567 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates(), and MediaWiki\Storage\DerivedPageDataUpdater\isCountable().

◆ isContentPrepared()

MediaWiki\Storage\DerivedPageDataUpdater::isContentPrepared ( )

Whether prepareUpdate() or prepareContent() have been called on this instance.

Returns: bool

Definition at line 539 of file DerivedPageDataUpdater.php.

◆ isCountable()

MediaWiki\Storage\DerivedPageDataUpdater::isCountable ( )

Returns: bool

Definition at line 629 of file DerivedPageDataUpdater.php.

References $content, and(), MediaWiki\Storage\DerivedPageDataUpdater\getCanonicalParserOutput(), MediaWiki\Storage\DerivedPageDataUpdater\getModifiedSlotRoles(), MediaWiki\Storage\DerivedPageDataUpdater\getRawContent(), MediaWiki\Storage\DerivedPageDataUpdater\getTitle(), MediaWiki\Storage\DerivedPageDataUpdater\isContentDeleted(), and MediaWiki\Storage\DerivedPageDataUpdater\isRedirect().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates().

◆ isCreation()

MediaWiki\Storage\DerivedPageDataUpdater::isCreation ( )

Whether the edit creates the page.

Returns: bool

Definition at line 928 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\assertPrepared(), and options().

◆ isRedirect()

MediaWiki\Storage\DerivedPageDataUpdater::isRedirect ( )

Returns: bool

Definition at line 674 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\getRawContent().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\isCountable().

◆ isReusableFor()

MediaWiki\Storage\DerivedPageDataUpdater::isReusableFor	(	UserIdentity	$user = null,
		RevisionRecord	$revision = null,
		RevisionSlotsUpdate	$slotsUpdate = null,
			$parentId = null )

Checks whether this DerivedPageDataUpdater can be re-used for running updates targeting the given revision.

Parameters

UserIdentity \| null	$user	The user creating the revision in question
RevisionRecord \| null	$revision	New revision (after save, if already saved)
RevisionSlotsUpdate \| null	$slotsUpdate	New content (before PST)
null \| int	$parentId	Parent revision of the edit (use 0 for page creation)

Returns: bool

Definition at line 351 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\$revision, MediaWiki\Storage\DerivedPageDataUpdater\$slotsUpdate, MediaWiki\Revision\RevisionRecord\getId(), MediaWiki\Revision\RevisionRecord\getParentId(), MediaWiki\Revision\RevisionRecord\getSlots(), and MediaWiki\Storage\RevisionSlotsUpdate\hasSameUpdates().

◆ isUpdatePrepared()

MediaWiki\Storage\DerivedPageDataUpdater::isUpdatePrepared ( )

Whether prepareUpdate() has been called on this instance.

Note: will also return null in case of a null-edit!

Returns: bool

Definition at line 550 of file DerivedPageDataUpdater.php.

◆ pageExisted()

MediaWiki\Storage\DerivedPageDataUpdater::pageExisted ( )

Determines whether the page being edited already existed.

Only defined after calling grabCurrentRevision() or prepareContent() or prepareUpdate()!

Returns: bool

Exceptions

LogicException if called before grabCurrentRevision

Definition at line 449 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\assertHasPageState().

◆ prepareContent()

MediaWiki\Storage\DerivedPageDataUpdater::prepareContent	(	User	$user,
		RevisionSlotsUpdate	$slotsUpdate,
			$useStash = true )

Prepare updates based on an update which has not yet been saved.

This may be used to create derived data that is needed when creating a new revision; particularly, this makes available the slots of the new revision via the getSlots() method, after applying PST and slot inheritance.

The derived data prepared for revision creation may then later be re-used by doUpdates(), without the need to re-calculate.

See also: docs/pageupdater.txt for more information on when thie method can and should be called.

Note: Calling this method more than once with the same $slotsUpdate has no effect. Calling this method multiple times with different content will cause an exception.; Calling this method after prepareUpdate() has been called will cause an exception.

Parameters

User	$user	The user to act as context for pre-save transformation (PST). Type hint should be reduced to UserIdentity at some point.
RevisionSlotsUpdate	$slotsUpdate	The new content of the slots to be updated by this edit, before PST.
bool	$useStash	Whether to use stashed ParserOutput

Definition at line 718 of file DerivedPageDataUpdater.php.

◆ prepareUpdate()

MediaWiki\Storage\DerivedPageDataUpdater::prepareUpdate	(	RevisionRecord	$revision,
		array	$options = [] )

Prepare derived data updates targeting the given Revision.

Calling this method requires the given revision to be present in the database. This may be right after a new revision has been created, or when re-generating derived data e.g. in ApiPurge, RefreshLinksJob, and the refreshLinks script.

See also: docs/pageupdater.txt for more information on when thie method can and should be called.

Note: Calling this method more than once with the same revision has no effect. $options are only used for the first call. Calling this method multiple times with different revisions will cause an exception.; If grabCurrentRevision() (or prepareContent()) has been called before calling this method, $revision->getParentRevision() has to refer to the revision that was the current revision at the time grabCurrentRevision() was called.

Parameters

RevisionRecord	$revision
array	$options	Array of options, following indexes are used: changed: bool, whether the revision changed the content (default true) created: bool, whether the revision created the page (default false) moved: bool, whether the page was moved (default false) restored: bool, whether the page was undeleted (default false) oldrevision: Revision object for the pre-update revision (default null) triggeringUser: The user triggering the update (UserIdentity, defaults to the user who created the revision) oldredirect: bool, null, or string 'no-change' (default null): bool: whether the page was counted as a redirect before that revision, only used in changed is true and created is false null or 'no-change': don't update the redirect status. oldcountable: bool, null, or string 'no-change' (default null): bool: whether the page was counted as an article before that revision, only used in changed is true and created is false null: if created is false, don't update the article count; if created is true, do update the article count 'no-change': don't update the article count, ever When set to null, pageState['oldCountable'] will be used instead if available.

causeAction: an arbitrary string identifying the reason for the update. See DataUpdate::getCauseAction(). (default 'unknown')
causeAgent: name of the user who caused the update. See DataUpdate::getCauseAgent(). (string, default 'unknown')

Definition at line 1071 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\$options, $rev, MediaWiki\Storage\DerivedPageDataUpdater\$revision, and(), MediaWiki\Storage\DerivedPageDataUpdater\doTransition(), MediaWiki\Revision\RevisionRecord\getId(), MediaWiki\Revision\RevisionRecord\getParentId(), MediaWiki\Revision\RevisionRecord\getSlots(), MediaWiki\Revision\RevisionRecord\getUser(), options(), and MediaWiki\Storage\DerivedPageDataUpdater\useMaster().

◆ revisionIsRedirect()

MediaWiki\Storage\DerivedPageDataUpdater::revisionIsRedirect ( RevisionRecord $rev )

private

Parameters

RevisionRecord $rev

Returns: bool

Definition at line 687 of file DerivedPageDataUpdater.php.

References $rev.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\wasRedirect().

◆ setArticleCountMethod()

MediaWiki\Storage\DerivedPageDataUpdater::setArticleCountMethod ( $articleCountMethod )

Parameters

string $articleCountMethod "any" or "link".

See also: $wgArticleCountMethod

Definition at line 414 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\$articleCountMethod.

Referenced by WikiPage\newDerivedDataUpdater().

◆ setRcWatchCategoryMembership()

MediaWiki\Storage\DerivedPageDataUpdater::setRcWatchCategoryMembership ( $rcWatchCategoryMembership )

Parameters

bool $rcWatchCategoryMembership

See also: $wgRCWatchCategoryMembership

Definition at line 422 of file DerivedPageDataUpdater.php.

References MediaWiki\Storage\DerivedPageDataUpdater\$rcWatchCategoryMembership.

Referenced by WikiPage\newDerivedDataUpdater().

◆ useMaster()

MediaWiki\Storage\DerivedPageDataUpdater::useMaster ( )

private

Definition at line 621 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\getParentRevision(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareUpdate().

◆ wasRedirect()

MediaWiki\Storage\DerivedPageDataUpdater::wasRedirect ( )

Whether the page was a redirect before the edit.

Returns: bool

Definition at line 952 of file DerivedPageDataUpdater.php.

References $rev, MediaWiki\Storage\DerivedPageDataUpdater\assertHasPageState(), and MediaWiki\Storage\DerivedPageDataUpdater\revisionIsRedirect().

Member Data Documentation

◆ $articleCountMethod

string MediaWiki\Storage\DerivedPageDataUpdater::$articleCountMethod

private

see $wgArticleCountMethod

Definition at line 141 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\setArticleCountMethod().

◆ $contLang

Language MediaWiki\Storage\DerivedPageDataUpdater::$contLang

private

Definition at line 121 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\__construct().

◆ $jobQueueGroup

JobQueueGroup MediaWiki\Storage\DerivedPageDataUpdater::$jobQueueGroup

private

Definition at line 126 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\__construct().

◆ $loadbalancerFactory

LBFactory MediaWiki\Storage\DerivedPageDataUpdater::$loadbalancerFactory

private

Definition at line 136 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\__construct().

◆ $messageCache

MessageCache MediaWiki\Storage\DerivedPageDataUpdater::$messageCache

private

Definition at line 131 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\__construct().

◆ $options

MediaWiki\Storage\DerivedPageDataUpdater::$options

private

Initial value:

= [
        'changed' => true,
        
        
        'newrev' => false,
        'created' => false,
        'moved' => false,
        'restored' => false,
        'oldrevision' => null,
        'oldcountable' => null,
        'oldredirect' => null,
        'triggeringUser' => null,
        
        
        'causeAction' => null,
        'causeAgent' => null,
    ]

Stores (most of) the $options parameter of prepareUpdate().

See also: prepareUpdate()

Definition at line 152 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doSecondaryDataUpdates(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareUpdate().

◆ $pageState

array MediaWiki\Storage\DerivedPageDataUpdater::$pageState = null

private

The state of the relevant row in page table before the edit.

This is determined by the first call to grabCurrentRevision, prepareContent, or prepareUpdate (so it is only accessible in 'knows-current' or a later stage). If pageState was not initialized when prepareUpdate() is called, prepareUpdate() will attempt to emulate the state of the page table before the edit.

Contains the following fields:

oldRevision (RevisionRecord|null): the revision that was current before the change associated with this update. Might not be set, use getParentRevision().
oldId (int|null): the id of the above revision. 0 if there is no such revision (the change was about creating a new page); null if not known (that should not happen).
oldIsRedirect (bool|null): whether the page was a redirect before the change. Lazy-loaded, can be null; use wasRedirect() instead of direct access.
oldCountable (bool|null): whether the page was countable before the change (or null if we don't have that information)

Definition at line 189 of file DerivedPageDataUpdater.php.

◆ $parentRevision

RevisionRecord null MediaWiki\Storage\DerivedPageDataUpdater::$parentRevision = null

private

Definition at line 199 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\getParentRevision(), MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareContent().

◆ $parserCache

ParserCache MediaWiki\Storage\DerivedPageDataUpdater::$parserCache

private

Definition at line 111 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\__construct().

◆ $rcWatchCategoryMembership

boolean MediaWiki\Storage\DerivedPageDataUpdater::$rcWatchCategoryMembership = false

private

see $wgRCWatchCategoryMembership

Definition at line 146 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\setRcWatchCategoryMembership().

◆ $renderedRevision

RenderedRevision MediaWiki\Storage\DerivedPageDataUpdater::$renderedRevision = null

private

Definition at line 209 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\getRenderedRevision(), and MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates().

◆ $revision

RevisionRecord null MediaWiki\Storage\DerivedPageDataUpdater::$revision = null

private

Definition at line 204 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\getRevision(), MediaWiki\Storage\DerivedPageDataUpdater\isReusableFor(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareUpdate().

◆ $revisionRenderer

RevisionRenderer MediaWiki\Storage\DerivedPageDataUpdater::$revisionRenderer

private

Definition at line 214 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\__construct().

◆ $revisionStore

RevisionStore MediaWiki\Storage\DerivedPageDataUpdater::$revisionStore

private

Definition at line 116 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\__construct().

◆ $slotRoleRegistry

SlotRoleRegistry MediaWiki\Storage\DerivedPageDataUpdater::$slotRoleRegistry

private

Definition at line 217 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\__construct().

◆ $slotsUpdate

RevisionSlotsUpdate null MediaWiki\Storage\DerivedPageDataUpdater::$slotsUpdate = null

private

Definition at line 194 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\getPreparedEdit(), MediaWiki\Storage\DerivedPageDataUpdater\getRevisionSlotsUpdate(), MediaWiki\Storage\DerivedPageDataUpdater\isReusableFor(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareContent().

◆ $stage

string MediaWiki\Storage\DerivedPageDataUpdater::$stage = 'new'

private

A stage identifier for managing the life cycle of this instance.

Possible stages are 'new', 'knows-current', 'has-content', 'has-revision', and 'done'.

See also: docs/pageupdater.txt for documentation of the life cycle.

Definition at line 227 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doTransition().

◆ $transitions

array [] MediaWiki\Storage\DerivedPageDataUpdater::$transitions

staticprivate

Initial value:

= [
        'new' => [
            'new' => true,
            'knows-current' => true,
            'has-content' => true,
            'has-revision' => true,
        ],
        'knows-current' => [
            'knows-current' => true,
            'has-content' => true,
            'has-revision' => true,
        ],
        'has-content' => [
            'has-content' => true,
            'has-revision' => true,
        ],
        'has-revision' => [
            'has-revision' => true,
            'done' => true,
        ],
    ]

Transition table for managing the life cycle of DerivedPageDateUpdater instances.

XXX: Overkill. This is a linear order, we could just count. Names are nice though, and constants are also overkill...

See also: docs/pageupdater.txt for documentation of the life cycle.

Definition at line 239 of file DerivedPageDataUpdater.php.

◆ $user

UserIdentity null MediaWiki\Storage\DerivedPageDataUpdater::$user = null

private

Definition at line 101 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doSecondaryDataUpdates(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareContent().

◆ $wikiPage

WikiPage MediaWiki\Storage\DerivedPageDataUpdater::$wikiPage

private

Definition at line 106 of file DerivedPageDataUpdater.php.

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\__construct(), MediaWiki\Storage\DerivedPageDataUpdater\doParserCacheUpdate(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\getSecondaryDataUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\getWikiPage(), MediaWiki\Storage\DerivedPageDataUpdater\grabCurrentRevision(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareContent().

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

includes/Storage/DerivedPageDataUpdater.php

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assertHasPageState()

◆ assertHasRevision()

◆ assertPrepared()

◆ assertTransition()

◆ doParserCacheUpdate()

◆ doSecondaryDataUpdates()

◆ doTransition()

◆ doUpdates()

◆ getCanonicalParserOptions()

◆ getCanonicalParserOutput()

◆ getContentHandler()

◆ getContentModel()

◆ getModifiedSlotRoles()

◆ getPageId()

◆ getParentRevision()

◆ getPreparedEdit()

◆ getRawContent()

◆ getRawSlot()

◆ getRemovedSlotRoles()

◆ getRenderedRevision()

◆ getRevision()

◆ getRevisionSlotsUpdate()

◆ getSecondaryDataUpdates()

◆ getSlotParserOutput()

◆ getSlots()

◆ getTitle()

◆ getTouchedSlotRoles()

◆ getWikiId()

◆ getWikiPage()

◆ grabCurrentRevision()

◆ isChange()

◆ isContentDeleted()

◆ isContentPrepared()

◆ isCountable()

◆ isCreation()

◆ isRedirect()

◆ isReusableFor()

◆ isUpdatePrepared()

◆ pageExisted()

◆ prepareContent()

◆ prepareUpdate()

◆ revisionIsRedirect()

◆ setArticleCountMethod()

◆ setRcWatchCategoryMembership()

◆ useMaster()

◆ wasRedirect()

Member Data Documentation

◆ $articleCountMethod

◆ $contLang

◆ $jobQueueGroup

◆ $loadbalancerFactory

◆ $messageCache

◆ $options

◆ $pageState

◆ $parentRevision

◆ $parserCache

◆ $rcWatchCategoryMembership

◆ $renderedRevision

◆ $revision

◆ $revisionRenderer

◆ $revisionStore

◆ $slotRoleRegistry

◆ $slotsUpdate

◆ $stage

◆ $transitions

◆ $user

◆ $wikiPage