Inheritance diagram for Revision:

Collaboration diagram for Revision:

[legend]

Public Member Functions
	__construct ( $row, $queryFlags=0, Title $title=null)

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

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

	getContentFormat ()
	Returns the content format for the main slot of this revision.

	getContentHandler ()
	Returns the content handler appropriate for this revision's content model.

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

	getId ()
	Get revision ID.

	getNext ()
	Get next revision for this title.

	getPage ()
	Get the page ID.

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

	getPrevious ()
	Get previous revision for this title.

	getRawComment ()
	Fetch revision comment without regard for the current user's permissions.

	getRawUser ()
	Fetch revision's user id without regard for the current user's permissions.

	getRawUserText ()
	Fetch revision's username without regard for view restrictions.

	getRecentChange ( $flags=0)
	Get the RC object belonging to the current revision, if there's one.

	getRevisionRecord ()

	getSerializedData ()
	Get original serialized data (without checking view restrictions)

	getSha1 ()
	Returns the base36 sha1 of the content in this revision, or null if unknown.

	getSize ()
	Returns the length of the text in this revision, or null if unknown.

	getTextId ()
	Get the ID of the row of the text table that contains the content of the revision's main slot, if that content is stored in the text table.

	getTimestamp ()

	getTitle ()
	Returns the title of the page associated with this entry.

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

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

	getVisibility ()
	Get the deletion bitfield of the revision.

	insertOn ( $dbw)
	Insert a new revision into the database, returning the new revision ID number on success and dies horribly on failure.

	isCurrent ()

	isDeleted ( $field)

	isMinor ()

	isUnpatrolled ()

	setId ( $id)
	Set the revision ID.

	setTitle ( $title)
	Set the title of the revision.

	setUserIdAndName ( $id, $name)
	Set the user ID/name.

	userCan ( $field, User $user=null)
	Determine if the current user is allowed to view a particular field of this revision, if it's marked as deleted.

Static Public Member Functions
static	base36Sha1 ( $text)
	Get the base 36 SHA-1 value for a string of text.

static	compressRevisionText (&$text)
	If $wgCompressRevisions is enabled, we will compress data.

static	countByPageId ( $db, $id)
	Get count of revisions per page...not very efficient.

static	countByTitle ( $db, $title)
	Get count of revisions per page...not very efficient.

static	decompressRevisionText ( $text, $flags)
	Re-converts revision text according to it's flags.

static	fetchRevision (LinkTarget $title)
	Return a wrapper for a series of database rows to fetch all of a given page's revisions in turn.

static	getArchiveQueryInfo ()
	Return the tables, fields, and join conditions to be selected to create a new archived revision object.

static	getParentLengths ( $db, array $revIds)
	Do a batched query to get the parent revision lengths.

static	getQueryInfo ( $options=[])
	Return the tables, fields, and join conditions to be selected to create a new revision object.

static	getRevisionText ( $row, $prefix='old_', $wiki=false)
	Get revision text associated with an old or archive row.

static	getTimestampFromId ( $title, $id, $flags=0)
	Get rev_timestamp from rev_id, without loading the rest of the row.

static	loadFromId ( $db, $id)
	Load a page revision from a given revision ID number.

static	loadFromPageId ( $db, $pageid, $id=0)
	Load either the current, or a specified, revision that's attached to a given page.

static	loadFromTimestamp ( $db, $title, $timestamp)
	Load the revision for the given title with the given timestamp.

static	loadFromTitle ( $db, $title, $id=0)
	Load either the current, or a specified, revision that's attached to a given page.

static	newFromArchiveRow ( $row, $overrides=[])
	Make a fake revision object from an archive table row.

static	newFromId ( $id, $flags=0)
	Load a page revision from a given revision ID number.

static	newFromPageId ( $pageId, $revId=0, $flags=0)
	Load either the current, or a specified, revision that's attached to a given page ID.

static	newFromRow ( $row)

static	newFromTitle (LinkTarget $linkTarget, $id=0, $flags=0)
	Load either the current, or a specified, revision that's attached to a given link target.

static	newKnownCurrent (IDatabase $db, $pageIdOrTitle, $revId=0)
	Load a revision based on a known page ID and current revision ID from the DB.

static	newNullRevision ( $dbw, $pageId, $summary, $minor, $user=null)
	Create a new null-revision for insertion into a page's history.

static	pageJoinCond ()
	Return the value of a select() page conds array for the page table.

static	selectArchiveFields ()
	Return the list of revision fields that should be selected to create a new revision from an archive row.

static	selectFields ()
	Return the list of revision fields that should be selected to create a new revision.

static	selectPageFields ()
	Return the list of page fields that should be selected from page table.

