Inheritance diagram for Revision:

Collaboration diagram for Revision:

Public Member Functions
	__construct ($row)
	Constructor. More...

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

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

	getContentFormat ()
	Returns the content format for this revision. More...

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

	getContentModel ()
	Returns the content model for this revision. More...

	getId ()
	Get revision ID. More...

	getNext ()
	Get next revision for this title. More...

	getPage ()
	Get the page ID. More...

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

	getPrevious ()
	Get previous revision for this title. More...

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

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

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

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

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

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

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

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

	getTextId ()
	Get text row ID. More...

	getTimestamp ()

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

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

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

	getVisibility ()
	Get the deletion bitfield of the revision. More...

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

	isCurrent ()

	isDeleted ($field)

	isMinor ()

	isUnpatrolled ()

	setId ($id)
	Set the revision ID. More...

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

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

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

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

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

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

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

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

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

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

static	getRevisionText ($row, $prefix= 'old_', $wiki=false)
	Get revision text associated with an old or archive row $row is usually an object from wfFetchRow(), both the flags and the text field must be included. More...

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

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

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

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

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

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

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

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

static	newFromRow ($row)

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

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

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

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

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

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

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

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

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

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

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

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

Public Attributes
const	DELETED_COMMENT = 2

const	DELETED_RESTRICTED = 8

const	DELETED_TEXT = 1

const	DELETED_USER = 4

const	FOR_PUBLIC = 1

const	FOR_THIS_USER = 2

const	RAW = 3

const	SUPPRESSED_USER = 12

const	TEXT_CACHE_GROUP = 'revisiontext:10'

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

const	READ_NONE = -1

Protected Member Functions
	checkContentModel ()

	getContentInternal ()
	Gets the content object for the revision (or null on failure). More...

Protected Attributes
string	$mComment

Content null bool	$mContent

string	$mContentFormat

null ContentHandler	$mContentHandler

string	$mContentModel

bool	$mCurrent

int	$mDeleted

int null	$mId

bool	$mMinorEdit

string	$mOrigUserText

int null	$mPage

int	$mParentId

int	$mQueryFlags = 0

bool	$mRefreshMutableFields = false
	Used for cached values to reload user text and rev_deleted. More...

string	$mSha1

int	$mSize

string	$mText

int	$mTextId

stdClass null	$mTextRow

string	$mTimestamp

null Title	$mTitle

int	$mUnpatrolled

int	$mUser

string	$mUserText

string	$mWiki = false
	Wiki ID; false means the current wiki. More...

Private Member Functions
	fetchText ()

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

	loadMutableFields ()
	For cached revisions, make sure the user name and rev_deleted is up-to-date. More...

	loadText ()
	Lazy-load the revision's text. More...

Static Private Member Functions
static	fetchFromConds ($db, $conditions, $flags=0)
	Given a set of conditions, return a ResultWrapper which will return matching database rows with the fields necessary to build Revision objects. More...

static	loadFromConds ($db, $conditions, $flags=0)
	Given a set of conditions, fetch a revision from the given database connection. More...

static	newFromConds ($conditions, $flags=0)
	Given a set of conditions, fetch a revision. More...

Detailed Description

Todo:: document

Definition at line 28 of file Revision.php.

Constructor & Destructor Documentation

Revision::__construct ( $row )

Constructor.

Parameters

object | array $row Either a database row or an array

Exceptions

MWException

Access:: private

Definition at line 562 of file Revision.php.

References $handler, $mPage, $wgUser, getContentFormat(), getContentHandler(), getContentModel(), global, needed(), Title\newFromRow(), on, wfDebug(), and wfTimestampNow().

Member Function Documentation

static Revision::base36Sha1 ( $text )

static

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

Parameters

string $text

Returns: string

Definition at line 1574 of file Revision.php.

Referenced by RevisionTest\dataGetSha1(), insertOn(), PopulateRevisionSha1\upgradeLegacyArchiveRow(), and PopulateRevisionSha1\upgradeRow().

Revision::checkContentModel ( )

protected

Definition at line 1512 of file Revision.php.

References $content, $handler, $mId, $revId, $t, $title, getContent(), getContentFormat(), getContentHandler(), getContentModel(), ContentHandler\getDefaultModelFor(), ContentHandler\getForModelID(), getTitle(), global, and RAW.

Referenced by insertOn().

