MediaWiki  master
RecentChange Class Reference

Utility class for creating new RC entries. More...

Inheritance diagram for RecentChange:
Collaboration diagram for RecentChange:

Public Member Functions

 __construct ()
 
 addTags ( $tags)
 Tags to append to the recent change, and associated revision/log. More...
 
 diffLinkTrail ( $forceCur)
 Gets the end part of the diff URL associated with this object Blank if no diff link should be displayed. More...
 
 doMarkPatrolled (Authority $performer, $auto=false, $tags=null)
 Mark this RecentChange as patrolled. More...
 
 getAttribute ( $name)
 Get an attribute value. More...
 
 getAttributes ()
 
 getCharacterDifference ( $old=0, $new=0)
 Returns the change size (HTML). More...
 
 getPage ()
 
 getParam ( $name)
 Get a parameter value. More...
 
 getPerformer ()
 Get the User object of the person who performed this change. More...
 
 getPerformerIdentity ()
 Get the UserIdentity of the client that performed this change. More...
 
 getTitle ()
 
 loadFromRow ( $row)
 Initialises the members of this object from a mysql row object. More...
 
 notifyRCFeeds (array $feeds=null)
 Notify all the feeds about the change. More...
 
 parseParams ()
 Parses and returns the rc_params attribute. More...
 
 reallyMarkPatrolled ()
 Mark this RecentChange patrolled, without error checking. More...
 
 save ( $send=self::SEND_FEED)
 Writes the data in this object to the database. More...
 
 setAttribs ( $attribs)
 
 setEditResult (?EditResult $editResult)
 Sets the EditResult associated with the edit. More...
 
 setExtra ( $extra)
 

Static Public Member Functions

static getChangeTypes ()
 Get an array of all change types. More...
 
static getEngine ( $uri, $params=[])
 
static getQueryInfo ()
 Return the tables, fields, and join conditions to be selected to create a new recentchanges object. More...
 
static isInRCLifespan ( $timestamp, $tolerance=0)
 Check whether the given timestamp is new enough to have a RC row with a given tolerance as the recentchanges table might not be cleared out regularly (so older entries might exist) or rows which will be deleted soon shouldn't be included. More...
 
static newForCategorization ( $timestamp, PageIdentity $categoryTitle, ?UserIdentity $user, $comment, PageIdentity $pageTitle, $oldRevId, $newRevId, $lastTimestamp, $bot, $ip='', $deleted=0, $added=null)
 Constructs a RecentChange object for the given categorization This does not call save() on the object and thus does not write to the db. More...
 
static newFromConds ( $conds, $fname=__METHOD__, $dbType=DB_REPLICA)
 Find the first recent change matching some specific conditions. More...
 
static newFromId ( $rcid)
 Obtain the recent change with a given rc_id value. More...
 
static newFromRow ( $row)
 
static newLogEntry ( $timestamp, $logPage, $user, $actionComment, $ip, $type, $action, $target, $logComment, $params, $newId=0, $actionCommentIRC='', $revId=0, $isPatrollable=false)
 
static notifyEdit ( $timestamp, $page, $minor, $user, $comment, $oldId, $lastTimestamp, $bot, $ip='', $oldSize=0, $newSize=0, $newId=0, $patrol=0, $tags=[], EditResult $editResult=null)
 Makes an entry in the database corresponding to an edit. More...
 
static notifyLog ( $timestamp, $logPage, $user, $actionComment, $ip, $type, $action, $target, $logComment, $params, $newId=0, $actionCommentIRC='')
 
static notifyNew ( $timestamp, $page, $minor, $user, $comment, $bot, $ip='', $size=0, $newId=0, $patrol=0, $tags=[])
 Makes an entry in the database corresponding to page creation. More...
 
static parseFromRCType ( $rcType)
 Parsing RC_* constants to human-readable test. More...
 
