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

Inheritance diagram for RecentChange:

Collaboration diagram for RecentChange:

[legend]

Public Member Functions
	addTags ( $tags)
	Tags to append to the recent change, and associated revision/log.

	diffLinkTrail ( $forceCur)
	Gets the end part of the diff URL associated with this object Blank if no diff link should be displayed.

	doMarkPatrolled (User $user, $auto=false, $tags=null)
	Mark this RecentChange as patrolled.

	getAttribute ( $name)
	Get an attribute value.

	getAttributes ()

	getCharacterDifference ( $old=0, $new=0)
	Returns the change size (HTML).

	getParam ( $name)
	Get a parameter value.

	getPerformer ()
	Get the User object of the person who performed this change.

&	getTitle ()

	loadFromRow ( $row)
	Initialises the members of this object from a mysql row object.

	notifyRCFeeds (array $feeds=null)
	Notify all the feeds about the change.

	parseParams ()
	Parses and returns the rc_params attribute.

	reallyMarkPatrolled ()
	Mark this RecentChange patrolled, without error checking.

	save ( $noudp=false)
	Writes the data in this object to the database.

	setAttribs ( $attribs)

	setExtra ( $extra)

Static Public Member Functions
static	getChangeTypes ()
	Get an array of all change types.

static	getEngine ( $uri, $params=[])

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

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.

static	markPatrolled ( $change, $auto=false, $tags=null)
	Mark a given change as patrolled.

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.

static	newFromConds ( $conds, $fname=__METHOD__, $dbType=DB_REPLICA)
	Find the first recent change matching some specific conditions.

static	newFromId ( $rcid)
	Obtain the recent change with a given rc_id value.

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.

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

static	parseFromRCType ( $rcType)
	Parsing RC_* constants to human-readable test.

static	parseToRCType ( $type)
	Parsing text to RC_* constants.

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

Public Attributes
int	$counter = -1
	Line number of recent change.

	$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.

Static Private Attributes
static array	$changeTypes
	Array of change types.

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

◆ addTags()

RecentChange::addTags ( $tags )

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

Since: 1.28

Parameters

string | array $tags

Definition at line 1184 of file RecentChange.php.

◆ checkIPAddress()

static RecentChange::checkIPAddress ( $ip )

staticprivate

Definition at line 1127 of file RecentChange.php.

References $wgRequest, and global.

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

References RC_EDIT.

◆ doMarkPatrolled()

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	$user	User object doing the action
bool	$auto	For 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 570 of file RecentChange.php.

References $auto, $user, $wgUseFilePatrol, $wgUseNPPatrol, $wgUseRCPatrol, getAttribute(), getTitle(), global, RC_LOG, RC_NEW, reallyMarkPatrolled(), and PatrolLog\record().

◆ getAttribute()

RecentChange::getAttribute ( $name )

Get an attribute value.

Parameters

string $name Attribute name

Returns: mixed

Definition at line 1051 of file RecentChange.php.

References $name, $user, and User\newFromAnyId().

Referenced by RCCacheEntryFactory\buildDiffLink(), doMarkPatrolled(), ChangesList\getDataAttributes(), EnhancedChangesList\getDiffHistLinks(), MachineReadableRCFeedFormatter\getLine(), parseParams(), and reallyMarkPatrolled().

◆ getAttributes()

RecentChange::getAttributes ( )

Returns: array

Definition at line 1080 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 171 of file RecentChange.php.

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

References ChangesList\showCharacterDifference().

◆ getEngine()

static RecentChange::getEngine	(	$uri,
		$params = `[]`
	)

static

Since: 1.22

Deprecated:: since 1.29 Use RCFeed::factory() instead

Parameters

string	$uri	URI to get the engine object for
array	$params

Returns: RCFeedEngine The engine object

Exceptions

MWException

Definition at line 520 of file RecentChange.php.

References $params, $wgRCEngines, and global.

◆ getParam()

RecentChange::getParam ( $name )

Get a parameter value.

Since: 1.27

Parameters

string $name parameter name

Returns: mixed

Definition at line 1003 of file RecentChange.php.

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

◆ getPerformer()

RecentChange::getPerformer ( )

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

Returns: User

Definition at line 332 of file RecentChange.php.

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

Referenced by notifyRCFeeds(), and save().

◆ getQueryInfo()

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

◆ getTitle()

& RecentChange::getTitle ( )

Returns: Title

Definition at line 319 of file RecentChange.php.

