mediawiki/mw-extension-registry-helper

dev-master / 1.x-dev 2018-05-13 19:03 UTC

README

The MediaWiki Extension Registry Helper is a tiny library that allows recursive loading of skins and extensions in MediaWiki.

Requirements

  • PHP 5.6 or later
  • MediaWiki 1.27 or later

Usage

In general dependencies on other extensions or skins should be specified in the extension.json of your extension [1]. If that is not possible (e.g. because they are conditional dependencies or because your MediaWiki version does not support dependency requirements yet), the methods of this helper may be used.

If your skin or extension depends on another extension, call

\ExtensionRegistryHelper\ExtensionRegistryHelper::singleton()->loadExtensionRecursive( $extensionName, $pathToExtensionJson ),

If your skin or extension depends on another skin, call

\ExtensionRegistryHelper\ExtensionRegistryHelper::singleton()->loadExtensionRecursive( $skinName, $pathToSkinJson ),

The paths to the extension.json/skin.json file may be ommitted. In this case a path will be generated from the extension or skin name.

The methods of this helper class should only be called from the callback function defined in your extension.json. If you call them later, e.g. from a SetupAfterCache hook handler, the hook handlers of the recursively loaded extensions may not get called.

(This is unfortunately not enforcable, as the respective property of ExtensionRegistry is not exposed.)

Be aware that this helper only ensures that extensions/skins are loaded. Due to the inner workings of the ExtensionRegistry it cannot enforce loading in the correct order. Particularly, if an extension or skin you depend on is already queued for loading, it will not be advanced in the queue to be available. This will commonly happen when both your extension and the extension it depends on are loaded from LocalSettings.php, but in the wrong order.

License

Copyright 2018, Stephan Gambke

GNU General Public License, version 3 (or any later version)