Mutable RevisionRecord implementation, for building new revision entries programmatically. More...

Inheritance diagram for MediaWiki\Revision\MutableRevisionRecord:

Collaboration diagram for MediaWiki\Revision\MutableRevisionRecord:

[legend]

Public Member Functions
	__construct (Title $title, $wikiId=false)

	applyUpdate (RevisionSlotsUpdate $update)
	Applies the given update to the slots of this revision.

	getSha1 ()
	Returns the base36 sha1 of this revision.

	getSize ()
	Returns the nominal size of this revision.

	getSlots ()
	Returns the slots defined for this revision as a MutableRevisionSlots instance, which can be modified to defined the slots for this revision.

	inheritSlot (SlotRecord $parentSlot)
	"Inherits" the given slot's content.

	removeSlot ( $role)
	Removes the slot with the given role from this revision.

	setComment (CommentStoreComment $comment)

	setContent ( $role, Content $content)
	Sets the content for the slot with the given role.

	setId ( $id)
	Set the revision ID.

	setMinorEdit ( $minorEdit)

	setPageId ( $pageId)

	setParentId ( $parentId)

	setSha1 ( $sha1)
	Set revision hash, for optimization.

	setSize ( $size)
	Set nominal revision size, for optimization.

	setSlot (SlotRecord $slot)
	Sets the given slot.

	setTimestamp ( $timestamp)

	setUser (UserIdentity $user)
	Sets the user identity associated with the revision.

	setVisibility ( $visibility)

Public Member Functions inherited from MediaWiki\Revision\RevisionRecord
	__construct (Title $title, RevisionSlots $slots, $wikiId=false)

	__sleep ()
	Implemented to defy serialization.

	audienceCan ( $field, $audience, User $user=null)
	Check that the given audience has access to the given field.

	getComment ( $audience=self::FOR_PUBLIC, User $user=null)
	Fetch revision comment, if it's available to the specified audience.

	getContent ( $role, $audience=self::FOR_PUBLIC, User $user=null)
	Returns the Content of the given slot of this revision.

	getId ()
	Get revision ID.

	getInheritedSlots ()
	Returns slots inherited from some previous revision.

	getOriginalSlots ()
	Returns the slots that originate in this revision.

	getPageAsLinkTarget ()
	Returns the title of the page this revision is associated with as a LinkTarget object.

	getPageId ()
	Get the page ID.

	getParentId ()
	Get parent revision ID (the original previous page revision).

	getSlot ( $role, $audience=self::FOR_PUBLIC, User $user=null)
	Returns meta-data for the given slot.

	getSlotRoles ()
	Returns the slot names (roles) of all slots present in this revision.

	getTimestamp ()
	MCR migration note: this replaces Revision::getTimestamp.

	getUser ( $audience=self::FOR_PUBLIC, User $user=null)
	Fetch revision's author's user identity, if it's available to the specified audience.

	getVisibility ()
	Get the deletion bitfield of the revision.

	getWikiId ()
	Get the ID of the wiki this revision belongs to.

	hasSameContent (RevisionRecord $rec)

	hasSlot ( $role)
	Returns whether the given slot is defined in this revision.

	isDeleted ( $field)
	MCR migration note: this replaces Revision::isDeleted.

	isMinor ()
	MCR migration note: this replaces Revision::isMinor.

	isReadyForInsertion ()
	Returns whether this RevisionRecord is ready for insertion, that is, whether it contains all information needed to save it to the database.

Static Public Member Functions
static	newFromParentRevision (RevisionRecord $parent)
	Returns an incomplete MutableRevisionRecord which uses $parent as its parent revision, and inherits all slots form it.

Static Public Member Functions inherited from MediaWiki\Revision\RevisionRecord
static	userCanBitfield ( $bitfield, $field, User $user, Title $title=null)
	Determine if the current user is allowed to view a particular field of this revision, if it's marked as deleted.

Private Member Functions
	resetAggregateValues ()
	Invalidate cached aggregate values such as hash and size.

Additional Inherited Members
Public Attributes inherited from MediaWiki\Revision\RevisionRecord
const	DELETED_COMMENT = 2

const	DELETED_RESTRICTED = 8

const	DELETED_TEXT = 1

const	DELETED_USER = 4

const	FOR_PUBLIC = 1

const	FOR_THIS_USER = 2

const	RAW = 3

const	SUPPRESSED_ALL

const	SUPPRESSED_USER = self::DELETED_USER \| self::DELETED_RESTRICTED

Protected Member Functions inherited from MediaWiki\Revision\RevisionRecord
	userCan ( $field, User $user)
	Determine if the current user is allowed to view a particular field of this revision, if it's marked as deleted.

Protected Attributes inherited from MediaWiki\Revision\RevisionRecord
CommentStoreComment null	$mComment

int	$mDeleted = 0
	using the DELETED_XXX and SUPPRESSED_XXX flags

int null	$mId

bool	$mMinorEdit = false

int null	$mPageId

int null	$mParentId

string null	$mSha1

int null	$mSize

RevisionSlots	$mSlots

