Controller-like object for creating and updating pages by creating new revisions. More...

Collaboration diagram for MediaWiki\Storage\PageUpdater:

[legend]

Public Member Functions
	__construct (User $user, WikiPage $wikiPage, DerivedPageDataUpdater $derivedDataUpdater, ILoadBalancer $loadBalancer, RevisionStore $revisionStore, SlotRoleRegistry $slotRoleRegistry)

	addTag ( $tag)
	Sets a tag to apply to this update.

	addTags (array $tags)
	Sets tags to apply to this update.

	getExplicitTags ()
	Returns the list of tags set using the addTag() method.

	getNewRevision ()
	The new revision created by saveRevision(), or null if saveRevision() has not yet been called, failed, or did not create a new revision because the content did not change.

	getOriginalRevisionId ()
	Returns the ID of an earlier revision that is being repeated or restored by this update.

	getStatus ()
	The Status object indicating whether saveRevision() was successful, or null if saveRevision() was not yet called on this instance.

	getUndidRevisionId ()
	Returns the revision ID set by setUndidRevisionId(), indicating what revision is being undone by this edit.

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

	hasEditConflict ( $expectedParentRevision)
	Checks whether this update conflicts with another update performed between the client loading data to prepare an edit, and the client committing the edit.

	inheritSlot (SlotRecord $originalSlot)
	Explicitly inherit a slot from some earlier revision.

	isNew ()
	Whether saveRevision() was called and created a new page.

	isUnchanged ()
	Whether saveRevision() did not create a revision because the content didn't change (null-edit).

	removeSlot ( $role)
	Removes the slot with the given role.

	saveRevision (CommentStoreComment $summary, $flags=0)
	Change an existing article or create a new article.

	setAjaxEditStash ( $ajaxEditStash)

	setContent ( $role, Content $content)
	Set the new content for the given slot role.

	setOriginalRevisionId ( $originalRevId)
	Sets the ID of an earlier revision that is being repeated or restored by this update.

	setRcPatrolStatus ( $status)
	Sets the "patrolled" status of the edit.

	setSlot (SlotRecord $slot)
	Set the new slot for the given slot role.

	setUndidRevisionId ( $undidRevId)
	Sets the ID of revision that was undone by the present update.

	setUseAutomaticEditSummaries ( $useAutomaticEditSummaries)
	Can be used to enable or disable automatic summaries that are applied to certain kinds of changes, like completely blanking a page.

	setUsePageCreationLog ( $use)
	Whether to create a log entry for new page creations.

	wasCommitted ()
	Whether saveRevision() has been called on this instance.

	wasSuccessful ()
	Whether saveRevision() completed successfully.

Private Member Functions
	checkAllRequiredRoles (array $roles, Status $status)

	checkAllRolesAllowed (array $roles, Status $status)

	checkFlags ( $flags)
	Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.

	checkNoRolesRequired (array $roles, Status $status)

	computeEffectiveTags ( $flags)

	doCreate (CommentStoreComment $summary, User $user, $flags)

	doModify (CommentStoreComment $summary, User $user, $flags)

	ensureRoleAllowed ( $role)

	ensureRoleNotRequired ( $role)

	getAllowedSlotRoles ()

	getAtomicSectionUpdate (IDatabase $dbw, WikiPage $wikiPage, RevisionRecord $newRevisionRecord, User $user, CommentStoreComment $summary, $flags, Status $status, $hints=[])

	getContentHandler ( $role)

	getDBConnectionRef ( $mode)

	getLinkTarget ()

	getParentContent ( $role)
	Returns the content of the given slot of the parent revision, with no audience checks applied.

	getRequiredSlotRoles ()

	getTitle ()

	getWikiId ()

	getWikiPage ()

	makeAutoSummary ( $flags)

	makeNewRevision (CommentStoreComment $comment, User $user, $flags, Status $status)
	Constructs a MutableRevisionRecord based on the Content prepared by the DerivedPageDataUpdater.

Private Attributes
boolean	$ajaxEditStash = true
	see $wgAjaxEditStash

DerivedPageDataUpdater	$derivedDataUpdater

ILoadBalancer	$loadBalancer

bool int	$originalRevId = false

int	$rcPatrolStatus = RecentChange::PRC_UNPATROLLED
	the RC patrol status the new revision should be marked with.

