Service for looking up page revisions. More...

Inheritance diagram for Revision\RevisionStore:

[legend]

Collaboration diagram for Revision\RevisionStore:

[legend]

Public Member Functions
	__construct (ILoadBalancer $loadBalancer, SqlBlobStore $blobStore, WANObjectCache $cache, CommentStore $commentStore, NameTableStore $contentModelStore, NameTableStore $slotRoleStore, SlotRoleRegistry $slotRoleRegistry, ActorMigration $actorMigration, IContentHandlerFactory $contentHandlerFactory, HookContainer $hookContainer, $dbDomain=false)

	countAuthorsBetween ( $pageId, RevisionRecord $old=null, RevisionRecord $new=null, User $user=null, $max=null, $options=[])
	Get the number of authors between the given revisions. More...

	countRevisionsBetween ( $pageId, RevisionRecord $old=null, RevisionRecord $new=null, $max=null, $options=[])
	Get the number of revisions between the given revisions. More...

	countRevisionsByPageId (IDatabase $db, $id)
	Get count of revisions per page...not very efficient. More...

	countRevisionsByTitle (IDatabase $db, $title)
	Get count of revisions per page...not very efficient. More...

	getArchiveQueryInfo ()
	Return the tables, fields, and join conditions to be selected to create a new RevisionArchiveRecord object. More...

	getAuthorsBetween ( $pageId, RevisionRecord $old=null, RevisionRecord $new=null, User $user=null, $max=null, $options=[])
	Get the authors between the given revisions or revisions. More...

	getContentBlobsForBatch ( $rowsOrIds, $slots=null, $queryFlags=0)
	Gets raw (serialized) content blobs for the given set of revisions. More...

	getFirstRevision (LinkTarget $title, int $flags=IDBAccessObject::READ_NORMAL)
	Get the first revision of a given page. More...

	getKnownCurrentRevision (Title $title, $revId=0)
	Load a revision based on a known page ID and current revision ID from the DB. More...

	getNextRevision (RevisionRecord $rev, $flags=0)
	Get the revision after $rev in the page's history, if any. More...

	getPreviousRevision (RevisionRecord $rev, $flags=0)
	Get the revision before $rev in the page's history, if any. More...

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

	getRcIdIfUnpatrolled (RevisionRecord $rev)
	MCR migration note: this replaces Revision::isUnpatrolled. More...

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

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

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

	getRevisionByTimestamp (LinkTarget $title, string $timestamp, int $flags=IDBAccessObject::READ_NORMAL)
	Load the revision for the given title with the given timestamp. More...

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

	getRevisionIdsBetween (int $pageId, RevisionRecord $old=null, RevisionRecord $new=null, ?int $max=null, $options=[], ?string $order=null, int $flags=IDBAccessObject::READ_NORMAL)
	Get IDs of revisions between the given revisions. More...

	getRevisionSizes (array $revIds)
	Do a batched query for the sizes of a set of revisions. More...

	getSlotsQueryInfo ( $options=[])
	Return the tables, fields, and join conditions to be selected to create a new SlotRecord. More...

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

	getTitle ( $pageId, $revId, $queryFlags=self::READ_NORMAL)
	Determines the page Title based on the available information. More...

	insertRevisionOn (RevisionRecord $rev, IDatabase $dbw)
	Insert a new revision into the database, returning the new revision record on success and dies horribly on failure. More...

	isReadOnly ()

	listRevisionSizes (IDatabase $db, array $revIds)
	Do a batched query for the sizes of a set of revisions. More...

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

	loadRevisionFromTimestamp (IDatabase $db, $title, $timestamp)
	Load the revision for the given title with the given timestamp. More...

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

	newMutableRevisionFromArray (array $fields, $queryFlags=0, Title $title=null)
	Constructs a new MutableRevisionRecord based on the given associative array following the MW1.29 convention for the Revision constructor. More...

	newNullRevision (IDatabase $dbw, Title $title, CommentStoreComment $comment, $minor, User $user)
	Create a new null-revision for insertion into a page's history. More...

	newRevisionFromArchiveRow ( $row, $queryFlags=0, Title $title=null, array $overrides=[])
	Make a fake revision object from an archive table row. More...

	newRevisionFromArchiveRowAndSlots ( $row, $slots, $queryFlags=0, Title $title=null, array $overrides=[])

	newRevisionFromRow ( $row, $queryFlags=0, Title $title=null, $fromCache=false)

	newRevisionFromRowAndSlots ( $row, $slots, $queryFlags=0, Title $title=null, $fromCache=false)

	newRevisionsFromBatch ( $rows, array $options=[], $queryFlags=0, Title $title=null)
	Construct a RevisionRecord instance for each row in $rows, and return them as an associative array indexed by revision ID. More...

	setLogger (LoggerInterface $logger)

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

Public Member Functions inherited from Revision\RevisionFactory
	newRevisionFromRow ( $row, $queryFlags=self::READ_NORMAL, Title $title=null)
	Constructs a RevisionRecord given a database row and content slots. More...

Public Attributes
const	INCLUDE_BOTH = 'include_both'

const	INCLUDE_NEW = 'include_new'

const	INCLUDE_OLD = 'include_old'

const	ORDER_NEWEST_TO_OLDEST = 'DESC'

const	ORDER_OLDEST_TO_NEWEST = 'ASC'

const	ROW_CACHE_KEY = 'revision-row-1.29'

Public Attributes inherited from IDBAccessObject
const	READ_NONE = -1
	Constants for object loading bitfield flags (higher => higher QoS) More...

Private Member Functions
	assertRevisionParameter ( $paramName, $pageId, RevisionRecord $rev=null)
	Asserts that if revision is provided, it's saved and belongs to the page with provided pageId. More...

	checkContent (Content $content, Title $title, $role)
	MCR migration note: this corresponds to Revision::checkContentModel. More...

	checkDatabaseDomain (IDatabase $db)
	Throws an exception if the given database connection does not belong to the wiki this RevisionStore is bound to. More...

	constructSlotRecords ( $revId, $slotRows, $queryFlags, Title $title, $slotContents=null)
	Factory method for SlotRecords based on known slot rows. More...

	ensureRevisionRowMatchesTitle ( $row, Title $title, $context=[])
	Check that the given row matches the given Title object. More...

	failOnEmpty ( $value, $name)

	failOnNull ( $value, $name)

	fetchRevisionRowFromConds (IDatabase $db, array $conditions, int $flags=IDBAccessObject::READ_NORMAL, array $options=[])
	Given a set of conditions, return a row with the fields necessary to build RevisionRecord objects. More...

	getBaseRevisionRow (IDatabase $dbw, RevisionRecord $rev, Title $title, $parentId)

	getDBConnectionRef ( $mode, $groups=[])

	getDBConnectionRefForQueryFlags ( $queryFlags)

	getDBLoadBalancer ()

	getPreviousRevisionId (IDatabase $db, RevisionRecord $rev)
	Get previous revision Id for this page_id This is used to populate rev_parent_id on save. More...

	getRelativeRevision (RevisionRecord $rev, $flags, $dir)
	Implementation of getPreviousRevision and getNextRevision. More...

	getRevisionLimitConditions (IDatabase $dbr, RevisionRecord $old=null, RevisionRecord $new=null, $options=[])
	Converts revision limits to query conditions. More...

	getRevisionRowCacheKey (IDatabase $db, $pageId, $revId)
	Get a cache key for use with a row as selected with getQueryInfo( [ 'page', 'user' ] ) Caching rows without 'page' or 'user' could lead to issues. More...

	getSlotRowsForBatch ( $rowsOrIds, array $options=[], $queryFlags=0)
	Gets the slot rows associated with a batch of revisions. More...

	initializeMutableRevisionFromArray (MutableRevisionRecord $record, array $fields)

	insertContentRowOn (SlotRecord $slot, IDatabase $dbw, $blobAddress)

	insertIpChangesRow (IDatabase $dbw, User $user, RevisionRecord $rev, $revisionId)
	Insert IP revision into ip_changes for use when querying for a range. More...

	insertRevisionInternal (RevisionRecord $rev, IDatabase $dbw, User $user, CommentStoreComment $comment, Title $title, $pageId, $parentId)

	insertRevisionRowOn (IDatabase $dbw, RevisionRecord $rev, Title $title, $parentId)

	insertSlotOn (IDatabase $dbw, $revisionId, SlotRecord $protoSlot, Title $title, array $blobHints=[])

	insertSlotRowOn (SlotRecord $slot, IDatabase $dbw, $revisionId, $contentId)

	loadRevisionFromConds (IDatabase $db, array $conditions, int $flags=IDBAccessObject::READ_NORMAL, Title $title=null, array $options=[])
	Given a set of conditions, fetch a revision from the given database connection. More...

	loadSlotContent (SlotRecord $slot, $blobData=null, $blobFlags=null, $blobFormat=null, $queryFlags=0)
	Loads a Content object based on a slot row. More...

	loadSlotRecords ( $revId, $queryFlags, Title $title)

	newRevisionFromConds (array $conditions, int $flags=IDBAccessObject::READ_NORMAL, Title $title=null, array $options=[])
	Given a set of conditions, fetch a revision. More...

	newRevisionSlots ( $revId, $revisionRow, $slotRows, $queryFlags, Title $title)
	Factory method for RevisionSlots based on a revision ID. More...

	storeContentBlob (SlotRecord $slot, Title $title, array $blobHints=[])

