mediawiki/parser-hooks

Adds a OOP and declarative parser hook interface on top of MediaWiki

Maintainers

Details

github.com/JeroenDeDauw/ParserHooks

Homepage

Source

Issues

IRC

Fund package maintenance!
JeroenDeDauw

Installs: 434 200

Dependents: 7

Suggesters: 0

Security: 0

Stars: 4

Watchers: 7

Forks: 4

Open Issues: 3

1.6.1 2020-01-14 02:43 UTC

Requires

GPL-2.0-or-later 45660efef737bcf33abbbb12c1ddb049c4e713fe

mediawikiparserhooksparser functionparser hooktag extension

This package is auto-updated.

Last update: 2024-11-30 01:56:19 UTC

README

Build Status Code Coverage Scrutinizer Code Quality

On Packagist: Latest Stable Version Download count

OOP interface for creating MediaWiki parser hooks in a declarative fashion.

This is a PHP library for MediaWiki extensions. It does not in itself add or enhance functionality of your wiki.

Platform compatibility and release status

The PHP and MediaWiki version ranges listed are those in which ParserHooks is known to work. It might also work with more recent versions of PHP and MediaWiki, though this is not guaranteed. Increases of minimum requirements are indicated in bold. For a detailed list of changes, see the release notes.

Installation

You can use Composer to download and install this package as well as its dependencies. Alternatively you can simply clone the git repository and take care of loading yourself.

Composer

To add this package as a local, per-project dependency to your project, simply add a dependency on mediawiki/parser-hooks to your project's composer.json file. Here is a minimal example of a composer.json file that just defines a dependency on ParserHooks 1.6:

{
    "require": {
        "mediawiki/parser-hooks": "~1.6"
    }
}

Manual

Get the ParserHooks code, either via git, or some other means. Also get all dependencies. You can find a list of the dependencies in the "require" section of the composer.json file. Load all dependencies and the load the ParserHooks library by including its entry point: ParserHooks.php.

Usage

All classes are located in the ParserHooks namespace, which is PSR-0 mapped onto the src/ directory.

General concept

The declarative OOP interface provided by this library allows you to define the signatures of your parser hooks and the handlers for them separately. The library makes use of the parameters specified in this definition to do parameter processing via the ParamProcessor library. This means that the handler you write for your parser function will not need to care about what the name of the parser function is, or how the parameters for it should be processed. It has a "sizes" parameter that takes an array of positive integers? Your handler will always get an actual PHP array of integer without needing to do any parsing, validation, defaulting, etc.

HookDefinition

An instance of the HookDefinition class represents the signature of a parser hook. It defines the name of the parser hook and the parameters (including their types, default values, etc) it accepts. It does not define any behaviour, and is thus purely declarative. Instances of this class are used in handling of actual parser hooks, though can also be used in other contexts. For instance, you can feed these definitions to a tool that generates parser hook documentation based on them.

The parameter definitions are ParamProcessor\ParamDefinition objects. See the ParamProcessor documentation on how to specify these.

HookHandler

The actual behaviour for your parser hook is implemented in an implementation of HookHandler. These implementations have a handle method which gets a Parser and a ParamProcssor\ProcessingResult, which is supposed to return a string.

Knitting it all together

This library also provides two additional classes, FunctionRunner, and HookRegistrant. The former takes care of invoking the ParamProcessor library based on a HookDefinition. The later takes care of registering the parser hooks defined by your HookDefinition objects to a MediaWiki Parser object.

$awesomeHookDefinition = new HookDefinition( 'awesome', [ /* ... */ ] );
$anotherHookDefinition = new HookDefinition( 'another', [ /* ... */ ] );

$awesomeHookHandler = new AwesomeHookHandler( /* ... */ );
$anotherHookHandler = new AnotherHookHandler( /* ... */ );

$hookRegistrant = new HookRegistrant( $mediaWikiParser );

$hookRegistrant->registerFunctionHandler( $awesomeHookDefinition, $awesomeHookHandler );
$hookRegistrant->registerFunctionHandler( $anotherHookDefinition, $anotherHookHandler );

If you want to have the same hook, but with other default behaviour, you can avoid any kind of duplication by doing something as follows on top of the above code:

$hookRegistrant->registerFunctionHandler( $extraAwesomeHookDefinition, $awesomeHookHandler );

Where $extraAwesomeHookDefinition is a variation of $awesomeHookDefinition.

Parser functions and tag hooks

To register a parser function, use HookRegistrant::registerFunctionHandler.

$hookRegistrant->registerFunctionHandler( $awesomeHookDefinition, $awesomeHookHandler );

To register a tag hook, use HookRegistrant::registerHookHandler.

$hookRegistrant->registerHookHandler( $awesomeHookDefinition, $awesomeHookHandler );

Both functions take the exact same arguments, so once you created a HookDefinition and a HookHandler, you can have them registered as both parser function and tag hook with no extra work.

Tests

This library comes with a set up PHPUnit tests that cover all non-trivial code. You can run these tests using the PHPUnit configuration file found in the root directory. The tests can also be run via TravisCI, as a TravisCI configuration file is also provided in the root directory.

The tests can be run for the tests/phpunit directory of your MediaWiki installation with this command:

php phpunit.php --wiki wikiName -c ../../extensions/ParserHooks/

Authors

ParserHooks has been written by Jeroen De Dauw as a hobby project to support the SubPageList MediaWiki extension.

Release notes

1.6.1 (2020-01-14)

  • Updated translations

1.6 (2019-07-14)

  • Added support for PHP 7.2, 7.3 and 7.4
  • Added support for MediaWiki 1.31, 1.32 and 1.33
  • Dropped support for PHP 7.1 and older
  • Dropped support for MediaWiki 1.30 and older
  • Updated translations

1.5 (2016-03-05)

  • Added license now shown on Special:Version
  • Updated translations
  • Made minor style improvements
  • Ensured the extension works with PHP 7 and MediaWiki up to at least 1.27

1.4 (2014-07-05)

  • Changed the PHPUnit bootstrap so that the tests can be run via the MediaWiki test runner
  • Updated the CI configuration to test the code against multiple MediaWiki versions
  • Updated translations

1.3 (2014-06-25)

  • Updated translations
  • Changed class loading to PSR-4
  • Updated the used Validator version to 2.x >= 2.0.4

1.2.1 (2013-11-22)

  • Updated the used Validator version from 1.0 alpha to 1.0.0.1 stable, or later

1.2 (2013-09-30)

  • Fixed parameter handling bug in FunctionRunner
  • Added system test for tag hook handling

1.1 (2013-09-25)

  • Added HookRunner and HookRegistrant::registerHook
  • Added HookRegistrant::registerFunctionHandler and HookRegistrant::registerHookHandler
  • Fixed parameter handling bug in FunctionRunner
  • Improved HookRegistrantTest

You can read the release blog post

1.0.1 (2013-09-22)

  • Improved HookDefinition documentation
  • Added extra type checking in HookDefinition
  • Added extra tests for HookDefinition
  • Added coveralls.io support
  • Added PHPUnit file whitelisting (for more accurate and faster generated coverage reports)

1.0 (2013-07-14)

Links