RevisionStore	$revisionStore

SlotRoleRegistry	$slotRoleRegistry

RevisionSlotsUpdate	$slotsUpdate

Status null	$status = null

array	$tags = []

int	$undidRevId = 0

boolean	$useAutomaticEditSummaries = true
	see $wgUseAutomaticEditSummaries

bool	$usePageCreationLog = true
	whether to create a log entry for new page creations.

User	$user

WikiPage	$wikiPage

Detailed Description

Controller-like object for creating and updating pages by creating new revisions.

PageUpdater instances provide compare-and-swap (CAS) protection against concurrent updates between the time grabParentRevision() is called and saveRevision() inserts a new revision. This allows application logic to safely perform edit conflict resolution using the parent revision's content.

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

MCR migration note: this replaces the relevant methods in WikiPage.

Since: 1.32

Definition at line 72 of file PageUpdater.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Storage\PageUpdater::__construct	(	User	$user,
		WikiPage	$wikiPage,
		DerivedPageDataUpdater	$derivedDataUpdater,
		ILoadBalancer	$loadBalancer,
		RevisionStore	$revisionStore,
		SlotRoleRegistry	$slotRoleRegistry
	)

Parameters

User	$user
WikiPage	$wikiPage
DerivedPageDataUpdater	$derivedDataUpdater
ILoadBalancer	$loadBalancer
RevisionStore	$revisionStore
SlotRoleRegistry	$slotRoleRegistry

Definition at line 158 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$derivedDataUpdater, MediaWiki\Storage\PageUpdater\$loadBalancer, MediaWiki\Storage\PageUpdater\$revisionStore, MediaWiki\Storage\PageUpdater\$slotRoleRegistry, MediaWiki\Storage\PageUpdater\$user, and MediaWiki\Storage\PageUpdater\$wikiPage.

Member Function Documentation

◆ addTag()

MediaWiki\Storage\PageUpdater::addTag ( $tag )

Sets a tag to apply to this update.

Callers are responsible for permission checks, using ChangeTags::canAddTagsAccompanyingChange.

Parameters

string $tag

Definition at line 457 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\addTags().

◆ addTags()

MediaWiki\Storage\PageUpdater::addTags ( array $tags )

Sets tags to apply to this update.

Callers are responsible for permission checks, using ChangeTags::canAddTagsAccompanyingChange.

Parameters

string[] $tags

Definition at line 468 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$tags, and MediaWiki\Storage\PageUpdater\addTag().

◆ checkAllRequiredRoles()

MediaWiki\Storage\PageUpdater::checkAllRequiredRoles	(	array	$roles,
		Status	$status
	)

private

Definition at line 1298 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$status, StatusValue\error(), and MediaWiki\Storage\PageUpdater\getRequiredSlotRoles().

Referenced by MediaWiki\Storage\PageUpdater\makeNewRevision().

◆ checkAllRolesAllowed()

MediaWiki\Storage\PageUpdater::checkAllRolesAllowed	(	array	$roles,
		Status	$status
	)

private

Definition at line 1272 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$status, StatusValue\error(), and MediaWiki\Storage\PageUpdater\getAllowedSlotRoles().

Referenced by MediaWiki\Storage\PageUpdater\saveRevision().

◆ checkFlags()

MediaWiki\Storage\PageUpdater::checkFlags ( $flags )

private

Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.

Parameters

int $flags

Returns: int Updated $flags

Definition at line 334 of file PageUpdater.php.

References EDIT_NEW, and EDIT_UPDATE.

Referenced by MediaWiki\Storage\PageUpdater\saveRevision().

◆ checkNoRolesRequired()

MediaWiki\Storage\PageUpdater::checkNoRolesRequired	(	array	$roles,
		Status	$status
	)

private

Definition at line 1285 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$status, StatusValue\error(), and MediaWiki\Storage\PageUpdater\getRequiredSlotRoles().

Referenced by MediaWiki\Storage\PageUpdater\saveRevision().

◆ computeEffectiveTags()

MediaWiki\Storage\PageUpdater::computeEffectiveTags ( $flags )

private

Parameters

int $flags Bit mask: a bit mask of EDIT_XXX flags.

Returns: string[]

Definition at line 488 of file PageUpdater.php.

