MediaWiki  REL1_19
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions
Revision Class Reference

List of all members.

Public Member Functions

 __construct ($row)
 Constructor.
 getComment ($audience=self::FOR_PUBLIC, User $user=null)
 Fetch revision comment if it's available to the specified audience.
 getId ()
 Get revision ID.
 getNext ()
 Get next revision for this title.
 getPage ()
 Get the page ID.
 getParentId ()
 Get parent revision ID (the original previous page revision)
 getPrevious ()
 Get previous revision for this title.
 getRawComment ()
 Fetch revision comment without regard for the current user's permissions.
 getRawText ()
 Fetch revision text without regard for view restrictions.
 getRawUser ()
 Fetch revision's user id without regard for the current user's permissions.
 getRawUserText ()
 Fetch revision's username without regard for view restrictions.
 getSha1 ()
 Returns the base36 sha1 of the text in this revision, or null if unknown.
 getSize ()
 Returns the length of the text in this revision, or null if unknown.
 getText ($audience=self::FOR_PUBLIC, User $user=null)
 Fetch revision text if it's available to the specified audience.
 getTextId ()
 Get text row ID.
 getTimestamp ()
 getTitle ()
 Returns the title of the page associated with this entry.
 getUser ($audience=self::FOR_PUBLIC, User $user=null)
 Fetch revision's user id if it's available to the specified audience.
 getUserText ($audience=self::FOR_PUBLIC, User $user=null)
 Fetch revision's username if it's available to the specified audience.
 getVisibility ()
 Get the deletion bitfield of the revision.
 insertOn ($dbw)
 Insert a new revision into the database, returning the new revision ID number on success and dies horribly on failure.
 isCurrent ()
 isDeleted ($field)
 isMinor ()
 isUnpatrolled ()
 revText ()
 Alias for getText(Revision::FOR_THIS_USER)
 setId ($id)
 Set the revision ID.
 setTitle ($title)
 Set the title of the 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.

Static Public Member Functions

static base36Sha1 ($text)
 Get the base 36 SHA-1 value for a string of text.
static compressRevisionText (&$text)
 If $wgCompressRevisions is enabled, we will compress data.
static countByPageId ($db, $id)
 Get count of revisions per page...not very efficient.
static countByTitle ($db, $title)
 Get count of revisions per page...not very efficient.
static fetchRevision ($title)
 Return a wrapper for a series of database rows to fetch all of a given page's revisions in turn.
static getRevisionText ($row, $prefix= 'old_')
 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.
static getTimestampFromId ($title, $id)
 Get rev_timestamp from rev_id, without loading the rest of the row.
static loadFromId ($db, $id)
 Load a page revision from a given revision ID number.
static loadFromPageId ($db, $pageid, $id=0)
 Load either the current, or a specified, revision that's attached to a given page.
static loadFromTimestamp ($db, $title, $timestamp)
 Load the revision for the given title with the given timestamp.
static loadFromTitle ($db, $title, $id=0)
 Load either the current, or a specified, revision that's attached to a given page.
static newFromArchiveRow ($row, $overrides=array())
 Make a fake revision object from an archive table row.
static newFromConds ($conditions)
 Given a set of conditions, fetch a revision.
static newFromId ($id)
 Load a page revision from a given revision ID number.
static newFromPageId ($pageId, $revId=0)
 Load either the current, or a specified, revision that's attached to a given page ID.
static newFromRow ($row)
static newFromTitle ($title, $id=0)
 Load either the current, or a specified, revision that's attached to a given title.
static newNullRevision ($dbw, $pageId, $summary, $minor)
 Create a new null-revision for insertion into a page's history.
static pageJoinCond ()
 Return the value of a select() page conds array for the paeg table.
static selectFields ()
 Return the list of revision fields that should be selected to create a new revision.
static selectPageFields ()
 Return the list of page fields that should be selected from page table.
static selectTextFields ()
 Return the list of text fields that should be selected to read the revision text.
static selectUserFields ()
 Return the list of user fields that should be selected from user table.