static parseToRCType ( $type)
 Parsing text to RC_* constants. More...
 

Public Attributes

int $counter = -1
 Line number of recent change. More...
 
array $mAttribs = []
 
 $mExtra = []
 
 $notificationtimestamp
 
 $numberofWatchingusers = 0
 
string null $watchlistExpiry
 The expiry time, if this is a temporary watchlist item. More...
 
const PRC_AUTOPATROLLED = 2
 
const PRC_PATROLLED = 1
 
const PRC_UNPATROLLED = 0
 
const SRC_CATEGORIZE = 'mw.categorize'
 
const SRC_EDIT = 'mw.edit'
 
const SRC_EXTERNAL = 'mw.external'
 
const SRC_LOG = 'mw.log'
 
const SRC_NEW = 'mw.new'
 

Detailed Description

Utility class for creating new RC entries.

mAttribs: rc_id id of the row in the recentchanges table rc_timestamp time the entry was made rc_namespace namespace # rc_title non-prefixed db key rc_type is new entry, used to determine whether updating is necessary rc_source string representation of change source rc_minor is minor rc_cur_id page_id of associated page entry rc_user user id who made the entry rc_user_text user name who made the entry rc_comment edit summary rc_this_oldid rev_id associated with this entry (or zero) rc_last_oldid rev_id associated with the entry before this one (or zero) rc_bot is bot, hidden rc_ip IP address of the user in dotted quad notation rc_new obsolete, use rc_type==RC_NEW rc_patrolled boolean whether or not someone has marked this edit as patrolled rc_old_len integer byte length of the text before the edit rc_new_len the same after the edit rc_deleted partial deletion rc_logid the log_id value for this log entry (or zero) rc_log_type the log type (or null) rc_log_action the log action (or null) rc_params log params

mExtra: prefixedDBkey prefixed db key, used by external app via msg queue lastTimestamp timestamp of previous entry, used in WHERE clause during update oldSize text size before the change newSize text size after the change pageStatus status of the page: created, deleted, moved, restored, changed

temporary: not stored in the database notificationtimestamp numberofWatchingusers watchlistExpiry for temporary watchlist items

Todo:
Deprecate access to mAttribs (direct or via getAttributes). Right now we're having to include both rc_comment and rc_comment_text/rc_comment_data so random crap works right.

Definition at line 83 of file RecentChange.php.

Constructor & Destructor Documentation

◆ __construct()

RecentChange::__construct ( )

Member Function Documentation

◆ addTags()

RecentChange::addTags (   $tags)

Tags to append to the recent change, and associated revision/log.

Since
1.28
Parameters
string | string[]$tags

Implements MediaWiki\ChangeTags\Taggable.

Definition at line 1303 of file RecentChange.php.

◆ diffLinkTrail()

RecentChange::diffLinkTrail (   $forceCur)

Gets the end part of the diff URL associated with this object Blank if no diff link should be displayed.

Parameters
bool$forceCur
Returns
string

Definition at line 1208 of file RecentChange.php.

References RC_EDIT.

◆ doMarkPatrolled()

RecentChange::doMarkPatrolled ( Authority  $performer,
  $auto = false,
  $tags = null 
)

Mark this RecentChange as patrolled.

NOTE: Can also return 'rcpatroldisabled', 'hookaborted' and 'markedaspatrollederror-noautopatrol' as errors

Parameters
Authority$performerUser performing the action
bool$autoFor automatic patrol
string | string[] | null$tagsChange tags to add to the patrol log entry ($user should be able to add the specified tags before this is called)
Returns
array[] Array of permissions errors, see PermissionManager::getPermissionErrors()

Definition at line 626 of file RecentChange.php.

References MediaWiki\Permissions\Authority\authorizeWrite(), getTitle(), MediaWiki\Permissions\Authority\getUser(), MediaWiki\Permissions\Authority\isAllowed(), RC_LOG, RC_NEW, PatrolLog\record(), and Hooks\runner().