References $content, MediaWiki\Storage\PageUpdater\$tags, MediaWiki\Storage\PageUpdater\getContentHandler(), MediaWiki\Storage\PageUpdater\getParentContent(), and ChangeTags\getSoftwareTags().

Referenced by MediaWiki\Storage\PageUpdater\doCreate(), and MediaWiki\Storage\PageUpdater\doModify().

◆ doCreate()

MediaWiki\Storage\PageUpdater::doCreate	(	CommentStoreComment	$summary,
		User	$user,
			$flags
	)

private

Parameters

CommentStoreComment	$summary	The edit summary
User	$user	The revision's author
int	$flags	EXIT_XXX constants

Exceptions

DBUnexpectedError
MWException

Returns: Status

Definition at line 1079 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\saveRevision().

◆ doModify()

MediaWiki\Storage\PageUpdater::doModify	(	CommentStoreComment	$summary,
		User	$user,
			$flags
	)

private

Parameters

CommentStoreComment	$summary	The edit summary
User	$user	The revision's author
int	$flags	EXIT_XXX constants

Exceptions

MWException

Returns: Status

Definition at line 928 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\saveRevision().

◆ ensureRoleAllowed()

MediaWiki\Storage\PageUpdater::ensureRoleAllowed ( $role )

private

Definition at line 1258 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\getAllowedSlotRoles().

Referenced by MediaWiki\Storage\PageUpdater\setContent(), and MediaWiki\Storage\PageUpdater\setSlot().

◆ ensureRoleNotRequired()

MediaWiki\Storage\PageUpdater::ensureRoleNotRequired ( $role )

private

Definition at line 1265 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\getRequiredSlotRoles().

Referenced by MediaWiki\Storage\PageUpdater\removeSlot().

◆ getAllowedSlotRoles()

MediaWiki\Storage\PageUpdater::getAllowedSlotRoles ( )

private

Returns: string[] Slots allowed for this page update, as a list of role names.

Definition at line 1254 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\getTitle().

Referenced by MediaWiki\Storage\PageUpdater\checkAllRolesAllowed(), and MediaWiki\Storage\PageUpdater\ensureRoleAllowed().

◆ getAtomicSectionUpdate()

MediaWiki\Storage\PageUpdater::getAtomicSectionUpdate	(	IDatabase	$dbw,
		WikiPage	$wikiPage,
		RevisionRecord	$newRevisionRecord,
		User	$user,
		CommentStoreComment	$summary,
			$flags,
		Status	$status,
			$hints = `[]`
	)

private

Definition at line 1197 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$status, MediaWiki\Storage\PageUpdater\$undidRevId, MediaWiki\Storage\PageUpdater\$user, MediaWiki\Storage\PageUpdater\$wikiPage, EDIT_MINOR, MediaWiki\Revision\RevisionRecord\getContent(), User\getName(), and MediaWiki\Storage\PageUpdater\getOriginalRevisionId().

Referenced by MediaWiki\Storage\PageUpdater\doCreate(), and MediaWiki\Storage\PageUpdater\doModify().

◆ getContentHandler()

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

private

Parameters

string $role slot role name

Returns: ContentHandler

Definition at line 534 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\grabParentRevision().

Referenced by MediaWiki\Storage\PageUpdater\computeEffectiveTags(), and MediaWiki\Storage\PageUpdater\makeAutoSummary().

◆ getDBConnectionRef()

MediaWiki\Storage\PageUpdater::getDBConnectionRef ( $mode )

private

Parameters

int $mode DB_MASTER or DB_REPLICA

Returns: DBConnRef

Definition at line 229 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\getWikiId().

Referenced by MediaWiki\Storage\PageUpdater\doCreate(), and MediaWiki\Storage\PageUpdater\doModify().

◆ getExplicitTags()

MediaWiki\Storage\PageUpdater::getExplicitTags ( )

Returns the list of tags set using the addTag() method.

Returns: string[]

Definition at line 480 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$tags.

◆ getLinkTarget()

MediaWiki\Storage\PageUpdater::getLinkTarget ( )

private

Returns: LinkTarget

Definition at line 236 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\saveRevision().

◆ getNewRevision()

MediaWiki\Storage\PageUpdater::getNewRevision ( )

The new revision created by saveRevision(), or null if saveRevision() has not yet been called, failed, or did not create a new revision because the content did not change.