static Revision::compressRevisionText ( & $text )

static

If $wgCompressRevisions is enabled, we will compress data.

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

Parameters

mixed $text Reference to a text

Returns: string

Definition at line 1318 of file Revision.php.

References $flags, $wgCompressRevisions, global, wfDebug(), and wfLogWarning().

Referenced by CheckStorage\importRevision(), RevisionTest\testCompressRevisionTextUtf8(), and RevisionTest\testCompressRevisionTextUtf8Gzip().

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

static

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

Parameters

IDatabase	$db
int	$id	Page id

Returns: int

Definition at line 1827 of file Revision.php.

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

static

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

Parameters

IDatabase	$db
Title	$title

Returns: int

Definition at line 1843 of file Revision.php.

References $title.

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

static

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

Parameters

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

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

Definition at line 1350 of file Revision.php.

References $flags, $wgContLang, $wgLegacyEncoding, global, unserialize(), and wfLogWarning().

static Revision::fetchFromConds	(	$db,
		$conditions,
		$flags = `0`
	)

staticprivate

Given a set of conditions, return a ResultWrapper which will return matching database rows with the fields necessary to build Revision objects.

Parameters

IDatabase	$db
array	$conditions
int	$flags	(optional)

Returns: stdClass

Definition at line 397 of file Revision.php.

References $flags, and $options.

static Revision::fetchRevision ( LinkTarget $title )

static

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

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

Parameters

LinkTarget $title

Returns: ResultWrapper

Deprecated:: Since 1.28

Definition at line 374 of file Revision.php.

References DB_REPLICA, MediaWiki\Linker\LinkTarget\getDBkey(), MediaWiki\Linker\LinkTarget\getNamespace(), and wfGetDB().

Referenced by RevisionStorageTest\testFetchRevision().

Revision::fetchText ( )

private

Definition at line 1606 of file Revision.php.

References $flags, $mQueryFlags, $mTextRow, $options, DBAccessObjectUtils\getDBOptions(), getTextId(), DBAccessObjectUtils\hasFlags(), list, wfDebugLog(), and wfGetDB().

Referenced by loadText().

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

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

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

Parameters

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

Returns: string

Definition at line 941 of file Revision.php.

References $mComment, $user, isDeleted(), and userCan().

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

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

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

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

Parameters

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

Since: 1.21

Returns: Content|null

Definition at line 1073 of file Revision.php.

References $user, getContentInternal(), isDeleted(), and userCan().

Referenced by checkContentModel(), WikiPage\doEditUpdates(), ApiQueryRevisionsBase\extractRevisionInfo(), CategoryMembershipChangeJob\getCategoriesAtRev(), getText(), ContentHandler\getUndoContent(), CategoryMembershipChangeJob\notifyUpdatesForRevision(), and BenchmarkParse\runParser().

Revision::getContentFormat ( )

Returns the content format for this revision.

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

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

Definition at line 1158 of file Revision.php.

References $handler, $mContentFormat, and getContentHandler().

Referenced by __construct(), RevisionStorageTest\assertRevEquals(), checkContentModel(), getContentHandler(), getContentInternal(), and insertOn().

Revision::getContentHandler ( )

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

Exceptions

MWException

Returns: ContentHandler

Definition at line 1175 of file Revision.php.

References $mContentHandler, getContentFormat(), getContentModel(), and ContentHandler\getForModelID().

Referenced by __construct(), checkContentModel(), ApiQueryRevisionsBase\extractRevisionInfo(), getContentFormat(), getContentInternal(), and WikiPage\getUndoContent().

Revision::getContentInternal ( )

protected

Gets the content object for the revision (or null on failure).

Note that for mutable Content objects, each call to this method will return a fresh clone.

Since: 1.21

Returns: Content|null The Revision's content, or null on failure.

Definition at line 1107 of file Revision.php.

References $handler, getContentFormat(), getContentHandler(), and getSerializedData().

Referenced by getContent().

Revision::getContentModel ( )

Returns the content model for this revision.

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

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

Definition at line 1134 of file Revision.php.

References $mContentModel, $title, CONTENT_MODEL_WIKITEXT, ContentHandler\getDefaultModelFor(), and getTitle().

Referenced by __construct(), RevisionStorageTest\assertRevEquals(), checkContentModel(), ApiQueryRevisionsBase\extractRevisionInfo(), getContentHandler(), and insertOn().

