Page MenuHomeWickedGov Phorge
Files F5982958

RevisionLookup.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

RevisionLookup.php
View Options

<?php
/**
* Service for looking up page revisions.
*
* @license GPL-2.0-or-later
* @file
*/
namespace MediaWiki\Revision;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\Page\PageIdentity;
use Wikimedia\Rdbms\IDBAccessObject;
/**
* Service for looking up page revisions.
*
* @note This was written to act as a drop-in replacement for the corresponding
* static methods in the old Revision class (which was later removed in 1.37).
*
* @since 1.31
* @since 1.32 Renamed from MediaWiki\Storage\RevisionLookup
*/
interface RevisionLookup {
/**
* 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:
*
* @param int $id
* @param int $flags bit field, see IDBAccessObject::READ_XXX
* @param PageIdentity|null $page The page the revision belongs to.
* Providing the page may improve performance.
*
* @return RevisionRecord|null
*/
public function getRevisionById( $id, $flags = 0, ?PageIdentity $page = null );
/**
* 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
*
* @param LinkTarget|PageIdentity $page Calling with LinkTarget is deprecated since 1.36
* @param int $revId (optional)
* @param int $flags bit field, see IDBAccessObject::READ_XXX
* @return RevisionRecord|null
*/
public function getRevisionByTitle( $page, $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
*
* @param int $pageId
* @param int $revId (optional)
* @param int $flags bit field, see IDBAccessObject::READ_XXX
* @return RevisionRecord|null
*/
public function getRevisionByPageId( $pageId, $revId = 0, $flags = 0 );
/**
* 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
*
* @param LinkTarget|PageIdentity $page Calling with LinkTarget is deprecated since 1.36
* @param string $timestamp
* @param 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
* @return RevisionRecord|null
*/
public function getRevisionByTimestamp(
$page,
string $timestamp,
int $flags = IDBAccessObject::READ_NORMAL
): ?RevisionRecord;
/**
* Get previous revision for this title
*
* MCR migration note: this replaced Revision::getPrevious
*
* @param RevisionRecord $rev
* @param int $flags (optional) $flags include:
* IDBAccessObject::READ_LATEST: Select the data from the primary DB
*
* @return RevisionRecord|null
*/
public function getPreviousRevision( RevisionRecord $rev, $flags = 0 );
/**
* Get next revision for this title
*
* MCR migration note: this replaced Revision::getNext
*
* @param RevisionRecord $rev
* @param int $flags (optional) $flags include:
* IDBAccessObject::READ_LATEST: Select the data from the primary DB
*
* @return RevisionRecord|null
*/
public function getNextRevision( RevisionRecord $rev, $flags = 0 );
/**
* Get rev_timestamp from rev_id, without loading the rest of the row.
*
* MCR migration note: this replaced Revision::getTimestampFromId
*
* @param int $id
* @param int $flags
* @return string|false False if not found
* @since 1.34 (present earlier in RevisionStore)
*/
public function getTimestampFromId( $id, $flags = 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
*
* @param PageIdentity $page the associated page
* @param int $revId current revision of this page
*
* @return RevisionRecord|false Returns false if missing
*/
public function getKnownCurrentRevision( PageIdentity $page, $revId = 0 );
/**
* Get the first revision of the page.
*
* @since 1.35
* @param LinkTarget|PageIdentity $page Calling with LinkTarget is deprecated since 1.36
* @param int $flags bit field, see IDBAccessObject::READ_* constants.
* @return RevisionRecord|null
*/
public function getFirstRevision(
$page,
int $flags = IDBAccessObject::READ_NORMAL
): ?RevisionRecord;
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 22:38 (1 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ed/0c/2dba5353b4107efd023e49c13c26
Default Alt Text
RevisionLookup.php (4 KB)

Event Timeline