Returns: RevisionRecord|null

Definition at line 850 of file PageUpdater.php.

◆ getOriginalRevisionId()

MediaWiki\Storage\PageUpdater::getOriginalRevisionId ( )

Returns the ID of an earlier revision that is being repeated or restored by this update.

Returns: bool|int The original revision id, or false if no earlier revision is known to be repeated or restored by this update.

Definition at line 409 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$originalRevId.

Referenced by MediaWiki\Storage\PageUpdater\doModify(), and MediaWiki\Storage\PageUpdater\getAtomicSectionUpdate().

◆ getParentContent()

MediaWiki\Storage\PageUpdater::getParentContent ( $role )

private

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

If there is no parent revision or the slot is not defined, this returns null.

Parameters

string $role slot role name

Returns: Content|null

Definition at line 520 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\grabParentRevision().

Referenced by MediaWiki\Storage\PageUpdater\computeEffectiveTags(), and MediaWiki\Storage\PageUpdater\makeAutoSummary().

◆ getRequiredSlotRoles()

MediaWiki\Storage\PageUpdater::getRequiredSlotRoles ( )

private

Returns: string[] Slots required for this page update, as a list of role names.

Definition at line 1247 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\getTitle().

Referenced by MediaWiki\Storage\PageUpdater\checkAllRequiredRoles(), MediaWiki\Storage\PageUpdater\checkNoRolesRequired(), and MediaWiki\Storage\PageUpdater\ensureRoleNotRequired().

◆ getStatus()

MediaWiki\Storage\PageUpdater::getStatus ( )

The Status object indicating whether saveRevision() was successful, or null if saveRevision() was not yet called on this instance.

Note: This is here for compatibility with WikiPage::doEditContent. It may be deprecated soon.

Possible status errors: edit-hook-aborted: The ArticleSave hook aborted the update but didn't set the fatal flag of $status. edit-gone-missing: In update mode, but the article didn't exist. edit-conflict: In update mode, the article changed unexpectedly. edit-no-change: Warning that the text was the same as before. edit-already-exists: In creation mode, but the article already exists.

Extensions may define additional errors.

$return->value will contain an associative array with members as follows: new: Boolean indicating if the function attempted to create a new article. revision: The revision object for the inserted revision, or null.

Returns: null|Status

Definition at line 809 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$status.

◆ getTitle()

MediaWiki\Storage\PageUpdater::getTitle ( )

private

Returns: Title

Definition at line 244 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\doCreate(), MediaWiki\Storage\PageUpdater\doModify(), MediaWiki\Storage\PageUpdater\getAllowedSlotRoles(), MediaWiki\Storage\PageUpdater\getRequiredSlotRoles(), and MediaWiki\Storage\PageUpdater\makeNewRevision().

◆ getUndidRevisionId()

MediaWiki\Storage\PageUpdater::getUndidRevisionId ( )

Returns the revision ID set by setUndidRevisionId(), indicating what revision is being undone by this edit.

Returns: int

Definition at line 435 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$undidRevId.

◆ getWikiId()

MediaWiki\Storage\PageUpdater::getWikiId ( )

private

Definition at line 220 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\getDBConnectionRef().

◆ getWikiPage()

MediaWiki\Storage\PageUpdater::getWikiPage ( )

private

Returns: WikiPage

Definition at line 252 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$wikiPage.

Referenced by MediaWiki\Storage\PageUpdater\doCreate(), MediaWiki\Storage\PageUpdater\doModify(), MediaWiki\Storage\PageUpdater\makeNewRevision(), and MediaWiki\Storage\PageUpdater\saveRevision().

◆ grabParentRevision()

MediaWiki\Storage\PageUpdater::grabParentRevision ( )

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

This revision is the expected parent revision of the update, and will be recorded as the new revision's parent revision (unless no new revision is created because the content was not changed).

This method MUST not be called after saveRevision() was called!

The current revision determined by the first call to this methods effectively acts a compare-and-swap (CAS) token which is checked by saveRevision(), which fails if any concurrent updates created a new revision.

Application code should call this method before applying transformations to the new content that depend on the parent revision, e.g. adding/replacing sections, or resolving conflicts via a 3-way merge. This protects against race conditions triggered by concurrent updates.

See also: DerivedPageDataUpdater::grabCurrentRevision()