static userCanBitfield ($bitfield, $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.
static userJoinCond ()
 Return the value of a select() JOIN conds array for the user table.

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

Protected Member Functions

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

Protected Attributes

 $mComment
 $mCurrent
 $mDeleted
 $mId
 $mMinorEdit
 $mOrigUserText
 $mPage
 $mParentId
 $mSha1
 $mSize
 $mText
 $mTextRow
 $mTimestamp
 $mTitle
 $mUser
 $mUserText

Private Member Functions

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

Static Private Member Functions

static fetchFromConds ($db, $conditions)
 Given a set of conditions, return a ResultWrapper which will return matching database rows with the fields necessary to build Revision objects.
static loadFromConds ($db, $conditions)
 Given a set of conditions, fetch a revision from the given database connection.

Detailed Description

Todo:
document

Definition at line 6 of file Revision.php.

Constructor & Destructor Documentation

Revision::__construct ( $  row)

Constructor.

Parameters:
$rowMixed: either a database row or an array
Access:
private

Definition at line 378 of file Revision.php.

References $wgUser, base36Sha1(), newFromRow(), and wfTimestampNow().

Here is the call graph for this function:

Member Function Documentation

static Revision::base36Sha1 ( $  text) [static]

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

Parameters:
$textString
Returns:
String

Definition at line 1016 of file Revision.php.

References wfBaseConvert().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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:
$textMixed: reference to a text
Returns:
String

Definition at line 916 of file Revision.php.

References $wgCompressRevisions, and wfDebug().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Parameters:
$dbDatabaseBase
$idInteger: page id
Returns:
Integer

Definition at line 1201 of file Revision.php.

Referenced by countByTitle().

Here is the caller graph for this function:

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

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

Parameters:
$dbDatabaseBase
$titleTitle
Returns:
Integer

Definition at line 1217 of file Revision.php.

References $title, and countByPageId().

Here is the call graph for this function:

static Revision::fetchFromConds ( $  db,
$  conditions 
) [static, private]

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

Parameters:
$dbDatabaseBase
$conditionsArray
Returns:
ResultWrapper

Definition at line 285 of file Revision.php.

Referenced by fetchRevision(), and loadFromConds().

Here is the caller graph for this function:

static Revision::fetchRevision ( $  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:
$titleTitle
Returns:
ResultWrapper

Definition at line 267 of file Revision.php.

References $title, fetchFromConds(), and wfGetDB().

Here is the call graph for this function:

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:
$audienceInteger: 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
$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns:
String

Definition at line 649 of file Revision.php.

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

Referenced by Linker\revComment().

Here is the call graph for this function:

Here is the caller graph for this function:

Revision::getId ( )

Get revision ID.

Returns:
Integer

Definition at line 474 of file Revision.php.

Referenced by WikiPage\doEditUpdates(), getNext(), getPrevious(), and isUnpatrolled().

Here is the caller graph for this function:

Revision::getNext ( )

Get next revision for this title.

Returns:
Revision or null

Definition at line 795 of file Revision.php.

References getId(), getTitle(), and newFromTitle().

Here is the call graph for this function:

Revision::getPage ( )

Get the page ID.

Returns:
Integer

Definition at line 560 of file Revision.php.

Revision::getParentId ( )

Get parent revision ID (the original previous page revision)

Returns:
Integer

Definition at line 502 of file Revision.php.

Revision::getPrevious ( )

Get previous revision for this title.

Returns:
Revision or null

Definition at line 780 of file Revision.php.

References getId(), getTitle(), and newFromTitle().

Here is the call graph for this function:

Revision::getPreviousRevisionId ( $  db) [private]

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

Parameters:
$dbDatabaseBase
Returns:
Integer

Definition at line 812 of file Revision.php.

Referenced by insertOn().

Here is the caller graph for this function:

Revision::getRawComment ( )

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

Returns:
String

Definition at line 664 of file Revision.php.

Referenced by Linker\revComment().

Here is the caller graph for this function:

Revision::getRawText ( )

Fetch revision text without regard for view restrictions.

Returns:
String

Definition at line 753 of file Revision.php.

References loadText().

Referenced by getText().

Here is the call graph for this function:

Here is the caller graph for this function:

Revision::getRawUser ( )

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

Returns:
String

Definition at line 592 of file Revision.php.

Revision::getRawUserText ( )

Fetch revision's username without regard for view restrictions.

Returns:
String

Definition at line 624 of file Revision.php.

References User\whoIs().

Referenced by getUserText(), and isUnpatrolled().

Here is the call graph for this function:

Here is the caller graph for this function:

static Revision::getRevisionText ( $  row,
$  prefix = 'old_' 
) [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:
$rowObject: the text data
$prefixString: table prefix (default 'old_')
Returns:
String: text the text requested or false on failure

Definition at line 839 of file Revision.php.

References $url, $wgContLang, $wgLegacyEncoding, ExternalStore\fetchFromURL(), wfProfileIn(), and wfProfileOut().

Referenced by CompressOld\compressWithConcat(), FetchText\doGetText(), RecompressTracked\doOrphanList(), RecompressTracked\doPage(), ApiQueryDeletedrevs\execute(), TextPassDumper\getTextDb(), PageArchive\getTextFromRow(), MessageCache\loadFromDB(), loadText(), newFromArchiveRow(), RebuildTextIndex\populateSearchIndex(), RevisionTest\testCompressRevisionTextUtf8(), RevisionTest\testCompressRevisionTextUtf8Gzip(), RevisionTest\testGetRevisionText(), RevisionTest\testGetRevisionTextGzip(), RevisionTest\testGetRevisionTextUtf8Legacy(), RevisionTest\testGetRevisionTextUtf8LegacyGzip(), RevisionTest\testGetRevisionTextUtf8Native(), RevisionTest\testGetRevisionTextUtf8NativeGzip(), and XmlDumpWriter\writeRevision().

Here is the call graph for this function:

Here is the caller graph for this function:

Revision::getSha1 ( )

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

Returns:
String

Definition at line 520 of file Revision.php.

Revision::getSize ( )

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

Returns:
Integer

Definition at line 511 of file Revision.php.

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:
$audienceInteger: 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
$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns:
String

Definition at line 727 of file Revision.php.

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

Referenced by WikiPage\doEditUpdates(), WikiPage\getUndoText(), and revText().

Here is the call graph for this function:

Here is the caller graph for this function:

Revision::getTextId ( )

Get text row ID.

Returns:
Integer

Definition at line 493 of file Revision.php.

Referenced by loadText().

Here is the caller graph for this function:

Revision::getTimestamp ( )
Returns:
String

Definition at line 764 of file Revision.php.

References wfTimestamp().

Referenced by DifferenceEngine\getRevisionHeader(), and WikiPage\setLastEdit().

Here is the call graph for this function:

Here is the caller graph for this function:

static Revision::getTimestampFromId ( $  title,
$  id 
) [static]

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

Parameters:
$titleTitle
$idInteger
Returns:
String

Definition at line 1177 of file Revision.php.

References $dbr, $title, wfGetDB(), wfGetLB(), and wfTimestamp().

Referenced by Skin\lastModified().

Here is the call graph for this function:

Here is the caller graph for this function:

Revision::getTitle ( )

Returns the title of the page associated with this entry.

Returns:
Title

Definition at line 529 of file Revision.php.

References $dbr, newFromRow(), and wfGetDB().

Referenced by getNext(), getPrevious(), DifferenceEngine\getRevisionHeader(), and Linker\revComment().

Here is the call graph for this function:

Here is the caller graph for this function:

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:
$audienceInteger: one of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to $wgUser Revision::RAW get the ID regardless of permissions
$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns:
Integer

Definition at line 577 of file Revision.php.

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

Here is the call graph for this function:

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:
$audienceInteger: 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
$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns:
string

Definition at line 609 of file Revision.php.

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

Here is the call graph for this function:

Revision::getVisibility ( )

Get the deletion bitfield of the revision.

Returns:
int

Definition at line 710 of file Revision.php.

Revision::insertOn ( $  dbw)

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

Parameters:
$dbwDatabaseBase: (master connection)
Returns:
Integer

Definition at line 942 of file Revision.php.

References $wgDefaultExternalStore, base36Sha1(), compressRevisionText(), getPreviousRevisionId(), ExternalStore\insertToDefault(), wfProfileIn(), wfProfileOut(), and wfRunHooks().

Referenced by WikiPage\doQuickEdit().

Here is the call graph for this function:

Here is the caller graph for this function:

Revision::isCurrent ( )
Returns:
Boolean

Definition at line 771 of file Revision.php.

Referenced by DifferenceEngine\getRevisionHeader().

Here is the caller graph for this function:

Revision::isDeleted ( $  field)
Parameters:
$fieldint one of DELETED_* bitfield constants
Returns:
Boolean

Definition at line 701 of file Revision.php.

Referenced by getComment(), DifferenceEngine\getRevisionHeader(), getText(), getUser(), getUserText(), and Linker\revComment().

Here is the caller graph for this function:

Revision::isMinor ( )
Returns:
Boolean

Definition at line 671 of file Revision.php.

Referenced by WikiPage\doEditUpdates().

Here is the caller graph for this function:

Revision::isUnpatrolled ( )
Returns:
Integer rcid of the unpatrolled row, zero if there isn't one

Definition at line 678 of file Revision.php.

References $dbr, getId(), getRawUserText(), and wfGetDB().

Here is the call graph for this function:

static Revision::loadFromConds ( $  db,
$  conditions 
) [static, private]

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

Parameters:
$dbDatabaseBase
$conditionsArray
Returns:
Revision or null

Definition at line 246 of file Revision.php.

References $res, and fetchFromConds().

Referenced by loadFromId(), loadFromPageId(), loadFromTimestamp(), loadFromTitle(), and newFromConds().

Here is the call graph for this function:

Here is the caller graph for this function:

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:
$dbDatabaseBase
$idInteger
Returns:
Revision or null

Definition at line 157 of file Revision.php.

References loadFromConds().

Here is the call graph for this function:

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:
$dbDatabaseBase
$pageidInteger
$idInteger
Returns:
Revision or null

Definition at line 171 of file Revision.php.

References loadFromConds().

Referenced by Maintenance\updateSearchIndexForPage().

Here is the call graph for this function:

Here is the caller graph for this function:

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:
$dbDatabaseBase
$titleTitle
$timestampString
Returns:
Revision or null

Definition at line 214 of file Revision.php.

References $title, and loadFromConds().

Referenced by AttachLatest\execute(), EditPage\getBaseRevision(), and WikiPage\replaceSection().

Here is the call graph for this function:

Here is the caller graph for this function:

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:
$dbDatabaseBase
$titleTitle
$idInteger
Returns:
Revision or null

Definition at line 191 of file Revision.php.

References $title, and loadFromConds().

Referenced by EditPage\mergeChangesInto().

Here is the call graph for this function:

Here is the caller graph for this function:

Revision::loadText ( ) [protected]

Lazy-load the revision's text.

Currently hardcoded to the 'text' table storage engine.

Returns:
String

Definition at line 1026 of file Revision.php.

References $dbr, $wgMemc, $wgRevisionCacheExpiry, getRevisionText(), getTextId(), wfDebug(), wfGetDB(), wfGetLB(), wfMemcKey(), wfProfileIn(), and wfProfileOut().

Referenced by getRawText().

Here is the call graph for this function:

Here is the caller graph for this function:

static Revision::newFromArchiveRow ( $  row,
$  overrides = array() 
) [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:
$row
$overridesarray
Returns:
Revision

Definition at line 115 of file Revision.php.

References getRevisionText().

Referenced by RevDel_ArchiveItem\__construct(), RevDel_ArchivedRevisionItem\__construct(), DifferenceEngine\deletedLink(), SpecialUndelete\formatRevisionRow(), PageArchive\getRevision(), PageArchive\undeleteRevisions(), PopulateRevisionSha1\upgradeLegacyArchiveRow(), and PopulateRevisionSha1\upgradeRow().

Here is the call graph for this function:

Here is the caller graph for this function:

static Revision::newFromConds ( $  conditions) [static]

Given a set of conditions, fetch a revision.

Parameters:
$conditionsArray
Returns:
Revision or null

Definition at line 228 of file Revision.php.

References loadFromConds(), wfGetDB(), and wfGetLB().

Referenced by newFromId(), newFromPageId(), and newFromTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

static Revision::newFromId ( $  id) [static]

Load a page revision from a given revision ID number.

Returns null if no such revision can be found.

Parameters:
$idInteger
Returns:
Revision or null

Definition at line 42 of file Revision.php.

References newFromConds().

Referenced by SpecialComparePages\checkExistingRevision(), Orphans\checkSeparation(), WikiPage\commitRollback(), CheckBadRedirects\execute(), SpecialRevisionDelete\execute(), SpecialNewpages\feedItemDesc(), Article\fetchContent(), FeedUtils\formatDiffRow(), EditPage\getContent(), Article\getOldIDFromRequest(), PageArchive\getPreviousRevision(), Parser\getRevisionObject(), DifferenceEngine\loadRevisionData(), MediaWiki\parseTitle(), Article\setOldSubtitle(), and Parser\statelessFetchTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

static Revision::newFromPageId ( $  pageId,
$  revId = 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.

Parameters:
$revIdInteger
$pageIdInteger (optional)
Returns:
Revision or null

Definition at line 87 of file Revision.php.

References newFromConds(), wfGetDB(), and wfGetLB().

Referenced by WikiPage\loadLastEdit().

Here is the call graph for this function:

Here is the caller graph for this function:

static Revision::newFromRow ( $  row) [static]
Since:
1.19
Parameters:
$row
Returns:
Revision

Definition at line 145 of file Revision.php.

Referenced by __construct(), ApiFeedContributions\feedItem(), and getTitle().

Here is the caller graph for this function:

static Revision::newFromTitle ( $  title,
$  id = 0 
) [static]

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

If not attached to that title, will return null.

Parameters:
$titleTitle
$idInteger (optional)
Returns:
Revision or null

Definition at line 55 of file Revision.php.

References $title, newFromConds(), wfGetDB(), and wfGetLB().

Referenced by CleanupSpam\cleanupArticle(), Title\countAuthorsBetween(), Title\countRevisionsBetween(), PoolWorkArticleView\doWork(), GetTextMaint\execute(), ApiEditPage\execute(), RefreshLinks\fixLinksFromArticle(), ResourceLoaderWikiModule\getContent(), LocalFile\getDescriptionText(), MessageCache\getMsgFromNamespace(), getNext(), getPrevious(), RawAction\getRawText(), Title\isValidMoveTarget(), DifferenceEngine\loadRevisionData(), CoreParserFunctions\pagesize(), LanguageConverter\parseCachedTable(), RefreshLinksJob\run(), DoubleRedirectJob\run(), RefreshLinksJob2\run(), SpecialBookSources\showList(), Parser\statelessFetchTemplate(), and UploadFromUrlTest\testLeaveMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

static Revision::newNullRevision ( $  dbw,
$  pageId,
$  summary,
$  minor 
) [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:
$dbwDatabaseBase
$pageIdInteger: ID number of the page to read from
$summaryString: revision's summary
$minorBoolean: whether the revision should be considered as minor
Returns:
Revision|null on error

Definition at line 1094 of file Revision.php.

References wfProfileIn(), and wfProfileOut().

Referenced by WikiPage\doUpdateRestrictions(), Title\moveToInternal(), LocalFile\recordUpload2(), and ImportReporter\reportPage().

Here is the call graph for this function:

Here is the caller graph for this function:

static Revision::pageJoinCond ( ) [static]

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

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

Since:
1.19
Returns:
Array

Definition at line 317 of file Revision.php.

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

Here is the caller graph for this function:

Revision::revText ( )

Alias for getText(Revision::FOR_THIS_USER)

Deprecated:
since 1.17
Returns:
String

Definition at line 743 of file Revision.php.

References getText(), and wfDeprecated().

Here is the call graph for this function:

static Revision::selectFields ( ) [static]

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

Definition at line 325 of file Revision.php.

Referenced by PopulateRevisionLength\doDBUpdates(), RevDel_RevisionList\doQuery(), RevisionList\doQuery(), ApiQueryRevisions\execute(), HistoryAction\fetchRevisions(), HistoryPager\getQueryInfo(), MergeHistoryPager\getQueryInfo(), and ContribsPager\getQueryInfo().

Here is the caller graph for this function:

static Revision::selectPageFields ( ) [static]

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

Definition at line 356 of file Revision.php.

Referenced by ApiQueryRevisions\execute().

Here is the caller graph for this function:

static Revision::selectTextFields ( ) [static]

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

Definition at line 346 of file Revision.php.

Referenced by ApiQueryRevisions\execute().

Here is the caller graph for this function:

static Revision::selectUserFields ( ) [static]

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

Definition at line 368 of file Revision.php.

Referenced by RevDel_RevisionList\doQuery(), RevisionList\doQuery(), HistoryPager\getQueryInfo(), MergeHistoryPager\getQueryInfo(), and ContribsPager\getQueryInfo().

Here is the caller graph for this function:

Revision::setId ( $  id)

Set the revision ID.

Since:
1.19
Parameters:
$idInteger

Definition at line 484 of file Revision.php.

Revision::setTitle ( $  title)

Set the title of the revision.

Parameters:
$titleTitle

Definition at line 551 of file Revision.php.

References $title.

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:
$fieldInteger:one of self::DELETED_TEXT, self::DELETED_COMMENT, self::DELETED_USER
$userUser object to check, or null to use $wgUser
Returns:
Boolean

Definition at line 1134 of file Revision.php.

References $user, and userCanBitfield().

Referenced by getComment(), DifferenceEngine\getRevisionHeader(), getText(), getUser(), getUserText(), and Linker\revComment().

Here is the call graph for this function:

Here is the caller graph for this function:

static Revision::userCanBitfield ( $  bitfield,
$  field,
User $  user = 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:
$bitfieldInteger: current field
$fieldInteger: one of self::DELETED_TEXT = File::DELETED_FILE, self::DELETED_COMMENT = File::DELETED_COMMENT, self::DELETED_USER = File::DELETED_USER
$userUser object to check, or null to use $wgUser
Returns:
Boolean

Definition at line 1150 of file Revision.php.

References $user, $wgUser, and wfDebug().

Referenced by OldLocalFile\userCan(), ChangesList\userCan(), ArchivedFile\userCan(), and userCan().

Here is the call graph for this function:

Here is the caller graph for this function:

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 307 of file Revision.php.

Referenced by RevDel_RevisionList\doQuery(), RevisionList\doQuery(), HistoryPager\getQueryInfo(), MergeHistoryPager\getQueryInfo(), and ContribsPager\getQueryInfo().

Here is the caller graph for this function:

Member Data Documentation

Revision::$mComment [protected]

Definition at line 18 of file Revision.php.

Revision::$mCurrent [protected]

Definition at line 22 of file Revision.php.

Revision::$mDeleted [protected]

Definition at line 14 of file Revision.php.

Revision::$mId [protected]

Definition at line 7 of file Revision.php.

Revision::$mMinorEdit [protected]

Definition at line 12 of file Revision.php.

Revision::$mOrigUserText [protected]

Definition at line 10 of file Revision.php.

Revision::$mPage [protected]

Definition at line 8 of file Revision.php.

Revision::$mParentId [protected]

Definition at line 17 of file Revision.php.

Revision::$mSha1 [protected]

Definition at line 16 of file Revision.php.

Revision::$mSize [protected]

Definition at line 15 of file Revision.php.

Revision::$mText [protected]

Definition at line 19 of file Revision.php.

Revision::$mTextRow [protected]

Definition at line 20 of file Revision.php.

Revision::$mTimestamp [protected]

Definition at line 13 of file Revision.php.

Revision::$mTitle [protected]

Definition at line 21 of file Revision.php.

Revision::$mUser [protected]

Definition at line 11 of file Revision.php.

Revision::$mUserText [protected]

Definition at line 9 of file Revision.php.

const Revision::DELETED_COMMENT = 2

Definition at line 25 of file Revision.php.

Referenced by LocalFileDeleteBatch\doDBInserts(), WikiPage\doDeleteArticleReal(), SpecialRevisionDelete\execute(), ApiQueryContributions\extractRowInfo(), ApiQueryRevisions\extractRowInfo(), FeedUtils\formatDiff(), RevisionDeleter\getChanges(), ChangesList\insertComment(), Linker\revComment(), and XmlDumpWriter\writeRevision().

const Revision::DELETED_RESTRICTED = 8

Definition at line 27 of file Revision.php.

Referenced by SpecialRevisionDelete\buildCheckBoxes(), RevDel_RevisionItem\canView(), RevisionItem\canView(), RevDel_LogItem\canView(), LocalFileDeleteBatch\doDBInserts(), WikiPage\doDeleteArticleReal(), SpecialRevisionDelete\execute(), SpecialRevisionDelete\extractBitParams(), RevisionDeleter\getChanges(), RevDel_RevisionList\getSuppressBit(), RevDel_LogList\getSuppressBit(), HistoryPager\historyLine(), RevisionDeleteUser\setUsernameBitfields(), RevDel_List\setVisibility(), Article\showDeletedRevisionHeader(), DifferenceEngine\showDiffPage(), and SpecialRevisionDelete\submit().

const Revision::DELETED_TEXT = 1

Definition at line 24 of file Revision.php.

Referenced by RevDel_RevisionItem\canViewContent(), RevisionItem\canViewContent(), CleanupSpam\cleanupArticle(), WikiPage\commitRollback(), HistoryPager\curLink(), HistoryPager\diffButtons(), LocalFileDeleteBatch\doDBInserts(), WikiPage\doDeleteArticleReal(), ApiParse\execute(), ApiEditPage\execute(), ApiQueryRevisions\execute(), ApiQueryRevisions\extractRowInfo(), SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), DeletedContribsPager\formatRow(), ContribsPager\formatRow(), RevisionDeleter\getChanges(), EditPage\getContent(), DifferenceEngine\getDiffBody(), SpecialUndelete\getPageLink(), DifferenceEngine\getRevisionHeader(), HistoryPager\historyLine(), ChangesList\insertArticleLink(), ChangesList\insertDiffHist(), RevDel_RevisionItem\isDeleted(), RevisionItem\isDeleted(), RevDel_RevisionItem\isHideCurrentOp(), HistoryPager\lastLink(), EnhancedChangesList\recentChangesBlockGroup(), EnhancedChangesList\recentChangesLine(), HistoryPager\revLink(), Article\showDeletedRevisionHeader(), DifferenceEngine\showDiffPage(), EditPage\showHeader(), SpecialUndelete\showRevision(), PageArchive\undeleteRevisions(), and XmlDumpWriter\writeRevision().

const Revision::DELETED_USER = 4

Definition at line 26 of file Revision.php.

Referenced by WikiPage\commitRollback(), WikiExporter\do_list_authors(), LocalFileDeleteBatch\doDBInserts(), WikiPage\doDeleteArticleReal(), ApiQueryRevisions\execute(), SpecialRevisionDelete\execute(), ApiQueryContributions\extractRowInfo(), ApiQueryRevisions\extractRowInfo(), DeletedContribsPager\formatRow(), ContribsPager\formatRow(), ChangesFeed\generateFeed(), WikiPage\getAutoDeleteReason(), RevisionDeleter\getChanges(), DeletedContribsPager\getQueryInfo(), ContribsPager\getQueryInfo(), RevDel_FileItem\getUserTools(), ChangesList\insertUserRelatedLinks(), ApiQueryContributions\prepareQuery(), EnhancedChangesList\recentChangesLine(), Linker\revUserLink(), Linker\revUserTools(), RevisionDeleteUser\setUsernameBitfields(), and XmlDumpWriter\writeRevision().

const Revision::FOR_PUBLIC = 1

Definition at line 31 of file Revision.php.

Referenced by GetTextMaint\execute().

const Revision::FOR_THIS_USER = 2

Definition at line 32 of file Revision.php.

Referenced by ApiParse\execute(), ApiEditPage\execute(), Article\fetchContent(), DifferenceEngine\loadNewText(), DifferenceEngine\loadText(), Linker\revComment(), Linker\revUserLink(), Linker\revUserTools(), and SpecialUndelete\showRevision().

const Revision::RAW = 3

Definition at line 33 of file Revision.php.

Referenced by GetTextMaint\execute().

const Revision::SUPPRESSED_USER = 12

Definition at line 29 of file Revision.php.

Referenced by DeletedContribsPager\getQueryInfo(), and ContribsPager\getQueryInfo().

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