static	selectTextFields ()
	Return the list of text fields that should be selected to read the revision text.

static	selectUserFields ()
	Return the list of user fields that should be selected from user table.

static	userCanBitfield ( $bitfield, $field, User $user=null, Title $title=null)
	Determine if the current user is allowed to view a particular field of this revision, if it's marked as deleted.

static	userJoinCond ()
	Return the value of a select() JOIN conds array for the user table.

static	userWasLastToEdit ( $db, $pageId, $userId, $since)
	Check if no edits were made by other users since the time a user started editing the page.

Public Attributes
const	DELETED_COMMENT = RevisionRecord::DELETED_COMMENT

const	DELETED_RESTRICTED = RevisionRecord::DELETED_RESTRICTED

const	DELETED_TEXT = RevisionRecord::DELETED_TEXT

const	DELETED_USER = RevisionRecord::DELETED_USER

const	FOR_PUBLIC = RevisionRecord::FOR_PUBLIC

const	FOR_THIS_USER = RevisionRecord::FOR_THIS_USER

const	RAW = RevisionRecord::RAW

const	SUPPRESSED_ALL = RevisionRecord::SUPPRESSED_ALL

const	SUPPRESSED_USER = RevisionRecord::SUPPRESSED_USER

const	TEXT_CACHE_GROUP = SqlBlobStore::TEXT_CACHE_GROUP

Public Attributes inherited from IDBAccessObject
const	READ_LOCKING = 3
	Constants for object loading bitfield flags (higher => higher QoS)

const	READ_NONE = -1

Static Protected Member Functions
static	getBlobStore ( $wiki=false)

static	getRevisionFactory ()

static	getRevisionLookup ()

static	getRevisionStore ()

Protected Attributes
RevisionRecord	$mRecord

Private Member Functions
	ensureTitle ( $row, $queryFlags, $title=null)
	Make sure we have some Title object for use by the constructor.

	getMainSlotRaw ()

Detailed Description

Deprecated: since 1.31, use RevisionRecord, RevisionStore, and BlobStore instead.

Definition at line 41 of file Revision.php.

Constructor & Destructor Documentation

◆ __construct()

Revision::__construct	(		$row,
			$queryFlags = 0,
		Title	$title = null )

Parameters

object \| array \| RevisionRecord	$row	Either a database row or an array
int	$queryFlags
Title \| null	$title

Access:\n private

Definition at line 530 of file Revision.php.

References $wgUser, and ensureTitle().

Member Function Documentation

◆ base36Sha1()

static Revision::base36Sha1 ( $text )

static

Get the base 36 SHA-1 value for a string of text.

Parameters

string $text

Returns: string

Definition at line 1140 of file Revision.php.

◆ compressRevisionText()

static Revision::compressRevisionText ( & $text )

static

If $wgCompressRevisions is enabled, we will compress data.

The input string is modified in place. Return value is the flags field: contains 'gzip' if the data is compressed, and 'utf-8' if we're saving in UTF-8 mode.

Parameters

mixed &$text Reference to a text

Returns: string

Definition at line 1086 of file Revision.php.

◆ countByPageId()

static Revision::countByPageId	(		$db,
			$id )

static

Get count of revisions per page...not very efficient.

Parameters

IDatabase	$db
int	$id	Page id

Returns: int

Definition at line 1236 of file Revision.php.

◆ countByTitle()

static Revision::countByTitle	(		$db,
			$title )

static

Get count of revisions per page...not very efficient.

Parameters

IDatabase	$db
Title	$title

Returns: int

Definition at line 1247 of file Revision.php.

◆ decompressRevisionText()

static Revision::decompressRevisionText	(		$text,
			$flags )

static

Re-converts revision text according to it's flags.

Parameters

mixed	$text	Reference to a text
array	$flags	Compression flags

Returns: string|bool Decompressed text, or false on failure

Definition at line 1097 of file Revision.php.

◆ ensureTitle()

Revision::ensureTitle	(	$row,
		$queryFlags,
		$title = null )

private

Make sure we have some Title object for use by the constructor.

For B/C, the constructor shouldn't fail even for a bad page ID or bad revision ID.

Parameters

array \| object	$row
int	$queryFlags
Title \| null	$title

Returns: Title $title if not null, or a Title constructed from information in $row.

Definition at line 570 of file Revision.php.

References $title, NS_SPECIAL, and wfLogWarning().

Referenced by __construct().

◆ fetchRevision()

static Revision::fetchRevision ( LinkTarget $title )

static

Return a wrapper for a series of database rows to fetch all of a given page's revisions in turn.

Each row can be fed to the constructor to get objects.

Parameters

LinkTarget $title