Note: The expected parent revision is not to be confused with the logical base revision. The base revision is specified by the client, the parent revision is determined from the database. If base revision and parent revision are not the same, the updates is considered to require edit conflict resolution.

Exceptions

LogicException if called after saveRevision().

Returns: RevisionRecord|null the parent revision, or null of the page does not yet exist.

Definition at line 324 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\doModify(), MediaWiki\Storage\PageUpdater\getContentHandler(), MediaWiki\Storage\PageUpdater\getParentContent(), MediaWiki\Storage\PageUpdater\hasEditConflict(), MediaWiki\Storage\PageUpdater\makeNewRevision(), and MediaWiki\Storage\PageUpdater\saveRevision().

◆ hasEditConflict()

MediaWiki\Storage\PageUpdater::hasEditConflict ( $expectedParentRevision )

Checks whether this update conflicts with another update performed between the client loading data to prepare an edit, and the client committing the edit.

This is intended to detect user level "edit conflict" when the latest revision known to the client is no longer the current revision when processing the update.

An update expected to create a new page can be checked by setting $expectedParentRevision = 0. Such an update is considered to have a conflict if a current revision exists (that is, the page was created since the edit was initiated on the client).

This method returning true indicates to calling code that edit conflict resolution should be applied before saving any data. It does not prevent the update from being performed, and it should not be confused with a "late" conflict indicated by the "edit-conflict" status. A "late" conflict is a CAS failure caused by an update being performed concurrently between the time grabParentRevision() was called and the time saveRevision() trying to insert the new revision.

Note: A user level edit conflict is not the same as the "edit-conflict" status triggered by a CAS failure. Calling this method establishes the CAS token, it does not check against it: This method calls grabParentRevision(), and thus causes the expected parent revision for the update to be fixed to the page's current revision at this point in time. It acts as a compare-and-swap (CAS) token in that it is guaranteed that saveRevision() will fail with the "edit-conflict" status if the current revision of the page changes after hasEditConflict() (or grabParentRevision()) was called and before saveRevision() could insert a new revision.

See also: grabParentRevision()

Parameters

int $expectedParentRevision The ID of the revision the client expects to be the current one. Use 0 to indicate that the page is expected to not yet exist.

Returns: bool

Definition at line 290 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\grabParentRevision().

◆ inheritSlot()

MediaWiki\Storage\PageUpdater::inheritSlot ( SlotRecord $originalSlot )

Explicitly inherit a slot from some earlier revision.

The primary use case for this is rollbacks, when slots are to be inherited from the rollback target, overriding the content from the parent revision (which is the revision being rolled back).

This should typically not be used to inherit slots from the parent revision, which happens implicitly. Using this method causes the given slot to be treated as "modified" during revision creation, even if it has the same content as in the parent revision.

Parameters

SlotRecord $originalSlot A slot already existing in the database, to be inherited by the new revision.

Definition at line 379 of file PageUpdater.php.

◆ isNew()

MediaWiki\Storage\PageUpdater::isNew ( )

Whether saveRevision() was called and created a new page.

Returns: bool

Definition at line 827 of file PageUpdater.php.

◆ isUnchanged()

MediaWiki\Storage\PageUpdater::isUnchanged ( )

Whether saveRevision() did not create a revision because the content didn't change (null-edit).

Whether the content changed or not is determined by DerivedPageDataUpdater::isChange().

Returns: bool

Definition at line 838 of file PageUpdater.php.

◆ makeAutoSummary()

MediaWiki\Storage\PageUpdater::makeAutoSummary ( $flags )

private

Parameters

int $flags Bit mask: a bit mask of EDIT_XXX flags.

Returns: CommentStoreComment

Definition at line 556 of file PageUpdater.php.

References $content, EDIT_AUTOSUMMARY, MediaWiki\Storage\PageUpdater\getContentHandler(), and MediaWiki\Storage\PageUpdater\getParentContent().

Referenced by MediaWiki\Storage\PageUpdater\saveRevision().

◆ makeNewRevision()

MediaWiki\Storage\PageUpdater::makeNewRevision	(	CommentStoreComment	$comment,
		User	$user,
			$flags,
		Status	$status
	)

private

Constructs a MutableRevisionRecord based on the Content prepared by the DerivedPageDataUpdater.