Revision::getId ( )

Get revision ID.

Returns: int|null

Definition at line 729 of file Revision.php.

References $mId.

Referenced by RevisionStorageTest\assertRevEquals(), WikiPage\doEditUpdates(), ApiQueryRevisionsBase\extractRevisionInfo(), CategoryMembershipChangeJob\getCategoriesAtRev(), getNext(), DifferenceEngine\getParserOutput(), getPrevious(), getRecentChange(), Linker\getRevDeleteLink(), DifferenceEngine\getRevisionHeader(), ContentHandler\getUndoContent(), and BenchmarkParse\runParser().

Revision::getNext ( )

Get next revision for this title.

Returns: Revision|null

Definition at line 1225 of file Revision.php.

References getId(), and getTitle().

Revision::getPage ( )

Get the page ID.

Returns: int|null

Definition at line 846 of file Revision.php.

References $mPage.

Referenced by RevisionStorageTest\assertRevEquals().

Revision::getParentId ( )

Get parent revision ID (the original previous page revision)

Returns: int|null

Definition at line 774 of file Revision.php.

References $mParentId.

Referenced by ApiQueryRevisionsBase\extractRevisionInfo(), and CategoryMembershipChangeJob\notifyUpdatesForRevision().

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

static

Do a batched query to get the parent revision lengths.

Parameters

IDatabase	$db
array	$revIds

Returns: array

Definition at line 540 of file Revision.php.

References $res, and as.

Referenced by ContribsPager\doBatchLookups(), HistoryPager\doBatchLookups(), and ApiQueryContributions\execute().

Revision::getPrevious ( )

Get previous revision for this title.

Returns: Revision|null

Definition at line 1210 of file Revision.php.

References getId(), and getTitle().

Revision::getPreviousRevisionId ( $db )

private

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

Parameters

IDatabase $db

Returns: int

Definition at line 1242 of file Revision.php.

Referenced by insertOn().

Revision::getRawComment ( )

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

Returns: string

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

Definition at line 957 of file Revision.php.

References getComment(), and wfDeprecated().

Revision::getRawUser ( )

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

Returns: string

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

Definition at line 879 of file Revision.php.

References getUser(), and wfDeprecated().

Revision::getRawUserText ( )

Fetch revision's username without regard for view restrictions.

Returns: string

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

Definition at line 923 of file Revision.php.

References getUserText(), and wfDeprecated().

Revision::getRecentChange ( $flags = 0 )

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

Parameters

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

Since: 1.22

Returns: RecentChange|null

Definition at line 994 of file Revision.php.

References $dbr, $flags, DB_REPLICA, DBAccessObjectUtils\getDBOptions(), getId(), getUserText(), list, RecentChange\newFromConds(), RAW, and wfGetDB().

Referenced by isUnpatrolled().

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

static

Get revision text associated with an old or archive row $row is usually an object from wfFetchRow(), both the flags and the text field must be included.

Parameters

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

Returns: string Text the text requested or false on failure

Definition at line 1273 of file Revision.php.

References $flags, and ExternalStore\fetchFromURL().

Revision::getSerializedData ( )

Get original serialized data (without checking view restrictions)

Since: 1.21

Returns: string

Definition at line 1089 of file Revision.php.

References $mText, and loadText().

Referenced by getContentInternal().

Revision::getSha1 ( )

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

Returns: string|null

Definition at line 792 of file Revision.php.

References $mSha1.

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

Revision::getSize ( )

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

Returns: int|null

Definition at line 783 of file Revision.php.

References $mSize.

Referenced by ApiQueryRevisionsBase\extractRevisionInfo().

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

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

If the specified audience does not have the ability to view this revision, an empty string will be returned.

Parameters

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

Deprecated:

since 1.21, use getContent() instead

Returns: string

Definition at line 1052 of file Revision.php.

References $content, $user, content, getContent(), ContentHandler\getContentText(), text, the, and wfDeprecated().

Referenced by RevisionTest\testGetContentClone().

Revision::getTextId ( )

Get text row ID.

Returns: int|null

Definition at line 765 of file Revision.php.

References $mTextId.

Referenced by fetchText().

Revision::getTimestamp ( )

Returns: string

Definition at line 1194 of file Revision.php.

References TS_MW, and wfTimestamp().