Returns: ResultWrapper

Deprecated: Since 1.28, no callers in core nor in known extensions. No-op since 1.31.

Definition at line 305 of file Revision.php.

References wfDeprecated().

◆ getArchiveQueryInfo()

static Revision::getArchiveQueryInfo ( )

static

Return the tables, fields, and join conditions to be selected to create a new archived revision object.

Since: 1.31

Deprecated: since 1.31, use RevisionStore::getArchiveQueryInfo() instead.

Returns

array With three keys:

tables: (string[]) to include in the $table to IDatabase->select()
fields: (string[]) to include in the $vars to IDatabase->select()
joins: (array) to include in the $join_conds to IDatabase->select()

Definition at line 506 of file Revision.php.

◆ getBlobStore()

static Revision::getBlobStore ( $wiki = false )

staticprotected

Parameters

bool | string $wiki The ID of the target wiki database. Use false for the local wiki.

Returns: SqlBlobStore

Definition at line 87 of file Revision.php.

◆ getComment()

Revision::getComment	(		$audience = self::FOR_PUBLIC,
		User	$user = null )

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

If the specified audience does not have access to the comment, an empty string will be returned.

Parameters

int	$audience	One of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to the given user Revision::RAW get the text regardless of permissions
User \| null	$user	User object to check for, only if FOR_THIS_USER is passed to the $audience parameter

Returns: string

Definition at line 848 of file Revision.php.

References $wgUser.

Referenced by ApiQueryRevisionsBase\extractRevisionInfo(), and getRawComment().

◆ getContent()

Revision::getContent	(		$audience = self::FOR_PUBLIC,
		User	$user = null )

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

If the specified audience does not have the ability to view this revision, or the content could not be loaded, null will be returned.

Parameters

int	$audience	One of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to $user Revision::RAW get the text regardless of permissions
User	$user	User object to check for, only if FOR_THIS_USER is passed to the $audience parameter

Since: 1.21

Returns: Content|null

Definition at line 929 of file Revision.php.

References $e, and $wgUser.

Referenced by WikiPage\doEditUpdates(), ApiQueryRevisionsBase\extractRevisionInfo(), ContentHandler\getUndoContent(), and BenchmarkParse\runParser().

◆ getContentFormat()

Revision::getContentFormat ( )

Returns the content format for the main slot of this revision.

If no content format was stored in the database, the default format for this revision's content model is returned.

Todo: : drop this, the format is irrelevant to the revision!

Returns: string The content format id associated with this revision, see the CONTENT_FORMAT_XXX constants.

Definition at line 984 of file Revision.php.

References getContentHandler(), and getMainSlotRaw().

Referenced by RevisionDbTestBase\assertRevEquals().

◆ getContentHandler()

Revision::getContentHandler ( )

Returns the content handler appropriate for this revision's content model.

Exceptions

MWException

Returns: ContentHandler

Definition at line 1001 of file Revision.php.

Referenced by ApiQueryRevisionsBase\extractRevisionInfo(), and getContentFormat().

◆ getContentModel()

Revision::getContentModel ( )

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

If no content model was stored in the database, the default content model for the title is used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT is used as a last resort.

Todo: : drop this, with MCR, there no longer is a single model associated with a revision.

Returns: string The content model id associated with this revision, see the CONTENT_MODEL_XXX constants.

Definition at line 969 of file Revision.php.

References getMainSlotRaw().

Referenced by RevisionDbTestBase\assertRevEquals(), and ApiQueryRevisionsBase\extractRevisionInfo().

◆ getId()

Revision::getId ( )

Get revision ID.

Returns: int|null

Definition at line 617 of file Revision.php.

Referenced by RevisionDbTestBase\assertRevEquals(), WikiPage\doEditUpdates(), ApiQueryRevisionsBase\extractRevisionInfo(), ContentHandler\getUndoContent(), CategoryMembershipChange\notifyCategorization(), and BenchmarkParse\runParser().

◆ getMainSlotRaw()

Revision::getMainSlotRaw ( )

private

Returns: SlotRecord

Definition at line 667 of file Revision.php.

Referenced by getContentFormat(), getContentModel(), getSerializedData(), and getTextId().

◆ getNext()

Revision::getNext ( )

Get next revision for this title.

Returns: Revision|null

Definition at line 1035 of file Revision.php.

References getTitle().

◆ getPage()

Revision::getPage ( )

Get the page ID.

Returns: int|null

Definition at line 761 of file Revision.php.

Referenced by RevisionDbTestBase\assertRevEquals().

◆ getParentId()

Revision::getParentId ( )

Get parent revision ID (the original previous page revision)

