Wikibase\Client\ChangeModification\ChangeModificationNotificationJob Class Reference

Base class for Jobs handling modifications to a set of client changes (identified by RepoRevisionIdentifiers). More...

Inheritance diagram for Wikibase\Client\ChangeModification\ChangeModificationNotificationJob:

Collaboration diagram for Wikibase\Client\ChangeModification\ChangeModificationNotificationJob:

Public Member Functions
	__construct (string $jobName, ClientDomainDb $clientDb, array $params=[])
	run ()

Protected Member Functions
	modifyChanges (array $relevantChanges)
	getRelevantRecentChanges ()

Protected Attributes
	$clientDb

Private Member Functions
	unpackRevisionIdentifiers (string $revisionIdentifiersJson)
	selectCandidateResults (string $entityIdSerialization, array $revisionIdentifiers)
	filterCandidateResults (IResultWrapper $candidateResults, array $revisionIdentifiers)
	getGroupedRepoRevisionIdentifiers ()
	readRecentChangeParams ( $rc_params)
	Extracts the metadata array from the value of an rc_params field.

Private Attributes
	$revisionIdentifiers

Detailed Description

Base class for Jobs handling modifications to a set of client changes (identified by RepoRevisionIdentifiers).

Copyright

GPL-2.0-or-later

Author

Marius Hoch

Constructor & Destructor Documentation

__construct()

Wikibase\Client\ChangeModification\ChangeModificationNotificationJob::__construct	(	string	$jobName,
		ClientDomainDb	$clientDb,
		array	$params = [] )

Parameters

string	$jobName	Name of this job.
ClientDomainDb	$clientDb
array	$params	Contains the revisionIdentifiersJson to act upon.

Member Function Documentation

filterCandidateResults()

Wikibase\Client\ChangeModification\ChangeModificationNotificationJob::filterCandidateResults ( IResultWrapper $candidateResults, array $revisionIdentifiers )

private

Parameters

IResultWrapper	$candidateResults
RepoRevisionIdentifier[]	$revisionIdentifiers

Returns

int[]

getGroupedRepoRevisionIdentifiers()

Wikibase\Client\ChangeModification\ChangeModificationNotificationJob::getGroupedRepoRevisionIdentifiers ( )

private

Returns

RepoRevisionIdentifier[][]

getRelevantRecentChanges()

Wikibase\Client\ChangeModification\ChangeModificationNotificationJob::getRelevantRecentChanges ( )

protected

Returns

int[] Relevant rc_ids

modifyChanges()

Wikibase\Client\ChangeModification\ChangeModificationNotificationJob::modifyChanges ( array $relevantChanges )

abstractprotected

Parameters

int[]

$relevantChanges

Ids of changes relevant for this job.

Returns

void

Reimplemented in Wikibase\Client\ChangeModification\ChangeDeletionNotificationJob, and Wikibase\Client\ChangeModification\ChangeVisibilityNotificationJob.

readRecentChangeParams()

Wikibase\Client\ChangeModification\ChangeModificationNotificationJob::readRecentChangeParams ( $rc_params )

private

Extracts the metadata array from the value of an rc_params field.

Parameters

array | string

$rc_params

Returns

array

run()

Wikibase\Client\ChangeModification\ChangeModificationNotificationJob::run

(

)

Returns

bool success

selectCandidateResults()

Wikibase\Client\ChangeModification\ChangeModificationNotificationJob::selectCandidateResults ( string $entityIdSerialization, array $revisionIdentifiers )

private

Parameters

string	$entityIdSerialization
RepoRevisionIdentifier[]	$revisionIdentifiers

Returns

IResultWrapper

unpackRevisionIdentifiers()

Wikibase\Client\ChangeModification\ChangeModificationNotificationJob::unpackRevisionIdentifiers ( string $revisionIdentifiersJson )

private

Parameters

string

$revisionIdentifiersJson

Returns

RepoRevisionIdentifier[]

Member Data Documentation

$clientDb

Wikibase\Client\ChangeModification\ChangeModificationNotificationJob::$clientDb

protected

$revisionIdentifiers

Wikibase\Client\ChangeModification\ChangeModificationNotificationJob::$revisionIdentifiers

private

---

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

• client/includes/ChangeModification/ChangeModificationNotificationJob.php