BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
Revision Class Reference
Inheritance diagram for Revision:
Collaboration diagram for Revision:

Public Member Functions

 __construct ($row, $queryFlags=0, Title $title=null)
 
 getRevisionRecord ()
 
 getId ()
 
 setId ($id)
 
 setUserIdAndName ($id, $name)
 
 getTextId ()
 
 getParentId ()
 
 getSize ()
 
 getSha1 ()
 
 getTitle ()
 
 setTitle ($title)
 
 getPage ()
 
 getUser ($audience=self::FOR_PUBLIC, User $user=null)
 
 getUserText ($audience=self::FOR_PUBLIC, User $user=null)
 
 getComment ($audience=self::FOR_PUBLIC, User $user=null)
 
 isMinor ()
 
 isUnpatrolled ()
 
 getRecentChange ($flags=0)
 
 isDeleted ($field)
 
 getVisibility ()
 
 getContent ($audience=self::FOR_PUBLIC, User $user=null)
 
 getSerializedData ()
 
 getContentModel ()
 
 getContentFormat ()
 
 getContentHandler ()
 
 getTimestamp ()
 
 isCurrent ()
 
 getPrevious ()
 
 getNext ()
 
 insertOn ($dbw)
 
 userCan ($field, User $user=null)
 

Static Public Member Functions

static newFromId ($id, $flags=0)
 
static newFromTitle (LinkTarget $linkTarget, $id=0, $flags=0)
 
static newFromPageId ($pageId, $revId=0, $flags=0)
 
static newFromArchiveRow ($row, $overrides=[])
 
static newFromRow ($row)
 
static loadFromId ($db, $id)
 
static loadFromPageId ($db, $pageid, $id=0)
 
static loadFromTitle ($db, $title, $id=0)
 
static loadFromTimestamp ($db, $title, $timestamp)
 
static fetchRevision (LinkTarget $title)
 
static userJoinCond ()
 
static pageJoinCond ()
 
static selectFields ()
 
static selectArchiveFields ()
 
static selectTextFields ()
 
static selectPageFields ()
 
static selectUserFields ()
 
static getQueryInfo ($options=[])
 
static getArchiveQueryInfo ()
 
static getParentLengths ($db, array $revIds)
 
static getRevisionText ($row, $prefix= 'old_', $wiki=false)
 
static compressRevisionText (&$text)
 
static decompressRevisionText ($text, $flags)
 
static base36Sha1 ($text)
 
static newNullRevision ($dbw, $pageId, $summary, $minor, $user=null)
 
static userCanBitfield ($bitfield, $field, User $user=null, Title $title=null)
 
static getTimestampFromId ($title, $id, $flags=0)
 
static countByPageId ($db, $id)
 
static countByTitle ($db, $title)
 
static userWasLastToEdit ($db, $pageId, $userId, $since)
 
static newKnownCurrent (IDatabase $db, $pageIdOrTitle, $revId=0)
 

Public Attributes

const DELETED_TEXT = RevisionRecord::DELETED_TEXT
 
const DELETED_COMMENT = RevisionRecord::DELETED_COMMENT
 
const DELETED_USER = RevisionRecord::DELETED_USER
 
const DELETED_RESTRICTED = RevisionRecord::DELETED_RESTRICTED
 
const SUPPRESSED_USER = RevisionRecord::SUPPRESSED_USER
 
const SUPPRESSED_ALL = RevisionRecord::SUPPRESSED_ALL
 
const FOR_PUBLIC = RevisionRecord::FOR_PUBLIC
 
const FOR_THIS_USER = RevisionRecord::FOR_THIS_USER
 
const RAW = RevisionRecord::RAW
 
const TEXT_CACHE_GROUP = SqlBlobStore::TEXT_CACHE_GROUP
 
- Public Attributes inherited from IDBAccessObject
const READ_NORMAL = 0
 
const READ_LATEST = 1
 
const READ_LOCKING = 3
 
const READ_EXCLUSIVE = 7
 
const READ_LATEST_IMMUTABLE = 8
 
const READ_NONE = -1
 

Static Protected Member Functions

static getRevisionStore ()
 
static getRevisionLookup ()
 
static getRevisionFactory ()
 
static getBlobStore ($wiki=false)
 

Protected Attributes

 $mRecord
 

Detailed Description

Deprecated:
since 1.31, use RevisionRecord, RevisionStore, and BlobStore instead.

Constructor & Destructor Documentation

Revision::__construct (   $row,
  $queryFlags = 0,
Title  $title = null 
)
Parameters
object | array | RevisionRecord$rowEither a database row or an array
int$queryFlags
Title | null$titleprivate

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
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&$textReference to a text
Returns
string
static Revision::countByPageId (   $db,
  $id 
)
static

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

Parameters
IDatabase$db
int$idPage id
Returns
int
static Revision::countByTitle (   $db,
  $title 
)
static

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