Returns: int|null The ID of the parent revision. 0 indicates that there is no parent revision. Null indicates that the parent revision is not known.

Definition at line 696 of file Revision.php.

Referenced by ApiQueryRevisionsBase\extractRevisionInfo().

◆ getParentLengths()

static Revision::getParentLengths	(		$db,
		array	$revIds )

static

Do a batched query to get the parent revision lengths.

Deprecated: in 1.31, use RevisionStore::getRevisionSizes instead.

Parameters

IDatabase	$db
array	$revIds

Returns: array

Definition at line 519 of file Revision.php.

◆ getPrevious()

Revision::getPrevious ( )

Get previous revision for this title.

Returns: Revision|null

Definition at line 1024 of file Revision.php.

References getTitle().

◆ getQueryInfo()

static Revision::getQueryInfo ( $options = [] )

static

Return the tables, fields, and join conditions to be selected to create a new revision object.

Since: 1.31

Deprecated: since 1.31, use RevisionStore::getQueryInfo() instead.

Parameters

array

$options

Any combination of the following strings

'page': Join with the page table, and select fields to identify the page
'user': Join with the user table, and select the user name
'text': Join with the text table, and select fields to load page text

Returns

array With three keys:

tables: (string[]) to include in the $table to IDatabase->select()
fields: (string[]) to include in the $vars to IDatabase->select()
joins: (array) to include in the $join_conds to IDatabase->select()

Definition at line 492 of file Revision.php.

References $options.

◆ getRawComment()

Revision::getRawComment ( )

Fetch revision comment without regard for the current user's permissions.

Returns: string

Deprecated: since 1.25, use getComment( Revision::RAW )

Definition at line 865 of file Revision.php.

References getComment(), and wfDeprecated().

◆ getRawUser()

Revision::getRawUser ( )

Fetch revision's user id without regard for the current user's permissions.

Returns: int

Deprecated: since 1.25, use getUser( Revision::RAW )

Definition at line 795 of file Revision.php.

References getUser(), and wfDeprecated().

◆ getRawUserText()

Revision::getRawUserText ( )

Fetch revision's username without regard for view restrictions.

Returns: string

Deprecated: since 1.25, use getUserText( Revision::RAW )

Definition at line 830 of file Revision.php.

References getUserText(), and wfDeprecated().

◆ getRecentChange()

Revision::getRecentChange ( $flags = 0 )

Get the RC object belonging to the current revision, if there's one.

Parameters

int $flags (optional) $flags include: Revision::READ_LATEST : Select the data from the master

Since: 1.22

Returns: RecentChange|null

Definition at line 893 of file Revision.php.

◆ getRevisionFactory()

static Revision::getRevisionFactory ( )

staticprotected

Returns: RevisionFactory

Definition at line 78 of file Revision.php.

◆ getRevisionLookup()

static Revision::getRevisionLookup ( )

staticprotected

Returns: RevisionLookup

Definition at line 71 of file Revision.php.

◆ getRevisionRecord()

Revision::getRevisionRecord ( )

Returns: RevisionRecord

Definition at line 608 of file Revision.php.

◆ getRevisionStore()

static Revision::getRevisionStore ( )

staticprotected

Returns: RevisionStore

Definition at line 64 of file Revision.php.

◆ getRevisionText()

static Revision::getRevisionText	(	$row,
		$prefix = 'old_',
		$wiki = false )

static

Get revision text associated with an old or archive row.

Both the flags and the text field must be included. Including the old_id field will activate cache usage as long as the $wiki parameter is not set.

Parameters

stdClass	$row	The text data
string	$prefix	Table prefix (default 'old_')
string \| bool	$wiki	The name of the wiki to load the revision text from (same as the the wiki $row was loaded from) or false to indicate the local wiki (this is the default). Otherwise, it must be a symbolic wiki database identifier as understood by the LoadBalancer class.

Returns: string|false Text the text requested or false on failure

Definition at line 1055 of file Revision.php.

◆ getSerializedData()

Revision::getSerializedData ( )

Get original serialized data (without checking view restrictions)

Since: 1.21

Deprecated: since 1.31, use BlobStore::getBlob instead.

Returns: string

Definition at line 952 of file Revision.php.

References getMainSlotRaw().

◆ getSha1()

Revision::getSha1 ( )

Returns the base36 sha1 of the content in this revision, or null if unknown.

Returns: string|null

Definition at line 718 of file Revision.php.

Referenced by RevisionDbTestBase\assertRevEquals(), and ApiQueryRevisionsBase\extractRevisionInfo().

◆ getSize()

Revision::getSize ( )

Returns the length of the text in this revision, or null if unknown.

Returns: int|null

Definition at line 705 of file Revision.php.