Referenced by RCCacheEntryFactory\buildCLink(), RCCacheEntryFactory\buildCurLink(), RCCacheEntryFactory\buildDiffLink(), RCCacheEntryFactory\buildLastLink(), doMarkPatrolled(), OldChangesList\formatChangeLine(), EnhancedChangesList\getDiffHistLinks(), IRCColourfulRCFeedFormatter\getLine(), MachineReadableRCFeedFormatter\getLine(), EnhancedChangesList\getLineData(), EnhancedChangesList\makeCacheGroupingKey(), reallyMarkPatrolled(), and save().

◆ 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	$timestamp	MWTimestamp compatible timestamp
int	$tolerance	Tolerance in seconds

Returns: bool

Definition at line 1153 of file RecentChange.php.

References $wgRCMaxAge, global, and wfTimestamp().

◆ loadFromRow()

RecentChange::loadFromRow ( $row )

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

Parameters

mixed $row

Definition at line 1013 of file RecentChange.php.

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

Referenced by newFromRow().

◆ markPatrolled()

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

static

Mark a given change as patrolled.

Parameters

RecentChange \| int	$change	RecentChange or corresponding rc_id
bool	$auto	For 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 545 of file RecentChange.php.

References $auto, $wgUser, and global.

◆ newForCategorization()

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	$timestamp	Timestamp of the recent change to occur
Title	$categoryTitle	Title of the category a page is being added to or removed from
User	$user	User object of the user that made the change
string	$comment	Change summary
Title	$pageTitle	Title of the page that is being added or removed
int	$oldRevId	Parent revision ID of this change
int	$newRevId	Revision ID of this change
string	$lastTimestamp	Parent revision timestamp of this change
bool	$bot	true, if the change was made by a bot
string	$ip	IP address of the user, if the change was made anonymously
int	$deleted	Indicates whether the change has been deleted
bool	$added	true, if the category was added, false for removed

Returns: RecentChange

Definition at line 930 of file RecentChange.php.

References $params, $user, WikiPage\factory(), Title\getArticleID(), Title\getDBkey(), Title\getNamespace(), Title\getPrefixedDBkey(), 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	$conds	Array of conditions
mixed	$fname	Override the method name in profiling/logs
int	$dbType	DB_* constant

Returns: RecentChange|null

Definition at line 194 of file RecentChange.php.

References $fname, and wfGetDB().

Referenced by MediaWiki\Storage\RevisionStore\getRecentChange().

◆ newFromId()

static RecentChange::newFromId ( $rcid )

static

Obtain the recent change with a given rc_id value.

Parameters

int $rcid The rc_id value to retrieve

Returns: RecentChange|null

Definition at line 181 of file RecentChange.php.

◆ newFromRow()

static RecentChange::newFromRow ( $row )

static

Parameters

mixed $row

Returns: RecentChange

Definition at line 124 of file RecentChange.php.

References loadFromRow().

◆ newLogEntry()

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	$revId	Id of associated revision, if any
bool	$isPatrollable	Whether this log entry is patrollable

Returns: RecentChange

Definition at line 836 of file RecentChange.php.

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

◆ notifyEdit()

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

References $title, $user, DB_MASTER, RC_EDIT, use, and wfGetDB().

◆ notifyLog()

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

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

◆ notifyNew()

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

References $title, $user, DB_MASTER, RC_NEW, use, and wfGetDB().

◆ notifyRCFeeds()

RecentChange::notifyRCFeeds ( array $feeds = null )

Notify all the feeds about the change.

Parameters

array $feeds Optional feeds to send to, defaults to $wgRCFeeds

Definition at line 473 of file RecentChange.php.

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

Referenced by save().

◆ parseFromRCType()

static RecentChange::parseFromRCType ( $rcType )

static

Parsing RC_* constants to human-readable test.

Since: 1.24

Parameters

int $rcType

Returns: string $type

Definition at line 160 of file RecentChange.php.

◆ parseParams()

RecentChange::parseParams ( )

Parses and returns the rc_params attribute.

Since: 1.26

Returns: mixed|bool false on failed unserialization

Definition at line 1166 of file RecentChange.php.

References getAttribute(), and unserialize().

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

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

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

◆ reallyMarkPatrolled()

RecentChange::reallyMarkPatrolled ( )

Mark this RecentChange patrolled, without error checking.

Returns: int Number of affected rows

Definition at line 620 of file RecentChange.php.

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

Referenced by doMarkPatrolled().

◆ save()

RecentChange::save ( $noudp = false )

Writes the data in this object to the database.

Parameters

bool $noudp

Definition at line 352 of file RecentChange.php.

References $editor, $title, $user, $wgPutIPinRC, $wgShowUpdatedMarker, $wgUseEnotif, ChangeTags\addTags(), as, DB_MASTER, getPerformer(), getTitle(), global, RecentChangesUpdateJob\newCacheUpdateJob(), User\newFromAnyId(), notifyRCFeeds(), RC_CATEGORIZE, JobQueueGroup\singleton(), use, and wfGetDB().