Private Attributes
ActorMigration	$actorMigration

SqlBlobStore	$blobStore

WANObjectCache	$cache

CommentStore	$commentStore

IContentHandlerFactory	$contentHandlerFactory

NameTableStore	$contentModelStore

bool string	$dbDomain

HookContainer	$hookContainer

HookRunner	$hookRunner

ILoadBalancer	$loadBalancer

LoggerInterface	$logger

SlotRoleRegistry	$slotRoleRegistry

NameTableStore	$slotRoleStore

Detailed Description

Service for looking up page revisions.

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

Note: This was written to act as a drop-in replacement for the corresponding static methods in Revision.

Definition at line 79 of file RevisionStore.php.

Constructor & Destructor Documentation

◆ __construct()

Revision\RevisionStore::__construct	(	ILoadBalancer	$loadBalancer,
		SqlBlobStore	$blobStore,
		WANObjectCache	$cache,
		CommentStore	$commentStore,
		NameTableStore	$contentModelStore,
		NameTableStore	$slotRoleStore,
		SlotRoleRegistry	$slotRoleRegistry,
		ActorMigration	$actorMigration,
		IContentHandlerFactory	$contentHandlerFactory,
		HookContainer	$hookContainer,
			$dbDomain = `false`
	)

Todo:: $blobStore should be allowed to be any BlobStore!

Parameters

ILoadBalancer	$loadBalancer
SqlBlobStore	$blobStore
WANObjectCache	$cache	A cache for caching revision rows. This can be the local wiki's default instance even if $dbDomain refers to a different wiki, since makeGlobalKey() is used to constructed a key that allows cached revision rows from the same database to be re-used between wikis. For example, enwiki and frwiki will use the same cache keys for revision rows from the wikidatawiki database, regardless of the cache's default key space.
CommentStore	$commentStore
NameTableStore	$contentModelStore
NameTableStore	$slotRoleStore
SlotRoleRegistry	$slotRoleRegistry
ActorMigration	$actorMigration
IContentHandlerFactory	$contentHandlerFactory
HookContainer	$hookContainer
bool \| string	$dbDomain	DB domain of the relevant wiki or false for the current one

Definition at line 169 of file RevisionStore.php.

References Revision\RevisionStore\$actorMigration, Revision\RevisionStore\$blobStore, Revision\RevisionStore\$cache, Revision\RevisionStore\$commentStore, Revision\RevisionStore\$contentHandlerFactory, Revision\RevisionStore\$contentModelStore, Revision\RevisionStore\$dbDomain, Revision\RevisionStore\$hookContainer, Revision\RevisionStore\$loadBalancer, Revision\RevisionStore\$slotRoleRegistry, and Revision\RevisionStore\$slotRoleStore.

Member Function Documentation

◆ assertRevisionParameter()

Revision\RevisionStore::assertRevisionParameter	(		$paramName,
			$pageId,
		RevisionRecord	$rev = `null`
	)

private

Asserts that if revision is provided, it's saved and belongs to the page with provided pageId.

Parameters

string	$paramName
int	$pageId
RevisionRecord \| null	$rev

Exceptions

InvalidArgumentException

Definition at line 3033 of file RevisionStore.php.

Referenced by Revision\RevisionStore\countRevisionsBetween(), Revision\RevisionStore\getAuthorsBetween(), and Revision\RevisionStore\getRevisionIdsBetween().

◆ checkContent()

Revision\RevisionStore::checkContent	(	Content	$content,
		Title	$title,
			$role
	)

private

MCR migration note: this corresponds to Revision::checkContentModel.

Parameters

Content	$content
Title	$title
string	$role

Exceptions

MWException
MWUnknownContentModelException

Definition at line 844 of file RevisionStore.php.

References $content.

Referenced by Revision\RevisionStore\storeContentBlob().

◆ checkDatabaseDomain()

Revision\RevisionStore::checkDatabaseDomain ( IDatabase $db )

private

Throws an exception if the given database connection does not belong to the wiki this RevisionStore is bound to.

Parameters

IDatabase $db

Exceptions

MWException

Definition at line 2375 of file RevisionStore.php.

References Revision\RevisionStore\$dbDomain.

Referenced by Revision\RevisionStore\countRevisionsByPageId(), Revision\RevisionStore\fetchRevisionRowFromConds(), Revision\RevisionStore\getPreviousRevisionId(), Revision\RevisionStore\insertRevisionOn(), Revision\RevisionStore\newNullRevision(), and Revision\RevisionStore\userWasLastToEdit().

◆ constructSlotRecords()

Revision\RevisionStore::constructSlotRecords	(		$revId,
			$slotRows,
			$queryFlags,
		Title	$title,
			$slotContents = `null`
	)

private

Factory method for SlotRecords based on known slot rows.

Parameters

int	$revId	The revision to load slots for.
\\stdClass[] \| IResultWrapper	$slotRows
int	$queryFlags
Title	$title
array \| null	$slotContents	a map from blobAddress to slot content blob or Content object.

Returns: SlotRecord[]

Definition at line 1270 of file RevisionStore.php.

References $blob, $title, Revision\RevisionStore\loadSlotContent(), Revision\SlotRecord\MAIN, and wfBacktrace().

Referenced by Revision\RevisionStore\loadSlotRecords(), and Revision\RevisionStore\newRevisionSlots().

◆ countAuthorsBetween()

Revision\RevisionStore::countAuthorsBetween	(		$pageId,
		RevisionRecord	$old = `null`,
		RevisionRecord	$new = `null`,
		User	$user = `null`,
			$max = `null`,
			$options = `[]`
	)

Get the number of authors between the given revisions.

Used for diffs and other things that really need it.

Since: 1.35

Parameters

int	$pageId	The id of the page
RevisionRecord \| null	$old	Old revision . If null is provided, count starting from the first revision (inclusive).
RevisionRecord \| null	$new	New revision. If null is provided, count until the last revision (inclusive).
User \| null	$user	the user who's access rights to apply
int \| null	$max	Limit of Revisions to count, will be incremented to detect truncations.
string \| array	$options	Single option, or an array of options: RevisionStore::INCLUDE_OLD Include $old in the range; $new is excluded. RevisionStore::INCLUDE_NEW Include $new in the range; $old is excluded. RevisionStore::INCLUDE_BOTH Include both $old and $new in the range.

Exceptions

InvalidArgumentException in case either revision is unsaved or the revisions do not belong to the same page or unknown option is passed.

Returns: int Number of revisions authors in the range.

Definition at line 3265 of file RevisionStore.php.

References Revision\RevisionStore\getAuthorsBetween().

◆ countRevisionsBetween()

Revision\RevisionStore::countRevisionsBetween	(		$pageId,
		RevisionRecord	$old = `null`,
		RevisionRecord	$new = `null`,
			$max = `null`,
			$options = `[]`
	)

Get the number of revisions between the given revisions.

Used for diffs and other things that really need it.

Since: 1.35

Parameters

int	$pageId	The id of the page
RevisionRecord \| null	$old	Old revision. If null is provided, count starting from the first revision (inclusive).
RevisionRecord \| null	$new	New revision. If null is provided, count until the last revision (inclusive).
int \| null	$max	Limit of Revisions to count, will be incremented to detect truncations.
string \| array	$options	Single option, or an array of options: RevisionStore::INCLUDE_OLD Include $old in the range; $new is excluded. RevisionStore::INCLUDE_NEW Include $new in the range; $old is excluded. RevisionStore::INCLUDE_BOTH Include both $old and $new in the range.

Exceptions

InvalidArgumentException in case either revision is unsaved or the revisions do not belong to the same page.

Returns: int Number of revisions between these revisions.

Definition at line 3298 of file RevisionStore.php.

References $dbr, Revision\RevisionStore\assertRevisionParameter(), DB_REPLICA, Revision\RevisionRecord\DELETED_TEXT, and Revision\RevisionStore\getDBConnectionRef().

◆ countRevisionsByPageId()

Revision\RevisionStore::countRevisionsByPageId	(	IDatabase	$db,
			$id
	)

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

MCR migration note: this replaces Revision::countByPageId

Parameters

IDatabase	$db
int	$id	Page id

Returns: int

Definition at line 2831 of file RevisionStore.php.

References Revision\RevisionStore\checkDatabaseDomain().

Referenced by Revision\RevisionStore\countRevisionsByTitle().

◆ countRevisionsByTitle()