Referenced by RevisionStorageTest\assertRevEquals(), WikiPage\doEditUpdates(), ApiQueryRevisionsBase\extractRevisionInfo(), CategoryMembershipChangeJob\getExplicitCategoriesChanges(), Linker\getRevDeleteLink(), DifferenceEngine\getRevisionHeader(), and WikiPage\setLastEdit().

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

static

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

Parameters

Title	$title
int	$id

Returns: string|bool False if not found

Definition at line 1805 of file Revision.php.

References $flags, $timestamp, $title, DB_MASTER, DB_REPLICA, TS_MW, wfGetDB(), and wfTimestamp().

Referenced by ApiSetNotificationTimestamp\execute(), and Skin\lastModified().

Revision::getTitle ( )

Returns the title of the page associated with this entry or null.

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

Returns: Title|null

Definition at line 803 of file Revision.php.

References $dbr, $mTitle, DB_REPLICA, Title\newFromID(), Title\newFromRow(), wfGetLB(), and wfWikiID().

Referenced by checkContentModel(), ApiQueryRevisionsBase\extractRevisionInfo(), getContentModel(), getNext(), DifferenceEngine\getParserOutput(), getPrevious(), DifferenceEngine\getRevisionHeader(), insertOn(), Linker\revComment(), and BenchmarkParse\runParser().

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

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

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

Parameters

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

Returns: int

Definition at line 863 of file Revision.php.

References $mUser, $user, isDeleted(), and userCan().

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

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

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

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

Parameters

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

Returns: string

Definition at line 897 of file Revision.php.

References $mOrigUserText, $mUserText, $user, isDeleted(), loadMutableFields(), userCan(), and User\whoIs().

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

Revision::getVisibility ( )

Get the deletion bitfield of the revision.

Returns: int

Definition at line 1031 of file Revision.php.

References $mDeleted, and loadMutableFields().

Referenced by Linker\getRevDeleteLink(), isDeleted(), and userCan().

Revision::insertOn ( $dbw )

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

Parameters

IDatabase $dbw (master connection)

Exceptions

MWException

Returns: int

Definition at line 1396 of file Revision.php.

References $flags, $mComment, $mDeleted, $mId, $mPage, $mParentId, $mSha1, $mSize, $mText, $mTextId, $mUser, $mUserText, $title, $wgDefaultExternalStore, base36Sha1(), checkContentModel(), getContentFormat(), getContentModel(), ContentHandler\getDefaultModelFor(), ContentHandler\getForModelID(), getPreviousRevisionId(), getTitle(), global, ExternalStore\insertToDefault(), and Hooks\run().

Referenced by WikiPage\doCreate(), MergeHistory\merge(), MovePage\moveToInternal(), and RevisionStorageTest\testUserWasLastToEdit().

Revision::isCurrent ( )

Returns: bool

Definition at line 1201 of file Revision.php.

References $mCurrent.

Referenced by DifferenceEngine\getParserOutput(), DifferenceEngine\getRevisionHeader(), and isDeleted().

Revision::isDeleted ( $field )

Parameters

int $field One of DELETED_* bitfield constants

Returns: bool

Definition at line 1015 of file Revision.php.

References getVisibility(), and isCurrent().

Referenced by ApiQueryRevisionsBase\extractRevisionInfo(), getComment(), getContent(), Linker\getRevDeleteLink(), DifferenceEngine\getRevisionHeader(), getUser(), getUserText(), and Linker\revComment().

Revision::isMinor ( )

Returns: bool

Definition at line 965 of file Revision.php.

References $mMinorEdit.

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

Revision::isUnpatrolled ( )

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

Definition at line 972 of file Revision.php.

References $mUnpatrolled, and getRecentChange().

static Revision::loadFromConds	(	$db,
		$conditions,
		$flags = `0`
	)

staticprivate

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

Parameters

IDatabase	$db
array	$conditions
int	$flags	(optional)

Returns: Revision|null

Definition at line 353 of file Revision.php.

References $flags, and $rev.

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

static

Load a page revision from a given revision ID number.

Returns null if no such revision can be found.

Parameters

IDatabase	$db
int	$id

Returns: Revision|null

Definition at line 242 of file Revision.php.

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

static

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

If not attached to that page, will return null.

Parameters

IDatabase	$db
int	$pageid
int	$id