Referenced by ApiQueryRevisionsBase\extractRevisionInfo().

◆ getTextId()

Revision::getTextId ( )

Get the ID of the row of the text table that contains the content of the revision's main slot, if that content is stored in the text table.

If the content is stored elsewhere, this returns null.

Deprecated: since 1.31, use RevisionRecord()->getSlot()->getContentAddress() to get that actual address that can be used with BlobStore::getBlob(); or use RevisionRecord::hasSameContent() to check if two revisions have the same content.

Returns: int|null

Definition at line 683 of file Revision.php.

References getMainSlotRaw().

◆ getTimestamp()

Revision::getTimestamp ( )

Returns: string

Definition at line 1008 of file Revision.php.

Referenced by CategoryMembershipChange\__construct(), RevisionDbTestBase\assertRevEquals(), WikiPage\doEditUpdates(), ApiQueryRevisionsBase\extractRevisionInfo(), and WikiPage\setLastEdit().

◆ getTimestampFromId()

static Revision::getTimestampFromId	(	$title,
		$id,
		$flags = 0 )

static

Get rev_timestamp from rev_id, without loading the rest of the row.

Parameters

Title	$title
int	$id
int	$flags

Returns: string|bool False if not found

Definition at line 1225 of file Revision.php.

◆ getTitle()

Revision::getTitle ( )

Returns the title of the page associated with this entry.

Since 1.31, this will never return null.

Will do a query, when title is not set and id is given.

Returns: Title

Definition at line 734 of file Revision.php.

Referenced by MediaWiki\Tests\Storage\RevisionStoreDbTest\assertRevisionRecordMatchesRevision(), ApiQueryRevisionsBase\extractRevisionInfo(), getNext(), getPrevious(), and BenchmarkParse\runParser().

◆ getUser()

Revision::getUser	(		$audience = self::FOR_PUBLIC,
		User	$user = null )

Fetch revision's user id if it's available to the specified audience.

If the specified audience does not have access to it, zero will be returned.

Parameters

int	$audience	One of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to the given user Revision::RAW get the ID regardless of permissions
User \| null	$user	User object to check for, only if FOR_THIS_USER is passed to the $audience parameter

Returns: int

Definition at line 778 of file Revision.php.

References $wgUser.

Referenced by RevisionDbTestBase\assertRevEquals(), ApiQueryRevisionsBase\extractRevisionInfo(), and getRawUser().

◆ getUserText()

Revision::getUserText	(		$audience = self::FOR_PUBLIC,
		User	$user = null )

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

If the specified audience does not have access to the username, an empty string will be returned.

Parameters

int	$audience	One of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to the given user Revision::RAW get the text regardless of permissions
User \| null	$user	User object to check for, only if FOR_THIS_USER is passed to the $audience parameter

Returns: string

Definition at line 813 of file Revision.php.

References $wgUser.

Referenced by ApiQueryRevisionsBase\extractRevisionInfo(), and getRawUserText().

◆ getVisibility()

Revision::getVisibility ( )

Get the deletion bitfield of the revision.

Returns: int

Definition at line 911 of file Revision.php.

Referenced by CategoryMembershipChange\notifyCategorization(), and userCan().

◆ insertOn()

Revision::insertOn ( $dbw )

Insert a new revision into the database, returning the new revision ID number on success and dies horribly on failure.

Parameters

IDatabase $dbw (master connection)

Exceptions

MWException

Returns: int The revision ID

Definition at line 1109 of file Revision.php.

References $wgUser.

◆ isCurrent()

Revision::isCurrent ( )

Returns: bool

Definition at line 1015 of file Revision.php.

Referenced by DifferenceEngine\getRevisionHeader().

◆ isDeleted()

Revision::isDeleted ( $field )

Parameters

int $field One of DELETED_* bitfield constants

Returns: bool

Definition at line 902 of file Revision.php.

Referenced by ApiQueryRevisionsBase\extractRevisionInfo().

◆ isMinor()

Revision::isMinor ( )

Returns: bool

Definition at line 873 of file Revision.php.

Referenced by WikiPage\doEditUpdates(), and ApiQueryRevisionsBase\extractRevisionInfo().

◆ isUnpatrolled()

Revision::isUnpatrolled ( )

Returns: int Rcid of the unpatrolled row, zero if there isn't one

Definition at line 880 of file Revision.php.

◆ loadFromId()

static Revision::loadFromId	(		$db,
			$id )

static

Load a page revision from a given revision ID number.

Returns null if no such revision can be found.

Deprecated: since 1.31, use RevisionStore::getRevisionById() instead.

Parameters

IDatabase	$db
int	$id

Returns: Revision|null