Revision\RevisionStore::countRevisionsByTitle	(	IDatabase	$db,
			$title
	)

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

MCR migration note: this replaces Revision::countByTitle

Parameters

IDatabase	$db
Title	$title

Returns: int

Definition at line 2854 of file RevisionStore.php.

References $title, and Revision\RevisionStore\countRevisionsByPageId().

◆ ensureRevisionRowMatchesTitle()

Revision\RevisionStore::ensureRevisionRowMatchesTitle	(		$row,
		Title	$title,
			$context = `[]`
	)

private

Check that the given row matches the given Title object.

When a mismatch is detected, this tries to re-load the title from master, to avoid spurious errors during page moves.

Parameters

\\stdClass	$row
Title	$title
array	$context

Definition at line 1608 of file RevisionStore.php.

References MediaWiki\$context, $title, and wfBacktrace().

Referenced by Revision\RevisionStore\getKnownCurrentRevision(), and Revision\RevisionStore\newRevisionFromRowAndSlots().

◆ failOnEmpty()

Revision\RevisionStore::failOnEmpty	(	$value,
		$name
	)

private

Parameters

mixed	$value
string	$name

Exceptions

IncompleteRevisionException if $value is empty

Returns: mixed $value, if $value is not null

Definition at line 344 of file RevisionStore.php.

Referenced by Revision\RevisionStore\insertRevisionOn().

◆ failOnNull()

Revision\RevisionStore::failOnNull	(	$value,
		$name
	)

private

Parameters

mixed	$value
string	$name

Exceptions

IncompleteRevisionException if $value is null

Returns: mixed $value, if $value is not null

Definition at line 327 of file RevisionStore.php.

Referenced by Revision\RevisionStore\insertRevisionOn().

◆ fetchRevisionRowFromConds()

Revision\RevisionStore::fetchRevisionRowFromConds	(	IDatabase	$db,
		array	$conditions,
		int	$flags = `IDBAccessObject::READ_NORMAL`,
		array	$options = `[]`
	)

private

Given a set of conditions, return a row with the fields necessary to build RevisionRecord objects.

MCR migration note: this corresponds to Revision::fetchFromConds

Parameters

IDatabase	$db
array	$conditions
int	$flags	(optional)
array	$options	(optional) additional query options

Returns: \stdClass|false data row as a raw object

Definition at line 2398 of file RevisionStore.php.

References $revQuery, Revision\RevisionStore\checkDatabaseDomain(), and Revision\RevisionStore\getQueryInfo().

Referenced by Revision\RevisionStore\getKnownCurrentRevision(), Revision\RevisionStore\loadRevisionFromConds(), and Revision\RevisionStore\newRevisionFromRowAndSlots().

◆ getArchiveQueryInfo()

Revision\RevisionStore::getArchiveQueryInfo ( )

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

MCR migration note: this replaces Revision::getArchiveQueryInfo

Since: 1.31

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 2586 of file RevisionStore.php.

◆ getAuthorsBetween()

Revision\RevisionStore::getAuthorsBetween	(		$pageId,
		RevisionRecord	$old = `null`,
		RevisionRecord	$new = `null`,
		User	$user = `null`,
			$max = `null`,
			$options = `[]`
	)

Get the authors between the given revisions or revisions.

Used for diffs and other things that really need it.

Since: 1.35

Parameters

int	$pageId	The id of the page
RevisionRecord \| null	$old	Old revision. If null is provided, count starting from the first revision (inclusive).
RevisionRecord \| null	$new	New revision. If null is provided, count until the last revision (inclusive).
User \| null	$user	the user who's access rights to apply
int \| null	$max	Limit of Revisions to count, will be incremented to detect truncations.
string \| array	$options	Single option, or an array of options: RevisionStore::INCLUDE_OLD Include $old in the range; $new is excluded. RevisionStore::INCLUDE_NEW Include $new in the range; $old is excluded. RevisionStore::INCLUDE_BOTH Include both $old and $new in the range.

Exceptions

InvalidArgumentException in case either revision is unsaved or the revisions do not belong to the same page or unknown option is passed.

Returns: UserIdentity[] Names of revision authors in the range

Definition at line 3194 of file RevisionStore.php.

References $dbr, Revision\RevisionStore\assertRevisionParameter(), DB_REPLICA, Revision\RevisionRecord\DELETED_USER, Revision\RevisionRecord\FOR_PUBLIC, and Revision\RevisionStore\getDBConnectionRef().

Referenced by Revision\RevisionStore\countAuthorsBetween().

◆ getBaseRevisionRow()

Revision\RevisionStore::getBaseRevisionRow	(	IDatabase	$dbw,
		RevisionRecord	$rev,
		Title	$title,
			$parentId
	)

private

Parameters

IDatabase	$dbw
RevisionRecord	$rev
Title	$title
int	$parentId

Returns: array a revision table row

Definition at line 738 of file RevisionStore.php.

References Revision\RevisionRecord\getId(), Revision\RevisionRecord\getPageId(), Revision\RevisionRecord\getSha1(), Revision\RevisionRecord\getSize(), Revision\RevisionRecord\getTimestamp(), Revision\RevisionRecord\getVisibility(), and Revision\RevisionRecord\isMinor().

Referenced by Revision\RevisionStore\insertRevisionRowOn().

◆ getContentBlobsForBatch()

Revision\RevisionStore::getContentBlobsForBatch	(	$rowsOrIds,
		$slots = `null`,
		$queryFlags = `0`
	)

Gets raw (serialized) content blobs for the given set of revisions.

Callers are responsible for unserializing and interpreting the content blobs based on the model_name field and the slot role.

This method is intended for bulk operations in maintenance scripts. It may be chosen over newRevisionsFromBatch by code that are only interested in raw content, as opposed to meta data. Code that needs to access meta data of revisions, slots, or content objects should use newRevisionsFromBatch() instead.

Parameters

Traversable \| array	$rowsOrIds	list of revision ids, or revision rows from a db query.
array \| null	$slots	the role names for which to get slots.
int	$queryFlags

Returns

StatusValue a status containing, if isOK() returns true, a two-level nested associative array, mapping from revision ID to an associative array that maps from role name to an anonymous object containing two fields:

model_name: the name of the content's model
blob_data: serialized content data

Definition at line 1990 of file RevisionStore.php.

References Revision\RevisionStore\getSlotRowsForBatch().

◆ getDBConnectionRef()

Revision\RevisionStore::getDBConnectionRef	(	$mode,
		$groups = `[]`
	)

private

Parameters

int	$mode	DB_MASTER or DB_REPLICA
array	$groups

Returns: DBConnRef

Definition at line 233 of file RevisionStore.php.

References Revision\RevisionStore\getDBLoadBalancer().

Referenced by Revision\RevisionStore\countRevisionsBetween(), Revision\RevisionStore\getAuthorsBetween(), Revision\RevisionStore\getDBConnectionRefForQueryFlags(), Revision\RevisionStore\getKnownCurrentRevision(), Revision\RevisionStore\getRelativeRevision(), Revision\RevisionStore\getRevisionSizes(), Revision\RevisionStore\getTitle(), Revision\RevisionStore\loadSlotRecords(), and Revision\RevisionStore\newRevisionFromConds().

◆ getDBConnectionRefForQueryFlags()

Revision\RevisionStore::getDBConnectionRefForQueryFlags ( $queryFlags )

private

Parameters

int $queryFlags a bit field composed of READ_XXX flags

Returns: DBConnRef

Definition at line 222 of file RevisionStore.php.

References Revision\RevisionStore\getDBConnectionRef(), and DBAccessObjectUtils\getDBOptions().

Referenced by Revision\RevisionStore\getRevisionByPageId(), Revision\RevisionStore\getRevisionByTimestamp(), Revision\RevisionStore\getRevisionByTitle(), Revision\RevisionStore\getRevisionIdsBetween(), Revision\RevisionStore\getSlotRowsForBatch(), Revision\RevisionStore\getTimestampFromId(), Revision\RevisionStore\newRevisionFromArchiveRowAndSlots(), Revision\RevisionStore\newRevisionFromConds(), and Revision\RevisionStore\newRevisionFromRowAndSlots().

◆ getDBLoadBalancer()

Revision\RevisionStore::getDBLoadBalancer ( )

private

Returns: ILoadBalancer

Definition at line 213 of file RevisionStore.php.

References Revision\RevisionStore\$loadBalancer.

Referenced by Revision\RevisionStore\getDBConnectionRef(), and Revision\RevisionStore\newRevisionFromConds().

◆ getFirstRevision()

Revision\RevisionStore::getFirstRevision	(	LinkTarget	$title,
		int	$flags = `IDBAccessObject::READ_NORMAL`
	)

Get the first revision of a given page.

Since: 1.35

Parameters

LinkTarget	$title
int	$flags

Returns: RevisionRecord|null

Implements Revision\RevisionLookup.

Definition at line 2987 of file RevisionStore.php.

