MediaWiki  master
RecentChange Class Reference

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

Inheritance diagram for RecentChange:
Collaboration diagram for RecentChange:

Public Member Functions

 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 (User $user, $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...
 
 getParam ($name)
 Get a parameter value. More...
 
 getPerformer ()
 Get the User object of the person who 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)
 
 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 markPatrolled ($change, $auto=false, $tags=null)
 Mark a given change as patrolled. More...
 
static newForCategorization ($timestamp, Title $categoryTitle, User $user=null, $comment, Title $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 array static newFromRow ($row)
 
static newLogEntry ($timestamp, &$title, &$user, $actionComment, $ip, $type, $action, $target, $logComment, $params, $newId=0, $actionCommentIRC= '', $revId=0, $isPatrollable=false)
 
static notifyEdit ($timestamp, &$title, $minor, &$user, $comment, $oldId, $lastTimestamp, $bot, $ip= '', $oldSize=0, $newSize=0, $newId=0, $patrol=0, $tags=[])
 Makes an entry in the database corresponding to an edit. More...
 
static notifyLog ($timestamp, &$title, &$user, $actionComment, $ip, $type, $action, $target, $logComment, $params, $newId=0, $actionCommentIRC= '')
 
static notifyNew ($timestamp, &$title, $minor, &$user, $comment, $bot, $ip= '', $size=0, $newId=0, $patrol=0, $tags=[])
 Makes an entry in the database corresponding to page creation Note: the title object must be loaded with the new id using resetArticleID() More...
 
static parseFromRCType ($rcType)
 Parsing RC_* constants to human-readable test. More...
 
static parseToRCType ($type)
 Parsing text to RC_* constants. More...
 
static selectFields ()
 Return the list of recentchanges fields that should be selected to create a new recentchanges object. More...
 

Public Attributes

int $counter = -1
 Line number of recent change. More...
 
 $mAttribs = []
 
 $mExtra = []
 
Title $mTitle = false
 
 $notificationtimestamp
 
 $numberofWatchingusers = 0
 
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'
 

Static Private Member Functions

static checkIPAddress ($ip)
 

Private Attributes

User $mPerformer = false
 
array $tags = []
 List of tags to apply. More...
 

Static Private Attributes

static array $changeTypes
 Array of change types. More...
 

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_actor actor id 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

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 68 of file RecentChange.php.

Member Function Documentation

RecentChange::addTags (   $tags)

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

Since
1.28
Parameters
string | array$tags

Definition at line 1206 of file RecentChange.php.

References $tags.

static RecentChange::checkIPAddress (   $ip)
staticprivate

Definition at line 1149 of file RecentChange.php.

References $wgRequest, global, and IP\isIPAddress().

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 1112 of file RecentChange.php.

References RC_EDIT.

RecentChange::doMarkPatrolled ( User  $user,
  $auto = false,
  $tags = null 
)

Mark this RecentChange as patrolled.

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

Parameters
User$userUser object doing the action
bool$autoFor automatic patrol
string|string[]$tags Change 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 Title::getUserPermissionsErrors()

Definition at line 592 of file RecentChange.php.

References $auto, getAttribute(), User\getName(), getTitle(), global, User\isAllowed(), RC_LOG, RC_NEW, reallyMarkPatrolled(), PatrolLog\record(), and Hooks\run().

RecentChange::getAttribute (   $name)
RecentChange::getAttributes ( )
Returns
array

Definition at line 1102 of file RecentChange.php.

References $mAttribs.

Referenced by IRCColourfulRCFeedFormatter\getLine().

static RecentChange::getChangeTypes ( )
static

Get an array of all change types.

Since
1.26
Returns
array

Definition at line 181 of file RecentChange.php.

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

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 1135 of file RecentChange.php.

References ChangesList\showCharacterDifference().

static RecentChange::getEngine (   $uri,
  $params = [] 
)
static
Since
1.22
Deprecated:
since 1.29 Use RCFeed::factory() instead
Parameters
string$uriURI to get the engine object for
array$params
Returns
RCFeedEngine The engine object
Exceptions
MWException

Definition at line 542 of file RecentChange.php.

References $params, and global.

Referenced by RCFeed\factory().

RecentChange::getParam (   $name)

Get a parameter value.

Since
1.27
Parameters
string$nameparameter name
Returns
mixed

Definition at line 1025 of file RecentChange.php.

References $name, $params, and parseParams().

RecentChange::getPerformer ( )

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

Returns
User

Definition at line 342 of file RecentChange.php.

References $mPerformer, User\newFromActorId(), User\newFromId(), and User\newFromName().

Referenced by notifyRCFeeds(), and save().

static RecentChange::getQueryInfo ( )
static

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

Since
1.31
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()

Definition at line 278 of file RecentChange.php.

References CommentStore\getStore(), and ActorMigration\newMigration().

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

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 1175 of file RecentChange.php.

References global, and wfTimestamp().

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

RecentChange::loadFromRow (   $row)

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

Parameters
mixed$row

Definition at line 1035 of file RecentChange.php.

References $user, DB_REPLICA, CommentStore\getStore(), User\newFromAnyId(), wfGetDB(), and wfTimestamp().

static RecentChange::markPatrolled (   $change,
  $auto = false,
  $tags = null 
)
static

Mark a given change as patrolled.

Parameters
RecentChange | int$changeRecentChange or corresponding rc_id
bool$autoFor automatic patrol
string|string[]$tags Change tags to add to the patrol log entry ($user should be able to add the specified tags before this is called)
Returns
array See doMarkPatrolled(), or null if $change is not an existing rc_id

Definition at line 567 of file RecentChange.php.

References $auto, and global.

static RecentChange::newForCategorization (   $timestamp,
Title  $categoryTitle,
User  $user = null,
  $comment,
Title  $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
Title$categoryTitleTitle of the category a page is being added to or removed from
User$userUser object of the user that made the change
string$commentChange summary
Title$pageTitleTitle of the 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$addedtrue, if the category was added, false for removed
Returns
RecentChange

Definition at line 952 of file RecentChange.php.

References $params, $user, WikiPage\factory(), Title\getArticleID(), Title\getDBkey(), Title\getNamespace(), Title\getPrefixedDBkey(), RC_CATEGORIZE, and serialize().

Referenced by ApiQueryRecentChangesIntegrationTest\testCategorizeTypeParameter(), ApiQueryWatchlistIntegrationTest\testCategorizeTypeParameter(), and RecentChangeTest\testHiddenCategoryChange().

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 204 of file RecentChange.php.

References $fname, and wfGetDB().

Referenced by CategoryMembershipChangeJobTest\getCategorizeRecentChangeForRevId(), DifferenceEngine\getMarkPatrolledLinkInfo(), MediaWiki\Storage\RevisionStore\getRecentChange(), and Article\showPatrolFooter().

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 191 of file RecentChange.php.

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

static array static RecentChange::newFromRow (   $row)
static
static RecentChange::newLogEntry (   $timestamp,
$title,
$user,
  $actionComment,
  $ip,
  $type,
  $action,
  $target,
  $logComment,
  $params,
  $newId = 0,
  $actionCommentIRC = '',
  $revId = 0,
  $isPatrollable = false 
)
static
Parameters
string$timestamp
Title&$title
User&$user
string$actionComment
string$ip
string$type
string$action
Title$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 858 of file RecentChange.php.

References $params, $title, $type, $user, $wgRequest, global, and RC_LOG.

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

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

Makes an entry in the database corresponding to an edit.

Parameters
string$timestamp
Title&$title
bool$minor
User&$user
string$comment
int$oldId
string$lastTimestamp
bool$bot
string$ip
int$oldSize
int$newSize
int$newId
int$patrol
array$tags
Returns
RecentChange

Definition at line 680 of file RecentChange.php.

References $title, $user, DeferredUpdates\addCallableUpdate(), DB_MASTER, DeferredUpdates\POSTSEND, RC_EDIT, use, and wfGetDB().

Referenced by WikiPage\doModify(), and ImportTextFiles\execute().

static RecentChange::notifyLog (   $timestamp,
$title,
$user,
  $actionComment,
  $ip,
  $type,
  $action,
  $target,
  $logComment,
  $params,
  $newId = 0,
  $actionCommentIRC = '' 
)
static
Parameters
string$timestamp
Title&$title
User&$user
string$actionComment
string$ip
string$type
string$action
Title$target
string$logComment
string$params
int$newId
string$actionCommentIRC
Returns
bool

Definition at line 825 of file RecentChange.php.

References $params, $title, $type, $user, and global.

Referenced by LogPage\saveContent().

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

Makes an entry in the database corresponding to page creation Note: the title object must be loaded with the new id using resetArticleID()

Parameters
string$timestamp
Title&$title
bool$minor
User&$user
string$comment
bool$bot
string$ip
int$size
int$newId
int$patrol
array$tags
Returns
RecentChange

Definition at line 754 of file RecentChange.php.

References $title, $user, DeferredUpdates\addCallableUpdate(), DB_MASTER, DeferredUpdates\POSTSEND, RC_NEW, use, and wfGetDB().

Referenced by WikiPage\doCreate(), and ImportTextFiles\execute().

RecentChange::notifyRCFeeds ( array  $feeds = null)

Notify all the feeds about the change.

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

Definition at line 495 of file RecentChange.php.

References $params, as, RCFeed\factory(), getPerformer(), global, and RC_EXTERNAL.

Referenced by save().

static RecentChange::parseFromRCType (   $rcType)
static

Parsing RC_* constants to human-readable test.

Since
1.24
Parameters
int$rcType
Returns
string $type

Definition at line 170 of file RecentChange.php.

Referenced by ApiQueryWatchlist\extractOutputData(), ApiQueryRecentChanges\extractRowInfo(), MachineReadableRCFeedFormatter\getLine(), and RecentChangeTest\testParseFromRCType().

RecentChange::parseParams ( )

Parses and returns the rc_params attribute.

Since
1.26
Returns
mixed|bool false on failed unserialization

Definition at line 1188 of file RecentChange.php.

References getAttribute(), and unserialize().

Referenced by MachineReadableRCFeedFormatter\getLine(), and getParam().

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 148 of file RecentChange.php.

References $retval, $t, $type, and as.

Referenced by ApiQueryWatchlist\run(), ApiQueryRecentChanges\run(), and RecentChangeTest\testParseToRCType().

RecentChange::reallyMarkPatrolled ( )

Mark this RecentChange patrolled, without error checking.

Returns
int Number of affected rows

Definition at line 642 of file RecentChange.php.

References DB_MASTER, getAttribute(), getTitle(), and wfGetDB().

Referenced by doMarkPatrolled().

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 367 of file RecentChange.php.

References $editor, $mAttribs, $title, $user, $wgUseEnotif, ChangeTags\addTags(), as, DB_MASTER, getPerformer(), CommentStore\getStore(), getTitle(), global, RecentChangesUpdateJob\newCacheUpdateJob(), User\newFromAnyId(), ActorMigration\newMigration(), notifyRCFeeds(), RC_CATEGORIZE, Hooks\run(), JobQueueGroup\singleton(), use, and wfGetDB().

static RecentChange::selectFields ( )
static

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

Deprecated:
since 1.31, use self::getQueryInfo() instead.
Returns
array

Definition at line 227 of file RecentChange.php.

References CommentStore\getStore(), global, MIGRATION_WRITE_BOTH, and wfDeprecated().

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

Definition at line 315 of file RecentChange.php.

References $attribs.

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

Definition at line 322 of file RecentChange.php.

Member Data Documentation

array RecentChange::$changeTypes
staticprivate
Initial value:
= [
'edit' => RC_EDIT

Array of change types.

Definition at line 120 of file RecentChange.php.

int RecentChange::$counter = -1

Line number of recent change.

Default -1.

Definition at line 110 of file RecentChange.php.

RecentChange::$mAttribs = []

Definition at line 91 of file RecentChange.php.

Referenced by getAttributes(), and save().

RecentChange::$mExtra = []

Definition at line 92 of file RecentChange.php.

User RecentChange::$mPerformer = false
private

Definition at line 102 of file RecentChange.php.

Referenced by getPerformer().

Title RecentChange::$mTitle = false

Definition at line 97 of file RecentChange.php.

Referenced by getTitle().

RecentChange::$notificationtimestamp

Definition at line 105 of file RecentChange.php.

RecentChange::$numberofWatchingusers = 0

Definition at line 104 of file RecentChange.php.

array RecentChange::$tags = []
private

List of tags to apply.

Definition at line 115 of file RecentChange.php.

Referenced by addTags().

const RecentChange::PRC_PATROLLED = 1
const RecentChange::SRC_CATEGORIZE = 'mw.categorize'
const RecentChange::SRC_EXTERNAL = 'mw.external'

Definition at line 74 of file RecentChange.php.

Referenced by PopulateRecentChangesSource\buildUpdateCondition().


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