MediaWiki\RecentChanges\RecentChangeFactory Interface Reference

Inherited by MediaWiki\RecentChanges\RecentChangeStore.

Public Member Functions
	createCategorizationRecentChange (string $timestamp, PageIdentity $categoryTitle, ?UserIdentity $user, string $comment, PageIdentity $pageTitle, int $oldRevId, int $newRevId, bool $bot, string $ip='', int $deleted=0, ?bool $added=null, bool $forImport=false)
	Create a RecentChange for a category membership change.
	createEditRecentChange (string $timestamp, PageIdentity $page, bool $minor, UserIdentity $user, string $comment, int $oldId, bool $bot, string $ip='', ?int $oldSize=0, ?int $newSize=0, int $newId=0, int $patrol=0, array $tags=[], ?EditResult $editResult=null)
	Create a RecentChange for an edit.
	createLogRecentChange (string $timestamp, PageReference $logPage, UserIdentity $user, string $actionComment, string $ip, string $type, string $action, PageReference $target, string $logComment, string $params, int $newId=0, string $actionCommentIRC='', int $revId=0, bool $isPatrollable=false, ?bool $forceBotFlag=null, int $deleted=0)
	Create a RecentChange for a log entry.
	createNewPageRecentChange (string $timestamp, PageIdentity $page, bool $minor, UserIdentity $user, string $comment, bool $bot, string $ip='', ?int $size=0, int $newId=0, int $patrol=0, array $tags=[])
	Create a RecentChange for a new page.
	insertRecentChange (RecentChange $recentChange, bool $send=self::SEND_FEED)
	Insert a recent change into the database.
	newRecentChangeFromRow ( $row)
	Create a new RecentChange object from a database row.

Detailed Description

Since

1.45

Definition at line 18 of file RecentChangeFactory.php.

Member Function Documentation

createCategorizationRecentChange()

MediaWiki\RecentChanges\RecentChangeFactory::createCategorizationRecentChange	(	string	$timestamp,
		PageIdentity	$categoryTitle,
		?UserIdentity	$user,
		string	$comment,
		PageIdentity	$pageTitle,
		int	$oldRevId,
		int	$newRevId,
		bool	$bot,
		string	$ip = '',
		int	$deleted = 0,
		?bool	$added = null,
		bool	$forImport = false )

Create a RecentChange for a category membership change.

Parameters

string	$timestamp	Timestamp of the recent change to occur
PageIdentity	$categoryTitle	the category a page is being added to or removed from
UserIdentity | null	$user	User object of the user that made the change
string	$comment	Change summary
PageIdentity	$pageTitle	the page that is being added or removed
int	$oldRevId	Parent revision ID of this change
int	$newRevId	Revision ID 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 | null	$added	true, if the category was added, false for removed
bool	$forImport	Whether the associated revision was imported

Returns

RecentChange

Implemented in MediaWiki\RecentChanges\RecentChangeStore.

createEditRecentChange()

MediaWiki\RecentChanges\RecentChangeFactory::createEditRecentChange	(	string	$timestamp,
		PageIdentity	$page,
		bool	$minor,
		UserIdentity	$user,
		string	$comment,
		int	$oldId,
		bool	$bot,
		string	$ip = '',
		?int	$oldSize = 0,
		?int	$newSize = 0,
		int	$newId = 0,
		int	$patrol = 0,
		array	$tags = [],
		?EditResult	$editResult = null )

Create a RecentChange for an edit.

Parameters

string	$timestamp	Timestamp of the edit to occur
PageIdentity	$page	Page of the edit to occur
bool	$minor	Whether the edit is minor
UserIdentity	$user	User who made the edit
string	$comment	Summary of the edit
int	$oldId	ID of the previous revision
bool	$bot	Whether the edit was made by a bot
string	$ip	IP address of the user, if the edit was made anonymously
int | null	$oldSize	Size of the previous revision
int | null	$newSize	Size of the new revision
int	$newId	ID of the new revision
int	$patrol	Whether the edit was patrolled (PRC_UNPATROLLED, PRC_PATROLLED, PRC_AUTOPATROLLED)
string[]	$tags
EditResult | null	$editResult	EditResult associated with this edit. Can be safely skipped if the edit is not a revert. Used only for marking revert tags.

Returns

RecentChange

Implemented in MediaWiki\RecentChanges\RecentChangeStore.

createLogRecentChange()

MediaWiki\RecentChanges\RecentChangeFactory::createLogRecentChange	(	string	$timestamp,
		PageReference	$logPage,
		UserIdentity	$user,
		string	$actionComment,
		string	$ip,
		string	$type,
		string	$action,
		PageReference	$target,
		string	$logComment,
		string	$params,
		int	$newId = 0,
		string	$actionCommentIRC = '',
		int	$revId = 0,
		bool	$isPatrollable = false,
		?bool	$forceBotFlag = null,
		int	$deleted = 0 )

Create a RecentChange for a log entry.

Parameters

string	$timestamp	Timestamp of the log entry to occur
PageReference	$logPage
UserIdentity	$user	User who performed the log action
string	$actionComment	Summary of the log action
string	$ip	IP address of the user, if the log action was made anonymously
string	$type	Log type
string	$action	Log action
PageReference	$target	Target of the log action
string	$logComment
string	$params
int	$newId
string	$actionCommentIRC	IRC comment of the log action
int	$revId	Id of associated revision, if any
bool	$isPatrollable	Whether this log entry is patrollable
bool | null	$forceBotFlag	Override the default behavior and set bot flag to the value of the argument. When omitted or null, it falls back to the global state.
int	$deleted

Returns

RecentChange

Implemented in MediaWiki\RecentChanges\RecentChangeStore.

createNewPageRecentChange()

MediaWiki\RecentChanges\RecentChangeFactory::createNewPageRecentChange	(	string	$timestamp,
		PageIdentity	$page,
		bool	$minor,
		UserIdentity	$user,
		string	$comment,
		bool	$bot,
		string	$ip = '',
		?int	$size = 0,
		int	$newId = 0,
		int	$patrol = 0,
		array	$tags = [] )

Create a RecentChange for a new page.

Parameters

string	$timestamp	Timestamp of the page creation to occur
PageIdentity	$page	created page
bool	$minor	Whether the page creation is minor
UserIdentity	$user	User who made the page creation
string	$comment	Summary of the page creation
bool	$bot	Whether the page creation was made by a bot
string	$ip	IP address of the user, if the page creation was made anonymously
int | null	$size	Size of the new revision
int	$newId	ID of the new revision
int	$patrol	Whether the edit was patrolled (PRC_UNPATROLLED, PRC_PATROLLED, PRC_AUTOPATROLLED)
string[]	$tags

Returns

RecentChange

Implemented in MediaWiki\RecentChanges\RecentChangeStore.

insertRecentChange()

MediaWiki\RecentChanges\RecentChangeFactory::insertRecentChange	(	RecentChange	$recentChange,
		bool	$send = self::SEND_FEED )

Insert a recent change into 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

RecentChange	$recentChange
bool	$send	self::SEND_FEED or self::SEND_NONE

Implemented in MediaWiki\RecentChanges\RecentChangeStore.

newRecentChangeFromRow()

MediaWiki\RecentChanges\RecentChangeFactory::newRecentChangeFromRow

(

$row

)

Create a new RecentChange object from a database row.

Parameters

stdClass

$row

Database row from recentchanges table

Returns

RecentChange

Implemented in MediaWiki\RecentChanges\RecentChangeStore.

---

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

• includes/RecentChanges/RecentChangeFactory.php