References $title, Title\newFromLinkTarget(), and Revision\RevisionStore\newRevisionFromConds().

◆ getKnownCurrentRevision()

Revision\RevisionStore::getKnownCurrentRevision	(	Title	$title,
			$revId = `0`
	)

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.

MCR migration note: this replaces Revision::newKnownCurrent

Parameters

Title	$title	the associated page title
int	$revId	current revision of this page. Defaults to $title->getLatestRevID().

Returns: RevisionRecord|bool Returns false if missing

Implements Revision\RevisionLookup.

Definition at line 2922 of file RevisionStore.php.

References $title, DB_REPLICA, Revision\RevisionStore\ensureRevisionRowMatchesTitle(), Revision\RevisionStore\fetchRevisionRowFromConds(), Wikimedia\Rdbms\Database\getCacheSetOptions(), Revision\RevisionStore\getDBConnectionRef(), Revision\RevisionStore\getRevisionRowCacheKey(), Revision\RevisionStore\newRevisionFromRow(), and wfWarn().

◆ getNextRevision()

Revision\RevisionStore::getNextRevision	(	RevisionRecord	$rev,
			$flags = `0`
	)

Get the revision after $rev in the page's history, if any.

Will return null for the latest revision but also for deleted or unsaved revisions.

MCR migration note: this replaces Revision::getNext

See also: Title::getNextRevisionID

Parameters

RevisionRecord	$rev
int	$flags	(optional) $flags include: IDBAccessObject::READ_LATEST: Select the data from the master

Returns: RevisionRecord|null

Implements Revision\RevisionLookup.

Definition at line 2751 of file RevisionStore.php.

References Revision\RevisionStore\getRelativeRevision(), and wfDeprecated().

◆ getPreviousRevision()

Revision\RevisionStore::getPreviousRevision	(	RevisionRecord	$rev,
			$flags = `0`
	)

Get the revision before $rev in the page's history, if any.

Will return null for the first revision but also for deleted or unsaved revisions.

MCR migration note: this replaces Revision::getPrevious

See also: Title::getPreviousRevisionID; PageArchive::getPreviousRevision

Parameters

RevisionRecord	$rev
int	$flags	(optional) $flags include: IDBAccessObject::READ_LATEST: Select the data from the master

Returns: RevisionRecord|null

Implements Revision\RevisionLookup.

Definition at line 2728 of file RevisionStore.php.

References Revision\RevisionStore\getRelativeRevision(), and wfDeprecated().

◆ getPreviousRevisionId()

Revision\RevisionStore::getPreviousRevisionId	(	IDatabase	$db,
		RevisionRecord	$rev
	)

private

Get previous revision Id for this page_id This is used to populate rev_parent_id on save.

MCR migration note: this corresponds to Revision::getPreviousRevisionId

Parameters

IDatabase	$db
RevisionRecord	$rev

Returns: int

Definition at line 2772 of file RevisionStore.php.

References Revision\RevisionStore\checkDatabaseDomain(), Revision\RevisionRecord\getId(), and Revision\RevisionRecord\getPageId().

Referenced by Revision\RevisionStore\insertRevisionOn().

◆ getQueryInfo()

Revision\RevisionStore::getQueryInfo ( $options = [] )

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

MCR migration note: this replaces Revision::getQueryInfo

If the format of fields returned changes in any way then the cache key provided by self::getRevisionRowCacheKey should be updated.

Since: 1.31

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

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() -return array{tables:string[],fields:string[],joins:array}

Definition at line 2441 of file RevisionStore.php.

Referenced by Revision\RevisionStore\fetchRevisionRowFromConds(), and Revision\RevisionStore\userWasLastToEdit().

◆ getRcIdIfUnpatrolled()

Revision\RevisionStore::getRcIdIfUnpatrolled ( RevisionRecord $rev )

MCR migration note: this replaces Revision::isUnpatrolled.

Todo:: This is overly specific, so move or kill this method.

Parameters

RevisionRecord $rev

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

Definition at line 961 of file RevisionStore.php.

References Revision\RevisionStore\getRecentChange(), and RecentChange\PRC_UNPATROLLED.

◆ getRecentChange()

Revision\RevisionStore::getRecentChange	(	RevisionRecord	$rev,
			$flags = `0`
	)

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

MCR migration note: this replaces Revision::getRecentChange

Todo:: move this somewhere else?

Parameters

RevisionRecord	$rev
int	$flags	(optional) $flags include: IDBAccessObject::READ_LATEST: Select the data from the master

Returns: null|RecentChange

Definition at line 983 of file RevisionStore.php.

References DBAccessObjectUtils\getDBOptions(), Revision\RevisionRecord\getId(), and RecentChange\newFromConds().

Referenced by Revision\RevisionStore\getRcIdIfUnpatrolled().

◆ getRelativeRevision()

Revision\RevisionStore::getRelativeRevision	(	RevisionRecord	$rev,
			$flags,
			$dir
	)

private

Implementation of getPreviousRevision and getNextRevision.

Parameters

RevisionRecord	$rev
int	$flags
string	$dir	'next' or 'prev'

Returns: RevisionRecord|null

Definition at line 2665 of file RevisionStore.php.

References Revision\RevisionStore\getDBConnectionRef(), DBAccessObjectUtils\getDBOptions(), Revision\RevisionRecord\getId(), Revision\RevisionRecord\getPageId(), Revision\RevisionStore\getRevisionById(), and Revision\RevisionStore\getTimestampFromId().

Referenced by Revision\RevisionStore\getNextRevision(), and Revision\RevisionStore\getPreviousRevision().

◆ getRevisionById()

Revision\RevisionStore::getRevisionById	(	$id,
		$flags = `0`
	)

Load a page revision from a given revision ID number.

Returns null if no such revision can be found.

MCR migration note: this replaces Revision::newFromId

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

Parameters

int	$id
int	$flags	(optional)

Returns: RevisionRecord|null

Implements Revision\RevisionLookup.

Definition at line 1091 of file RevisionStore.php.

References Revision\RevisionStore\newRevisionFromConds().

Referenced by Revision\RevisionStore\getRelativeRevision().

◆ getRevisionByPageId()

Revision\RevisionStore::getRevisionByPageId	(	$pageId,
		$revId = `0`,
		$flags = `0`
	)

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.

MCR migration note: this replaces Revision::newFromPageId

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

Parameters

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

Returns: RevisionRecord|null

Implements Revision\RevisionLookup.

Definition at line 1159 of file RevisionStore.php.

References Revision\RevisionStore\getDBConnectionRefForQueryFlags(), Revision\RevisionStore\loadRevisionFromConds(), and Revision\RevisionStore\newRevisionFromConds().

◆ getRevisionByTimestamp()

Revision\RevisionStore::getRevisionByTimestamp	(	LinkTarget	$title,
		string	$timestamp,
		int	$flags = `IDBAccessObject::READ_NORMAL`
	)

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.

MCR migration note: this replaces Revision::loadFromTimestamp

Parameters

LinkTarget	$title
string	$timestamp
int	$flags	Bitfield (optional) include: IDBAccessObject::READ_LATEST: Select the data from the master IDBAccessObject::READ_LOCKING: Select & lock the data from the master Default: IDBAccessObject::READ_NORMAL

Returns: RevisionRecord|null

Implements Revision\RevisionLookup.

Definition at line 1198 of file RevisionStore.php.

References $title, Revision\RevisionStore\getDBConnectionRefForQueryFlags(), Title\newFromLinkTarget(), and Revision\RevisionStore\newRevisionFromConds().

◆ getRevisionByTitle()

Revision\RevisionStore::getRevisionByTitle	(	LinkTarget	$linkTarget,
			$revId = `0`,
			$flags = `0`
	)

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.

MCR migration note: this replaces Revision::newFromTitle

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

Parameters

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

Returns: RevisionRecord|null

Implements Revision\RevisionLookup.

Definition at line 1111 of file RevisionStore.php.

References $title, Revision\RevisionStore\getDBConnectionRefForQueryFlags(), Revision\RevisionStore\loadRevisionFromConds(), Title\newFromLinkTarget(), and Revision\RevisionStore\newRevisionFromConds().

◆ getRevisionIdsBetween()

Revision\RevisionStore::getRevisionIdsBetween	(	int	$pageId,
		RevisionRecord	$old = `null`,
		RevisionRecord	$new = `null`,
		?int	$max = `null`,
			$options = `[]`,
		?string	$order = `null`,
		int	$flags = `IDBAccessObject::READ_NORMAL`
	)

Get IDs of revisions between the given revisions.

Since: 1.36

Parameters

