Wikibase
MediaWiki Wikibase extension
Loading...
Searching...
No Matches
Wikibase\Client\ChangeNotificationJob Class Reference

Job for notifying a client wiki of a batch of changes on the repository. More...

+ Inheritance diagram for Wikibase\Client\ChangeNotificationJob:
+ Collaboration diagram for Wikibase\Client\ChangeNotificationJob:

Public Member Functions

 __construct (Title $title, array $params=[])
 Constructs a ChangeNotificationJob representing the changes given by $changeIds.
 

Private Member Functions

 getChanges ()
 Returns the batch of changes that should be processed.
 
 getChangeHandler ()
 

Private Attributes

 $changes = null
 
 $changeHandler = null
 
 $logger
 

Detailed Description

Job for notifying a client wiki of a batch of changes on the repository.

See also
md_docs_topics_change-propagation for an overview of the change propagation mechanism.
Author
Daniel Kinzler

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Client\ChangeNotificationJob::__construct ( Title  $title,
array  $params = [] 
)

Constructs a ChangeNotificationJob representing the changes given by $changeIds.

Note
the constructor's signature is dictated by Job::factory, so we'll have to live with it even though it's rather ugly for our use case.
See also
Job::factory.
Parameters
Title$title
array$paramsNeeds to have two keys: "repo": the id of the repository, "changeIds": array of change ids.

Member Function Documentation

◆ getChangeHandler()

Wikibase\Client\ChangeNotificationJob::getChangeHandler ( )
private
Returns
ChangeHandler

◆ getChanges()

EntityChange[] null Initialized lazily by Wikibase\Client\ChangeNotificationJob::getChanges ( )
private

Returns the batch of changes that should be processed.

EntityChange objects are loaded using a EntityChangeLookup.

Returns
EntityChange[] the changes to process.

Member Data Documentation

◆ $changeHandler

Wikibase\Client\ChangeNotificationJob::$changeHandler = null
private

◆ $changes

Wikibase\Client\ChangeNotificationJob::$changes = null
private

◆ $logger

Wikibase\Client\ChangeNotificationJob::$logger
private

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