MediaWiki: MediaWiki\Revision\RevisionStore Class Reference

Definition at line 2360 of file RevisionStore.php.

References Wikimedia\Rdbms\IDatabase\getDomainID().

◆ constructSlotRecords()

MediaWiki\Revision\RevisionStore::constructSlotRecords	(		$revId,
			$slotRows,
			$queryFlags,
		PageIdentity	$page,
			$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
PageIdentity	$page
array \| null	$slotContents	a map from blobAddress to slot content blob or Content object.

Returns: SlotRecord[]

Definition at line 1463 of file RevisionStore.php.

References $blob, and wfBacktrace().

◆ countAuthorsBetween()

MediaWiki\Revision\RevisionStore::countAuthorsBetween	(		$pageId,
		RevisionRecord	$old = `null`,
		RevisionRecord	$new = `null`,
		Authority	$performer = `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).
Authority \| null	$performer	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 3279 of file RevisionStore.php.

◆ countRevisionsBetween()

MediaWiki\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 3312 of file RevisionStore.php.

References $dbr, and DB_REPLICA.

◆ countRevisionsByPageId()

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

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

MCR migration note: this replaced Revision::countByPageId

Parameters

IDatabase	$db
int	$id	Page id

Returns: int

Definition at line 2829 of file RevisionStore.php.

References Wikimedia\Rdbms\IDatabase\selectRow().

◆ countRevisionsByTitle()

MediaWiki\Revision\RevisionStore::countRevisionsByTitle	(	IDatabase	$db,
		PageIdentity	$page
	)

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

MCR migration note: this replaced Revision::countByTitle

Parameters

IDatabase	$db
PageIdentity	$page

Returns: int

Definition at line 2852 of file RevisionStore.php.

◆ ensureRevisionRowMatchesPage()

MediaWiki\Revision\RevisionStore::ensureRevisionRowMatchesPage	(		$row,
		PageIdentity	$page,
			$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 primary DB, to avoid spurious errors during page moves.

Parameters

\\stdClass	$row
PageIdentity	$page
array	$context

Returns: Pageidentity

Definition at line 1825 of file RevisionStore.php.

References MediaWiki\Page\PageReference\getDBkey(), MediaWiki\Page\PageIdentity\getId(), MediaWiki\Page\PageReference\getNamespace(), and wfBacktrace().

◆ failOnEmpty()

MediaWiki\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 413 of file RevisionStore.php.

◆ failOnNull()

MediaWiki\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 396 of file RevisionStore.php.

◆ fetchRevisionRowFromConds()

MediaWiki\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 corresponded 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 2383 of file RevisionStore.php.

References $revQuery, and Wikimedia\Rdbms\IDatabase\selectRow().

◆ findIdenticalRevision()

MediaWiki\Revision\RevisionStore::findIdenticalRevision	(	RevisionRecord	$revision,
		int	$searchLimit
	)

Tries to find a revision identical to $revision in $searchLimit most recent revisions of this page.

The comparison is based on SHA1s of these revisions.

Since: 1.37

Parameters

RevisionRecord	$revision	which revision to compare to
int	$searchLimit	How many recent revisions should be checked

Returns: RevisionRecord|null

Definition at line 3360 of file RevisionStore.php.

◆ getArchiveQueryInfo()

MediaWiki\Revision\RevisionStore::getArchiveQueryInfo ( )

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

Since 1.34, ar_user and ar_user_text have not been present in the database, but they continue to be available in query results as aliases.

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

References MediaWiki\Revision\RevisionRecord\getId(), MediaWiki\Revision\RevisionRecord\getPageId(), MediaWiki\Revision\RevisionRecord\getSha1(), MediaWiki\Revision\RevisionRecord\getSize(), MediaWiki\Revision\RevisionRecord\getTimestamp(), MediaWiki\Revision\RevisionRecord\getVisibility(), MediaWiki\Revision\RevisionRecord\isMinor(), and Wikimedia\Rdbms\IDatabase\timestamp().

Definition at line 2597 of file RevisionStore.php.

◆ getAuthorsBetween()

MediaWiki\Revision\RevisionStore::getAuthorsBetween	(		$pageId,
		RevisionRecord	$old = `null`,
		RevisionRecord	$new = `null`,
		Authority	$performer = `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).
Authority \| null	$performer	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 3202 of file RevisionStore.php.

References $dbr, and DB_REPLICA.

◆ getBaseRevisionRow()

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

private

Parameters

IDatabase	$dbw
RevisionRecord	$rev
int	$parentId

Returns: array a revision table row

Definition at line 882 of file RevisionStore.php.

◆ getContentBlobsForBatch()

MediaWiki\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 2249 of file RevisionStore.php.

◆ getDBConnectionRef()

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

private

Parameters

int	$mode	DB_PRIMARY or DB_REPLICA
array	$groups

Returns: DBConnRef

Definition at line 276 of file RevisionStore.php.

References MediaWiki\Revision\RevisionStore\getDBLoadBalancer().

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

◆ getDBConnectionRefForQueryFlags()

MediaWiki\Revision\RevisionStore::getDBConnectionRefForQueryFlags ( $queryFlags )

private

Parameters

int $queryFlags a bit field composed of READ_XXX flags

Returns: DBConnRef

Definition at line 265 of file RevisionStore.php.

References MediaWiki\Revision\RevisionStore\getDBConnectionRef().

◆ getDBLoadBalancer()

MediaWiki\Revision\RevisionStore::getDBLoadBalancer ( )

private

Returns: ILoadBalancer

Definition at line 247 of file RevisionStore.php.

References MediaWiki\Revision\RevisionStore\$loadBalancer.

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

◆ getFirstRevision()

MediaWiki\Revision\RevisionStore::getFirstRevision	(		$page,
		int	$flags = `IDBAccessObject::READ_NORMAL`
	)

Get the first revision of a given page.

Since: 1.35

Parameters

LinkTarget \| PageIdentity	$page	Calling with LinkTarget is deprecated since 1.36
int	$flags

Returns: RevisionRecord|null

Definition at line 2992 of file RevisionStore.php.

◆ getKnownCurrentRevision()

MediaWiki\Revision\RevisionStore::getKnownCurrentRevision	(	PageIdentity	$page,
			$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 replaced Revision::newKnownCurrent

Parameters

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

Returns: RevisionRecord|bool Returns false if missing

Definition at line 2920 of file RevisionStore.php.

References $title, MediaWiki\Page\PageReference\__toString(), and DB_REPLICA.

◆ getNextRevision()

MediaWiki\Revision\RevisionStore::getNextRevision	(	RevisionRecord	$rev,
			$flags = `self::READ_NORMAL`
	)

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 replaced Revision::getNext

Parameters

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

Returns: RevisionRecord|null

Definition at line 2745 of file RevisionStore.php.

◆ getPage()

MediaWiki\Revision\RevisionStore::getPage	(	?int	$pageId,
		?int	$revId,
		int	$queryFlags = `self::READ_NORMAL`
	)

private

Determines the page based on the available information.

Parameters

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

Returns: PageIdentity

Exceptions

RevisionAccessException

Definition at line 317 of file RevisionStore.php.

References $title, MediaWiki\Revision\RevisionStore\getPage(), wfBacktrace(), and MediaWiki\Revision\RevisionStore\wrapPage().

Referenced by MediaWiki\Revision\RevisionStore\getPage(), and MediaWiki\Revision\RevisionStore\getTitle().

◆ getPreviousRevision()

MediaWiki\Revision\RevisionStore::getPreviousRevision	(	RevisionRecord	$rev,
			$flags = `self::READ_NORMAL`
	)

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 replaced Revision::getPrevious

See also: PageArchive::getPreviousRevisionRecord

Parameters

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

Returns: RevisionRecord|null

Definition at line 2730 of file RevisionStore.php.

◆ getPreviousRevisionId()

MediaWiki\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 corresponded to Revision::getPreviousRevisionId

Parameters

IDatabase	$db
RevisionRecord	$rev

Returns: int

Definition at line 2760 of file RevisionStore.php.

References MediaWiki\Revision\RevisionRecord\getId(), MediaWiki\Revision\RevisionRecord\getPageId(), and Wikimedia\Rdbms\IDatabase\selectField().

◆ getQueryInfo()

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

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

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

Definition at line 2426 of file RevisionStore.php.

◆ getRcIdIfUnpatrolled()

MediaWiki\Revision\RevisionStore::getRcIdIfUnpatrolled ( RevisionRecord $rev )

MCR migration note: this replaced 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 1103 of file RevisionStore.php.

◆ getRecentChange()

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

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

MCR migration note: this replaced Revision::getRecentChange

Todo:: move this somewhere else?

Parameters

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

Returns: null|RecentChange

Definition at line 1125 of file RevisionStore.php.

References MediaWiki\Revision\RevisionRecord\getId().

◆ getRelativeRevision()

MediaWiki\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 2666 of file RevisionStore.php.

References MediaWiki\Revision\RevisionRecord\getId(), and MediaWiki\Revision\RevisionRecord\getPageId().

◆ getRevisionById()

MediaWiki\Revision\RevisionStore::getRevisionById	(		$id,
			$flags = `0`,
		PageIdentity	$page = `null`
	)

Load a page revision from a given revision ID number.

Returns null if no such revision can be found.

MCR migration note: this replaced Revision::newFromId

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

Parameters

int	$id
int	$flags	(optional)
PageIdentity \| null	$page	The page the revision belongs to. Providing the page may improve performance.

Returns: RevisionRecord|null

Definition at line 1239 of file RevisionStore.php.

◆ getRevisionByPageId()

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

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

Parameters

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

Returns: RevisionRecord|null

Definition at line 1306 of file RevisionStore.php.

◆ getRevisionByTimestamp()

MediaWiki\Revision\RevisionStore::getRevisionByTimestamp	(		$page,
		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 replaced Revision::loadFromTimestamp

Parameters

LinkTarget \| PageIdentity	$page	Calling with LinkTarget is deprecated since 1.36
string	$timestamp
int	$flags	Bitfield (optional) include: IDBAccessObject::READ_LATEST: Select the data from the primary DB IDBAccessObject::READ_LOCKING: Select & lock the data from the primary DB Default: IDBAccessObject::READ_NORMAL

Returns: RevisionRecord|null

Definition at line 1345 of file RevisionStore.php.

◆ getRevisionByTitle()

MediaWiki\Revision\RevisionStore::getRevisionByTitle	(	$page,
		$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 replaced Revision::newFromTitle

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

Parameters

LinkTarget \| PageIdentity	$page	Calling with LinkTarget is deprecated since 1.36
int	$revId	(optional)
int	$flags	Bitfield (optional)

Returns: RevisionRecord|null

Definition at line 1259 of file RevisionStore.php.

◆ getRevisionIdsBetween()

MediaWiki\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 3128 of file RevisionStore.php.

◆ getRevisionLimitConditions()

MediaWiki\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 3068 of file RevisionStore.php.

References $dbr.

◆ getRevisionRowCacheKey()

MediaWiki\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 3025 of file RevisionStore.php.

References Wikimedia\Rdbms\IDatabase\getDomainID().

◆ getRevisionSizes()

MediaWiki\Revision\RevisionStore::getRevisionSizes ( array $revIds )

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

MCR migration note: this replaced 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 2637 of file RevisionStore.php.

References $dbr, $res, and DB_REPLICA.

◆ getSlotRowsForBatch()

MediaWiki\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 serialized 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 2132 of file RevisionStore.php.

◆ getSlotsQueryInfo()

MediaWiki\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 2506 of file RevisionStore.php.

◆ getTimestampFromId()

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

Parameters

int	$id
int	$flags

Returns: string|bool False if not found

References Wikimedia\Rdbms\IDatabase\delete(), MediaWiki\Revision\RevisionRecord\getComment(), Wikimedia\Rdbms\IDatabase\getType(), MediaWiki\Revision\RevisionRecord\getUser(), Wikimedia\Rdbms\IDatabase\insert(), Wikimedia\Rdbms\IDatabase\insertId(), Wikimedia\Rdbms\IDatabase\lock(), Wikimedia\Rdbms\IDatabase\onTransactionResolution(), Wikimedia\Rdbms\IDatabase\query(), Wikimedia\Rdbms\IDatabase\selectField(), Wikimedia\Rdbms\IDatabase\selectSQLText(), and Wikimedia\Rdbms\IDatabase\unlock().

Definition at line 2796 of file RevisionStore.php.

◆ getTitle()

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

Determines the page Title based on the available information.

MCR migration note: this corresponded to Revision::getTitle

Deprecated:: since 1.36, Use RevisionRecord::getPage() instead.

Note: The resulting Title object will be misleading if the RevisionStore is not for the local wiki.

Parameters

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

Returns: Title

Exceptions

RevisionAccessException

Definition at line 297 of file RevisionStore.php.

References MediaWiki\Revision\RevisionStore\getPage(), and wfDeprecatedMsg().

◆ getWikiId()

MediaWiki\Revision\RevisionStore::getWikiId ( )

Get the ID of the wiki this revision belongs to.

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

Definition at line 256 of file RevisionStore.php.

References MediaWiki\Revision\RevisionStore\$wikiId.

◆ insertContentRowOn()

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

private

Parameters

SlotRecord	$slot
IDatabase	$dbw
string	$blobAddress

Returns: int content row ID

Definition at line 966 of file RevisionStore.php.

References MediaWiki\Revision\SlotRecord\getModel(), MediaWiki\Revision\SlotRecord\getSha1(), MediaWiki\Revision\SlotRecord\getSize(), Wikimedia\Rdbms\IDatabase\insert(), and Wikimedia\Rdbms\IDatabase\insertId().

◆ insertIpChangesRow()

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

private

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

Parameters

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

Definition at line 742 of file RevisionStore.php.

References MediaWiki\User\UserIdentity\getId(), MediaWiki\User\UserIdentity\getName(), MediaWiki\Revision\RevisionRecord\getTimestamp(), Wikimedia\Rdbms\IDatabase\insert(), and Wikimedia\Rdbms\IDatabase\timestamp().

◆ insertRevisionInternal()

MediaWiki\Revision\RevisionStore::insertRevisionInternal	(	RevisionRecord	$rev,
		IDatabase	$dbw,
		UserIdentity	$user,
		CommentStoreComment	$comment,
		PageIdentity	$page,
			$pageId,
			$parentId
	)

private

Definition at line 628 of file RevisionStore.php.

References MediaWiki\Revision\RevisionRecord\getSlot(), and MediaWiki\Revision\RevisionRecord\getSlotRoles().

◆ insertRevisionOn()

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

Parameters

RevisionRecord	$rev
IDatabase	$dbw	(primary connection)

Returns: RevisionRecord the new revision record.

Definition at line 434 of file RevisionStore.php.

◆ insertRevisionRowOn()

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

private

Parameters

IDatabase	$dbw
RevisionRecord	$rev
int	$parentId

Returns: array a revision table row

Exceptions

MWException
MWUnknownContentModelException

Definition at line 768 of file RevisionStore.php.

◆ insertSlotOn()

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

private

Parameters

IDatabase	$dbw
int	$revisionId
SlotRecord	$protoSlot
PageIdentity	$page
array	$blobHints	See the BlobStore::XXX_HINT constants

Returns: SlotRecord

Definition at line 704 of file RevisionStore.php.

References MediaWiki\Revision\SlotRecord\getAddress(), MediaWiki\Revision\SlotRecord\getContentId(), MediaWiki\Revision\SlotRecord\hasAddress(), and MediaWiki\Revision\SlotRecord\hasContentId().

◆ insertSlotRowOn()

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

private

Parameters

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

Definition at line 948 of file RevisionStore.php.

References MediaWiki\Revision\SlotRecord\getOrigin(), MediaWiki\Revision\SlotRecord\getRole(), MediaWiki\Revision\SlotRecord\hasOrigin(), and Wikimedia\Rdbms\IDatabase\insert().

◆ isReadOnly()

MediaWiki\Revision\RevisionStore::isReadOnly ( )

Returns: bool Whether the store is read-only

Definition at line 240 of file RevisionStore.php.

◆ isRevisionRow()

MediaWiki\Revision\RevisionStore::isRevisionRow	(		$row,
		string	$table = `''`
	)

Determine whether the parameter is a row containing all the fields that RevisionStore needs to create a RevisionRecord from the row.

Parameters

mixed	$row
string	$table	'archive' or empty

Returns: bool

Definition at line 2566 of file RevisionStore.php.

◆ loadRevisionFromConds()

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

private

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

MCR migration note: this corresponded to Revision::loadFromConds

Parameters

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

Returns: RevisionRecord|null

Definition at line 2338 of file RevisionStore.php.

◆ loadSlotContent()

MediaWiki\Revision\RevisionStore::loadSlotContent	(	SlotRecord	$slot,
		?string	$blobData = `null`,
		?string	$blobFlags = `null`,
		?string	$blobFormat = `null`,
		int	$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 corresponded 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 1157 of file RevisionStore.php.

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

◆ loadSlotRecords()

MediaWiki\Revision\RevisionStore::loadSlotRecords	(		$revId,
			$queryFlags,
		PageIdentity	$page
	)

private

Parameters

int	$revId	The revision to load slots for.
int	$queryFlags
PageIdentity	$page

Returns: SlotRecord[]

Definition at line 1373 of file RevisionStore.php.

References $res, MediaWiki\Page\PageIdentity\getId(), MediaWiki\Page\PageReference\getNamespace(), MediaWiki\Page\PageReference\getWikiId(), and NS_TEMPLATE.

◆ loadSlotRecordsFromDb()

MediaWiki\Revision\RevisionStore::loadSlotRecordsFromDb	(		$revId,
			$queryFlags,
		PageIdentity	$page
	)

private

Definition at line 1416 of file RevisionStore.php.

◆ newNullRevision()

MediaWiki\Revision\RevisionStore::newNullRevision	(	IDatabase	$dbw,
		PageIdentity	$page,
		CommentStoreComment	$comment,
			$minor,
		UserIdentity	$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 replaced 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
PageIdentity	$page	the page to read from
CommentStoreComment	$comment	RevisionRecord's summary
bool	$minor	Whether the revision should be considered as minor
UserIdentity	$user	The user to attribute the revision to

Returns: RevisionRecord|null RevisionRecord or null on error

Definition at line 1032 of file RevisionStore.php.

References Wikimedia\Rdbms\IDatabase\selectField().

◆ newRevisionFromArchiveRow()

MediaWiki\Revision\RevisionStore::newRevisionFromArchiveRow	(		$row,
			$queryFlags = `0`,
		PageIdentity	$page = `null`,
		array	$overrides = `[]`
	)

Make a fake RevisionRecord object from an archive table row.

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

The user ID and user name may optionally be supplied using the aliases ar_user and ar_user_text (the names of fields which existed before MW 1.34).

MCR migration note: this replaced Revision::newFromArchiveRow

Parameters

\\stdClass	$row
int	$queryFlags
PageIdentity \| null	$page
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

Definition at line 1582 of file RevisionStore.php.

◆ newRevisionFromArchiveRowAndSlots()

MediaWiki\Revision\RevisionStore::newRevisionFromArchiveRowAndSlots	(	stdClass	$row,
			$slots,
		int	$queryFlags = `0`,
		?PageIdentity	$page = `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
PageIdentity \| null	$page
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

Definition at line 1631 of file RevisionStore.php.

◆ newRevisionFromConds()

MediaWiki\Revision\RevisionStore::newRevisionFromConds	(	array	$conditions,
		int	$flags = `IDBAccessObject::READ_NORMAL`,
		PageIdentity	$page = `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 primary database.

MCR migration note: this corresponded to Revision::newFromConds

Parameters

array	$conditions
int	$flags	(optional)
PageIdentity \| null	$page	(optional)
array	$options	(optional) additional query options

Returns: RevisionRecord|null

Definition at line 2298 of file RevisionStore.php.

References DB_PRIMARY.

◆ newRevisionFromRow()

MediaWiki\Revision\RevisionStore::newRevisionFromRow	(		$row,
			$queryFlags = `0`,
		PageIdentity	$page = `null`,
			$fromCache = `false`
	)

See also: RevisionFactory::newRevisionFromRow

MCR migration note: this replaced Revision::newFromRow

Parameters

\\stdClass	$row	A database row generated from a query based on getQueryInfo()
int	$queryFlags
PageIdentity \| null	$page	Preloaded page object
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 1603 of file RevisionStore.php.

◆ newRevisionFromRowAndSlots()

MediaWiki\Revision\RevisionStore::newRevisionFromRowAndSlots	(	stdClass	$row,
			$slots,
		int	$queryFlags = `0`,
		?PageIdentity	$page = `null`,
		bool	$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
PageIdentity \| null	$page
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
RevisionAccessException

See also: RevisionFactory::newRevisionFromRow

Definition at line 1706 of file RevisionStore.php.

References wfBacktrace().

◆ newRevisionsFromBatch()

MediaWiki\Revision\RevisionStore::newRevisionsFromBatch	(		$rows,
		array	$options = `[]`,
			$queryFlags = `0`,
		PageIdentity	$page = `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
PageIdentity \| null	$page	The page to which all the revision rows belong, if there is such a page 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 Article Id associated with the page, 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 1917 of file RevisionStore.php.

References MediaWiki\Page\PageReference\getDBkey(), MediaWiki\Page\PageReference\getNamespace(), and if.

◆ newRevisionSlots()

MediaWiki\Revision\RevisionStore::newRevisionSlots	(		$revId,
			$revisionRow,
			$slotRows,
			$queryFlags,
		PageIdentity	$page
	)

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
PageIdentity	$page

Returns: RevisionSlots

Exceptions

Definition at line 1541 of file RevisionStore.php.

◆ setLogger()

MediaWiki\Revision\RevisionStore::setLogger ( LoggerInterface $logger )

Definition at line 233 of file RevisionStore.php.

References MediaWiki\Revision\RevisionStore\$logger.

◆ storeContentBlob()

MediaWiki\Revision\RevisionStore::storeContentBlob	(	SlotRecord	$slot,
		PageIdentity	$page,
		array	$blobHints = `[]`
	)

private

Parameters

SlotRecord	$slot
PageIdentity	$page
array	$blobHints	See the BlobStore::XXX_HINT constants

Exceptions