Parameters
IDatabase$db
Title$title
Returns
int
static Revision::decompressRevisionText (   $text,
  $flags 
)
static

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

Parameters
mixed$textReference to a text
array$flagsCompression flags
Returns
string|bool Decompressed text, or false on failure
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, no callers in core nor in known extensions. No-op since 1.31.
static Revision::getArchiveQueryInfo ( )
static

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

Since
1.31
Deprecated:
since 1.31, use RevisionStore::getArchiveQueryInfo() instead.
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()
static Revision::getBlobStore (   $wiki = false)
staticprotected
Parameters
bool | string$wikiThe ID of the target wiki database. Use false for the local wiki.
Returns
SqlBlobStore
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$audienceOne 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 | null$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns
string
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, or the content could not be loaded, null will be returned.

Parameters
int$audienceOne of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to $user Revision::RAW get the text regardless of permissions
User$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Since
1.21
Returns
Content|null
Revision::getContentFormat ( )

Returns the content format for the main slot of this revision.

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

Todo:
: drop this, the format is irrelevant to the revision!
Returns
string The content format id associated with this revision, see the CONTENT_FORMAT_XXX constants.
Revision::getContentHandler ( )

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

Exceptions
MWException
Returns
ContentHandler
Revision::getContentModel ( )

Returns the content model for the main slot of 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.

Todo:
: drop this, with MCR, there no longer is a single model associated with a revision.
Returns
string The content model id associated with this revision, see the CONTENT_MODEL_XXX constants.
Revision::getId ( )

Get revision ID

Returns
int|null
Revision::getNext ( )

Get next revision for this title

Returns
Revision|null
Revision::getPage ( )

Get the page ID

Returns
int|null
Revision::getParentId ( )

Get parent revision ID (the original previous page revision)

Returns
int|null The ID of the parent revision. 0 indicates that there is no parent revision. Null indicates that the parent revision is not known.
static Revision::getParentLengths (   $db,
array  $revIds 
)
static

Do a batched query to get the parent revision lengths

Deprecated:
in 1.31, use RevisionStore::getRevisionSizes instead.
Parameters
IDatabase$db
array$revIds
Returns
array
Revision::getPrevious ( )

Get previous revision for this title

Returns
Revision|null
static Revision::getQueryInfo (   $options = [])
static

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

Since
1.31
Deprecated:
since 1.31, use RevisionStore::getQueryInfo() instead.
Parameters
array$optionsAny 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
  • 'text': Join with the text table, and select fields to load page text
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()
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
static Revision::getRevisionFactory ( )
staticprotected
Returns
RevisionFactory
static Revision::getRevisionLookup ( )
staticprotected
Returns
RevisionLookup
Revision::getRevisionRecord ( )
Returns
RevisionRecord
static Revision::getRevisionStore ( )
staticprotected
Returns
RevisionStore
static Revision::getRevisionText (   $row,
  $prefix = 'old_',
  $wiki = false 
)
static

Get revision text associated with an old or archive row

Both the flags and the text field must be included. Including the old_id field will activate cache usage as long as the $wiki parameter is not set.

Parameters
stdClass$rowThe text data
string$prefixTable prefix (default 'old_')
string | bool$wikiThe 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|false Text the text requested or false on failure
Revision::getSerializedData ( )

Get original serialized data (without checking view restrictions)

Since
1.21
Deprecated:
since 1.31, use BlobStore::getBlob instead.
Returns
string
Revision::getSha1 ( )

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

Returns
string|null
Revision::getSize ( )

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

Returns
int|null
Revision::getTextId ( )

Get the ID of the row of the text table that contains the content of the revision's main slot, if that content is stored in the text table.

If the content is stored elsewhere, this returns null.

Deprecated:
since 1.31, use RevisionRecord()->getSlot()->getContentAddress() to get that actual address that can be used with BlobStore::getBlob(); or use RevisionRecord::hasSameContent() to check if two revisions have the same content.
Returns
int|null
Revision::getTimestamp ( )
Returns
string
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
int$flags
Returns
string|bool False if not found
Revision::getTitle ( )

Returns the title of the page associated with this entry. Since 1.31, this will never return null.

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

Returns
Title
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$audienceOne 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 | null$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns
int
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$audienceOne 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 | null$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns
string
Revision::getVisibility ( )

Get the deletion bitfield of the revision

Returns
int
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 The revision ID
Revision::isCurrent ( )
Returns
bool
Revision::isDeleted (   $field)
Parameters
int$fieldOne of DELETED_* bitfield constants
Returns
bool
Revision::isMinor ( )
Returns
bool
Revision::isUnpatrolled ( )
Returns
int Rcid of the unpatrolled row, zero if there isn't one
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.

Deprecated:
since 1.31, use RevisionStore::getRevisionById() instead.
Parameters
IDatabase$db
int$id
Returns
Revision|null
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.

