Wikibase
MediaWiki Wikibase extension
Wikibase\Client\Changes\PageUpdater Interface Reference

Service interface for triggering different kinds of page updates and generally notifying the local wiki of external changes. More...

+ Inheritance diagram for Wikibase\Client\Changes\PageUpdater:

Public Member Functions

 purgeWebCache (array $titles, array $rootJobParams, $causeAction, $causeAgent)
 Invalidates external web cached of the given pages. More...
 
 scheduleRefreshLinks (array $titles, array $rootJobParams, $causeAction, $causeAgent)
 Schedules RefreshLinks jobs for the given titles. More...
 
 injectRCRecords (array $titles, EntityChange $change, array $rootJobParams=[])
 Injects an RC entry into the recentchanges, using the given title and attribs. More...
 

Detailed Description

Service interface for triggering different kinds of page updates and generally notifying the local wiki of external changes.

Used by ChangeHandler as an interface to the local wiki.

Author
Daniel Kinzler

Member Function Documentation

◆ injectRCRecords()

Wikibase\Client\Changes\PageUpdater::injectRCRecords ( array  $titles,
EntityChange  $change,
array  $rootJobParams = [] 
)

Injects an RC entry into the recentchanges, using the given title and attribs.

Parameters
Title[]$titles
EntityChange$change
array$rootJobParamsany relevant root job parameters to be inherited by new jobs.

◆ purgeWebCache()

Wikibase\Client\Changes\PageUpdater::purgeWebCache ( array  $titles,
array  $rootJobParams,
  $causeAction,
  $causeAgent 
)

Invalidates external web cached of the given pages.

Parameters
Title[]$titlesThe Titles of the pages to update
array$rootJobParamsany relevant root job parameters to be inherited by new jobs.
string$causeActionTriggering action
string$causeAgentTriggering agent

◆ scheduleRefreshLinks()

Wikibase\Client\Changes\PageUpdater::scheduleRefreshLinks ( array  $titles,
array  $rootJobParams,
  $causeAction,
  $causeAgent 
)

Schedules RefreshLinks jobs for the given titles.

Parameters
Title[]$titlesThe Titles of the pages to update
array$rootJobParamsany relevant root job parameters to be inherited by new jobs.
string$causeActionTriggering action
string$causeAgentTriggering agent

Implemented in Wikibase\Client\Changes\WikiPageUpdater.


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