This takes care of inheriting slots, updating slots with PST applied, and removing discontinued slots.

This calls Content::prepareSave() to verify that the slot content can be saved. The $status parameter is updated with any errors or warnings found by Content::prepareSave().

Parameters

CommentStoreComment	$comment
User	$user
int	$flags
Status	$status

Returns: MutableRevisionRecord

Definition at line 871 of file PageUpdater.php.

References $content, MediaWiki\Storage\PageUpdater\$status, $title, MediaWiki\Storage\PageUpdater\$user, MediaWiki\Storage\PageUpdater\$wikiPage, MediaWiki\Storage\PageUpdater\checkAllRequiredRoles(), EDIT_MINOR, MediaWiki\Storage\PageUpdater\getTitle(), MediaWiki\Storage\PageUpdater\getWikiPage(), MediaWiki\Storage\PageUpdater\grabParentRevision(), and StatusValue\merge().

Referenced by MediaWiki\Storage\PageUpdater\doCreate(), and MediaWiki\Storage\PageUpdater\doModify().

◆ removeSlot()

MediaWiki\Storage\PageUpdater::removeSlot ( $role )

Removes the slot with the given role.

This discontinues the "stream" of slots with this role on the page, preventing the new revision, and any subsequent revisions, from inheriting the slot with this role.

Parameters

string $role A slot role name (but not "main")

Definition at line 397 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\ensureRoleNotRequired().

◆ saveRevision()

MediaWiki\Storage\PageUpdater::saveRevision	(	CommentStoreComment	$summary,
			$flags = `0`
	)

Change an existing article or create a new article.

Updates RC and all necessary caches, optionally via the deferred update array. This does not check user permissions.

It is guaranteed that saveRevision() will fail if the current revision of the page changes after grabParentRevision() was called and before saveRevision() can insert a new revision, as per the CAS mechanism described above.

The caller is however responsible for calling hasEditConflict() to detect a user-level edit conflict, and to adjust the content of the new revision accordingly, e.g. by using a 3-way-merge.

MCR migration note: this replaces WikiPage::doEditContent. Callers that change to using saveRevision() now need to check the "minoredit" themselves before using EDIT_MINOR.

Parameters

CommentStoreComment	$summary	Edit summary
int	$flags	Bitfield: EDIT_NEW Create a new page, or fail with "edit-already-exists" if the page exists. EDIT_UPDATE Create a new revision, or fail with "edit-gone-missing" if the page does not exist. EDIT_MINOR Mark this revision as minor EDIT_SUPPRESS_RC Do not log the change in recentchanges EDIT_FORCE_BOT Mark the revision as automated ("bot edit") EDIT_AUTOSUMMARY Fill in blank summaries with generated text where possible EDIT_INTERNAL Signal that the page retrieve/save cycle happened entirely in this request.

If neither EDIT_NEW nor EDIT_UPDATE is specified, the expected state is detected automatically via grabParentRevision(). In this case, the "edit-already-exists" or "edit-gone-missing" errors may still be triggered due to race conditions, if the page was unexpectedly created or deleted while revision creation is in progress. This can be viewed as part of the CAS mechanism described above.

Returns: RevisionRecord|null The new revision, or null if no new revision was created due to a failure or a null-edit. Use isUnchanged(), wasSuccessful() and getStatus() to determine the outcome of the revision creation.

Exceptions

MWException
RuntimeException

Definition at line 624 of file PageUpdater.php.

◆ setAjaxEditStash()

MediaWiki\Storage\PageUpdater::setAjaxEditStash ( $ajaxEditStash )

Parameters

bool $ajaxEditStash

See also: $wgAjaxEditStash

Definition at line 216 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$ajaxEditStash.

◆ setContent()

MediaWiki\Storage\PageUpdater::setContent	(		$role,
		Content	$content
	)

Set the new content for the given slot role.

Parameters

string	$role	A slot role name (such as "main")
Content	$content

Definition at line 348 of file PageUpdater.php.

References $content, and MediaWiki\Storage\PageUpdater\ensureRoleAllowed().

◆ setOriginalRevisionId()

MediaWiki\Storage\PageUpdater::setOriginalRevisionId ( $originalRevId )

Sets the ID of an earlier revision that is being repeated or restored by this update.

The new revision is expected to have the exact same content as the given original revision. This is used with rollbacks and with dummy "null" revisions which are created to record things like page moves.