Returns: Revision|null

Definition at line 256 of file Revision.php.

Referenced by newKnownCurrent(), and Maintenance\updateSearchIndexForPage().

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

static

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

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

Parameters

IDatabase	$db
Title	$title
string	$timestamp

Returns: Revision|null

Definition at line 301 of file Revision.php.

References $timestamp, and $title.

Referenced by AttachLatest\execute(), EditPage\getBaseRevision(), User\getNewMessageLinks(), and WikiPage\replaceSectionContent().

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

static

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

If not attached to that page, will return null.

Parameters

IDatabase	$db
Title	$title
int	$id

Returns: Revision|null

Definition at line 276 of file Revision.php.

References $title.

Referenced by EditPage\mergeChangesIntoContent().

Revision::loadMutableFields ( )

private

For cached revisions, make sure the user name and rev_deleted is up-to-date.

Definition at line 1929 of file Revision.php.

References $dbr, DB_REPLICA, and wfGetLB().

Referenced by getUserText(), and getVisibility().

Revision::loadText ( )

private

Lazy-load the revision's text.

Currently hardcoded to the 'text' table storage engine.

Returns: string|bool The revision's text, or false on failure

Definition at line 1584 of file Revision.php.

References $cache, $wgRevisionCacheExpiry, fetchText(), ObjectCache\getMainWANInstance(), and global.

Referenced by getSerializedData().

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

static

Make a fake revision object from an archive table row.

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

Todo:: FIXME: Should be a subclass for RevisionDelete. [TS]

Parameters

object	$row
array	$overrides

Exceptions

MWException

Returns: Revision

Definition at line 183 of file Revision.php.

References $attribs, global, and Title\makeTitle().

Referenced by RevDelArchiveItem\__construct(), RevDelArchivedRevisionItem\__construct(), DifferenceEngine\deletedLink(), SpecialUndelete\formatRevisionRow(), DeletedContribsPager\formatRow(), PageArchive\getRevision(), ApiQueryDeletedRevisions\run(), ApiQueryAllDeletedRevisions\run(), RevisionStorageTest\testNewFromArchiveRow(), PageArchive\undeleteRevisions(), PopulateRevisionSha1\upgradeLegacyArchiveRow(), PopulateRevisionLength\upgradeRow(), and PopulateRevisionSha1\upgradeRow().

static Revision::newFromConds	(	$conditions,
		$flags = `0`
	)

staticprivate

Given a set of conditions, fetch a revision.

This method is used then a revision ID is qualified and will incorporate some basic replica DB/master fallback logic

Parameters

array	$conditions
int	$flags	(optional)

Returns: Revision|null

Definition at line 321 of file Revision.php.

References $flags, $rev, DB_MASTER, DB_REPLICA, wfGetDB(), and wfGetLB().

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

static

Load a page revision from a given revision ID number.

Returns null if no such revision can be found.

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

Parameters

int	$id
int	$flags	(optional)

Returns: Revision|null

Definition at line 110 of file Revision.php.

References $flags.

Referenced by SpecialComparePages\checkExistingRevision(), Orphans\checkSeparation(), User\clearNotification(), WikiPage\commitRollback(), EditPage\edit(), ApiComparePages\execute(), ApiPatrol\execute(), ApiExpandTemplates\execute(), CheckBadRedirects\execute(), ApiEditPage\execute(), ApiParse\execute(), ImportTextFiles\execute(), BenchmarkParse\execute(), SpecialNewpages\feedItemDesc(), Article\fetchContentObject(), FeedUtils\formatDiffRow(), EditPage\getBaseRevision(), EditPage\getContentObject(), Article\getOldIDFromRequest(), PageArchive\getPreviousRevision(), CategoryMembershipChange\getPreviousRevisionTimestamp(), Parser\getRevisionObject(), DifferenceEngine\loadRevisionData(), CategoryMembershipChangeJob\notifyUpdatesForRevision(), ApiQueryRevisionsBase\parseParameters(), MediaWiki\parseTitle(), WikiPage\prepareContentForEdit(), ApiTag\processIndividual(), WikiPage\replaceSectionAtRev(), RefreshLinksJob\runForTitle(), Article\setOldSubtitle(), SpecialComparePages\showDiff(), Parser\statelessFetchTemplate(), RevDelRevisionList\suggestTarget(), CategoryMembershipChangeTest\testChangeAddedWithRev(), CategoryMembershipChangeTest\testChangeRemovedWithRev(), RevisionStorageTest\testGetContent(), RevisionStorageTest\testGetContentFormat(), RevisionStorageTest\testGetContentModel(), RevisionStorageTest\testGetPage(), RevisionStorageTest\testGetText(), ApiRevisionDeleteTest\testHidingRevisions(), RevisionStorageTest\testIsCurrent(), RevisionStorageTest\testNewFromId(), and ChangeTags\updateTagsWithChecks().

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