◆ getAttribute()

RecentChange::getAttribute (   $name)

Get an attribute value.

Parameters
string$nameAttribute name
Returns
mixed

Definition at line 1168 of file RecentChange.php.

References DB_REPLICA, CommentStore\getStore(), wfDeprecatedMsg(), and wfGetDB().

Referenced by ChangesList\getDataAttributes(), EnhancedChangesList\getDiffHistLinks(), MachineReadableRCFeedFormatter\getLine(), and SpecialWatchlist\isChangeEffectivelySeen().

◆ getAttributes()

RecentChange::getAttributes ( )
Returns
array

Definition at line 1198 of file RecentChange.php.

Referenced by IRCColourfulRCFeedFormatter\getLine().

◆ getChangeTypes()

static RecentChange::getChangeTypes ( )
static

Get an array of all change types.

Since
1.26
Returns
array

Definition at line 206 of file RecentChange.php.

Referenced by ApiQueryRecentChanges\getAllowedParams(), and ApiQueryWatchlist\getAllowedParams().

◆ getCharacterDifference()

RecentChange::getCharacterDifference (   $old = 0,
  $new = 0 
)

Returns the change size (HTML).

The lengths can be given optionally.

Parameters
int$old
int$new
Returns
string

Definition at line 1231 of file RecentChange.php.

References ChangesList\showCharacterDifference().

◆ getEngine()

static RecentChange::getEngine (   $uri,
  $params = [] 
)
static
Since
1.22 @codeCoverageIgnore
Deprecated:
since 1.29 Use RCFeed::factory() instead. Hard deprecated since 1.38.
Parameters
string$uriURI to get the engine object for
array$params
Returns
FormattedRCFeed
Exceptions
MWException

Definition at line 598 of file RecentChange.php.

References wfDeprecated().

◆ getPage()

RecentChange::getPage ( )
Since
1.37
Returns
?PageReference

Definition at line 344 of file RecentChange.php.

Referenced by getTitle().

◆ getParam()

RecentChange::getParam (   $name)

Get a parameter value.

Since
1.27
Parameters
string$nameparameter name
Returns
mixed

Definition at line 1124 of file RecentChange.php.

◆ getPerformer()

RecentChange::getPerformer ( )

Get the User object of the person who performed this change.

Deprecated:
since 1.36, hard deprecated since 1.37, use getPerformerIdentity() instead.
Returns
User

Definition at line 374 of file RecentChange.php.

References User\newFromIdentity().

◆ getPerformerIdentity()

RecentChange::getPerformerIdentity ( )

Get the UserIdentity of the client that performed this change.

Since
1.36
Returns
UserIdentity

Definition at line 390 of file RecentChange.php.

◆ getQueryInfo()

static RecentChange::getQueryInfo ( )
static

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

Since 1.34, rc_user and rc_user_text have not been present in the database, but they continue to be available in query results as aliases.

Since
1.31
Returns
array[] With three keys:
  • tables: (string[]) to include in the $table to IDatabase->select() or SelectQueryBuilder::tables
  • fields: (string[]) to include in the $vars to IDatabase->select() or SelectQueryBuilder::fields
  • joins: (array) to include in the $join_conds to IDatabase->select() or SelectQueryBuilder::joinConds

Definition at line 261 of file RecentChange.php.

References CommentStore\getStore().

Referenced by ChangesListSpecialPage\doMainQuery(), SpecialRecentChanges\doMainQuery(), SpecialWatchlist\doMainQuery(), SpecialRecentChangesLinked\doMainQuery(), NewPagesPager\getQueryInfo(), newFromConds(), and RecentChangesUpdateJob\purgeExpiredRows().

◆ getTitle()

◆ isInRCLifespan()

static RecentChange::isInRCLifespan (   $timestamp,
  $tolerance = 0 
)
static