int	$pageId	The id of the page
RevisionRecord \| null	$old	Old revision. If null is provided, count starting from the first revision (inclusive).
RevisionRecord \| null	$new	New revision. If null is provided, count until the last revision (inclusive).
int \| null	$max	Limit of Revisions to count, will be incremented by one to detect truncations.
string \| array	$options	Single option, or an array of options: RevisionStore::INCLUDE_OLD Include $old in the range; $new is excluded. RevisionStore::INCLUDE_NEW Include $new in the range; $old is excluded. RevisionStore::INCLUDE_BOTH Include both $old and $new in the range.
string \| null	$order	The direction in which the revisions should be sorted. Possible values: RevisionStore::ORDER_OLDEST_TO_NEWEST RevisionStore::ORDER_NEWEST_TO_OLDEST null for no specific ordering (default value)
int	$flags

Exceptions

InvalidArgumentException in case either revision is unsaved or the revisions do not belong to the same page or unknown option is passed.

Returns: int[]

Definition at line 3120 of file RevisionStore.php.

References Revision\RevisionStore\assertRevisionParameter(), Revision\RevisionRecord\DELETED_TEXT, and Revision\RevisionStore\getDBConnectionRefForQueryFlags().

◆ getRevisionLimitConditions()

Revision\RevisionStore::getRevisionLimitConditions	(	IDatabase	$dbr,
		RevisionRecord	$old = `null`,
		RevisionRecord	$new = `null`,
			$options = `[]`
	)

private

Converts revision limits to query conditions.

Parameters

IDatabase	$dbr
RevisionRecord \| null	$old	Old revision. If null is provided, count starting from the first revision (inclusive).
RevisionRecord \| null	$new	New revision. If null is provided, count until the last revision (inclusive).
string \| array	$options	Single option, or an array of options: RevisionStore::INCLUDE_OLD Include $old in the range; $new is excluded. RevisionStore::INCLUDE_NEW Include $new in the range; $old is excluded. RevisionStore::INCLUDE_BOTH Include both $old and $new in the range.

Returns: array

Definition at line 3060 of file RevisionStore.php.

References $dbr.

◆ getRevisionRowCacheKey()

Revision\RevisionStore::getRevisionRowCacheKey	(	IDatabase	$db,
			$pageId,
			$revId
	)

private

Get a cache key for use with a row as selected with getQueryInfo( [ 'page', 'user' ] ) Caching rows without 'page' or 'user' could lead to issues.

If the format of the rows returned by the query provided by getQueryInfo changes the cache key should be updated to avoid conflicts.

Parameters

IDatabase	$db
int	$pageId
int	$revId

Returns: string

Definition at line 3017 of file RevisionStore.php.

Referenced by Revision\RevisionStore\getKnownCurrentRevision().

◆ getRevisionSizes()

Revision\RevisionStore::getRevisionSizes ( array $revIds )

Do a batched query for the sizes of a set of revisions.

MCR migration note: this replaces Revision::getParentLengths

Parameters

int[] $revIds

Returns: int[] associative array mapping revision IDs from $revIds to the nominal size of the corresponding revision.

Definition at line 2619 of file RevisionStore.php.

References $dbr, $res, DB_REPLICA, and Revision\RevisionStore\getDBConnectionRef().

Referenced by Revision\RevisionStore\listRevisionSizes().

◆ getSlotRowsForBatch()

Revision\RevisionStore::getSlotRowsForBatch	(		$rowsOrIds,
		array	$options = `[]`,
			$queryFlags = `0`
	)

private

Gets the slot rows associated with a batch of revisions.

The serialized content of each slot can be included by setting the 'blobs' option. Callers are responsible for unserializing and interpreting the content blobs based on the model_name and role_name fields.

Parameters

Traversable \| array	$rowsOrIds	list of revision ids, or revision or archive rows from a db query.
array	$options	Supports the following options: 'slots' - a list of slot role names to fetch. If omitted or true or null, all slots are fetched 'blobs' - whether the serialized content of each slot should be loaded. If true, the serialiezd content will be present in the slot row in the blob_data field.
int	$queryFlags

Returns: StatusValue a status containing, if isOK() returns true, a two-level nested associative array, mapping from revision ID to an associative array that maps from role name to a database row object. The database row object will contain the fields defined by getSlotQueryInfo() with the 'content' flag set, plus the blob_data field if the 'blobs' is set in $options. The model_name and role_name fields will also be set.

Definition at line 1874 of file RevisionStore.php.

References Revision\RevisionStore\getDBConnectionRefForQueryFlags(), and Revision\RevisionStore\getSlotsQueryInfo().

Referenced by Revision\RevisionStore\getContentBlobsForBatch(), and Revision\RevisionStore\newRevisionsFromBatch().

◆ getSlotsQueryInfo()

Revision\RevisionStore::getSlotsQueryInfo ( $options = [] )

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

Since: 1.32

Parameters

array

$options

Any combination of the following strings

'content': Join with the content table, and select content meta-data fields
'model': Join with the content_models table, and select the model_name field. Only applicable if 'content' is also set.
'role': Join with the slot_roles table, and select the role_name field

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()
keys: (associative array) to look up fields to match against. In particular, the field that can be used to find slots by rev_id can be found in ['keys']['rev_id'].

Definition at line 2521 of file RevisionStore.php.

Referenced by Revision\RevisionStore\getSlotRowsForBatch(), and Revision\RevisionStore\loadSlotRecords().

◆ getTimestampFromId()

Revision\RevisionStore::getTimestampFromId	(	$id,
		$flags = `0`
	)

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

Historically, there was an extra Title parameter that was passed before $id. This is no longer needed and is deprecated in 1.34.

MCR migration note: this replaces Revision::getTimestampFromId

Parameters

int	$id
int	$flags

Returns: string|bool False if not found

Implements Revision\RevisionLookup.

Definition at line 2808 of file RevisionStore.php.

References Revision\RevisionStore\getDBConnectionRefForQueryFlags().

Referenced by Revision\RevisionStore\getRelativeRevision().

◆ getTitle()

Revision\RevisionStore::getTitle	(	$pageId,
		$revId,
		$queryFlags = `self::READ_NORMAL`
	)

Determines the page Title based on the available information.

MCR migration note: this corresponds to Revision::getTitle

Note: this method should be private, external use should be avoided!

Parameters

int \| null	$pageId
int \| null	$revId
int	$queryFlags

Returns: Title

Exceptions

RevisionAccessException

Definition at line 252 of file RevisionStore.php.

References $dbr, $title, DB_MASTER, Revision\RevisionStore\getDBConnectionRef(), DBAccessObjectUtils\getDBOptions(), DBAccessObjectUtils\hasFlags(), Title\newFromID(), Title\newFromRow(), and wfBacktrace().

Referenced by Revision\RevisionStore\newMutableRevisionFromArray(), and Revision\RevisionStore\newRevisionFromRowAndSlots().

◆ initializeMutableRevisionFromArray()

Revision\RevisionStore::initializeMutableRevisionFromArray	(	MutableRevisionRecord	$record,
		array	$fields
	)

private

Parameters

MutableRevisionRecord	$record
array	$fields

Definition at line 2131 of file RevisionStore.php.

References User\newFromAnyId(), Revision\MutableRevisionRecord\setComment(), Revision\MutableRevisionRecord\setId(), Revision\MutableRevisionRecord\setMinorEdit(), Revision\MutableRevisionRecord\setPageId(), Revision\MutableRevisionRecord\setParentId(), Revision\MutableRevisionRecord\setSha1(), Revision\MutableRevisionRecord\setSize(), Revision\MutableRevisionRecord\setTimestamp(), Revision\MutableRevisionRecord\setUser(), and Revision\MutableRevisionRecord\setVisibility().

Referenced by Revision\RevisionStore\newMutableRevisionFromArray().

◆ insertContentRowOn()

Revision\RevisionStore::insertContentRowOn	(	SlotRecord	$slot,
		IDatabase	$dbw,
			$blobAddress
	)

private

Parameters

SlotRecord	$slot
IDatabase	$dbw
string	$blobAddress

Returns: int content row ID

Definition at line 823 of file RevisionStore.php.

References Revision\SlotRecord\getModel(), Revision\SlotRecord\getSha1(), and Revision\SlotRecord\getSize().

Referenced by Revision\RevisionStore\insertSlotOn().

◆ insertIpChangesRow()

Revision\RevisionStore::insertIpChangesRow	(	IDatabase	$dbw,
		User	$user,
		RevisionRecord	$rev,
			$revisionId
	)

private

Insert IP revision into ip_changes for use when querying for a range.

Parameters

IDatabase	$dbw
User	$user
RevisionRecord	$rev
int	$revisionId

Definition at line 595 of file RevisionStore.php.

References User\getId(), User\getName(), and Revision\RevisionRecord\getTimestamp().

Referenced by Revision\RevisionStore\insertRevisionInternal().

◆ insertRevisionInternal()

Revision\RevisionStore::insertRevisionInternal	(	RevisionRecord	$rev,
		IDatabase	$dbw,
		User	$user,
		CommentStoreComment	$comment,
		Title	$title,
			$pageId,
			$parentId
	)

private

Definition at line 480 of file RevisionStore.php.

