Manual:Revision.php

From mediawiki.org
Jump to navigation Jump to search
Other languages:
MediaWiki version:
1.36

Gerrit change 684071

The Revision class represents a MediaWiki revision.

This class was deprecated in MediaWiki 1.31, in favor of RevisionRecord, RevisionStore and BlobStore. It was completely removed in MediaWiki 1.37. See Manual:Revision.php/Migration .

Creating a new Revision object[edit]

To instantiate Revision, call one of the static factory methods:

  • loadFromId( $db, $id ) - load a page revision from a given revision ID number.
  • loadFromPageId( $db, $pageid, $id = 0 ) - load either the current, or a specified, revision that's attached to a given page.
  • loadFromTimestamp( $db, $title, $timestamp ) - load the revision for the given title with the given timestamp.
  • loadFromTitle( $db, $title, $id = 0 ) - load either the current, or a specified, revision that's attached to a given page.
  • newFromArchiveRow( $row, $overrides = array() ) - make a fake revision object from an archive table row.
  • newFromId( $id, $flags = 0 ) - load a page revision from a given revision ID number.
  • newFromPageId( $pageId, $revId = 0, $flags = 0 ) - load either the current, or a specified, revision that's attached to a given page ID.
  • newFromRow( $row )
  • newFromTitle( $title, $id = 0, $flags = 0 ) - load either the current, or a specified, revision that's attached to a given title.
  • newNullRevision( $dbw, $pageId, $summary, $minor ) - create a new null-revision for insertion into a page's history.

Methods[edit]

  • 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.
  • getText( $audience = Revision::FOR_PUBLIC, User $user = null ) (deprecated in 1.21) see Manual:ContentHandler.php#Migration .
  • base36Sha1( $text ) This is simply wfBaseConvert( sha1( $text ), 16, 36, 31 )

Accessors[edit]

  • getRecentChange() - get the RC object belonging to the current revision, if there's one.
  • getNext() - get next revision for this title.
  • getPrevious() - get previous revision for this title.
  • getTitle() - returns the title of the page associated with this entry or null.

Audiences[edit]

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