Definition at line 238 of file Revision.php.

References wfDeprecated().

◆ loadFromPageId()

static Revision::loadFromPageId	(	$db,
		$pageid,
		$id = 0 )

static

Load either the current, or a specified, revision that's attached to a given page.

If not attached to that page, will return null.

Deprecated: since 1.31, use RevisionStore::getRevisionByPageId() instead.

Parameters

IDatabase	$db
int	$pageid
int	$id

Returns: Revision|null

Definition at line 256 of file Revision.php.

◆ loadFromTimestamp()

static Revision::loadFromTimestamp	(	$db,
		$title,
		$timestamp )

static

Load the revision for the given title with the given timestamp.

WARNING: Timestamps may in some circumstances not be unique, so this isn't the best key to use.

Deprecated: since 1.31, use RevisionStore::getRevisionByTimestamp() or RevisionStore::loadRevisionFromTimestamp() instead.

Parameters

IDatabase	$db
Title	$title
string	$timestamp

Returns: Revision|null

Definition at line 291 of file Revision.php.

◆ loadFromTitle()

static Revision::loadFromTitle	(	$db,
		$title,
		$id = 0 )

static

Load either the current, or a specified, revision that's attached to a given page.

If not attached to that page, will return null.

Deprecated: since 1.31, use RevisionStore::getRevisionByTitle() instead.

Parameters

IDatabase	$db
Title	$title
int	$id

Returns: Revision|null

Definition at line 273 of file Revision.php.

◆ newFromArchiveRow()

static Revision::newFromArchiveRow	(		$row,
			$overrides = [] )

static

Make a fake revision object from an archive table row.

This is queried for permissions or even inserted (as in Special:Undelete)

Parameters

object	$row
array	$overrides

Exceptions

MWException

Returns: Revision

Definition at line 167 of file Revision.php.

◆ newFromId()

static Revision::newFromId	(		$id,
			$flags = 0 )

static

Load a page revision from a given revision ID number.

Returns null if no such revision can be found.

$flags include: Revision::READ_LATEST : Select the data from the master Revision::READ_LOCKING : Select & lock the data from the master

Parameters

int	$id
int	$flags	(optional)

Returns: Revision|null

Definition at line 114 of file Revision.php.

◆ newFromPageId()

static Revision::newFromPageId	(	$pageId,
		$revId = 0,
		$flags = 0 )

static

Load either the current, or a specified, revision that's attached to a given page ID.

Returns null if no such revision can be found.

$flags include: Revision::READ_LATEST : Select the data from the master (since 1.20) Revision::READ_LOCKING : Select & lock the data from the master

Parameters

int	$pageId
int	$revId	(optional)
int	$flags	Bitfield (optional)

Returns: Revision|null

Definition at line 152 of file Revision.php.

◆ newFromRow()

static Revision::newFromRow ( $row )

static

Since: 1.19

MCR migration note: replaced by RevisionStore::newRevisionFromRow(). Note that newFromRow() also accepts arrays, while newRevisionFromRow() does not. Instead, a MutableRevisionRecord should be constructed directly. RevisionStore::newMutableRevisionFromArray() can be used as a temporary replacement, but should be avoided.

Parameters

object | array $row

Returns: Revision

Definition at line 218 of file Revision.php.

◆ newFromTitle()

static Revision::newFromTitle	(	LinkTarget	$linkTarget,
			$id = 0,
			$flags = 0 )

static

Load either the current, or a specified, revision that's attached to a given link target.

If not attached to that link target, will return null.

$flags include: Revision::READ_LATEST : Select the data from the master Revision::READ_LOCKING : Select & lock the data from the master

Parameters

LinkTarget	$linkTarget
int	$id	(optional)
int	$flags	Bitfield (optional)

Returns: Revision|null

Definition at line 133 of file Revision.php.

◆ newKnownCurrent()

static Revision::newKnownCurrent	(	IDatabase	$db,
			$pageIdOrTitle,
			$revId = 0 )

static

Load a revision based on a known page ID and current revision ID from the DB.

This method allows for the use of caching, though accessing anything that normally requires permission checks (aside from the text) will trigger a small DB lookup. The title will also be loaded if $pageIdOrTitle is an integer ID.

Parameters

IDatabase	$db	ignored!
int \| Title	$pageIdOrTitle	Page ID or Title object
int	$revId	Known current revision of this page. Determined automatically if not given.

Returns: Revision|bool Returns false if missing

Since: 1.28

Definition at line 1288 of file Revision.php.

◆ newNullRevision()

static Revision::newNullRevision	(	$dbw,
		$pageId,
		$summary,
		$minor,
		$user = null )

static