This value is passed to the PageContentSaveComplete and NewRevisionFromEditComplete hooks.

Parameters

int | bool $originalRevId The original revision id, or false if no earlier revision is known to be repeated or restored by this update.

Definition at line 424 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$originalRevId.

◆ setRcPatrolStatus()

MediaWiki\Storage\PageUpdater::setRcPatrolStatus ( $status )

Sets the "patrolled" status of the edit.

Callers should check the "patrol" and "autopatrol" permissions as appropriate.

See also: $wgUseRCPatrol; $wgUseNPPatrol

Parameters

int $status RC patrol status, e.g. RecentChange::PRC_AUTOPATROLLED.

Definition at line 197 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$status.

◆ setSlot()

MediaWiki\Storage\PageUpdater::setSlot ( SlotRecord $slot )

Set the new slot for the given slot role.

Parameters

SlotRecord $slot

Definition at line 359 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\ensureRoleAllowed(), and MediaWiki\Revision\SlotRecord\getRole().

◆ setUndidRevisionId()

MediaWiki\Storage\PageUpdater::setUndidRevisionId ( $undidRevId )

Sets the ID of revision that was undone by the present update.

This is used with the "undo" action, and is expected to hold the oldest revision ID in case more then one revision is being undone.

Parameters

int $undidRevId

Definition at line 446 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$undidRevId.

◆ setUseAutomaticEditSummaries()

MediaWiki\Storage\PageUpdater::setUseAutomaticEditSummaries ( $useAutomaticEditSummaries )

Can be used to enable or disable automatic summaries that are applied to certain kinds of changes, like completely blanking a page.

Parameters

bool $useAutomaticEditSummaries

See also: $wgUseAutomaticEditSummaries

Definition at line 184 of file PageUpdater.php.

References MediaWiki\Storage\PageUpdater\$useAutomaticEditSummaries.

◆ setUsePageCreationLog()

MediaWiki\Storage\PageUpdater::setUsePageCreationLog ( $use )

Whether to create a log entry for new page creations.

See also: $wgPageCreationLog

Parameters

bool $use

Definition at line 208 of file PageUpdater.php.

◆ wasCommitted()

MediaWiki\Storage\PageUpdater::wasCommitted ( )

Whether saveRevision() has been called on this instance.

Returns: bool

Definition at line 782 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\saveRevision().

◆ wasSuccessful()

MediaWiki\Storage\PageUpdater::wasSuccessful ( )

Whether saveRevision() completed successfully.

Returns: bool

Definition at line 818 of file PageUpdater.php.

Member Data Documentation

◆ $ajaxEditStash

boolean MediaWiki\Storage\PageUpdater::$ajaxEditStash = true

private

see $wgAjaxEditStash

Definition at line 123 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\saveRevision(), and MediaWiki\Storage\PageUpdater\setAjaxEditStash().

◆ $derivedDataUpdater

DerivedPageDataUpdater MediaWiki\Storage\PageUpdater::$derivedDataUpdater

private

Definition at line 87 of file PageUpdater.php.

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

◆ $loadBalancer

ILoadBalancer MediaWiki\Storage\PageUpdater::$loadBalancer

private

Definition at line 92 of file PageUpdater.php.

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

◆ $originalRevId

bool int MediaWiki\Storage\PageUpdater::$originalRevId = false

private

Definition at line 128 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\getOriginalRevisionId(), and MediaWiki\Storage\PageUpdater\setOriginalRevisionId().

◆ $rcPatrolStatus

int MediaWiki\Storage\PageUpdater::$rcPatrolStatus = RecentChange::PRC_UNPATROLLED

private

the RC patrol status the new revision should be marked with.

Definition at line 113 of file PageUpdater.php.

◆ $revisionStore

RevisionStore MediaWiki\Storage\PageUpdater::$revisionStore

private

Definition at line 97 of file PageUpdater.php.

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

◆ $slotRoleRegistry

SlotRoleRegistry MediaWiki\Storage\PageUpdater::$slotRoleRegistry

private

Definition at line 102 of file PageUpdater.php.

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

◆ $slotsUpdate

RevisionSlotsUpdate MediaWiki\Storage\PageUpdater::$slotsUpdate

private

Definition at line 143 of file PageUpdater.php.