string null	$mTimestamp

Title	$mTitle

UserIdentity null	$mUser

string	$mWiki = false
	Wiki ID; false means the current wiki.

Detailed Description

Mutable RevisionRecord implementation, for building new revision entries programmatically.

Provides setters for all fields.

Since: 1.31; 1.32 Renamed from MediaWiki\Storage\MutableRevisionRecord

Definition at line 41 of file MutableRevisionRecord.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Revision\MutableRevisionRecord::__construct	(	Title	$title,
			$wikiId = `false`
	)

Note: Avoid calling this constructor directly. Use the appropriate methods in RevisionStore instead.

Parameters

Title	$title	The title of the page this Revision is associated with.
bool \| string	$wikiId	the wiki ID of the site this Revision belongs to, or false for the local site.

Exceptions

MWException

Definition at line 78 of file MutableRevisionRecord.php.

References $title.

Member Function Documentation

◆ applyUpdate()

MediaWiki\Revision\MutableRevisionRecord::applyUpdate ( RevisionSlotsUpdate $update )

Applies the given update to the slots of this revision.

Parameters

RevisionSlotsUpdate $update

Definition at line 178 of file MutableRevisionRecord.php.

References MediaWiki\Storage\RevisionSlotsUpdate\apply().

◆ getSha1()

MediaWiki\Revision\MutableRevisionRecord::getSha1 ( )

Returns the base36 sha1 of this revision.

MCR migration note: this replaces Revision::getSha1

Returns: string The revision hash, may be computed on the fly if not yet known.

Reimplemented from MediaWiki\Revision\RevisionRecord.

Definition at line 310 of file MutableRevisionRecord.php.

References MediaWiki\Revision\RevisionRecord\$mSha1.

◆ getSize()

MediaWiki\Revision\MutableRevisionRecord::getSize ( )

Returns the nominal size of this revision.

MCR migration note: this replaces Revision::getSize

Returns: int The nominal size, may be computed on the fly if not yet known.

Reimplemented from MediaWiki\Revision\RevisionRecord.

Definition at line 294 of file MutableRevisionRecord.php.

References MediaWiki\Revision\RevisionRecord\$mSize.

◆ getSlots()

MediaWiki\Revision\MutableRevisionRecord::getSlots ( )

Returns the slots defined for this revision as a MutableRevisionSlots instance, which can be modified to defined the slots for this revision.

Returns: MutableRevisionSlots

Reimplemented from MediaWiki\Revision\RevisionRecord.

Definition at line 325 of file MutableRevisionRecord.php.

◆ inheritSlot()

MediaWiki\Revision\MutableRevisionRecord::inheritSlot ( SlotRecord $parentSlot )

"Inherits" the given slot's content.

If a slot with the same role is already present in the revision, it is replaced.

Note: This may cause the slot meta-data for the revision to be lazy-loaded.

Parameters

SlotRecord $parentSlot

Definition at line 132 of file MutableRevisionRecord.php.

References MediaWiki\Revision\MutableRevisionRecord\resetAggregateValues().

◆ newFromParentRevision()

static MediaWiki\Revision\MutableRevisionRecord::newFromParentRevision ( RevisionRecord $parent )

static

Returns an incomplete MutableRevisionRecord which uses $parent as its parent revision, and inherits all slots form it.

If saved unchanged, the new revision will act as a null-revision.

Parameters

RevisionRecord $parent

Returns: MutableRevisionRecord

Definition at line 52 of file MutableRevisionRecord.php.

References $parent, $rev, $title, and as.

Referenced by MediaWiki\Revision\RevisionStore\newNullRevision().

◆ removeSlot()

MediaWiki\Revision\MutableRevisionRecord::removeSlot ( $role )

Removes the slot with the given role from this revision.

This effectively ends the "stream" with that role on the revision's page. Future revisions will no longer inherit this slot, unless it is added back explicitly.

Note: This may cause the slot meta-data for the revision to be lazy-loaded.; Calling this method will cause the revision size and hash to be re-calculated upon the next call to getSize() and getSha1(), respectively.

Parameters

string $role

Definition at line 168 of file MutableRevisionRecord.php.

References MediaWiki\Revision\MutableRevisionRecord\resetAggregateValues().

◆ resetAggregateValues()

MediaWiki\Revision\MutableRevisionRecord::resetAggregateValues ( )

private

Invalidate cached aggregate values such as hash and size.

Definition at line 333 of file MutableRevisionRecord.php.

Referenced by MediaWiki\Revision\MutableRevisionRecord\inheritSlot(), MediaWiki\Revision\MutableRevisionRecord\removeSlot(), MediaWiki\Revision\MutableRevisionRecord\setContent(), and MediaWiki\Revision\MutableRevisionRecord\setSlot().

◆ setComment()

MediaWiki\Revision\MutableRevisionRecord::setComment ( CommentStoreComment $comment )

Parameters

CommentStoreComment $comment

Definition at line 185 of file MutableRevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionStore\initializeMutableRevisionFromArray().

◆ setContent()

