Page revision base class. More...

Inherits MediaWiki\DAO\WikiAwareEntity.

Inherited by MediaWiki\Revision\MutableRevisionRecord, MediaWiki\Revision\RevisionArchiveRecord, and MediaWiki\Revision\RevisionStoreRecord.

Collaboration diagram for MediaWiki\Revision\RevisionRecord:

[legend]

Public Member Functions
	__construct (PageIdentity $page, RevisionSlots $slots, $wikiId=self::LOCAL)

	audienceCan ( $field, $audience, ?Authority $performer=null)
	Check that the given audience has access to the given field.

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

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

	getContentOrThrow ( $role, $audience=self::FOR_PUBLIC, ?Authority $performer=null)
	Get the Content of the given slot of this revision.

	getId ( $wikiId=self::LOCAL)
	Get revision ID.

	getInheritedSlots ()
	Returns slots inherited from some previous revision.

	getMainContentModel ()
	Returns the content model of the main slot of this revision.

	getMainContentRaw ()
	Returns the Content of the main slot of this revision.

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

	getPage ()
	Returns the page this revision belongs to.

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

	getPageId ( $wikiId=self::LOCAL)
	Get the page ID.

	getParentId ( $wikiId=self::LOCAL)
	Get parent revision ID (the original previous page revision).

	getPrimarySlots ()
	Returns primary slots (those that are not derived).

	getSha1 ()
	Returns the base36 sha1 of this revision.

	getSize ()
	Returns the nominal size of this revision, in bogo-bytes.

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

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

	getSlots ()
	Returns the slots defined for this revision.

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

	getUser ( $audience=self::FOR_PUBLIC, ?Authority $performer=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.

	isCurrent ()
	Checks whether the revision record is a stored current revision.

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

	isMinor ()
	MCR migration note: this replaced 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.

	userCan ( $field, Authority $performer)
	Determine if the give authority is allowed to view a particular field of this revision, if it's marked as deleted.

Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity
	assertWiki ( $wikiId)
	Throws if $wikiId is different from the return value of getWikiId().

Static Public Member Functions
static	userCanBitfield ( $bitfield, $field, Authority $performer, ?PageIdentity $page=null)
	Determine if the current user is allowed to view a particular field of this revision, if it's marked as deleted.

Public Attributes
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 Attributes
CommentStoreComment null	$mComment

int	$mDeleted = 0
	using the DELETED_XXX and SUPPRESSED_XXX flags

int null	$mId

bool	$mMinorEdit = false

PageIdentity	$mPage

int	$mPageId

int null	$mParentId

string null	$mSha1

int null	$mSize

RevisionSlots	$mSlots

string null	$mTimestamp

UserIdentity null	$mUser

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

Detailed Description

Page revision base class.

RevisionRecords are considered value objects, but they may use callbacks for lazy loading. Note that while the base class has no setters, subclasses may offer a mutable interface.

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

Definition at line 49 of file RevisionRecord.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Revision\RevisionRecord::__construct	(	PageIdentity	$page,
		RevisionSlots	$slots,
			$wikiId = self::LOCAL )

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

Parameters

PageIdentity	$page	The page this RevisionRecord is associated with.
RevisionSlots	$slots	The slots of this revision.
false \| string	$wikiId	Relevant wiki id or self::LOCAL for the current one.

Definition at line 105 of file RevisionRecord.php.

References MediaWiki\Revision\RevisionRecord\$wikiId, and MediaWiki\Page\PageIdentity\canExist().

Member Function Documentation

◆ audienceCan()

MediaWiki\Revision\RevisionRecord::audienceCan	(		$field,
			$audience,
		?Authority	$performer = null )

Check that the given audience has access to the given field.

MCR migration note: this corresponded to Revision::userCan

Parameters

int	$field	One of self::DELETED_TEXT, self::DELETED_COMMENT, self::DELETED_USER
int	$audience	One of: RevisionRecord::FOR_PUBLIC to be displayed to all users RevisionRecord::FOR_THIS_USER to be displayed to the given user RevisionRecord::RAW get the text regardless of permissions
Authority \| null	$performer	user on whose behalf to check

Returns: bool

Reimplemented in MediaWiki\Revision\RevisionArchiveRecord.

Definition at line 530 of file RevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionRenderer\getRenderedRevision().

◆ getComment()

MediaWiki\Revision\RevisionRecord::getComment	(		$audience = self::FOR_PUBLIC,
		?Authority	$performer = null )

Fetch revision comment, if it's available to the specified audience.

If the specified audience does not have access to the comment, this will return null. Depending on the concrete subclass, null may also be returned if the comment is not yet specified.

MCR migration note: this replaced Revision::getComment

Parameters

int	$audience	One of: RevisionRecord::FOR_PUBLIC to be displayed to all users RevisionRecord::FOR_THIS_USER to be displayed to the given user RevisionRecord::RAW get the text regardless of permissions
Authority \| null	$performer	user on whose behalf to check

Returns: CommentStoreComment|null

Reimplemented in MediaWiki\Revision\RevisionArchiveRecord, and MediaWiki\Revision\RevisionStoreRecord.

Definition at line 464 of file RevisionRecord.php.

Referenced by MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo(), MediaWiki\Api\ApiFeedContributions\feedItemDesc(), and MediaWiki\Revision\RevisionStore\insertRevisionOn().

◆ getContent()

MediaWiki\Revision\RevisionRecord::getContent	(		$role,
			$audience = self::FOR_PUBLIC,
		?Authority	$performer = null )

Returns the Content of the given slot of this revision.

Call getSlotNames() to get a list of available slots.

Note that for mutable Content objects, each call to this method will return a fresh clone.

Use getContentOrThrow() for more specific error information.

Parameters

string	$role	The role name of the desired slot
int	$audience
Authority \| null	$performer	user on whose behalf to check

Returns: Content|null The content of the given slot, or null on error

Exceptions

RevisionAccessException

Definition at line 184 of file RevisionRecord.php.

Referenced by MediaWiki\Api\ApiFeedContributions\feedItemDesc(), MediaWiki\Page\WikiPage\replaceSectionAtRev(), DifferenceEngine\setRevisions(), and MediaWiki\Page\WikiPage\updateRevisionOn().

◆ getContentOrThrow()

MediaWiki\Revision\RevisionRecord::getContentOrThrow	(		$role,
			$audience = self::FOR_PUBLIC,
		?Authority	$performer = null )

Get the Content of the given slot of this revision.

Parameters

string	$role	The role name of the desired slot
int	$audience
Authority \| null	$performer	user on whose behalf to check

Returns: Content

Exceptions

SuppressedDataException	if the content is not viewable by the given audience
BadRevisionException	if the content is missing or corrupted
RevisionAccessException

Definition at line 215 of file RevisionRecord.php.

◆ getId()

MediaWiki\Revision\RevisionRecord::getId ( $wikiId = self::LOCAL )

Get revision ID.

Depending on the concrete subclass, this may return null if the revision ID is not known (e.g. because the revision does not yet exist in the database).

MCR migration note: this replaced Revision::getId

Parameters

string | false $wikiId The wiki ID expected by the caller.

Returns: int|null

Reimplemented in MediaWiki\Revision\RevisionArchiveRecord, and MediaWiki\Revision\RevisionStoreRecord.

Definition at line 332 of file RevisionRecord.php.

Referenced by MediaWiki\Pager\PagerTools\__construct(), MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo(), MediaWiki\Revision\RevisionStore\getRecentChange(), MediaWiki\Revision\RevisionRenderer\getRenderedRevision(), MediaWiki\Linker\Linker\getRevDeleteLink(), DifferenceEngine\getRevisionHeader(), MediaWiki\Revision\RevisionStore\insertRevisionOn(), DifferenceEngine\loadRevisionData(), MediaWiki\Revision\MutableRevisionRecord\newFromParentRevision(), MediaWiki\Page\ParserOutputAccess\newPoolWorkArticleView(), MediaWiki\Page\WikiPage\onArticleEdit(), MediaWiki\Storage\DerivedPageDataUpdater\prepareUpdate(), MediaWiki\RecentChanges\ChangesList\revDateLink(), MediaWiki\Linker\Linker\revUserTools(), MediaWiki\Parser\RevisionOutputCache\save(), DifferenceEngine\setRevisions(), MediaWiki\Revision\RenderedRevision\updateRevision(), and MediaWiki\Page\WikiPage\updateRevisionOn().

◆ getInheritedSlots()

MediaWiki\Revision\RevisionRecord::getInheritedSlots ( )

Returns slots inherited from some previous revision.

"Inherited" slots are all slots that do not originate in this revision. Note that these slots may still differ from the one in the parent revision. This is the case for rollbacks: slots of a rollback revision are inherited from the rollback target, and are different from the slots in the parent revision, which was rolled back.

Definition at line 308 of file RevisionRecord.php.

◆ getMainContentModel()

MediaWiki\Revision\RevisionRecord::getMainContentModel ( )

Returns the content model of the main slot of this revision.

Returns: string The content model

Exceptions

RevisionAccessException

Definition at line 199 of file RevisionRecord.php.

Referenced by MediaWiki\ResourceLoader\WikiModule\invalidateModuleCache(), and MediaWiki\Page\WikiPage\updateRevisionOn().

◆ getMainContentRaw()

MediaWiki\Revision\RevisionRecord::getMainContentRaw ( )

Returns the Content of the main slot of this revision.

See also: getContent()

Returns: Content|null The content of the main slot, or null on error

Exceptions

RevisionAccessException

Definition at line 164 of file RevisionRecord.php.

◆ getOriginalSlots()

MediaWiki\Revision\RevisionRecord::getOriginalSlots ( )

Returns the slots that originate in this revision.

Note that this does not include any slots inherited from some earlier revision, even if they are different from the slots in the immediate parent revision. This is the case for rollbacks: slots of a rollback revision are inherited from the rollback target, and are different from the slots in the parent revision, which was rolled back.

To find all slots modified by this revision against its immediate parent revision, use RevisionSlotsUpdate::newFromRevisionSlots().

Definition at line 295 of file RevisionRecord.php.

◆ getPage()

MediaWiki\Revision\RevisionRecord::getPage ( )

Returns the page this revision belongs to.

MCR migration note: this replaced Revision::getTitle

Since: 1.36

Returns: PageIdentity

Reimplemented in MediaWiki\Revision\RevisionArchiveRecord, and MediaWiki\Revision\RevisionStoreRecord.

Definition at line 421 of file RevisionRecord.php.

Referenced by MediaWiki\Page\Event\PageRevisionUpdatedEvent\__construct(), DifferenceEngine\getRevisionHeader(), MediaWiki\Revision\RevisionStore\insertRevisionOn(), MediaWiki\Revision\MutableRevisionRecord\newFromParentRevision(), and DifferenceEngine\setRevisions().

◆ getPageAsLinkTarget()

MediaWiki\Revision\RevisionRecord::getPageAsLinkTarget ( )

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

Exceptions

InvalidArgumentException if this revision does not belong to a local wiki

Returns: LinkTarget

Definition at line 408 of file RevisionRecord.php.

Referenced by MediaWiki\Linker\Linker\buildRollbackLink(), MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo(), DifferenceEngine\getRevisionHeader(), and MediaWiki\RecentChanges\ChangesList\revDateLink().

◆ getPageId()

MediaWiki\Revision\RevisionRecord::getPageId ( $wikiId = self::LOCAL )

Get the page ID.

If the page does not yet exist, the page ID is 0.

MCR migration note: this replaced Revision::getPage

Parameters

string | false $wikiId The wiki ID expected by the caller.

Returns: int

Definition at line 388 of file RevisionRecord.php.

Referenced by MediaWiki\PoolCounter\PoolWorkArticleViewCurrent\__construct(), MediaWiki\Linker\Linker\getRollbackEditCount(), MediaWiki\Revision\RevisionStore\insertRevisionOn(), and MediaWiki\Revision\MutableRevisionRecord\newFromParentRevision().

◆ getParentId()

MediaWiki\Revision\RevisionRecord::getParentId ( $wikiId = self::LOCAL )

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

If there is no parent revision, this returns 0. If the parent revision is undefined or unknown, this returns null.

Note: As of MW 1.31, the database schema allows the parent ID to be NULL to indicate that it is unknown.

MCR migration note: this replaced Revision::getParentId

Parameters

string | false $wikiId The wiki ID expected by the caller.

Returns: int|null

Definition at line 350 of file RevisionRecord.php.

Referenced by MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo(), MediaWiki\Revision\RevisionStore\insertRevisionOn(), MediaWiki\JobQueue\Jobs\CategoryMembershipChangeJob\notifyUpdatesForRevision(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareUpdate().

◆ getPrimarySlots()

MediaWiki\Revision\RevisionRecord::getPrimarySlots ( )

Returns primary slots (those that are not derived).

Returns: RevisionSlots

Since: 1.36

Definition at line 318 of file RevisionRecord.php.

◆ getSha1()

MediaWiki\Revision\RevisionRecord::getSha1 ( )

abstract

Returns the base36 sha1 of this revision.

This hash is derived from the hashes of all slots associated with the revision. May be calculated on the fly if not known, which may in the worst case may involve loading all content.

MCR migration note: this replaced Revision::getSha1

Exceptions

RevisionAccessException if the hash was unknown and could not be calculated.

Returns: string

Reimplemented in MediaWiki\Revision\MutableRevisionRecord, MediaWiki\Revision\RevisionArchiveRecord, and MediaWiki\Revision\RevisionStoreRecord.

Referenced by MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo(), and MediaWiki\Revision\RevisionStore\insertRevisionOn().

◆ getSize()

MediaWiki\Revision\RevisionRecord::getSize ( )

abstract

Returns the nominal size of this revision, in bogo-bytes.

May be calculated on the fly if not known, which may in the worst case may involve loading all content.

MCR migration note: this replaced Revision::getSize

Exceptions

RevisionAccessException if the size was unknown and could not be calculated.

Returns: int

Reimplemented in MediaWiki\Revision\MutableRevisionRecord, MediaWiki\Revision\RevisionArchiveRecord, and MediaWiki\Revision\RevisionStoreRecord.

Referenced by MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo(), and MediaWiki\Revision\RevisionStore\insertRevisionOn().

◆ getSlot()

MediaWiki\Revision\RevisionRecord::getSlot	(		$role,
			$audience = self::FOR_PUBLIC,
		?Authority	$performer = null )

Returns meta-data for the given slot.

Parameters

string	$role	The role name of the desired slot
int	$audience
Authority \| null	$performer	user on whose behalf to check

Exceptions

RevisionAccessException if the slot does not exist or slot data could not be lazy-loaded.

Returns: SlotRecord The slot meta-data. If access to the slot's content is forbidden, calling getContent() on the SlotRecord will throw an exception.

Definition at line 237 of file RevisionRecord.php.

Referenced by PrewarmParsoidParserCache\execute(), MediaWiki\Revision\RevisionStore\insertRevisionOn(), and MediaWiki\Revision\MutableRevisionRecord\newFromParentRevision().

◆ getSlotRoles()

MediaWiki\Revision\RevisionRecord::getSlotRoles ( )

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

getContent() will succeed only for the names returned by this method.

Returns: string[]

Definition at line 264 of file RevisionRecord.php.

Referenced by MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo(), MediaWiki\Revision\RevisionStore\insertRevisionOn(), and MediaWiki\Revision\MutableRevisionRecord\newFromParentRevision().

◆ getSlots()

MediaWiki\Revision\RevisionRecord::getSlots ( )

Returns the slots defined for this revision.

Note: This provides access to slot content with no audience checks applied. Calling getContent() on the RevisionSlots object returned here, or on any SlotRecord it returns from getSlot(), will not fail due to access restrictions. If audience checks are desired, use getSlot( $role, $audience, $performer ) or getContent( $role, $audience, $performer ) instead.

Returns: RevisionSlots

Reimplemented in MediaWiki\Revision\MutableRevisionRecord.

Definition at line 279 of file RevisionRecord.php.

Referenced by MediaWiki\Page\WikiPage\hasDifferencesOutsideMainSlot(), MediaWiki\Storage\DerivedPageDataUpdater\prepareUpdate(), and MediaWiki\Revision\RenderedRevision\updateRevision().

◆ getTimestamp()

MediaWiki\Revision\RevisionRecord::getTimestamp ( )

MCR migration note: this replaced Revision::getTimestamp.

May return null if the timestamp was not specified.

Returns: string|null

Reimplemented in MediaWiki\Revision\RevisionArchiveRecord, and MediaWiki\Revision\RevisionStoreRecord.

Definition at line 510 of file RevisionRecord.php.

Referenced by MediaWiki\Page\Event\PageRevisionUpdatedEvent\__construct(), MediaWiki\RecentChanges\CategoryMembershipChange\__construct(), MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo(), MediaWiki\Revision\RevisionRenderer\getRenderedRevision(), MediaWiki\Linker\Linker\getRevDeleteLink(), DifferenceEngine\getRevisionHeader(), MediaWiki\Revision\RevisionStore\insertRevisionOn(), MediaWiki\RecentChanges\ChangesList\revDateLink(), MediaWiki\Parser\RevisionOutputCache\save(), and MediaWiki\Page\WikiPage\updateRevisionOn().

◆ getUser()

MediaWiki\Revision\RevisionRecord::getUser	(		$audience = self::FOR_PUBLIC,
		?Authority	$performer = null )

Fetch revision's author's user identity, if it's available to the specified audience.

If the specified audience does not have access to it, null will be returned. Depending on the concrete subclass, null may also be returned if the user is not yet specified.

MCR migration note: this replaced Revision::getUser

Parameters

int	$audience	One of: RevisionRecord::FOR_PUBLIC to be displayed to all users RevisionRecord::FOR_THIS_USER to be displayed to the given user RevisionRecord::RAW get the ID regardless of permissions
Authority \| null	$performer	user on whose behalf to check

Returns: UserIdentity|null

Reimplemented in MediaWiki\Revision\RevisionArchiveRecord, MediaWiki\Revision\RevisionStoreCacheRecord, and MediaWiki\Revision\RevisionStoreRecord.

Definition at line 440 of file RevisionRecord.php.

Referenced by MediaWiki\Pager\PagerTools\__construct(), MediaWiki\Linker\Linker\buildRollbackLink(), MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo(), MediaWiki\Api\ApiFeedContributions\feedItemAuthor(), MediaWiki\Page\WikiPage\getCreator(), MediaWiki\Linker\Linker\getRollbackEditCount(), MediaWiki\Revision\RevisionStore\insertRevisionOn(), MediaWiki\Storage\DerivedPageDataUpdater\prepareUpdate(), MediaWiki\Linker\Linker\revUserLink(), and MediaWiki\Linker\Linker\revUserTools().

◆ getVisibility()

MediaWiki\Revision\RevisionRecord::getVisibility ( )

Get the deletion bitfield of the revision.

MCR migration note: this replaced Revision::getVisibility

Returns: int

Reimplemented in MediaWiki\Revision\RevisionStoreCacheRecord.

Definition at line 499 of file RevisionRecord.php.

Referenced by MediaWiki\Linker\Linker\getRevDeleteLink().

◆ getWikiId()

MediaWiki\Revision\RevisionRecord::getWikiId ( )

Get the ID of the wiki this revision belongs to.

Returns: string|false The wiki's logical name, of false to indicate the local wiki.

Implements MediaWiki\DAO\WikiAwareEntity.

Definition at line 398 of file RevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionRenderer\getRenderedRevision(), and MediaWiki\Revision\MutableRevisionRecord\newFromParentRevision().

◆ hasSameContent()

MediaWiki\Revision\RevisionRecord::hasSameContent ( RevisionRecord $rec )

Parameters

RevisionRecord $rec

Returns: bool True if this RevisionRecord is known to have same content as $rec. False if the content is different (or not known to be the same).

Definition at line 133 of file RevisionRecord.php.

◆ hasSlot()

MediaWiki\Revision\RevisionRecord::hasSlot ( $role )

Returns whether the given slot is defined in this revision.

Parameters

string $role The role name of the desired slot

Returns: bool

Definition at line 254 of file RevisionRecord.php.

◆ isCurrent()

MediaWiki\Revision\RevisionRecord::isCurrent ( )

Checks whether the revision record is a stored current revision.

Since: 1.35

Returns: bool

Reimplemented in MediaWiki\Revision\RevisionStoreRecord.

Definition at line 638 of file RevisionRecord.php.

Referenced by DifferenceEngine\getRevisionHeader().

◆ isDeleted()

MediaWiki\Revision\RevisionRecord::isDeleted ( $field )

MCR migration note: this replaced Revision::isDeleted.

Parameters

int $field One of DELETED_* bitfield constants

Returns: bool

Reimplemented in MediaWiki\Revision\RevisionStoreRecord.

Definition at line 488 of file RevisionRecord.php.

Referenced by MediaWiki\Pager\PagerTools\__construct(), MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo(), MediaWiki\Linker\Linker\getRevDeleteLink(), DifferenceEngine\getRevisionHeader(), MediaWiki\JobQueue\Jobs\CategoryMembershipChangeJob\notifyUpdatesForRevision(), MediaWiki\RecentChanges\ChangesList\revDateLink(), MediaWiki\Linker\Linker\revUserLink(), and MediaWiki\Linker\Linker\revUserTools().

◆ isMinor()

MediaWiki\Revision\RevisionRecord::isMinor ( )

MCR migration note: this replaced Revision::isMinor.

Returns: bool

Definition at line 477 of file RevisionRecord.php.

Referenced by MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo().

◆ isReadyForInsertion()

MediaWiki\Revision\RevisionRecord::isReadyForInsertion ( )

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

This should trivially be true for RevisionRecords loaded from the database.

Note that this may return true even if getId() or getPage() return null or 0, since these are generally assigned while the revision is saved to the database, and may not be available before.

Returns: bool

Reimplemented in MediaWiki\Revision\RevisionArchiveRecord, and MediaWiki\Revision\RevisionStoreRecord.

Definition at line 619 of file RevisionRecord.php.

References getTimestamp().

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

◆ userCan()

MediaWiki\Revision\RevisionRecord::userCan	(		$field,
		Authority	$performer )

Determine if the give authority is allowed to view a particular field of this revision, if it's marked as deleted.

MCR migration note: this corresponded to Revision::userCan

Parameters

int	$field	One of self::DELETED_TEXT, self::DELETED_COMMENT, self::DELETED_USER
Authority	$performer	user on whose behalf to check

Returns: bool

Reimplemented in MediaWiki\Revision\RevisionArchiveRecord, and MediaWiki\Revision\RevisionStoreRecord.

Definition at line 560 of file RevisionRecord.php.

Referenced by MediaWiki\Linker\Linker\getRevDeleteLink(), and MediaWiki\RecentChanges\ChangesList\revDateLink().

◆ userCanBitfield()

static MediaWiki\Revision\RevisionRecord::userCanBitfield	(		$bitfield,
			$field,
		Authority	$performer,
		?PageIdentity	$page = null )

static

Determine if the current user is allowed to view a particular field of this revision, if it's marked as deleted.

This is used by various classes to avoid duplication.

MCR migration note: this replaced Revision::userCanBitfield

Parameters

int	$bitfield	Current field
int	$field	One of self::DELETED_TEXT = File::DELETED_FILE, self::DELETED_COMMENT = File::DELETED_COMMENT, self::DELETED_USER = File::DELETED_USER
Authority	$performer	user on whose behalf to check
PageIdentity \| null	$page	A PageIdentity object to check for per-page restrictions on, instead of just plain user rights

Returns: bool

Definition at line 580 of file RevisionRecord.php.

References MediaWiki\Permissions\Authority\authorizeRead(), MediaWiki\Permissions\Authority\isAllowedAny(), and wfDebug().

Member Data Documentation

◆ $mComment

CommentStoreComment null MediaWiki\Revision\RevisionRecord::$mComment

protected

Definition at line 89 of file RevisionRecord.php.

◆ $mDeleted

int MediaWiki\Revision\RevisionRecord::$mDeleted = 0

protected

using the DELETED_XXX and SUPPRESSED_XXX flags

Definition at line 81 of file RevisionRecord.php.

◆ $mId

int null MediaWiki\Revision\RevisionRecord::$mId

protected

Definition at line 71 of file RevisionRecord.php.

◆ $mMinorEdit

bool MediaWiki\Revision\RevisionRecord::$mMinorEdit = false

protected

Definition at line 77 of file RevisionRecord.php.

◆ $mPage

PageIdentity MediaWiki\Revision\RevisionRecord::$mPage

protected

Definition at line 92 of file RevisionRecord.php.

◆ $mPageId

int MediaWiki\Revision\RevisionRecord::$mPageId

protected

Definition at line 73 of file RevisionRecord.php.

◆ $mParentId

int null MediaWiki\Revision\RevisionRecord::$mParentId

protected

Definition at line 87 of file RevisionRecord.php.

◆ $mSha1

string null MediaWiki\Revision\RevisionRecord::$mSha1

protected

Definition at line 85 of file RevisionRecord.php.

◆ $mSize

int null MediaWiki\Revision\RevisionRecord::$mSize

protected

Definition at line 83 of file RevisionRecord.php.

◆ $mSlots

RevisionSlots MediaWiki\Revision\RevisionRecord::$mSlots

protected

Definition at line 95 of file RevisionRecord.php.

◆ $mTimestamp

string null MediaWiki\Revision\RevisionRecord::$mTimestamp

protected

Definition at line 79 of file RevisionRecord.php.

◆ $mUser

UserIdentity null MediaWiki\Revision\RevisionRecord::$mUser

protected

Definition at line 75 of file RevisionRecord.php.

◆ $wikiId

string false MediaWiki\Revision\RevisionRecord::$wikiId = false

protected

Wiki ID; false means the current wiki.

Definition at line 69 of file RevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionRecord\__construct(), MediaWiki\Revision\RevisionStoreRecord\__construct(), and MediaWiki\Revision\RevisionArchiveRecord\__construct().

◆ DELETED_COMMENT

const MediaWiki\Revision\RevisionRecord::DELETED_COMMENT = 2

Definition at line 56 of file RevisionRecord.php.

◆ DELETED_RESTRICTED

const MediaWiki\Revision\RevisionRecord::DELETED_RESTRICTED = 8

Definition at line 58 of file RevisionRecord.php.

◆ DELETED_TEXT

const MediaWiki\Revision\RevisionRecord::DELETED_TEXT = 1

Definition at line 55 of file RevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionRenderer\getRenderedRevision(), and MediaWiki\Revision\RenderedRevision\isContentDeleted().

◆ DELETED_USER

const MediaWiki\Revision\RevisionRecord::DELETED_USER = 4

Definition at line 57 of file RevisionRecord.php.

◆ FOR_PUBLIC

const MediaWiki\Revision\RevisionRecord::FOR_PUBLIC = 1

Definition at line 64 of file RevisionRecord.php.

Referenced by MediaWiki\Revision\RevisionRenderer\getRenderedRevision().

◆ FOR_THIS_USER

const MediaWiki\Revision\RevisionRecord::FOR_THIS_USER = 2

Definition at line 65 of file RevisionRecord.php.

Referenced by MediaWiki\Revision\RenderedRevision\__construct(), and MediaWiki\Revision\RevisionRenderer\getRenderedRevision().

◆ RAW

const MediaWiki\Revision\RevisionRecord::RAW = 3

Definition at line 66 of file RevisionRecord.php.

◆ SUPPRESSED_ALL

const MediaWiki\Revision\RevisionRecord::SUPPRESSED_ALL

Initial value:

= self::DELETED_TEXT | self::DELETED_COMMENT | self::DELETED_USER |

self::DELETED_RESTRICTED

Definition at line 60 of file RevisionRecord.php.

◆ SUPPRESSED_USER

const MediaWiki\Revision\RevisionRecord::SUPPRESSED_USER = self::DELETED_USER | self::DELETED_RESTRICTED

Definition at line 59 of file RevisionRecord.php.

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

includes/Revision/RevisionRecord.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ audienceCan()

◆ getComment()

◆ getContent()

◆ getContentOrThrow()

◆ getId()

◆ getInheritedSlots()

◆ getMainContentModel()

◆ getMainContentRaw()

◆ getOriginalSlots()

◆ getPage()

◆ getPageAsLinkTarget()

◆ getPageId()

◆ getParentId()

◆ getPrimarySlots()

◆ getSha1()

◆ getSize()

◆ getSlot()

◆ getSlotRoles()

◆ getSlots()

◆ getTimestamp()

◆ getUser()

◆ getVisibility()

◆ getWikiId()

◆ hasSameContent()

◆ hasSlot()

◆ isCurrent()

◆ isDeleted()

◆ isMinor()

◆ isReadyForInsertion()

◆ userCan()

◆ userCanBitfield()

Member Data Documentation

◆ $mComment

◆ $mDeleted

◆ $mId

◆ $mMinorEdit

◆ $mPage

◆ $mPageId

◆ $mParentId

◆ $mSha1

◆ $mSize

◆ $mSlots

◆ $mTimestamp

◆ $mUser

◆ $wikiId

◆ DELETED_COMMENT

◆ DELETED_RESTRICTED

◆ DELETED_TEXT

◆ DELETED_USER

◆ FOR_PUBLIC

◆ FOR_THIS_USER

◆ RAW

◆ SUPPRESSED_ALL

◆ SUPPRESSED_USER