References $title, Revision\RevisionRecord\getSlot(), Revision\RevisionRecord\getSlotRoles(), Revision\RevisionStore\insertIpChangesRow(), Revision\RevisionStore\insertRevisionRowOn(), Revision\RevisionStore\insertSlotOn(), MediaWiki\Storage\BlobStore\PAGE_HINT, MediaWiki\Storage\BlobStore\PARENT_HINT, Revision\RevisionRecord\RAW, and MediaWiki\Storage\BlobStore\REVISION_HINT.

Referenced by Revision\RevisionStore\insertRevisionOn().

◆ insertRevisionOn()

Revision\RevisionStore::insertRevisionOn	(	RevisionRecord	$rev,
		IDatabase	$dbw
	)

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

MCR migration note: this replaces Revision::insertOn

Parameters

RevisionRecord	$rev
IDatabase	$dbw	(master connection)

Returns: RevisionRecord the new revision record.

Definition at line 365 of file RevisionStore.php.

◆ insertRevisionRowOn()

Revision\RevisionStore::insertRevisionRowOn	(	IDatabase	$dbw,
		RevisionRecord	$rev,
		Title	$title,
			$parentId
	)

private

Parameters

IDatabase	$dbw
RevisionRecord	$rev
Title	$title
int	$parentId

Returns: array a revision table row

Exceptions

MWException
MWUnknownContentModelException

Definition at line 622 of file RevisionStore.php.

References $title, Revision\RevisionStore\getBaseRevisionRow(), Revision\RevisionRecord\getComment(), Revision\RevisionRecord\getUser(), and Revision\RevisionRecord\RAW.

Referenced by Revision\RevisionStore\insertRevisionInternal().

◆ insertSlotOn()

Revision\RevisionStore::insertSlotOn	(	IDatabase	$dbw,
			$revisionId,
		SlotRecord	$protoSlot,
		Title	$title,
		array	$blobHints = `[]`
	)

private

Parameters

IDatabase	$dbw
int	$revisionId
SlotRecord	$protoSlot
Title	$title
array	$blobHints	See the BlobStore::XXX_HINT constants

Returns: SlotRecord

Definition at line 557 of file RevisionStore.php.

References $title, Revision\SlotRecord\getAddress(), Revision\SlotRecord\getContentId(), Revision\SlotRecord\hasAddress(), Revision\SlotRecord\hasContentId(), Revision\RevisionStore\insertContentRowOn(), Revision\RevisionStore\insertSlotRowOn(), Revision\SlotRecord\newSaved(), and Revision\RevisionStore\storeContentBlob().

Referenced by Revision\RevisionStore\insertRevisionInternal().

◆ insertSlotRowOn()

Revision\RevisionStore::insertSlotRowOn	(	SlotRecord	$slot,
		IDatabase	$dbw,
			$revisionId,
			$contentId
	)

private

Parameters

SlotRecord	$slot
IDatabase	$dbw
int	$revisionId
int	$contentId

Definition at line 805 of file RevisionStore.php.

References Revision\SlotRecord\getOrigin(), Revision\SlotRecord\getRole(), and Revision\SlotRecord\hasOrigin().

Referenced by Revision\RevisionStore\insertSlotOn().

◆ isReadOnly()

Revision\RevisionStore::isReadOnly ( )

Returns: bool Whether the store is read-only

Definition at line 206 of file RevisionStore.php.

◆ listRevisionSizes()

Revision\RevisionStore::listRevisionSizes	(	IDatabase	$db,
		array	$revIds
	)

Do a batched query for the sizes of a set of revisions.

MCR migration note: this replaces Revision::getParentLengths

Deprecated:: since 1.35 use RevisionStore::getRevisionSizes instead.

Parameters

IDatabase	$db
int[]	$revIds

Returns: int[] associative array mapping revision IDs from $revIds to the nominal size of the corresponding revision.

Definition at line 2652 of file RevisionStore.php.

References Revision\RevisionStore\getRevisionSizes(), and wfDeprecated().

◆ loadRevisionFromConds()

Revision\RevisionStore::loadRevisionFromConds	(	IDatabase	$db,
		array	$conditions,
		int	$flags = `IDBAccessObject::READ_NORMAL`,
		Title	$title = `null`,
		array	$options = `[]`
	)

private

Given a set of conditions, fetch a revision from the given database connection.

MCR migration note: this corresponds to Revision::loadFromConds

Parameters

IDatabase	$db
array	$conditions
int	$flags	(optional)
Title \| null	$title	(optional) additional query options
array	$options	(optional) additional query options

Returns: RevisionRecord|null

Definition at line 2353 of file RevisionStore.php.

References $title, Revision\RevisionStore\fetchRevisionRowFromConds(), and Revision\RevisionStore\newRevisionFromRow().

Referenced by Revision\RevisionStore\getRevisionByPageId(), Revision\RevisionStore\getRevisionByTitle(), Revision\RevisionStore\loadRevisionFromPageId(), Revision\RevisionStore\loadRevisionFromTimestamp(), Revision\RevisionStore\loadRevisionFromTitle(), Revision\RevisionStore\newNullRevision(), and Revision\RevisionStore\newRevisionFromConds().

◆ loadRevisionFromPageId()

Revision\RevisionStore::loadRevisionFromPageId	(	IDatabase	$db,
			$pageid,
			$id = `0`
	)

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

If not attached to that page, will return null.

MCR migration note: this replaces Revision::loadFromPageId

Deprecated:: since 1.35 Use RevisionStore::getRevisionByPageId instead.

Parameters

IDatabase	$db
int	$pageid
int	$id

Returns: RevisionRecord|null

Definition at line 2222 of file RevisionStore.php.

References Revision\RevisionStore\loadRevisionFromConds(), and wfDeprecated().

◆ loadRevisionFromTimestamp()

Revision\RevisionStore::loadRevisionFromTimestamp	(	IDatabase	$db,
			$title,
			$timestamp
	)

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.

MCR migration note: this replaces Revision::loadFromTimestamp

Deprecated:: since 1.35

Parameters

IDatabase	$db
Title	$title
string	$timestamp

Returns: RevisionRecord|null

Definition at line 2284 of file RevisionStore.php.

References $title, Revision\RevisionStore\loadRevisionFromConds(), and wfDeprecated().

◆ loadRevisionFromTitle()

Revision\RevisionStore::loadRevisionFromTitle	(	IDatabase	$db,
			$title,
			$id = `0`
	)

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

If not attached to that page, will return null.

MCR migration note: this replaces Revision::loadFromTitle

Note: direct use is deprecated!

Todo:: remove when unused!

Deprecated:: since 1.35

Parameters

IDatabase	$db
Title	$title
int	$id

Returns: RevisionRecord|null

Definition at line 2250 of file RevisionStore.php.

References $title, Revision\RevisionStore\loadRevisionFromConds(), and wfDeprecated().

◆ loadSlotContent()

Revision\RevisionStore::loadSlotContent	(	SlotRecord	$slot,
			$blobData = `null`,
			$blobFlags = `null`,
			$blobFormat = `null`,
			$queryFlags = `0`
	)

private

Loads a Content object based on a slot row.

This method does not call $slot->getContent(), and may be used as a callback called by $slot->getContent().

MCR migration note: this roughly corresponds to Revision::getContentInternal

Parameters

SlotRecord	$slot	The SlotRecord to load content for
string \| null	$blobData	The content blob, in the form indicated by $blobFlags
string \| null	$blobFlags	Flags indicating how $blobData needs to be processed. Use null if no processing should happen. That is in constrast to the empty string, which causes the blob to be decoded according to the configured legacy encoding.
string \| null	$blobFormat	MIME type indicating how $dataBlob is encoded
int	$queryFlags

Exceptions

RevisionAccessException

Returns: Content

Definition at line 1015 of file RevisionStore.php.

References Revision\SlotRecord\getAddress(), Revision\SlotRecord\getModel(), Revision\SlotRecord\getRevision(), Revision\SlotRecord\getRole(), Revision\SlotRecord\hasAddress(), and wfBacktrace().

Referenced by Revision\RevisionStore\constructSlotRecords().

◆ loadSlotRecords()

Revision\RevisionStore::loadSlotRecords	(		$revId,
			$queryFlags,
		Title	$title
	)

private

Parameters

int	$revId	The revision to load slots for.
int	$queryFlags
Title	$title

Returns: SlotRecord[]

Definition at line 1222 of file RevisionStore.php.

References $res, $revQuery, $title, Revision\RevisionStore\constructSlotRecords(), Revision\RevisionStore\getDBConnectionRef(), DBAccessObjectUtils\getDBOptions(), Revision\RevisionStore\getSlotsQueryInfo(), and wfBacktrace().

Referenced by Revision\RevisionStore\newRevisionSlots().

◆ newMutableRevisionFromArray()

Revision\RevisionStore::newMutableRevisionFromArray	(	array	$fields,
			$queryFlags = `0`,
		Title	$title = `null`
	)