Check whether the given timestamp is new enough to have a RC row with a given tolerance as the recentchanges table might not be cleared out regularly (so older entries might exist) or rows which will be deleted soon shouldn't be included.

Parameters
mixed$timestampMWTimestamp compatible timestamp
int$toleranceTolerance in seconds
Returns
bool

Definition at line 1271 of file RecentChange.php.

References wfTimestamp().

Referenced by DifferenceEngine\getMarkPatrolledLinkInfo(), and Article\showPatrolFooter().

◆ loadFromRow()

RecentChange::loadFromRow (   $row)

Initialises the members of this object from a mysql row object.

Parameters
mixed$row

Definition at line 1134 of file RecentChange.php.

References DB_REPLICA, CommentStore\getStore(), wfGetDB(), and wfTimestamp().

Referenced by newFromRow().

◆ newForCategorization()

static RecentChange::newForCategorization (   $timestamp,
PageIdentity  $categoryTitle,
?UserIdentity  $user,
  $comment,
PageIdentity  $pageTitle,
  $oldRevId,
  $newRevId,
  $lastTimestamp,
  $bot,
  $ip = '',
  $deleted = 0,
  $added = null 
)
static

Constructs a RecentChange object for the given categorization This does not call save() on the object and thus does not write to the db.

Since
1.27
Parameters
string$timestampTimestamp of the recent change to occur
PageIdentity$categoryTitlethe category a page is being added to or removed from
UserIdentity | null$userUser object of the user that made the change
string$commentChange summary
PageIdentity$pageTitlethe page that is being added or removed
int$oldRevIdParent revision ID of this change
int$newRevIdRevision ID of this change
string$lastTimestampParent revision timestamp of this change
bool$bottrue, if the change was made by a bot
string$ipIP address of the user, if the change was made anonymously
int$deletedIndicates whether the change has been deleted
bool | null$addedtrue, if the category was added, false for removed
Returns
RecentChange

Definition at line 1038 of file RecentChange.php.

References Page\PageReference\getDBkey(), Page\PageIdentity\getId(), MediaWiki\User\UserIdentity\getId(), MediaWiki\User\UserIdentity\getName(), Page\PageReference\getNamespace(), RC_CATEGORIZE, and serialize().

◆ newFromConds()

static RecentChange::newFromConds (   $conds,
  $fname = __METHOD__,
  $dbType = DB_REPLICA 
)
static

Find the first recent change matching some specific conditions.

Parameters
array$condsArray of conditions
mixed$fnameOverride the method name in profiling/logs
int$dbTypeDB_* constant
Returns
RecentChange|null

Definition at line 229 of file RecentChange.php.

References getQueryInfo(), newFromRow(), and wfGetDB().

Referenced by DifferenceEngine\getMarkPatrolledLinkInfo(), MediaWiki\Revision\RevisionStore\getRecentChange(), newFromId(), and Article\showPatrolFooter().

◆ newFromId()

static RecentChange::newFromId (   $rcid)
static

Obtain the recent change with a given rc_id value.

Parameters
int$rcidThe rc_id value to retrieve
Returns
RecentChange|null

Definition at line 216 of file RecentChange.php.

References newFromConds().

Referenced by ApiPatrol\execute(), MarkpatrolledAction\getRecentChange(), ApiTag\processIndividual(), and PatrolLog\record().

◆ newFromRow()

static RecentChange::newFromRow (   $row)
static
Parameters
mixed$row
Returns
RecentChange

Definition at line 159 of file RecentChange.php.

References loadFromRow().

Referenced by newFromConds(), SpecialRecentChanges\outputChangesList(), and SpecialWatchlist\outputChangesList().

◆ newLogEntry()

