MediaWiki  master
MediaWiki\HookContainer\GlobalHookRegistry Class Reference

A HookRegistry which sources its data from dynamically changing sources: $wgHooks and an ExtensionRegistry. More...

Inheritance diagram for MediaWiki\HookContainer\GlobalHookRegistry:
Collaboration diagram for MediaWiki\HookContainer\GlobalHookRegistry:

Public Member Functions

 __construct (ExtensionRegistry $extensionRegistry, DeprecatedHooks $deprecatedHooks)
 
 getDeprecatedHooks ()
 
 getExtensionHooks ()
 Get the current contents of the Hooks attribute in the ExtensionRegistry. More...
 
 getGlobalHooks ()
 Get the current contents of the $wgHooks variable or a mocked substitute. More...
 

Private Attributes

DeprecatedHooks $deprecatedHooks
 
ExtensionRegistry $extensionRegistry
 

Detailed Description

A HookRegistry which sources its data from dynamically changing sources: $wgHooks and an ExtensionRegistry.

Definition at line 11 of file GlobalHookRegistry.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\HookContainer\GlobalHookRegistry::__construct ( ExtensionRegistry  $extensionRegistry,
DeprecatedHooks  $deprecatedHooks 
)

Member Function Documentation

◆ getDeprecatedHooks()

MediaWiki\HookContainer\GlobalHookRegistry::getDeprecatedHooks ( )

◆ getExtensionHooks()

MediaWiki\HookContainer\GlobalHookRegistry::getExtensionHooks ( )

Get the current contents of the Hooks attribute in the ExtensionRegistry.

The contents is extended and normalized from the value of the corresponding attribute in extension.json. It does not contain "legacy" handlers, those are extracted into $wgHooks.

It is a three dimensional array:

  • The outer level is an array of hooks keyed by hook name.
  • The second level is an array of handlers, with integer indexes.
  • The third level is an associative array with the following members:
    • handler: An ObjectFactory spec, except that it also has an element "name" which is a unique string identifying the handler, for the purposes of sharing handler instances.
    • deprecated: A boolean value indicating whether the extension is acknowledging deprecation of the hook, to activate call filtering.
    • extensionPath: The path to the extension.json file in which the handler was defined. This is only used for deprecation messages.
Returns
array

Implements MediaWiki\HookContainer\HookRegistry.

Definition at line 30 of file GlobalHookRegistry.php.

◆ getGlobalHooks()

MediaWiki\HookContainer\GlobalHookRegistry::getGlobalHooks ( )

Get the current contents of the $wgHooks variable or a mocked substitute.

Returns
array

Implements MediaWiki\HookContainer\HookRegistry.

Definition at line 25 of file GlobalHookRegistry.php.

References $wgHooks.

Member Data Documentation

◆ $deprecatedHooks

DeprecatedHooks MediaWiki\HookContainer\GlobalHookRegistry::$deprecatedHooks
private

◆ $extensionRegistry

ExtensionRegistry MediaWiki\HookContainer\GlobalHookRegistry::$extensionRegistry
private

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