static

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

Returns null if no such revision can be found.

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

Parameters

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

Returns: Revision|null

Definition at line 159 of file Revision.php.

References $flags, $revId, DB_MASTER, DB_REPLICA, and wfGetDB().

Referenced by NamespaceConflictChecker\canMerge(), ApiStashEdit\execute(), and WikiPage\loadLastEdit().

static Revision::newFromRow ( $row )

static

Since: 1.19

Parameters

object $row

Returns: Revision

Definition at line 230 of file Revision.php.

Referenced by ApiFeedContributions\feedItem(), WikiPage\getOldestRevision(), ApiQueryAllRevisions\run(), CategoryMembershipChangeJob\run(), and RevisionStorageTest\testNewFromRow().

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

static

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

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

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

Parameters

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

Returns: Revision|null

Definition at line 128 of file Revision.php.

References $flags, DB_MASTER, DB_REPLICA, MediaWiki\Linker\LinkTarget\getDBkey(), MediaWiki\Linker\LinkTarget\getNamespace(), and wfGetDB().

Referenced by NamespaceConflictChecker\canMerge(), CleanupSpam\cleanupArticle(), Title\countRevisionsBetween(), PoolWorkArticleView\doWork(), ApiEditPage\execute(), GetTextMaint\execute(), BenchmarkParse\execute(), Title\getAuthorsBetween(), ContentHandler\getAutoDeleteReason(), ResourceLoaderWikiModule\getContent(), LocalFile\getDescriptionText(), Skin\getNewtalks(), RawAction\getRawText(), FixDefaultJsonContentPages\handleRow(), SearchResult\initFromTitle(), InfoAction\invalidateCache(), MovePage\isValidMoveTarget(), Title\isValidMoveTarget(), DifferenceEngine\loadRevisionData(), LanguageConverter\parseCachedTable(), DoubleRedirectJob\run(), RefreshLinksJob\runForTitle(), SpecialBookSources\showList(), Parser\statelessFetchTemplate(), ApiQueryWatchlistIntegrationTest\testCategorizeTypeParameter(), and SpecialChangeContentModel\validateTitle().

static Revision::newKnownCurrent	(	IDatabase	$db,
			$pageId,
			$revId
	)

static

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

This method allows for the use of caching, though accessing anything that normally requires permission checks (aside from the text) will trigger a small DB lookup. The title will also be lazy loaded, though setTitle() can be used to preload it.

Parameters

IDatabase	$db
int	$pageId	Page ID
int	$revId	Known current revision of this page

Returns: Revision|bool Returns false if missing

Since: 1.28

Definition at line 1905 of file Revision.php.

References $cache, $rev, $revId, array(), Database\getCacheSetOptions(), IDatabase\getWikiID(), loadFromPageId(), and use.

Referenced by MessageCache\getMsgFromNamespace(), WikiPage\loadLastEdit(), and Parser\statelessFetchRevision().

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

static

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

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

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

Parameters

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

Returns: Revision|null Revision or null on error

Definition at line 1678 of file Revision.php.

References $summary, $user, $wgContLang, $wgUser, global, and Title\makeTitle().

Referenced by WikiPage\insertProtectNullRevision(), MovePage\moveToInternal(), LocalFile\recordUpload2(), ImportReporter\reportPage(), and RevisionStorageTest\testNewNullRevision().

static Revision::pageJoinCond ( )

static

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

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

Since: 1.19

Returns: array

Definition at line 433 of file Revision.php.

Referenced by ChangeTagsRevisionList\doQuery(), RevDelRevisionList\doQuery(), RevisionList\doQuery(), MergeHistoryPager\getQueryInfo(), and ContribsPager\getQueryInfo().

static Revision::selectArchiveFields ( )

static

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

Returns: array

Definition at line 473 of file Revision.php.