static RecentChange::newLogEntry (   $timestamp,
  $logPage,
  $user,
  $actionComment,
  $ip,
  $type,
  $action,
  $target,
  $logComment,
  $params,
  $newId = 0,
  $actionCommentIRC = '',
  $revId = 0,
  $isPatrollable = false 
)
static
Parameters
string$timestamp
PageReference$logPage
UserIdentity$user
string$actionComment
string$ip
string$type
string$action
PageReference$target
string$logComment
string$params
int$newId
string$actionCommentIRC
int$revIdId of associated revision, if any
bool$isPatrollableWhether this log entry is patrollable
Returns
RecentChange

Definition at line 928 of file RecentChange.php.

References $type, $wgRequest, Page\PageIdentity\canExist(), and RC_LOG.

Referenced by ManualLogEntry\getRecentChange(), and LogPage\saveContent().

◆ notifyEdit()

static RecentChange::notifyEdit (   $timestamp,
  $page,
  $minor,
  $user,
  $comment,
  $oldId,
  $lastTimestamp,
  $bot,
  $ip = '',
  $oldSize = 0,
  $newSize = 0,
  $newId = 0,
  $patrol = 0,
  $tags = [],
EditResult  $editResult = null 
)
static

Makes an entry in the database corresponding to an edit.

Since
1.36 Added $editResult parameter
Parameters
string$timestamp
PageIdentity$page
bool$minor
UserIdentity$user
string$comment
int$oldId
string$lastTimestamp
bool$bot
string$ip
int$oldSize
int$newSize
int$newId
int$patrol
string[]$tags
EditResult | null$editResultEditResult associated with this edit. Can be safely skipped if the edit is not a revert. Used only for marking revert tags.
Returns
RecentChange

Definition at line 733 of file RecentChange.php.

References DeferredUpdates\addCallableUpdate(), DB_PRIMARY, RC_EDIT, and wfGetDB().

Referenced by ImportTextFiles\execute().

◆ notifyLog()

static RecentChange::notifyLog (   $timestamp,
  $logPage,
  $user,
  $actionComment,
  $ip,
  $type,
  $action,
  $target,
  $logComment,
  $params,
  $newId = 0,
  $actionCommentIRC = '' 
)
static
Parameters
string$timestamp
PageReference$logPage
UserIdentity$user
string$actionComment
string$ip
string$type
string$action
PageReference$target
string$logComment
string$params
int$newId
string$actionCommentIRC
Returns
bool

Definition at line 891 of file RecentChange.php.

References $type.

Referenced by LogPage\saveContent().

◆ notifyNew()

static RecentChange::notifyNew (   $timestamp,
  $page,
  $minor,
  $user,
  $comment,
  $bot,
  $ip = '',
  $size = 0,
  $newId = 0,
  $patrol = 0,
  $tags = [] 
)
static

Makes an entry in the database corresponding to page creation.

Note
$page must reflect the state of the database after the page creation. In particular, $page->getId() must return the newly assigned page ID.
Parameters
string$timestamp
PageIdentity$page
bool$minor
UserIdentity$user
string$comment
bool$bot
string$ip
int$size
int$newId
int$patrol
string[]$tags
Returns
RecentChange

Definition at line 814 of file RecentChange.php.

References DeferredUpdates\addCallableUpdate(), DB_PRIMARY, RC_NEW, and wfGetDB().

Referenced by ImportTextFiles\execute().

◆ notifyRCFeeds()

RecentChange::notifyRCFeeds ( array  $feeds = null)

Notify all the feeds about the change.

Parameters
array | null$feedsOptional feeds to send to, defaults to $wgRCFeeds

Definition at line 553 of file RecentChange.php.

References RCFeed\factory(), and RC_EXTERNAL.

◆ parseFromRCType()

static RecentChange::parseFromRCType (   $rcType)
static

Parsing RC_* constants to human-readable test.

Since
1.24
Parameters
int$rcType
Returns
string

Definition at line 195 of file RecentChange.php.

Referenced by ApiQueryRecentChanges\extractRowInfo(), and MachineReadableRCFeedFormatter\getLine().

