A RevisionRecord representing a revision of a deleted page persisted in the archive table. More...

Inherits MediaWiki\Revision\RevisionRecord.

Collaboration diagram for MediaWiki\Revision\RevisionArchiveRecord:

[legend]

Public Member Functions
	__construct (PageIdentity $page, UserIdentity $user, CommentStoreComment $comment, stdClass $row, RevisionSlots $slots, $wikiId=self::LOCAL)

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

	getArchiveId ()
	Get archive row ID.

	getComment ( $audience=self::FOR_PUBLIC, Authority $performer=null)

	getId ( $wikiId=self::LOCAL)

	getSha1 ()

	getSize ()

	getTimestamp ()

	getUser ( $audience=self::FOR_PUBLIC, Authority $performer=null)

	isReadyForInsertion ()

	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\Revision\RevisionRecord
	__construct (PageIdentity $page, RevisionSlots $slots, $wikiId=self::LOCAL)

	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.

	getInheritedSlots ()
	Returns slots inherited from some previous 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).

	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.

	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.

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

Protected Attributes
int	$mArchiveId

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

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.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Revision\RevisionRecord
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 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

Detailed Description

A RevisionRecord representing a revision of a deleted page persisted in the archive table.

Most getters on RevisionArchiveRecord will never return null. However, getId() and getParentId() may indeed return null if this information was not stored when the archive entry was created.

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

Definition at line 42 of file RevisionArchiveRecord.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Revision\RevisionArchiveRecord::__construct	(	PageIdentity	$page,
		UserIdentity	$user,
		CommentStoreComment	$comment,
		stdClass	$row,
		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.
UserIdentity	$user
CommentStoreComment	$comment
stdClass	$row	An archive table row. Use RevisionStore::getArchiveQueryInfo() to build a query that yields the required fields.
RevisionSlots	$slots	The slots of this revision.
false \| string	$wikiId	Relevant wiki or self::LOCAL for the current one.

Definition at line 61 of file RevisionArchiveRecord.php.

References MediaWiki\Revision\RevisionRecord\$wikiId.

Member Function Documentation

◆ audienceCan()

MediaWiki\Revision\RevisionArchiveRecord::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