Collaboration diagram for CategoryMembershipChange:

[legend]

Public Member Functions
	__construct (Title $pageTitle, $revision=null)

	checkTemplateLinks ()
	Determines the number of template links for recursive link updates.

	overrideNewForCategorizationCallback (callable $callback)
	Overrides the default new for categorization callback This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined.

	triggerCategoryAddedNotification (Title $categoryTitle)
	Create a recentchanges entry for category additions.

	triggerCategoryRemovedNotification (Title $categoryTitle)
	Create a recentchanges entry for category removals.

Private Member Functions
	createRecentChangesEntry (Title $categoryTitle, $type)
	Create a recentchanges entry using RecentChange::notifyCategorization()

	getChangeMessageText ( $type, $prefixedText, $numTemplateLinks)
	Returns the change message according to the type of category membership change.

	getPreviousRevisionTimestamp ()
	Returns the timestamp of the page's previous revision or null if the latest revision does not refer to a parent revision.

	getUser ()
	Get the user associated with this change.

	notifyCategorization ( $timestamp, Title $categoryTitle, ?User $user, $comment, Title $pageTitle, $lastTimestamp, $revision, $added)

Private Attributes
callable null	$newForCategorizationCallback = null

int	$numTemplateLinks = 0
	Number of pages this WikiPage is embedded by Set by CategoryMembershipChange::checkTemplateLinks()

Title	$pageTitle
	Title instance of the categorized page.

RevisionRecord null	$revision
	Latest Revision instance of the categorized page.

string	$timestamp
	Current timestamp, set during CategoryMembershipChange::__construct()

const	CATEGORY_ADDITION = 1

const	CATEGORY_REMOVAL = -1

Detailed Description

Definition at line 31 of file CategoryMembershipChange.php.

Constructor & Destructor Documentation

◆ __construct()

CategoryMembershipChange::__construct	(	Title	$pageTitle,
			$revision = `null`
	)

Parameters

Title	$pageTitle	Title instance of the categorized page
RevisionRecord \| Revision \| null	$revision	Latest Revision instance of the categorized page. Since 1.35 passing a Revision object is deprecated in favor of RevisionRecord.

Exceptions

MWException

Definition at line 70 of file CategoryMembershipChange.php.

References $pageTitle, $revision, MediaWiki\Revision\RevisionRecord\getTimestamp(), wfDeprecatedMsg(), and wfTimestampNow().

Member Function Documentation

◆ checkTemplateLinks()

CategoryMembershipChange::checkTemplateLinks ( )

Determines the number of template links for recursive link updates.

Definition at line 108 of file CategoryMembershipChange.php.

◆ createRecentChangesEntry()

CategoryMembershipChange::createRecentChangesEntry	(	Title	$categoryTitle,
			$type
	)

private

Create a recentchanges entry using RecentChange::notifyCategorization()

Parameters

Title	$categoryTitle
int	$type

Definition at line 136 of file CategoryMembershipChange.php.

References $type, getChangeMessageText(), getUser(), and notifyCategorization().

Referenced by triggerCategoryAddedNotification(), and triggerCategoryRemovedNotification().

◆ getChangeMessageText()

CategoryMembershipChange::getChangeMessageText	(	$type,
		$prefixedText,
		$numTemplateLinks
	)

private

Returns the change message according to the type of category membership change.

The message keys created in this method may be one of:

recentchanges-page-added-to-category
recentchanges-page-added-to-category-bundled
recentchanges-page-removed-from-category
recentchanges-page-removed-from-category-bundled

Parameters

int	$type	may be CategoryMembershipChange::CATEGORY_ADDITION or CategoryMembershipChange::CATEGORY_REMOVAL
string	$prefixedText	result of Title::->getPrefixedText()
int	$numTemplateLinks

Returns: string

Definition at line 268 of file CategoryMembershipChange.php.

References $numTemplateLinks, $type, and wfMessage().

Referenced by createRecentChangesEntry().

◆ getPreviousRevisionTimestamp()

CategoryMembershipChange::getPreviousRevisionTimestamp ( )

private

Returns the timestamp of the page's previous revision or null if the latest revision does not refer to a parent revision.

Returns: null|string

Definition at line 289 of file CategoryMembershipChange.php.

◆ getUser()

CategoryMembershipChange::getUser ( )

private

Get the user associated with this change.

If there is no revision associated with the change and thus no editing user fallback to a default.

False will be returned if the user name specified in the 'autochange-username' message is invalid.

Returns: User|bool

Definition at line 234 of file CategoryMembershipChange.php.

References User\newFromIdentity(), User\newFromName(), and wfMessage().

Referenced by createRecentChangesEntry().

◆ notifyCategorization()

CategoryMembershipChange::notifyCategorization	(		$timestamp,
		Title	$categoryTitle,
		?User	$user,
			$comment,
		Title	$pageTitle,
			$lastTimestamp,
			$revision,
			$added
	)

private

Parameters

string	$timestamp	Timestamp of the recent change to occur in TS_MW format
Title	$categoryTitle	Title of the category a page is being added to or removed from
User \| null	$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
string	$lastTimestamp	Parent revision timestamp of this change in TS_MW format
RevisionRecord \| null	$revision
bool	$added	true, if the category was added, false for removed