CirrusSearch\PageChangeTracker Class Reference

Listen to a set of hooks to keep track if a pageId was involved in a "page change". More...

Inheritance diagram for CirrusSearch\PageChangeTracker:

Collaboration diagram for CirrusSearch\PageChangeTracker:

Public Member Functions
	__construct (int $maxStateSize=512)
	onPageDeleteComplete (ProperPageIdentity $page, Authority $deleter, string $reason, int $pageID, RevisionRecord $deletedRev, ManualLogEntry $logEntry, int $archivedRevisionCount)
	onPageDelete (ProperPageIdentity $page, Authority $deleter, string $reason, StatusValue $status, bool $suppress)
	onPageMoveComplete ( $old, $new, $user, $pageid, $redirid, $reason, $revision)
	onPageSaveComplete ( $wikiPage, $user, $summary, $flags, $revisionRecord, $editResult)
	onPageUndeleteComplete (ProperPageIdentity $page, Authority $restorer, string $reason, RevisionRecord $restoredRev, ManualLogEntry $logEntry, int $restoredRevisionCount, bool $created, array $restoredPageIds)
	isPageChange (int $pageId)
	Test if this pageId was references in a hook call earlier.

Detailed Description

Listen to a set of hooks to keep track if a pageId was involved in a "page change".

A page change is a change happening to the page itself, based on the hooks used by EventBus to emit its page_change stream we use this to determine in which stream we might emit a cirrus event based on a LinksUpdateComplete hook. Mainly we want to identify if a particular LinksUpdate is caused by a page change or something else unrelated to the life of the page.

Member Function Documentation

isPageChange()

CirrusSearch\PageChangeTracker::isPageChange

(

int

$pageId

)

Test if this pageId was references in a hook call earlier.

Calling this function resets the state held by this class.

Parameters

int

$pageId

Returns

bool

onPageDelete()

CirrusSearch\PageChangeTracker::onPageDelete	(	ProperPageIdentity	$page,
		Authority	$deleter,
		string	$reason,
		StatusValue	$status,
		bool	$suppress )

Parameters

ProperPageIdentity	$page
Authority	$deleter
string	$reason
StatusValue	$status
bool	$suppress

Returns

void

onPageDeleteComplete()

CirrusSearch\PageChangeTracker::onPageDeleteComplete	(	ProperPageIdentity	$page,
		Authority	$deleter,
		string	$reason,
		int	$pageID,
		RevisionRecord	$deletedRev,
		ManualLogEntry	$logEntry,
		int	$archivedRevisionCount )

Parameters

ProperPageIdentity	$page
Authority	$deleter
string	$reason
int	$pageID
RevisionRecord	$deletedRev
ManualLogEntry	$logEntry
int	$archivedRevisionCount

Returns

void

Reimplemented in CirrusSearch\ChangeListener.

onPageMoveComplete()

CirrusSearch\PageChangeTracker::onPageMoveComplete	(		$old,
			$new,
			$user,
			$pageid,
			$redirid,
			$reason,
			$revision )

Parameters

LinkTarget	$old	Old title
LinkTarget	$new	New title
UserIdentity	$user	User who did the move
int	$pageid	Database ID of the page that's been moved
int	$redirid	Database ID of the created redirect
string	$reason	Reason for the move
RevisionRecord	$revision	RevisionRecord created by the move

Returns

bool|void True or no return value to continue or false stop other hook handlers, doesn't abort the move itself

Reimplemented in CirrusSearch\ChangeListener.

onPageSaveComplete()

CirrusSearch\PageChangeTracker::onPageSaveComplete	(		$wikiPage,
			$user,
			$summary,
			$flags,
			$revisionRecord,
			$editResult )

Parameters

\WikiPage	$wikiPage	WikiPage modified
UserIdentity	$user	User performing the modification
string	$summary	Edit summary/comment
int	$flags	Flags passed to WikiPage::doUserEditContent()
RevisionRecord	$revisionRecord	New RevisionRecord of the article
EditResult	$editResult	Object storing information about the effects of this edit, including which edits were reverted and which edit is this based on (for reverts and null edits).

Returns

bool|void True or no return value to continue or false to stop other hook handlers from being called; save cannot be aborted

onPageUndeleteComplete()

CirrusSearch\PageChangeTracker::onPageUndeleteComplete	(	ProperPageIdentity	$page,
		Authority	$restorer,
		string	$reason,
		RevisionRecord	$restoredRev,
		ManualLogEntry	$logEntry,
		int	$restoredRevisionCount,
		bool	$created,
		array	$restoredPageIds )

Parameters

ProperPageIdentity	$page
Authority	$restorer
string	$reason
RevisionRecord	$restoredRev
ManualLogEntry	$logEntry
int	$restoredRevisionCount
bool	$created
array	$restoredPageIds

Returns

void

Reimplemented in CirrusSearch\ChangeListener.

---

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

• includes/PageChangeTracker.php