◆ $status

Status null MediaWiki\Storage\PageUpdater::$status = null

private

Definition at line 148 of file PageUpdater.php.

◆ $tags

array MediaWiki\Storage\PageUpdater::$tags = []

private

Definition at line 133 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\addTags(), MediaWiki\Storage\PageUpdater\computeEffectiveTags(), MediaWiki\Storage\PageUpdater\doCreate(), MediaWiki\Storage\PageUpdater\doModify(), and MediaWiki\Storage\PageUpdater\getExplicitTags().

◆ $undidRevId

int MediaWiki\Storage\PageUpdater::$undidRevId = 0

private

Definition at line 138 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\getAtomicSectionUpdate(), MediaWiki\Storage\PageUpdater\getUndidRevisionId(), and MediaWiki\Storage\PageUpdater\setUndidRevisionId().

◆ $useAutomaticEditSummaries

boolean MediaWiki\Storage\PageUpdater::$useAutomaticEditSummaries = true

private

see $wgUseAutomaticEditSummaries

See also: $wgUseAutomaticEditSummaries

Definition at line 108 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\setUseAutomaticEditSummaries().

◆ $usePageCreationLog

bool MediaWiki\Storage\PageUpdater::$usePageCreationLog = true

private

whether to create a log entry for new page creations.

Definition at line 118 of file PageUpdater.php.

◆ $user

User MediaWiki\Storage\PageUpdater::$user

private

Definition at line 77 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\__construct(), MediaWiki\Storage\PageUpdater\doCreate(), MediaWiki\Storage\PageUpdater\doModify(), MediaWiki\Storage\PageUpdater\getAtomicSectionUpdate(), MediaWiki\Storage\PageUpdater\makeNewRevision(), and MediaWiki\Storage\PageUpdater\saveRevision().

◆ $wikiPage

WikiPage MediaWiki\Storage\PageUpdater::$wikiPage

private

Definition at line 82 of file PageUpdater.php.

Referenced by MediaWiki\Storage\PageUpdater\__construct(), MediaWiki\Storage\PageUpdater\doCreate(), MediaWiki\Storage\PageUpdater\doModify(), MediaWiki\Storage\PageUpdater\getAtomicSectionUpdate(), MediaWiki\Storage\PageUpdater\getWikiPage(), MediaWiki\Storage\PageUpdater\makeNewRevision(), and MediaWiki\Storage\PageUpdater\saveRevision().

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

includes/Storage/PageUpdater.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addTag()

◆ addTags()

◆ checkAllRequiredRoles()

◆ checkAllRolesAllowed()

◆ checkFlags()

◆ checkNoRolesRequired()

◆ computeEffectiveTags()

◆ doCreate()

◆ doModify()

◆ ensureRoleAllowed()

◆ ensureRoleNotRequired()

◆ getAllowedSlotRoles()

◆ getAtomicSectionUpdate()

◆ getContentHandler()

◆ getDBConnectionRef()

◆ getExplicitTags()

◆ getLinkTarget()

◆ getNewRevision()

◆ getOriginalRevisionId()

◆ getParentContent()

◆ getRequiredSlotRoles()

◆ getStatus()

◆ getTitle()

◆ getUndidRevisionId()

◆ getWikiId()

◆ getWikiPage()

◆ grabParentRevision()

◆ hasEditConflict()

◆ inheritSlot()

◆ isNew()

◆ isUnchanged()

◆ makeAutoSummary()

◆ makeNewRevision()

◆ removeSlot()

◆ saveRevision()

◆ setAjaxEditStash()

◆ setContent()

◆ setOriginalRevisionId()

◆ setRcPatrolStatus()

◆ setSlot()

◆ setUndidRevisionId()

◆ setUseAutomaticEditSummaries()

◆ setUsePageCreationLog()

◆ wasCommitted()

◆ wasSuccessful()

Member Data Documentation

◆ $ajaxEditStash

◆ $derivedDataUpdater

◆ $loadBalancer

◆ $originalRevId

◆ $rcPatrolStatus

◆ $revisionStore

◆ $slotRoleRegistry

◆ $slotsUpdate

◆ $status

◆ $tags

◆ $undidRevId

◆ $useAutomaticEditSummaries

◆ $usePageCreationLog

◆ $user

◆ $wikiPage