Create a new null-revision for insertion into a page's history.

This will not re-save the text, but simply refer to the text from the previous version.

Such revisions can for instance identify page rename operations and other such meta-modifications.

Parameters

IDatabase	$dbw
int	$pageId	ID number of the page to read from
string	$summary	Revision's summary
bool	$minor	Whether the revision should be considered as minor
User \| null	$user	User object to use or null for $wgUser

Returns: Revision|null Revision or null on error

Definition at line 1159 of file Revision.php.

References $wgUser.

◆ pageJoinCond()

static Revision::pageJoinCond ( )

static

Return the value of a select() page conds array for the page table.

This will assure that the revision(s) are not orphaned from live pages.

Since: 1.19

Deprecated: since 1.31, use RevisionStore::getQueryInfo( [ 'page' ] ) instead.

Returns: array

Definition at line 340 of file Revision.php.

References wfDeprecated().

◆ selectArchiveFields()

static Revision::selectArchiveFields ( )

static

Return the list of revision fields that should be selected to create a new revision from an archive row.

Deprecated: since 1.31, use RevisionStore::getArchiveQueryInfo() instead.

Returns: array

Definition at line 397 of file Revision.php.

References $wgActorTableSchemaMigrationStage, $wgContentHandlerUseDB, MIGRATION_WRITE_BOTH, and wfDeprecated().

◆ selectFields()

static Revision::selectFields ( )

static

Return the list of revision fields that should be selected to create a new revision.

Deprecated: since 1.31, use RevisionStore::getQueryInfo() instead.

Returns: array

Definition at line 351 of file Revision.php.

References $wgActorTableSchemaMigrationStage, $wgContentHandlerUseDB, MIGRATION_WRITE_BOTH, and wfDeprecated().

◆ selectPageFields()

static Revision::selectPageFields ( )

static

Return the list of page fields that should be selected from page table.

Deprecated: since 1.31, use RevisionStore::getQueryInfo( [ 'page' ] ) instead.

Returns: array

Definition at line 456 of file Revision.php.

References wfDeprecated().

◆ selectTextFields()

static Revision::selectTextFields ( )

static

Return the list of text fields that should be selected to read the revision text.

Deprecated: since 1.31, use RevisionStore::getQueryInfo( [ 'text' ] ) instead.

Returns: array

Definition at line 443 of file Revision.php.

References wfDeprecated().

◆ selectUserFields()

static Revision::selectUserFields ( )

static

Return the list of user fields that should be selected from user table.

Deprecated: since 1.31, use RevisionStore::getQueryInfo( [ 'user' ] ) instead.

Returns: array

Definition at line 473 of file Revision.php.

References wfDeprecated().

◆ setId()

Revision::setId ( $id )

Set the revision ID.

This should only be used for proposed revisions that turn out to be null edits.

Note: Only supported on Revisions that were constructed based on associative arrays, since they are mutable.

Since: 1.19

Parameters

int | string $id

Exceptions

MWException

Definition at line 633 of file Revision.php.

◆ setTitle()

Revision::setTitle ( $title )

Set the title of the revision.

Deprecated: : since 1.31, this is now a noop. Pass the Title to the constructor instead.

Parameters

Title $title

Definition at line 746 of file Revision.php.

◆ setUserIdAndName()

Revision::setUserIdAndName	(		$id,
			$name )

Set the user ID/name.

This should only be used for proposed revisions that turn out to be null edits

Note: Only supported on Revisions that were constructed based on associative arrays, since they are mutable.

Since: 1.28

Deprecated: since 1.31, please reuse old Revision object

Parameters

int	$id	User ID
string	$name	User name

Exceptions

MWException

Definition at line 655 of file Revision.php.

References User\newFromAnyId().

◆ userCan()

Revision::userCan	(		$field,
		User	$user = null )

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

Parameters

int	$field	One of self::DELETED_TEXT, self::DELETED_COMMENT, self::DELETED_USER
User \| null	$user	User object to check, or null to use $wgUser

Returns: bool

Definition at line 1187 of file Revision.php.

References getVisibility().

Referenced by ApiQueryRevisionsBase\extractRevisionInfo().

◆ userCanBitfield()

