090f6daa1b
They belong in RevisionStore. This change removes the dependency on Title for these methods and will assist in porting more code to LinkTarget. At the same time, deprecate the Title parameter to RevisionLookup/RevisionStore getPreviousRevision/getNextRevision, and add a $flags parameter to match the functionality of the Title versions. Since code search turned up no callers that passed a Title outside core, this variant is immediately hard-deprecated. The Title methods themselves are only soft-deprecated. Change-Id: I76bc6fd6ee1a9f35b5f29fa640824fb5da3bb78e
141 lines
4.3 KiB
PHP
141 lines
4.3 KiB
PHP
<?php
|
|
/**
|
|
* Service for looking up page revisions.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace MediaWiki\Revision;
|
|
|
|
use IDBAccessObject;
|
|
use MediaWiki\Linker\LinkTarget;
|
|
use Title;
|
|
|
|
/**
|
|
* Service for looking up page revisions.
|
|
*
|
|
* @note This was written to act as a drop-in replacement for the corresponding
|
|
* static methods in Revision.
|
|
*
|
|
* @since 1.31
|
|
* @since 1.32 Renamed from MediaWiki\Storage\RevisionLookup
|
|
*/
|
|
interface RevisionLookup extends IDBAccessObject {
|
|
|
|
/**
|
|
* 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:
|
|
*
|
|
* @param int $id
|
|
* @param int $flags bit field, see IDBAccessObject::READ_XXX
|
|
* @return RevisionRecord|null
|
|
*/
|
|
public function getRevisionById( $id, $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
|
|
*
|
|
* @param LinkTarget $linkTarget
|
|
* @param int $revId (optional)
|
|
* @param int $flags bit field, see IDBAccessObject::READ_XXX
|
|
* @return RevisionRecord|null
|
|
*/
|
|
public function getRevisionByTitle( LinkTarget $linkTarget, $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
|
|
*
|
|
* @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 );
|
|
|
|
/**
|
|
* Get previous revision for this title
|
|
*
|
|
* MCR migration note: this replaces Revision::getPrevious
|
|
*
|
|
* @param RevisionRecord $rev
|
|
* @param int $flags (optional) $flags include:
|
|
* IDBAccessObject::READ_LATEST: Select the data from the master
|
|
*
|
|
* @return RevisionRecord|null
|
|
*/
|
|
public function getPreviousRevision( RevisionRecord $rev, $flags = 0 );
|
|
|
|
/**
|
|
* Get next revision for this title
|
|
*
|
|
* MCR migration note: this replaces Revision::getNext
|
|
*
|
|
* @param RevisionRecord $rev
|
|
* @param int $flags (optional) $flags include:
|
|
* IDBAccessObject::READ_LATEST: Select the data from the master
|
|
*
|
|
* @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 replaces Revision::getTimestampFromId
|
|
*
|
|
* @param int $id
|
|
* @param int $flags
|
|
* @return string|bool 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 replaces Revision::newKnownCurrent
|
|
*
|
|
* @param Title $title the associated page title
|
|
* @param int $revId current revision of this page
|
|
*
|
|
* @return RevisionRecord|bool Returns false if missing
|
|
*/
|
|
public function getKnownCurrentRevision( Title $title, $revId );
|
|
|
|
}
|
|
|
|
/**
|
|
* Retain the old class name for backwards compatibility.
|
|
* @deprecated since 1.32
|
|
*/
|
|
class_alias( RevisionLookup::class, 'MediaWiki\Storage\RevisionLookup' );
|