MediaWiki master
MediaWiki\Revision\RevisionStoreRecord Class Reference

A RevisionRecord representing an existing revision persisted in the revision table. More...

Inherits MediaWiki\Revision\RevisionRecord.

Inherited by MediaWiki\Revision\RevisionStoreCacheRecord.

Collaboration diagram for MediaWiki\Revision\RevisionStoreRecord:

Public Member Functions

 __construct (PageIdentity $page, UserIdentity $user, CommentStoreComment $comment, \stdClass $row, RevisionSlots $slots, $wikiId=self::LOCAL)
 
 getComment ( $audience=self::FOR_PUBLIC, ?Authority $performer=null)
 
 getId ( $wikiId=self::LOCAL)
 
 getSha1 ()
 
 getSize ()
 
 getTimestamp ()
 
 getUser ( $audience=self::FOR_PUBLIC, ?Authority $performer=null)
 
 isCurrent ()
 Checks whether the revision record is a stored current revision.
Since
1.35
Returns
bool

 
 isDeleted ( $field)
 MCR migration note: this replaced Revision::isDeleted.
 
 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)
 
 audienceCan ( $field, $audience, ?Authority $performer=null)
 Check that the given audience has access to the given field.
 
 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.
 
 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

bool $mCurrent = false
 
- 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 an existing revision persisted in the revision table.

RevisionStoreRecord has no optional fields, getters will never return null.

Since
1.31
1.32 Renamed from MediaWiki\Storage\RevisionStoreRecord

Definition at line 39 of file RevisionStoreRecord.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Revision\RevisionStoreRecord::__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$pageThe page this RevisionRecord is associated with.
UserIdentity$user
CommentStoreComment$comment
\\stdClass$rowA row from the revision table. Use RevisionStore::getQueryInfo() to build a query that yields the required fields.
RevisionSlots$slotsThe slots of this revision.
false | string$wikiIdRelevant wiki id or self::LOCAL for the current one.

Definition at line 56 of file RevisionStoreRecord.php.

References MediaWiki\Revision\RevisionRecord\$wikiId, and MediaWiki\Revision\RevisionStoreRecord\getTimestamp().

Member Function Documentation

◆ getComment()

MediaWiki\Revision\RevisionStoreRecord::getComment ( $audience = self::FOR_PUBLIC,
?Authority $performer = null )
Parameters
int$audience
Authority | null$performer
Returns
CommentStoreComment The revision comment, null if access is forbidden.

Reimplemented from MediaWiki\Revision\RevisionRecord.

Definition at line 189 of file RevisionStoreRecord.php.

◆ getId()

MediaWiki\Revision\RevisionStoreRecord::getId ( $wikiId = self::LOCAL)
Parameters
string | false$wikiIdThe wiki ID expected by the caller.
Returns
int|null The revision id, never null.

Reimplemented from MediaWiki\Revision\RevisionRecord.

Definition at line 143 of file RevisionStoreRecord.php.

References MediaWiki\Revision\RevisionRecord\$wikiId.

◆ getSha1()

MediaWiki\Revision\RevisionStoreRecord::getSha1 ( )
Exceptions
RevisionAccessExceptionif the hash was unknown and could not be calculated.
Returns
string The revision hash, never null. May be computed on the fly.

Reimplemented from MediaWiki\Revision\RevisionRecord.

Definition at line 164 of file RevisionStoreRecord.php.

References MediaWiki\Revision\RevisionRecord\$mSha1.

◆ getSize()

MediaWiki\Revision\RevisionStoreRecord::getSize ( )
Exceptions
RevisionAccessExceptionif the size was unknown and could not be calculated.
Returns
int The nominal revision size, never null. May be computed on the fly.

Reimplemented from MediaWiki\Revision\RevisionRecord.

Definition at line 152 of file RevisionStoreRecord.php.

References MediaWiki\Revision\RevisionRecord\$mSize.

◆ getTimestamp()

MediaWiki\Revision\RevisionStoreRecord::getTimestamp ( )
Returns
string timestamp, never null

Reimplemented from MediaWiki\Revision\RevisionRecord.

Definition at line 197 of file RevisionStoreRecord.php.

Referenced by MediaWiki\Revision\RevisionStoreRecord\__construct().

◆ getUser()

MediaWiki\Revision\RevisionStoreRecord::getUser ( $audience = self::FOR_PUBLIC,
?Authority $performer = null )
Parameters
int$audience
Authority | null$performer
Returns
UserIdentity The identity of the revision author, null if access is forbidden.

Reimplemented from MediaWiki\Revision\RevisionRecord.

Reimplemented in MediaWiki\Revision\RevisionStoreCacheRecord.

Definition at line 178 of file RevisionStoreRecord.php.

◆ isCurrent()

MediaWiki\Revision\RevisionStoreRecord::isCurrent ( )

Checks whether the revision record is a stored current revision.

Since
1.35
Returns
bool

Reimplemented from MediaWiki\Revision\RevisionRecord.

Definition at line 106 of file RevisionStoreRecord.php.

References MediaWiki\Revision\RevisionStoreRecord\$mCurrent.

Referenced by MediaWiki\Revision\RevisionStoreRecord\isDeleted(), and MediaWiki\Revision\RevisionStoreRecord\userCan().

◆ isDeleted()

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

MCR migration note: this replaced Revision::isDeleted.

Parameters
int$fieldOne of DELETED_* bitfield constants
Returns
bool

Reimplemented from MediaWiki\Revision\RevisionRecord.

Definition at line 117 of file RevisionStoreRecord.php.

References MediaWiki\Revision\RevisionStoreRecord\isCurrent().

◆ isReadyForInsertion()

MediaWiki\Revision\RevisionStoreRecord::isReadyForInsertion ( )
See also
RevisionStore::isComplete
Returns
bool always true.

Reimplemented from MediaWiki\Revision\RevisionRecord.

Definition at line 207 of file RevisionStoreRecord.php.

◆ userCan()

MediaWiki\Revision\RevisionStoreRecord::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$fieldOne of self::DELETED_TEXT, self::DELETED_COMMENT, self::DELETED_USER
Authority$performeruser on whose behalf to check
Returns
bool

Reimplemented from MediaWiki\Revision\RevisionRecord.

Definition at line 128 of file RevisionStoreRecord.php.

References MediaWiki\Revision\RevisionStoreRecord\isCurrent().

Member Data Documentation

◆ $mCurrent

bool MediaWiki\Revision\RevisionStoreRecord::$mCurrent = false
protected

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