Constructs a new MutableRevisionRecord based on the given associative array following the MW1.29 convention for the Revision constructor.

MCR migration note: this replaces Revision::newFromRow

Parameters

array	$fields
int	$queryFlags
Title \| null	$title

Returns: MutableRevisionRecord

Exceptions

MWException
RevisionAccessException

Implements Revision\RevisionFactory.

Definition at line 2037 of file RevisionStore.php.

References $content, $title, Revision\RevisionStore\getTitle(), Revision\RevisionStore\initializeMutableRevisionFromArray(), Revision\SlotRecord\MAIN, and CommentStoreComment\newUnsavedComment().

◆ newNullRevision()

Revision\RevisionStore::newNullRevision	(	IDatabase	$dbw,
		Title	$title,
		CommentStoreComment	$comment,
			$minor,
		User	$user
	)

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.

Note: This method grabs a FOR UPDATE lock on the relevant row of the page table, to prevent a new revision from being inserted before the null revision has been written to the database.

MCR migration note: this replaces Revision::newNullRevision

Todo:: Introduce newFromParentRevision(). newNullRevision can then be based on that (or go away).

Parameters

IDatabase	$dbw	used for obtaining the lock on the page table row
Title	$title	Title of the page to read from
CommentStoreComment	$comment	RevisionRecord's summary
bool	$minor	Whether the revision should be considered as minor
User	$user	The user to attribute the revision to

Returns: RevisionRecord|null RevisionRecord or null on error

Definition at line 889 of file RevisionStore.php.

References $title, Revision\RevisionStore\checkDatabaseDomain(), Revision\RevisionStore\loadRevisionFromConds(), and Revision\MutableRevisionRecord\newFromParentRevision().

◆ newRevisionFromArchiveRow()

Revision\RevisionStore::newRevisionFromArchiveRow	(		$row,
			$queryFlags = `0`,
		Title	$title = `null`,
		array	$overrides = `[]`
	)

Make a fake revision object from an archive table row.

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

MCR migration note: this replaces Revision::newFromArchiveRow

Parameters

\\stdClass	$row
int	$queryFlags
Title \| null	$title
array	$overrides	associative array with fields of $row to override. This may be used e.g. to force the parent revision ID or page ID. Keys in the array are fields names from the archive table without the 'ar_' prefix, i.e. use 'parent_id' to override ar_parent_id.

Returns: RevisionRecord

Exceptions

MWException

Implements Revision\RevisionFactory.

Definition at line 1388 of file RevisionStore.php.

References $title, and Revision\RevisionStore\newRevisionFromArchiveRowAndSlots().

◆ newRevisionFromArchiveRowAndSlots()

Revision\RevisionStore::newRevisionFromArchiveRowAndSlots	(		$row,
			$slots,
			$queryFlags = `0`,
		Title	$title = `null`,
		array	$overrides = `[]`
	)

See also: newRevisionFromArchiveRow()

Since: 1.35

Parameters

\\stdClass	$row
null \| \\stdClass[] \| RevisionSlots	$slots	Database rows generated from a query based on getSlotsQueryInfo with the 'content' flag set. Or RevisionSlots instance
int	$queryFlags
Title \| null	$title
array	$overrides	associative array with fields of $row to override. This may be used e.g. to force the parent revision ID or page ID. Keys in the array are fields names from the archive table without the 'ar_' prefix, i.e. use 'parent_id' to override ar_parent_id.

Returns: RevisionRecord

Exceptions

MWException

Definition at line 1438 of file RevisionStore.php.

References $title, Revision\RevisionStore\getDBConnectionRefForQueryFlags(), Title\makeTitle(), User\newFromAnyId(), Revision\RevisionStore\newRevisionSlots(), and wfWarn().

Referenced by Revision\RevisionStore\newRevisionFromArchiveRow().

◆ newRevisionFromConds()

Revision\RevisionStore::newRevisionFromConds	(	array	$conditions,
		int	$flags = `IDBAccessObject::READ_NORMAL`,
		Title	$title = `null`,
		array	$options = `[]`
	)

private

Given a set of conditions, fetch a revision.

This method should be used if we are pretty sure the revision exists. Unless $flags has READ_LATEST set, this method will first try to find the revision on a replica before hitting the master database.

MCR migration note: this corresponds to Revision::newFromConds

Parameters

array	$conditions
int	$flags	(optional)
Title \| null	$title	(optional)
array	$options	(optional) additional query options

Returns: RevisionRecord|null

Definition at line 2313 of file RevisionStore.php.

References $title, DB_MASTER, Revision\RevisionStore\getDBConnectionRef(), Revision\RevisionStore\getDBConnectionRefForQueryFlags(), Revision\RevisionStore\getDBLoadBalancer(), and Revision\RevisionStore\loadRevisionFromConds().

Referenced by Revision\RevisionStore\getFirstRevision(), Revision\RevisionStore\getRevisionById(), Revision\RevisionStore\getRevisionByPageId(), Revision\RevisionStore\getRevisionByTimestamp(), and Revision\RevisionStore\getRevisionByTitle().

◆ newRevisionFromRow()

Revision\RevisionStore::newRevisionFromRow	(		$row,
			$queryFlags = `0`,
		Title	$title = `null`,
			$fromCache = `false`
	)

See also: RevisionFactory::newRevisionFromRow

MCR migration note: this replaces Revision::newFromRow

Parameters

\\stdClass	$row	A database row generated from a query based on getQueryInfo()
int	$queryFlags
Title \| null	$title	Preloaded title object based on Title::newFromRow from database row when query was build with option 'page' on getQueryInfo
bool	$fromCache	if true, the returned RevisionRecord will ensure that no stale data is returned from getters, by querying the database as needed

Returns: RevisionRecord

Definition at line 1410 of file RevisionStore.php.

References $title, and Revision\RevisionStore\newRevisionFromRowAndSlots().

Referenced by Revision\RevisionStore\getKnownCurrentRevision(), and Revision\RevisionStore\loadRevisionFromConds().

◆ newRevisionFromRowAndSlots()

Revision\RevisionStore::newRevisionFromRowAndSlots	(		$row,
			$slots,
			$queryFlags = `0`,
		Title	$title = `null`,
			$fromCache = `false`
	)

See also: newFromRevisionRow()

Parameters

\\stdClass	$row	A database row generated from a query based on getQueryInfo()
null \| \\stdClass[] \| RevisionSlots	$slots	Database rows generated from a query based on getSlotsQueryInfo with the 'content' flag set. Or RevisionSlots instance
int	$queryFlags
Title \| null	$title
bool	$fromCache	if true, the returned RevisionRecord will ensure that no stale data is returned from getters, by querying the database as needed

Returns: RevisionRecord

Exceptions

MWException

See also: RevisionFactory::newRevisionFromRow

Definition at line 1519 of file RevisionStore.php.

References Revision\RevisionStore\$dbDomain, $title, Revision\RevisionStore\ensureRevisionRowMatchesTitle(), Revision\RevisionStore\fetchRevisionRowFromConds(), Revision\RevisionStore\getDBConnectionRefForQueryFlags(), Revision\RevisionStore\getTitle(), User\newFromAnyId(), Revision\RevisionStore\newRevisionSlots(), wfBacktrace(), and wfWarn().

Referenced by Revision\RevisionStore\newRevisionFromRow().

◆ newRevisionsFromBatch()

Revision\RevisionStore::newRevisionsFromBatch	(		$rows,
		array	$options = `[]`,
			$queryFlags = `0`,
		Title	$title = `null`
	)

Construct a RevisionRecord instance for each row in $rows, and return them as an associative array indexed by revision ID.

Use getQueryInfo() or getArchiveQueryInfo() to construct the query that produces the rows.

Parameters

IResultWrapper \| \\stdClass[]	$rows	the rows to construct revision records from
array	$options	Supports the following options: 'slots' - whether metadata about revision slots should be loaded immediately. Supports falsy or truthy value as well as an explicit list of slot role names. The main slot will always be loaded. 'content' - whether the actual content of the slots should be preloaded. 'archive' - whether the rows where generated using getArchiveQueryInfo(), rather than getQueryInfo.
int	$queryFlags
Title \| null	$title	The title to which all the revision rows belong, if there is such a title and the caller has it handy, so we don't have to look it up again. If this parameter is given and any of the rows has a rev_page_id that is different from $title->getArticleID(), an InvalidArgumentException is thrown.

Returns: StatusValue a status with a RevisionRecord[] of successfully fetched revisions and an array of errors for the revisions failed to fetch.

Definition at line 1663 of file RevisionStore.php.

References $t, $title, Revision\RevisionStore\getSlotRowsForBatch(), if, Revision\SlotRecord\MAIN, Title\makeTitle(), Title\newFromIDs(), and Title\newFromRow().

◆ newRevisionSlots()

Revision\RevisionStore::newRevisionSlots	(		$revId,
			$revisionRow,
			$slotRows,
			$queryFlags,
		Title	$title
	)

