Wikibase\Client\Hooks\DataUpdateHookHandler Class Reference

Hook handlers for triggering data updates. More...

Inheritance diagram for Wikibase\Client\Hooks\DataUpdateHookHandler:

Collaboration diagram for Wikibase\Client\Hooks\DataUpdateHookHandler:

Public Member Functions
	__construct (UsageUpdater $usageUpdater, JobQueueGroup $jobScheduler, UsageLookup $usageLookup, EntityUsageFactory $entityUsageFactory)
	onArticleDeleteComplete ( $wikiPage, $user, $reason, $id, $content, $logEntry, $archivedRevisionCount)
	Static handler for ArticleDeleteComplete.
	onLinksUpdateComplete ( $linksUpdate, $ticket)
	Triggered when a page gets re-rendered to update secondary link tables.
	doLinksUpdateComplete (LinksUpdate $linksUpdate)
	onParserCacheSaveComplete ( $parserCache, $parserOutput, $title, $popts, $revId)
	Triggered when a new rendering of a page is committed to the ParserCache.

Static Public Member Functions
static	newFromGlobalState ()

Private Member Functions
	reindexEntityUsages (array $usages)
	Re-indexes the given list of EntityUsages so that each EntityUsage can be found by using its string representation as a key.

Private Attributes
	$usageUpdater
	$jobScheduler
	$usageLookup
	$entityUsageFactory

Detailed Description

Hook handlers for triggering data updates.

This class has a static interface for use with MediaWiki's hook mechanism; the static handler functions will create a new instance of DataUpdateHookHandler and then call the corresponding member function on that.

Copyright

GPL-2.0-or-later

Author

Daniel Kinzler

Marius Hoch

Constructor & Destructor Documentation

__construct()

Wikibase\Client\Hooks\DataUpdateHookHandler::__construct	(	UsageUpdater	$usageUpdater,
		JobQueueGroup	$jobScheduler,
		UsageLookup	$usageLookup,
		EntityUsageFactory	$entityUsageFactory
	)

Member Function Documentation

doLinksUpdateComplete()

Wikibase\Client\Hooks\DataUpdateHookHandler::doLinksUpdateComplete

(

LinksUpdate

$linksUpdate

)

newFromGlobalState()

static Wikibase\Client\Hooks\DataUpdateHookHandler::newFromGlobalState ( )

static

onArticleDeleteComplete()

Wikibase\Client\Hooks\DataUpdateHookHandler::onArticleDeleteComplete	(		$wikiPage,
			$user,
			$reason,
			$id,
			$content,
			$logEntry,
			$archivedRevisionCount
	)

Static handler for ArticleDeleteComplete.

See also

https://www.mediawiki.org/wiki/Manual:Hooks/ArticleDeleteComplete

Parameters

WikiPage	$wikiPage	WikiPage that was deleted
User	$user	User that deleted the article
string	$reason	Reason the article was deleted
int	$id	ID of the article that was deleted
Content | null	$content	Content of the deleted page (or null, when deleting a broken page)
\ManualLogEntry	$logEntry	ManualLogEntry used to record the deletion
int	$archivedRevisionCount	Number of revisions archived during the deletion

onLinksUpdateComplete()

Wikibase\Client\Hooks\DataUpdateHookHandler::onLinksUpdateComplete	(		$linksUpdate,
			$ticket
	)

Triggered when a page gets re-rendered to update secondary link tables.

Implemented to update usage tracking information via UsageUpdater.

Parameters

LinksUpdate	$linksUpdate
mixed	$ticket	Prior result of LBFactory::getEmptyTransactionTicket()

onParserCacheSaveComplete()

Wikibase\Client\Hooks\DataUpdateHookHandler::onParserCacheSaveComplete	(		$parserCache,
			$parserOutput,
			$title,
			$popts,
			$revId
	)

Triggered when a new rendering of a page is committed to the ParserCache.

Implemented to update usage tracking information via UsageUpdater.

Parameters

ParserCache	$parserCache	ParserCache object $parserOutput was stored in
ParserOutput	$parserOutput	ParserOutput object that was stored
Title	$title	Title of the page that was parsed to generate $parserOutput
ParserOptions	$popts	ParserOptions used for generating $parserOutput
int	$revId	ID of the revision that was parsed to create $parserOutput

reindexEntityUsages()

Wikibase\Client\Hooks\DataUpdateHookHandler::reindexEntityUsages ( array  $usages )

private

Re-indexes the given list of EntityUsages so that each EntityUsage can be found by using its string representation as a key.

Parameters

EntityUsage[]

$usages

Exceptions

InvalidArgumentException

Returns

EntityUsage[]

Member Data Documentation

$entityUsageFactory

Wikibase\Client\Hooks\DataUpdateHookHandler::$entityUsageFactory

private

$jobScheduler

Wikibase\Client\Hooks\DataUpdateHookHandler::$jobScheduler

private

$usageLookup

Wikibase\Client\Hooks\DataUpdateHookHandler::$usageLookup

private

$usageUpdater

Wikibase\Client\Hooks\DataUpdateHookHandler::$usageUpdater

private

---

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

• client/includes/Hooks/DataUpdateHookHandler.php