MediaWiki\Revision\MutableRevisionRecord::setContent	(		$role,
		Content	$content
	)

Sets the content for the slot with the given role.

If a slot with the same role is already present in the revision, it is replaced. Calling code that has access to a SlotRecord can use inheritSlot() instead.

Note: This may cause the slot meta-data for the revision to be lazy-loaded.; Calling this method will cause the revision size and hash to be re-calculated upon the next call to getSize() and getSha1(), respectively.

Parameters

string	$role
Content	$content

Definition at line 151 of file MutableRevisionRecord.php.

References $content, and MediaWiki\Revision\MutableRevisionRecord\resetAggregateValues().

◆ setId()

MediaWiki\Revision\MutableRevisionRecord::setId ( $id )

Set the revision ID.

MCR migration note: this replaces Revision::setId()

Warning: Use this with care, especially when preparing a revision for insertion into the database! The revision ID should only be fixed in special cases like preserving the original ID when restoring a revision.

Parameters

int $id

Definition at line 257 of file MutableRevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionStore\initializeMutableRevisionFromArray().

◆ setMinorEdit()

MediaWiki\Revision\MutableRevisionRecord::setMinorEdit ( $minorEdit )

Parameters

bool $minorEdit

Definition at line 240 of file MutableRevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionStore\initializeMutableRevisionFromArray().

◆ setPageId()

MediaWiki\Revision\MutableRevisionRecord::setPageId ( $pageId )

Parameters

int $pageId

Definition at line 275 of file MutableRevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionStore\initializeMutableRevisionFromArray().

◆ setParentId()

MediaWiki\Revision\MutableRevisionRecord::setParentId ( $parentId )

Parameters

int $parentId

Definition at line 89 of file MutableRevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionStore\initializeMutableRevisionFromArray().

◆ setSha1()

MediaWiki\Revision\MutableRevisionRecord::setSha1 ( $sha1 )

Set revision hash, for optimization.

Prevents getSha1() from re-calculating the hash.

Note: This should only be used if the calling code is sure that the given hash is correct for the revision's content, and there is no chance of the content being manipulated later. When in doubt, this method should not be called.

Parameters

string $sha1 SHA1 hash as a base36 string.

Definition at line 198 of file MutableRevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionStore\initializeMutableRevisionFromArray().

◆ setSize()

MediaWiki\Revision\MutableRevisionRecord::setSize ( $size )

Set nominal revision size, for optimization.

Prevents getSize() from re-calculating the size.

Note: This should only be used if the calling code is sure that the given size is correct for the revision's content, and there is no chance of the content being manipulated later. When in doubt, this method should not be called.

Parameters

int $size nominal size in bogo-bytes

Definition at line 213 of file MutableRevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionStore\initializeMutableRevisionFromArray().

◆ setSlot()

MediaWiki\Revision\MutableRevisionRecord::setSlot ( SlotRecord $slot )

Sets the given slot.

If a slot with the same role is already present in the revision, it is replaced.

Note: This can only be used with a fresh "unattached" SlotRecord. Calling code that has a SlotRecord from another revision should use inheritSlot(). Calling code that has access to a Content object can use setContent().; This may cause the slot meta-data for the revision to be lazy-loaded.; Calling this method will cause the revision size and hash to be re-calculated upon the next call to getSize() and getSha1(), respectively.

Parameters

SlotRecord $slot

Definition at line 110 of file MutableRevisionRecord.php.

References MediaWiki\Revision\SlotRecord\getRevision(), MediaWiki\Revision\SlotRecord\hasRevision(), and MediaWiki\Revision\MutableRevisionRecord\resetAggregateValues().

◆ setTimestamp()

MediaWiki\Revision\MutableRevisionRecord::setTimestamp ( $timestamp )

Parameters

string $timestamp A timestamp understood by wfTimestamp

Definition at line 231 of file MutableRevisionRecord.php.

References wfTimestamp().

Referenced by MediaWiki\Revision\RevisionStore\initializeMutableRevisionFromArray().

◆ setUser()

MediaWiki\Revision\MutableRevisionRecord::setUser ( UserIdentity $user )

Sets the user identity associated with the revision.

Parameters

UserIdentity $user

Definition at line 268 of file MutableRevisionRecord.php.

References $user.

Referenced by MediaWiki\Revision\RevisionStore\initializeMutableRevisionFromArray().

◆ setVisibility()

MediaWiki\Revision\MutableRevisionRecord::setVisibility ( $visibility )

Parameters

int $visibility

Definition at line 222 of file MutableRevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionStore\initializeMutableRevisionFromArray().

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

includes/Revision/MutableRevisionRecord.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyUpdate()

◆ getSha1()

◆ getSize()

◆ getSlots()

◆ inheritSlot()

◆ newFromParentRevision()

◆ removeSlot()

◆ resetAggregateValues()

◆ setComment()

◆ setContent()

◆ setId()

◆ setMinorEdit()

◆ setPageId()

◆ setParentId()

◆ setSha1()

◆ setSize()

◆ setSlot()

◆ setTimestamp()

◆ setUser()

◆ setVisibility()