◆ selectFields()

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

References $wgActorTableSchemaMigrationStage, global, MIGRATION_WRITE_BOTH, and wfDeprecated().

◆ setAttribs()

RecentChange::setAttribs ( $attribs )

Parameters

array $attribs

Definition at line 305 of file RecentChange.php.

References $attribs.

Referenced by RecentChangeTest\assertParseParams().

◆ setExtra()

RecentChange::setExtra ( $extra )

Parameters

array $extra

Definition at line 312 of file RecentChange.php.

Member Data Documentation

◆ $changeTypes

array RecentChange::$changeTypes

staticprivate

Initial value:

= [
        'edit' => RC_EDIT,
        'new' => RC_NEW,
        'log' => RC_LOG,
        'external' => RC_EXTERNAL,
        'categorize' => RC_CATEGORIZE,
    ]

Array of change types.

Definition at line 110 of file RecentChange.php.

◆ $counter

int RecentChange::$counter = -1

Line number of recent change.

Default -1.

Definition at line 100 of file RecentChange.php.

◆ $mAttribs

RecentChange::$mAttribs = []

Definition at line 81 of file RecentChange.php.

◆ $mExtra

RecentChange::$mExtra = []

Definition at line 82 of file RecentChange.php.

◆ $mPerformer

User RecentChange::$mPerformer = false

private

Definition at line 92 of file RecentChange.php.

◆ $mTitle

Title RecentChange::$mTitle = false

Definition at line 87 of file RecentChange.php.

◆ $notificationtimestamp

RecentChange::$notificationtimestamp

Definition at line 95 of file RecentChange.php.

◆ $numberofWatchingusers

RecentChange::$numberofWatchingusers = 0

Definition at line 94 of file RecentChange.php.

◆ $tags

array RecentChange::$tags = []

private

List of tags to apply.

Definition at line 105 of file RecentChange.php.

◆ PRC_AUTOPATROLLED

const RecentChange::PRC_AUTOPATROLLED = 2

Definition at line 79 of file RecentChange.php.

◆ PRC_PATROLLED

const RecentChange::PRC_PATROLLED = 1

Definition at line 78 of file RecentChange.php.

◆ PRC_UNPATROLLED

const RecentChange::PRC_UNPATROLLED = 0

Definition at line 77 of file RecentChange.php.

Referenced by MediaWiki\Storage\RevisionStore\getRcIdIfUnpatrolled().

◆ SRC_CATEGORIZE

const RecentChange::SRC_CATEGORIZE = 'mw.categorize'

Definition at line 75 of file RecentChange.php.

◆ SRC_EDIT

const RecentChange::SRC_EDIT = 'mw.edit'

Definition at line 71 of file RecentChange.php.

◆ SRC_EXTERNAL

const RecentChange::SRC_EXTERNAL = 'mw.external'

Definition at line 74 of file RecentChange.php.

◆ SRC_LOG

const RecentChange::SRC_LOG = 'mw.log'

Definition at line 73 of file RecentChange.php.

◆ SRC_NEW

const RecentChange::SRC_NEW = 'mw.new'

Definition at line 72 of file RecentChange.php.

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

includes/changes/RecentChange.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ addTags()

◆ checkIPAddress()

◆ diffLinkTrail()

◆ doMarkPatrolled()

◆ getAttribute()

◆ getAttributes()

◆ getChangeTypes()

◆ getCharacterDifference()

◆ getEngine()

◆ getParam()

◆ getPerformer()

◆ getQueryInfo()

◆ getTitle()

◆ isInRCLifespan()

◆ loadFromRow()

◆ markPatrolled()

◆ newForCategorization()

◆ newFromConds()

◆ newFromId()

◆ newFromRow()

◆ newLogEntry()

◆ notifyEdit()

◆ notifyLog()

◆ notifyNew()

◆ notifyRCFeeds()

◆ parseFromRCType()

◆ parseParams()

◆ parseToRCType()

◆ reallyMarkPatrolled()

◆ save()

◆ selectFields()

◆ setAttribs()

◆ setExtra()

Member Data Documentation

◆ $changeTypes

◆ $counter

◆ $mAttribs

◆ $mExtra

◆ $mPerformer

◆ $mTitle

◆ $notificationtimestamp

◆ $numberofWatchingusers

◆ $tags

◆ PRC_AUTOPATROLLED

◆ PRC_PATROLLED

◆ PRC_UNPATROLLED

◆ SRC_CATEGORIZE

◆ SRC_EDIT

◆ SRC_EXTERNAL

◆ SRC_LOG

◆ SRC_NEW