private

Factory method for RevisionSlots based on a revision ID.

Note: If other code has a need to construct RevisionSlots objects, this should be made public, since RevisionSlots instances should not be constructed directly.

Parameters

int	$revId
\\stdClass	$revisionRow
\\stdClass[] \| null	$slotRows
int	$queryFlags
Title	$title

Returns: RevisionSlots

Exceptions

MWException

Definition at line 1348 of file RevisionStore.php.

References $title, Revision\RevisionStore\constructSlotRecords(), and Revision\RevisionStore\loadSlotRecords().

Referenced by Revision\RevisionStore\newRevisionFromArchiveRowAndSlots(), and Revision\RevisionStore\newRevisionFromRowAndSlots().

◆ setLogger()

Revision\RevisionStore::setLogger ( LoggerInterface $logger )

Definition at line 199 of file RevisionStore.php.

References Revision\RevisionStore\$logger.

◆ storeContentBlob()

Revision\RevisionStore::storeContentBlob	(	SlotRecord	$slot,
		Title	$title,
		array	$blobHints = `[]`
	)

private

Parameters

SlotRecord	$slot
Title	$title
array	$blobHints	See the BlobStore::XXX_HINT constants

Exceptions

MWException

Returns: string the blob address

Definition at line 771 of file RevisionStore.php.

References $content, Revision\RevisionStore\checkContent(), MediaWiki\Storage\BlobStore\DESIGNATION_HINT, MediaWiki\Storage\BlobStore\FORMAT_HINT, Revision\SlotRecord\getContent(), Revision\SlotRecord\getRole(), Revision\SlotRecord\getSha1(), MediaWiki\Storage\BlobStore\MODEL_HINT, MediaWiki\Storage\BlobStore\ROLE_HINT, and MediaWiki\Storage\BlobStore\SHA1_HINT.

Referenced by Revision\RevisionStore\insertSlotOn().

◆ userWasLastToEdit()

Revision\RevisionStore::userWasLastToEdit	(	IDatabase	$db,
			$pageId,
			$userId,
			$since
	)

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.

MCR migration note: this replaces Revision::userWasLastToEdit

Deprecated:: since 1.31; Can possibly be removed, since the self-conflict suppression logic in EditPage that uses this seems conceptually dubious. Revision::userWasLastToEdit has been deprecated since 1.24.

Parameters

IDatabase	$db	The Database to perform the check on.
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 2880 of file RevisionStore.php.

References $res, $revQuery, Revision\RevisionStore\checkDatabaseDomain(), and Revision\RevisionStore\getQueryInfo().

Member Data Documentation

◆ $actorMigration

ActorMigration Revision\RevisionStore::$actorMigration

private

Definition at line 120 of file RevisionStore.php.

Referenced by Revision\RevisionStore\__construct().

◆ $blobStore

SqlBlobStore Revision\RevisionStore::$blobStore

private

Definition at line 95 of file RevisionStore.php.

Referenced by Revision\RevisionStore\__construct().

◆ $cache

WANObjectCache Revision\RevisionStore::$cache

private

Definition at line 110 of file RevisionStore.php.

Referenced by Revision\RevisionStore\__construct().

◆ $commentStore

CommentStore Revision\RevisionStore::$commentStore

private

Definition at line 115 of file RevisionStore.php.

Referenced by Revision\RevisionStore\__construct().

◆ $contentHandlerFactory

IContentHandlerFactory Revision\RevisionStore::$contentHandlerFactory

private

Definition at line 141 of file RevisionStore.php.

Referenced by Revision\RevisionStore\__construct().

◆ $contentModelStore

NameTableStore Revision\RevisionStore::$contentModelStore

private

Definition at line 130 of file RevisionStore.php.

Referenced by Revision\RevisionStore\__construct().

◆ $dbDomain

bool string Revision\RevisionStore::$dbDomain

private

Definition at line 100 of file RevisionStore.php.

Referenced by Revision\RevisionStore\__construct(), Revision\RevisionStore\checkDatabaseDomain(), and Revision\RevisionStore\newRevisionFromRowAndSlots().

◆ $hookContainer

HookContainer Revision\RevisionStore::$hookContainer

private

Definition at line 144 of file RevisionStore.php.

Referenced by Revision\RevisionStore\__construct().

◆ $hookRunner

HookRunner Revision\RevisionStore::$hookRunner

private

Definition at line 147 of file RevisionStore.php.

◆ $loadBalancer

ILoadBalancer Revision\RevisionStore::$loadBalancer

private

Definition at line 105 of file RevisionStore.php.

Referenced by Revision\RevisionStore\__construct(), and Revision\RevisionStore\getDBLoadBalancer().

◆ $logger

LoggerInterface Revision\RevisionStore::$logger

private

Definition at line 125 of file RevisionStore.php.

Referenced by Revision\RevisionStore\setLogger().

◆ $slotRoleRegistry

SlotRoleRegistry Revision\RevisionStore::$slotRoleRegistry

private

Definition at line 138 of file RevisionStore.php.

Referenced by Revision\RevisionStore\__construct().

◆ $slotRoleStore

NameTableStore Revision\RevisionStore::$slotRoleStore

private

Definition at line 135 of file RevisionStore.php.

Referenced by Revision\RevisionStore\__construct().

◆ INCLUDE_BOTH

const Revision\RevisionStore::INCLUDE_BOTH = 'include_both'

Definition at line 90 of file RevisionStore.php.

Referenced by MediaWiki\Storage\RevertedTagUpdate\doUpdate().

◆ INCLUDE_NEW

const Revision\RevisionStore::INCLUDE_NEW = 'include_new'

Definition at line 89 of file RevisionStore.php.

◆ INCLUDE_OLD

const Revision\RevisionStore::INCLUDE_OLD = 'include_old'

Definition at line 88 of file RevisionStore.php.

◆ ORDER_NEWEST_TO_OLDEST

const Revision\RevisionStore::ORDER_NEWEST_TO_OLDEST = 'DESC'

Definition at line 85 of file RevisionStore.php.

◆ ORDER_OLDEST_TO_NEWEST

const Revision\RevisionStore::ORDER_OLDEST_TO_NEWEST = 'ASC'

Definition at line 84 of file RevisionStore.php.

◆ ROW_CACHE_KEY

const Revision\RevisionStore::ROW_CACHE_KEY = 'revision-row-1.29'

Definition at line 82 of file RevisionStore.php.

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

includes/Revision/RevisionStore.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assertRevisionParameter()

◆ checkContent()

◆ checkDatabaseDomain()

◆ constructSlotRecords()

◆ countAuthorsBetween()

◆ countRevisionsBetween()

◆ countRevisionsByPageId()

◆ countRevisionsByTitle()

◆ ensureRevisionRowMatchesTitle()

◆ failOnEmpty()

◆ failOnNull()

◆ fetchRevisionRowFromConds()

◆ getArchiveQueryInfo()

◆ getAuthorsBetween()

◆ getBaseRevisionRow()

◆ getContentBlobsForBatch()

◆ getDBConnectionRef()

◆ getDBConnectionRefForQueryFlags()

◆ getDBLoadBalancer()

◆ getFirstRevision()

◆ getKnownCurrentRevision()

◆ getNextRevision()

◆ getPreviousRevision()

◆ getPreviousRevisionId()

◆ getQueryInfo()

◆ getRcIdIfUnpatrolled()

◆ getRecentChange()

◆ getRelativeRevision()

◆ getRevisionById()

◆ getRevisionByPageId()

◆ getRevisionByTimestamp()

◆ getRevisionByTitle()

◆ getRevisionIdsBetween()

◆ getRevisionLimitConditions()

◆ getRevisionRowCacheKey()

◆ getRevisionSizes()

◆ getSlotRowsForBatch()

◆ getSlotsQueryInfo()

◆ getTimestampFromId()

◆ getTitle()

◆ initializeMutableRevisionFromArray()

◆ insertContentRowOn()

◆ insertIpChangesRow()

◆ insertRevisionInternal()

◆ insertRevisionOn()

◆ insertRevisionRowOn()

◆ insertSlotOn()

◆ insertSlotRowOn()

◆ isReadOnly()

◆ listRevisionSizes()

◆ loadRevisionFromConds()

◆ loadRevisionFromPageId()

◆ loadRevisionFromTimestamp()

◆ loadRevisionFromTitle()

◆ loadSlotContent()

◆ loadSlotRecords()

◆ newMutableRevisionFromArray()

◆ newNullRevision()

◆ newRevisionFromArchiveRow()

◆ newRevisionFromArchiveRowAndSlots()

◆ newRevisionFromConds()

◆ newRevisionFromRow()

◆ newRevisionFromRowAndSlots()

◆ newRevisionsFromBatch()

◆ newRevisionSlots()

◆ setLogger()

◆ storeContentBlob()

◆ userWasLastToEdit()

Member Data Documentation

◆ $actorMigration

◆ $blobStore

◆ $cache