◆ parseParams()

RecentChange::parseParams ( )

Parses and returns the rc_params attribute.

Since
1.26
Returns
mixed|bool false on failed unserialization

Definition at line 1285 of file RecentChange.php.

References unserialize().

Referenced by MachineReadableRCFeedFormatter\getLine().

◆ parseToRCType()

static RecentChange::parseToRCType (   $type)
static

Parsing text to RC_* constants.

Since
1.24
Parameters
string | array$type
Exceptions
MWException
Returns
int|array RC_TYPE

Definition at line 173 of file RecentChange.php.

References $t, and $type.

Referenced by ApiQueryRecentChanges\run().

◆ reallyMarkPatrolled()

RecentChange::reallyMarkPatrolled ( )

Mark this RecentChange patrolled, without error checking.

Returns
int Number of affected rows

Definition at line 682 of file RecentChange.php.

References DB_PRIMARY, getTitle(), and wfGetDB().

◆ save()

RecentChange::save (   $send = self::SEND_FEED)

Writes the data in this object to the database.

For compatibility reasons, the SEND_ constants internally reference a value that may seem negated from their purpose (none=true, feed=false). This is because the parameter used to be called "$noudp", defaulting to false.

Parameters
bool$sendself::SEND_FEED or self::SEND_NONE

Definition at line 411 of file RecentChange.php.

References $title, ChangeTags\addTags(), Title\castFromPageReference(), DB_PRIMARY, FormatJson\encode(), CommentStore\getStore(), RecentChangesUpdateJob\newCacheUpdateJob(), RecentChangesUpdateJob\newPurgeJob(), RC_CATEGORIZE, Hooks\runner(), and wfGetDB().

◆ setAttribs()

RecentChange::setAttribs (   $attribs)
Parameters
array$attribs

Definition at line 320 of file RecentChange.php.

◆ setEditResult()

RecentChange::setEditResult ( ?EditResult  $editResult)

Sets the EditResult associated with the edit.

Since
1.36
Parameters
EditResult | null$editResult

Definition at line 1318 of file RecentChange.php.

◆ setExtra()

RecentChange::setExtra (   $extra)
Parameters
array$extra

Definition at line 327 of file RecentChange.php.

Member Data Documentation

◆ $counter

int RecentChange::$counter = -1

Line number of recent change.

Default -1.

Definition at line 133 of file RecentChange.php.

◆ $mAttribs

array RecentChange::$mAttribs = []

Definition at line 109 of file RecentChange.php.

◆ $mExtra

RecentChange::$mExtra = []

Definition at line 110 of file RecentChange.php.

◆ $notificationtimestamp

RecentChange::$notificationtimestamp

Definition at line 123 of file RecentChange.php.

◆ $numberofWatchingusers

RecentChange::$numberofWatchingusers = 0

Definition at line 122 of file RecentChange.php.

◆ $watchlistExpiry

string null RecentChange::$watchlistExpiry

The expiry time, if this is a temporary watchlist item.

Definition at line 128 of file RecentChange.php.

◆ PRC_AUTOPATROLLED

◆ PRC_PATROLLED

const RecentChange::PRC_PATROLLED = 1

Definition at line 95 of file RecentChange.php.

Referenced by ChangesListSpecialPage\__construct().

◆ PRC_UNPATROLLED

◆ SRC_CATEGORIZE

const RecentChange::SRC_CATEGORIZE = 'mw.categorize'

◆ SRC_EDIT

const RecentChange::SRC_EDIT = 'mw.edit'

◆ SRC_EXTERNAL

const RecentChange::SRC_EXTERNAL = 'mw.external'

Definition at line 91 of file RecentChange.php.

Referenced by PopulateRecentChangesSource\buildUpdateCondition().

◆ SRC_LOG

◆ SRC_NEW

const RecentChange::SRC_NEW = 'mw.new'

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