Deprecated:
since 1.31, use RevisionStore::getRevisionByPageId() instead.
Parameters
IDatabase$db
int$pageid
int$id
Returns
Revision|null
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.

Deprecated:
since 1.31, use RevisionStore::getRevisionByTimestamp() or RevisionStore::loadRevisionFromTimestamp() instead.
Parameters
IDatabase$db
Title$title
string$timestamp
Returns
Revision|null
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.

Deprecated:
since 1.31, use RevisionStore::getRevisionByTitle() instead.
Parameters
IDatabase$db
Title$title
int$id
Returns
Revision|null
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)

Parameters
object$row
array$overrides
Exceptions
MWException
Returns
Revision

MCR Migration: https://phabricator.wikimedia.org/T183564 This method used to overwrite attributes, then passed to Revision::__construct RevisionStore::newRevisionFromArchiveRow instead overrides row field names So do a conversion here.

We require a Title for both the Revision object and the RevisionRecord. Below is duplicated logic from RevisionStore::newRevisionFromArchiveRow to fetch a title in order pass it into the Revision object.

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
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$flagsBitfield (optional)
Returns
Revision|null
static Revision::newFromRow (   $row)
static
Since
1.19

MCR migration note: replaced by RevisionStore::newRevisionFromRow(). Note that newFromRow() also accepts arrays, while newRevisionFromRow() does not. Instead, a MutableRevisionRecord should be constructed directly. RevisionStore::newMutableRevisionFromArray() can be used as a temporary replacement, but should be avoided.

Parameters
object | array$row
Returns
Revision
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$flagsBitfield (optional)
Returns
Revision|null
static Revision::newKnownCurrent ( IDatabase  $db,
  $pageIdOrTitle,
  $revId = 0 
)
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 loaded if $pageIdOrTitle is an integer ID.

Parameters
IDatabase$dbignored!
int | Title$pageIdOrTitlePage ID or Title object
int$revIdKnown current revision of this page. Determined automatically if not given.
Returns
Revision|bool Returns false if missing
Since
1.28
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$pageIdID number of the page to read from
string$summaryRevision's summary
bool$minorWhether the revision should be considered as minor
User | null$userUser object to use or null for $wgUser
Returns
Revision|null Revision or null on error
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
Deprecated:
since 1.31, use RevisionStore::getQueryInfo( [ 'page' ] ) instead.
Returns
array
static Revision::selectArchiveFields ( )
static

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

Deprecated:
since 1.31, use RevisionStore::getArchiveQueryInfo() instead.
Returns
array
static Revision::selectFields ( )
static

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

Deprecated:
since 1.31, use RevisionStore::getQueryInfo() instead.
Returns
array
static Revision::selectPageFields ( )
static

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

Deprecated:
since 1.31, use RevisionStore::getQueryInfo( [ 'page' ] ) instead.
Returns
array
static Revision::selectTextFields ( )
static

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

Deprecated:
since 1.31, use RevisionStore::getQueryInfo( [ 'text' ] ) instead.
Returns
array
static Revision::selectUserFields ( )
static

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

Deprecated:
since 1.31, use RevisionStore::getQueryInfo( [ 'user' ] ) instead.
Returns
array
Revision::setId (   $id)

Set the revision ID

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

Note
Only supported on Revisions that were constructed based on associative arrays, since they are mutable.
Since
1.19
Parameters
int | string$id
Exceptions
MWException
Revision::setTitle (   $title)

Set the title of the revision

Deprecated:
: since 1.31, this is now a noop. Pass the Title to the constructor instead.
Parameters
Title$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

Note
Only supported on Revisions that were constructed based on associative arrays, since they are mutable.
Since
1.28
Deprecated:
since 1.31, please reuse old Revision object
Parameters
int$idUser ID
string$nameUser name
Exceptions
MWException
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$fieldOne of self::DELETED_TEXT, self::DELETED_COMMENT, self::DELETED_USER
User | null$userUser object to check, or null to use $wgUser
Returns
bool
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$bitfieldCurrent field
int$fieldOne of self::DELETED_TEXT = File::DELETED_FILE, self::DELETED_COMMENT = File::DELETED_COMMENT, self::DELETED_USER = File::DELETED_USER
User | null$userUser object to check, or null to use $wgUser
Title | null$titleA Title object to check for per-page restrictions on, instead of just plain userrights
Returns
bool
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
Deprecated:
since 1.31, use RevisionStore::getQueryInfo( [ 'user' ] ) instead.
Returns
array
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$dbThe Database to perform the check on. May be given as a Database object or a database identifier usable with wfGetDB.
int$pageIdThe ID of the page in question
int$userIdThe ID of the user in question
string$sinceLook at edits since this time
Returns
bool True if the given user was the only one to edit since the given timestamp

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