MediaWiki REL1_30
|
Utility class for creating new RC entries. More...
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 | 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 | 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. | |
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
Definition at line 67 of file RecentChange.php.
RecentChange::addTags | ( | $tags | ) |
Tags to append to the recent change, and associated revision/log.
string | array | $tags |
Definition at line 1081 of file RecentChange.php.
References $tags.
|
staticprivate |
Definition at line 1024 of file RecentChange.php.
References $wgRequest.
Referenced by newForCategorization(), newLogEntry(), notifyEdit(), and notifyNew().
RecentChange::diffLinkTrail | ( | $forceCur | ) |
Gets the end part of the diff URL associated with this object Blank if no diff link should be displayed.
bool | $forceCur |
Definition at line 987 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
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) |
Definition at line 494 of file RecentChange.php.
References $auto, $tags, $wgUseFilePatrol, $wgUseNPPatrol, $wgUseRCPatrol, getAttribute(), getTitle(), RC_LOG, RC_NEW, reallyMarkPatrolled(), and PatrolLog\record().
RecentChange::getAttribute | ( | $name | ) |
Get an attribute value.
string | $name | Attribute name |
Definition at line 967 of file RecentChange.php.
References $name, and CommentStore\newKey().
Referenced by doMarkPatrolled(), parseParams(), and reallyMarkPatrolled().
RecentChange::getAttributes | ( | ) |
|
static |
Get an array of all change types.
Definition at line 166 of file RecentChange.php.
Referenced by ApiQueryRecentChanges\getAllowedParams(), and ApiQueryWatchlist\getAllowedParams().
RecentChange::getCharacterDifference | ( | $old = 0, | |
$new = 0 ) |
Returns the change size (HTML).
The lengths can be given optionally.
int | $old | |
int | $new |
Definition at line 1010 of file RecentChange.php.
References ChangesList\showCharacterDifference().
|
static |
string | $uri | URI to get the engine object for |
array | $params |
MWException |
Definition at line 444 of file RecentChange.php.
References $params, and $wgRCEngines.
Referenced by RCFeed\factory().
RecentChange::getParam | ( | $name | ) |
Get a parameter value.
string | $name | parameter name |
Definition at line 929 of file RecentChange.php.
References $name, $params, and parseParams().
RecentChange::getPerformer | ( | ) |
Get the User object of the person who performed this change.
Definition at line 270 of file RecentChange.php.
References $mPerformer.
Referenced by notifyRCFeeds(), and save().
& RecentChange::getTitle | ( | ) |
Definition at line 257 of file RecentChange.php.
References $mTitle.
Referenced by doMarkPatrolled(), OldChangesList\formatChangeLine(), reallyMarkPatrolled(), and save().
|
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.
mixed | $timestamp | MWTimestamp compatible timestamp |
int | $tolerance | Tolerance in seconds |
Definition at line 1050 of file RecentChange.php.
References $wgRCMaxAge, 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.
mixed | $row |
Definition at line 939 of file RecentChange.php.
References DB_REPLICA, CommentStore\newKey(), wfGetDB(), and wfTimestamp().
Referenced by newFromRow().
|
static |
Mark a given change as patrolled.
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) |
Definition at line 469 of file RecentChange.php.
References $auto, $tags, $wgUser, and newFromId().
|
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.
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 |
Definition at line 857 of file RecentChange.php.
References $params, $user, checkIPAddress(), WikiPage\factory(), RC_CATEGORIZE, serialize(), and SRC_CATEGORIZE.
Referenced by ApiQueryWatchlistIntegrationTest\testCategorizeTypeParameter(), and RecentChangeTest\testHiddenCategoryChange().
|
static |
Find the first recent change matching some specific conditions.
array | $conds | Array of conditions |
mixed | $fname | Override the method name in profiling/logs |
int | $dbType | DB_* constant |
Definition at line 189 of file RecentChange.php.
References $fname, newFromRow(), and wfGetDB().
Referenced by CategoryMembershipChangeJobTest\getCategorizeRecentChangeForRevId(), DifferenceEngine\getMarkPatrolledLinkInfo(), Revision\getRecentChange(), newFromId(), and Article\showPatrolFooter().
|
static |
Obtain the recent change with a given rc_id value.
int | $rcid | The rc_id value to retrieve |
Definition at line 176 of file RecentChange.php.
References newFromConds().
Referenced by ApiPatrol\execute(), MarkpatrolledAction\getRecentChange(), markPatrolled(), ApiTag\processIndividual(), and PatrolLog\record().
|
static |
mixed | $row |
Definition at line 119 of file RecentChange.php.
References loadFromRow().
Referenced by ApiQueryRecentChanges\extractRowInfo(), newFromConds(), SpecialRecentChanges\outputChangesList(), SpecialWatchlist\outputChangesList(), and RecentChangeTest\testNewFromRow().
|
static |
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 |
Definition at line 764 of file RecentChange.php.
References $params, $type, $user, $wgRequest, checkIPAddress(), RC_LOG, and SRC_LOG.
Referenced by ManualLogEntry\getRecentChange(), notifyLog(), LogPage\saveContent(), and RCFeedIntegrationTest\testNotify().
|
static |
Makes an entry in the database corresponding to an edit.
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 |
Definition at line 582 of file RecentChange.php.
References $tags, $title, $user, checkIPAddress(), DB_MASTER, RC_EDIT, SRC_EDIT, and wfGetDB().
Referenced by WikiPage\doModify(), and ImportTextFiles\execute().
|
static |
string | $timestamp | |
Title | &$title | |
User | &$user | |
string | $actionComment | |
string | $ip | |
string | $type | |
string | $action | |
Title | $target | |
string | $logComment | |
string | $params | |
int | $newId | |
string | $actionCommentIRC |
Definition at line 731 of file RecentChange.php.
References $params, $type, $wgLogRestrictions, and newLogEntry().
Referenced by LogPage\saveContent().
|
static |
Makes an entry in the database corresponding to page creation Note: the title object must be loaded with the new id using resetArticleID()
string | $timestamp | |
Title | &$title | |
bool | $minor | |
User | &$user | |
string | $comment | |
bool | $bot | |
string | $ip | |
int | $size | |
int | $newId | |
int | $patrol | |
array | $tags |
Definition at line 658 of file RecentChange.php.
References $tags, $title, $user, checkIPAddress(), DB_MASTER, RC_NEW, SRC_NEW, and wfGetDB().
Referenced by WikiPage\doCreate(), and ImportTextFiles\execute().
RecentChange::notifyRCFeeds | ( | array | $feeds = null | ) |
Notify all the feeds about the change.
array | $feeds | Optional feeds to send to, defaults to $wgRCFeeds |
Definition at line 397 of file RecentChange.php.
References $params, $wgRCFeeds, RCFeed\factory(), getPerformer(), and RC_EXTERNAL.
Referenced by save().
|
static |
Parsing RC_* constants to human-readable test.
int | $rcType |
Definition at line 155 of file RecentChange.php.
Referenced by ApiQueryWatchlist\extractOutputData(), ApiQueryRecentChanges\extractRowInfo(), MachineReadableRCFeedFormatter\getLine(), and RecentChangeTest\testParseFromRCType().
RecentChange::parseParams | ( | ) |
Parses and returns the rc_params attribute.
Definition at line 1063 of file RecentChange.php.
References getAttribute(), and unserialize().
Referenced by getParam().
|
static |
Parsing text to RC_* constants.
string | array | $type |
MWException |
Definition at line 133 of file RecentChange.php.
References $retval, $t, $type, and parseToRCType().
Referenced by parseToRCType(), ApiQueryRecentChanges\run(), ApiQueryWatchlist\run(), and RecentChangeTest\testParseToRCType().
RecentChange::reallyMarkPatrolled | ( | ) |
Mark this RecentChange patrolled, without error checking.
Definition at line 544 of file RecentChange.php.
References DB_MASTER, getAttribute(), getTitle(), and wfGetDB().
Referenced by doMarkPatrolled().
RecentChange::save | ( | $noudp = false | ) |
Writes the data in this object to the database.
bool | $noudp |
Definition at line 286 of file RecentChange.php.
References $editor, $mAttribs, $wgPutIPinRC, $wgShowUpdatedMarker, $wgUseEnotif, ChangeTags\addTags(), DB_MASTER, getPerformer(), getTitle(), RecentChangesUpdateJob\newCacheUpdateJob(), CommentStore\newKey(), notifyRCFeeds(), RC_CATEGORIZE, JobQueueGroup\singleton(), and wfGetDB().
|
static |
Return the list of recentchanges fields that should be selected to create a new recentchanges object.
Definition at line 210 of file RecentChange.php.
References CommentStore\newKey().
Referenced by ChangesListSpecialPage\doMainQuery(), SpecialRecentChanges\doMainQuery(), SpecialWatchlist\doMainQuery(), SpecialRecentChangesLinked\doMainQuery(), and RecentChangesUpdateJob\purgeExpiredRows().
RecentChange::setAttribs | ( | $attribs | ) |
array | $attribs |
Definition at line 243 of file RecentChange.php.
References $attribs.
Referenced by RecentChangeTest\assertParseParams().
RecentChange::setExtra | ( | $extra | ) |
array | $extra |
Definition at line 250 of file RecentChange.php.
|
staticprivate |
Array of change types.
Definition at line 105 of file RecentChange.php.
int RecentChange::$counter = -1 |
RecentChange::$mAttribs = [] |
Definition at line 76 of file RecentChange.php.
Referenced by getAttributes(), and save().
RecentChange::$mExtra = [] |
Definition at line 77 of file RecentChange.php.
|
private |
Definition at line 87 of file RecentChange.php.
Referenced by getPerformer().
Title RecentChange::$mTitle = false |
Definition at line 82 of file RecentChange.php.
Referenced by getTitle().
RecentChange::$notificationtimestamp |
Definition at line 90 of file RecentChange.php.
RecentChange::$numberofWatchingusers = 0 |
Definition at line 89 of file RecentChange.php.
|
private |
List of tags to apply.
Definition at line 100 of file RecentChange.php.
Referenced by addTags(), doMarkPatrolled(), markPatrolled(), notifyEdit(), and notifyNew().
const RecentChange::SRC_CATEGORIZE = 'mw.categorize' |
Definition at line 74 of file RecentChange.php.
Referenced by ChangesListSpecialPage\__construct(), newForCategorization(), and CategoryMembershipChangeJob\run().
const RecentChange::SRC_EDIT = 'mw.edit' |
Definition at line 70 of file RecentChange.php.
Referenced by ChangesListSpecialPage\__construct(), PopulateRecentChangesSource\buildUpdateCondition(), ChangesList\getDataAttributes(), notifyEdit(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), and RebuildRecentchanges\rebuildRecentChangesTablePass2().
const RecentChange::SRC_EXTERNAL = 'mw.external' |
Definition at line 73 of file RecentChange.php.
Referenced by PopulateRecentChangesSource\buildUpdateCondition().
const RecentChange::SRC_LOG = 'mw.log' |
Definition at line 72 of file RecentChange.php.
Referenced by ChangesListSpecialPage\__construct(), PopulateRecentChangesSource\buildUpdateCondition(), ChangesListSpecialPage\execute(), ChangesList\getDataAttributes(), newLogEntry(), and RebuildRecentchanges\rebuildRecentChangesTablePass3().
const RecentChange::SRC_NEW = 'mw.new' |
Definition at line 71 of file RecentChange.php.
Referenced by ChangesListSpecialPage\__construct(), PopulateRecentChangesSource\buildUpdateCondition(), ChangesList\getDataAttributes(), notifyNew(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), and RebuildRecentchanges\rebuildRecentChangesTablePass2().