static Revision::userCanBitfield	(		$bitfield,
			$field,
		User	$user = null,
		Title	$title = 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.

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
User \| null	$user	User object to check, or null to use $wgUser
Title \| null	$title	A Title object to check for per-page restrictions on, instead of just plain userrights

Returns: bool

Definition at line 1205 of file Revision.php.

References $wgUser.

◆ userJoinCond()

static Revision::userJoinCond ( )

static

Return the value of a select() JOIN conds array for the user table.

This will get user table rows for logged-in users.

Since: 1.19

Deprecated: since 1.31, use RevisionStore::getQueryInfo( [ 'user' ] ) instead.

Returns: array

Definition at line 317 of file Revision.php.

References $wgActorTableSchemaMigrationStage, MIGRATION_WRITE_BOTH, and wfDeprecated().

◆ userWasLastToEdit()

static Revision::userWasLastToEdit	(	$db,
		$pageId,
		$userId,
		$since )

static

Check if no edits were made by other users since the time a user started editing the page.

Limit to 50 revisions for the sake of performance.

Since: 1.20

Deprecated: since 1.24

Parameters

IDatabase \| int	$db	The Database to perform the check on. May be given as a Database object or a database identifier usable with wfGetDB.
int	$pageId	The ID of the page in question
int	$userId	The ID of the user in question
string	$since	Look at edits since this time

Returns: bool True if the given user was the only one to edit since the given timestamp

Definition at line 1267 of file Revision.php.

References wfGetDB().

Member Data Documentation

◆ $mRecord

RevisionRecord Revision::$mRecord

protected

Definition at line 44 of file Revision.php.

◆ DELETED_COMMENT

const Revision::DELETED_COMMENT = RevisionRecord::DELETED_COMMENT

Definition at line 48 of file Revision.php.

◆ DELETED_RESTRICTED

const Revision::DELETED_RESTRICTED = RevisionRecord::DELETED_RESTRICTED

Definition at line 50 of file Revision.php.

◆ DELETED_TEXT

const Revision::DELETED_TEXT = RevisionRecord::DELETED_TEXT

Definition at line 47 of file Revision.php.

◆ DELETED_USER

const Revision::DELETED_USER = RevisionRecord::DELETED_USER

Definition at line 49 of file Revision.php.

◆ FOR_PUBLIC

const Revision::FOR_PUBLIC = RevisionRecord::FOR_PUBLIC

Definition at line 55 of file Revision.php.

◆ FOR_THIS_USER

const Revision::FOR_THIS_USER = RevisionRecord::FOR_THIS_USER

Definition at line 56 of file Revision.php.

◆ RAW

const Revision::RAW = RevisionRecord::RAW

Definition at line 57 of file Revision.php.

◆ SUPPRESSED_ALL

const Revision::SUPPRESSED_ALL = RevisionRecord::SUPPRESSED_ALL

Definition at line 52 of file Revision.php.

◆ SUPPRESSED_USER

const Revision::SUPPRESSED_USER = RevisionRecord::SUPPRESSED_USER

Definition at line 51 of file Revision.php.

◆ TEXT_CACHE_GROUP

const Revision::TEXT_CACHE_GROUP = SqlBlobStore::TEXT_CACHE_GROUP

Definition at line 59 of file Revision.php.

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

includes/Revision.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ base36Sha1()

◆ compressRevisionText()

◆ countByPageId()

◆ countByTitle()

◆ decompressRevisionText()

◆ ensureTitle()

◆ fetchRevision()

◆ getArchiveQueryInfo()

◆ getBlobStore()

◆ getComment()

◆ getContent()

◆ getContentFormat()

◆ getContentHandler()

◆ getContentModel()

◆ getId()

◆ getMainSlotRaw()

◆ getNext()

◆ getPage()

◆ getParentId()

◆ getParentLengths()

◆ getPrevious()

◆ getQueryInfo()

◆ getRawComment()

◆ getRawUser()

◆ getRawUserText()

◆ getRecentChange()

◆ getRevisionFactory()

◆ getRevisionLookup()

◆ getRevisionRecord()

◆ getRevisionStore()

◆ getRevisionText()

◆ getSerializedData()

◆ getSha1()

◆ getSize()

◆ getTextId()

◆ getTimestamp()

◆ getTimestampFromId()

◆ getTitle()

◆ getUser()

◆ getUserText()

◆ getVisibility()

◆ insertOn()

◆ isCurrent()

◆ isDeleted()

◆ isMinor()

◆ isUnpatrolled()

◆ loadFromId()

◆ loadFromPageId()

◆ loadFromTimestamp()

◆ loadFromTitle()

◆ newFromArchiveRow()

◆ newFromId()

◆ newFromPageId()

◆ newFromRow()

◆ newFromTitle()

◆ newKnownCurrent()

◆ newNullRevision()

◆ pageJoinCond()

◆ selectArchiveFields()

◆ selectFields()

◆ selectPageFields()

◆ selectTextFields()

◆ selectUserFields()

◆ setId()

◆ setTitle()

◆ setUserIdAndName()

◆ userCan()

◆ userCanBitfield()

◆ userJoinCond()

◆ userWasLastToEdit()