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

Handle Changes' hooks. More...

+ Inheritance diagram for Wikibase\Client\Hooks\WikibaseClientHookRunner:
+ Collaboration diagram for Wikibase\Client\Hooks\WikibaseClientHookRunner:

Public Member Functions

 __construct (HookContainer $hookContainer)
 
 onWikibaseHandleChange ( $change, array $rootJobParams=[])
 Hook runner for the 'WikibaseHandleChange' hook.
 
 onWikibaseHandleChanges (array $changes, array $rootJobParams=[])
 Hook runner for the 'WikibaseHandleChanges' hook.
 
 onWikibaseClientSiteLinksForItem (Item $item, array &$siteLinks, UsageAccumulator $usageAccumulator)
 Called by Wikibase::Client::Hooks::SiteLinksForDisplayLookup to allow altering the sitelinks used in language links and the other project's sidebar.Only called in case the page we are on is linked with an item.
Parameters
Item$itemItem the page is linked with.
SiteLink[]&$siteLinksArray containing the site links to display indexed by site global ID.
UsageAccumulator$usageAccumulatorA usage accumulator to track the usages of Wikibase entities done by the hook handlers.

 
 onWikibaseClientDataTypes (array &$dataTypeDefinitions)
 Called when constructing the top-level WikibaseClient factory May be used to define additional data types See also the Wikibase::Repo::Hooks::WikibaseRepoDataTypesHook.Hook handlers may add additional definitions. See the datatypes documentation for details.
Parameters
array&$dataTypeDefinitionsThe array of data type definitions, as defined by WikibaseClient.datatypes.php

 
 onWikibaseClientEntityTypes (array &$entityTypeDefinitions)
 Called when constructing the top-level WikibaseClient factory May be used to define additional entity types.See also the WikibaseRepoEntityTypesHook.Hook handlers may add additional definitions. See entitytypes documentation for details.
Parameters
array&$entityTypeDefinitionsthe array of entity type definitions, as defined by WikibaseLib.entitytypes.php

 

Private Attributes

 $hookContainer
 

Detailed Description

Handle Changes' hooks.

Author
dang

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Client\Hooks\WikibaseClientHookRunner::__construct ( HookContainer $hookContainer)

Member Function Documentation

◆ onWikibaseClientDataTypes()

Wikibase\Client\Hooks\WikibaseClientHookRunner::onWikibaseClientDataTypes ( array & $dataTypeDefinitions)

Called when constructing the top-level WikibaseClient factory May be used to define additional data types See also the Wikibase::Repo::Hooks::WikibaseRepoDataTypesHook.Hook handlers may add additional definitions. See the datatypes documentation for details.

Parameters
array&$dataTypeDefinitionsThe array of data type definitions, as defined by WikibaseClient.datatypes.php

Implements Wikibase\Client\Hooks\WikibaseClientDataTypesHook.

◆ onWikibaseClientEntityTypes()

Wikibase\Client\Hooks\WikibaseClientHookRunner::onWikibaseClientEntityTypes ( array & $entityTypeDefinitions)

Called when constructing the top-level WikibaseClient factory May be used to define additional entity types.See also the WikibaseRepoEntityTypesHook.Hook handlers may add additional definitions. See entitytypes documentation for details.

Parameters
array&$entityTypeDefinitionsthe array of entity type definitions, as defined by WikibaseLib.entitytypes.php

Implements Wikibase\Client\Hooks\WikibaseClientEntityTypesHook.

◆ onWikibaseClientSiteLinksForItem()

Wikibase\Client\Hooks\WikibaseClientHookRunner::onWikibaseClientSiteLinksForItem ( Item $item,
array & $siteLinks,
UsageAccumulator $usageAccumulator )

Called by Wikibase::Client::Hooks::SiteLinksForDisplayLookup to allow altering the sitelinks used in language links and the other project's sidebar.Only called in case the page we are on is linked with an item.

Parameters
Item$itemItem the page is linked with.
SiteLink[]&$siteLinksArray containing the site links to display indexed by site global ID.
UsageAccumulator$usageAccumulatorA usage accumulator to track the usages of Wikibase entities done by the hook handlers.

Implements Wikibase\Client\Hooks\WikibaseClientSiteLinksForItemHook.

◆ onWikibaseHandleChange()

Wikibase\Client\Hooks\WikibaseClientHookRunner::onWikibaseHandleChange ( $change,
array $rootJobParams = [] )

Hook runner for the 'WikibaseHandleChange' hook.

Parameters
EntityChange$change
array$rootJobParams
Returns
bool

Implements Wikibase\Client\Hooks\WikibaseHandleChangeHook.

◆ onWikibaseHandleChanges()

Wikibase\Client\Hooks\WikibaseClientHookRunner::onWikibaseHandleChanges ( array $changes,
array $rootJobParams = [] )

Hook runner for the 'WikibaseHandleChanges' hook.

Parameters
array$changes
array$rootJobParams
Returns
bool

Implements Wikibase\Client\Hooks\WikibaseHandleChangesHook.

Member Data Documentation

◆ $hookContainer

Wikibase\Client\Hooks\WikibaseClientHookRunner::$hookContainer
private

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