References global.

Referenced by PopulateRevisionLength\doDBUpdates(), RevDelArchiveList\doQuery(), RevDelRevisionList\doQuery(), ApiQueryDeletedRevisions\run(), and ApiQueryAllDeletedRevisions\run().

static Revision::selectFields ( )

static

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

Returns: array

Definition at line 442 of file Revision.php.

References global.

Referenced by PopulateRevisionLength\doDBUpdates(), WikiPage\doDeleteArticleReal(), ChangeTagsRevisionList\doQuery(), RevDelRevisionList\doQuery(), RevisionList\doQuery(), HistoryAction\fetchRevisions(), Title\getFirstRevision(), WikiPage\getOldestRevision(), MergeHistoryPager\getQueryInfo(), ContribsPager\getQueryInfo(), HistoryPager\getQueryInfo(), RebuildTextIndex\populateSearchIndex(), ApiQueryAllRevisions\run(), CategoryMembershipChangeJob\run(), ApiQueryRevisions\run(), RevisionTestContentHandlerUseDB\testSelectFields(), and RevisionStorageTest\testSelectFields().

static Revision::selectPageFields ( )

static

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

Returns: array

Definition at line 515 of file Revision.php.

Referenced by RebuildTextIndex\populateSearchIndex(), ApiQueryAllRevisions\run(), and ApiQueryRevisions\run().

static Revision::selectTextFields ( )

static

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

Returns: array

Definition at line 504 of file Revision.php.

Referenced by RebuildTextIndex\populateSearchIndex(), ApiQueryAllRevisions\run(), and ApiQueryRevisions\run().

static Revision::selectUserFields ( )

static

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

Returns: array

Definition at line 530 of file Revision.php.

Referenced by ChangeTagsRevisionList\doQuery(), RevDelRevisionList\doQuery(), RevisionList\doQuery(), MergeHistoryPager\getQueryInfo(), ContribsPager\getQueryInfo(), HistoryPager\getQueryInfo(), and ApiQueryRevisions\run().

Revision::setId ( $id )

Set the revision ID.

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

Since: 1.19

Parameters

int $id

Definition at line 741 of file Revision.php.

Revision::setTitle ( $title )

Set the title of the revision.

Parameters

Title $title

Definition at line 837 of file Revision.php.

References $title.

Revision::setUserIdAndName	(	$id,
		$name
	)

Set the user ID/name.

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

Since: 1.28

Parameters

integer	$id	User ID
string	$name	User name

Definition at line 754 of file Revision.php.

References $name.

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

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

Parameters

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

Returns: bool

Definition at line 1746 of file Revision.php.

References $user, and getVisibility().

Referenced by ApiQueryRevisionsBase\extractRevisionInfo(), getComment(), getContent(), Linker\getRevDeleteLink(), DifferenceEngine\getRevisionHeader(), getUser(), getUserText(), and Linker\revComment().

static Revision::userCanBitfield	(		$bitfield,
			$field,
		User	$user = `null`,
		Title	$title = `null`
	)

static

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

This is used by various classes to avoid duplication.

Parameters

int	$bitfield	Current field
int	$field	One of self::DELETED_TEXT = File::DELETED_FILE, self::DELETED_COMMENT = File::DELETED_COMMENT, self::DELETED_USER = File::DELETED_USER
User \| null	$user	User object to check, or null to use $wgUser
Title \| null	$title	A Title object to check for per-page restrictions on, instead of just plain userrights

Returns: bool

Definition at line 1764 of file Revision.php.

References $title, $user, $wgUser, as, global, and wfDebug().

Referenced by ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryWatchlist\extractOutputData(), ApiQueryContributions\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), OldLocalFile\userCan(), ChangesList\userCan(), and ArchivedFile\userCan().

static Revision::userJoinCond ( )

static

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

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

Since: 1.19

Returns: array

Definition at line 423 of file Revision.php.

Referenced by ChangeTagsRevisionList\doQuery(), RevDelRevisionList\doQuery(), RevisionList\doQuery(), MergeHistoryPager\getQueryInfo(), ContribsPager\getQueryInfo(), HistoryPager\getQueryInfo(), and ApiQueryRevisions\run().

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

static

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

Limit to 50 revisions for the sake of performance.

Since: 1.20

Deprecated:: since 1.24

Parameters

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