mwstake/mediawiki-component-lockdown

Provides classes and services to lockdown pages

1.0.1 2023-01-18 15:30 UTC

Requires

• mwstake/mediawiki-componentloader: ~1

Requires (Dev)

• jakub-onderka/php-console-highlighter: 0.4.0
• jakub-onderka/php-parallel-lint: 1.0.0
• mediawiki/mediawiki-codesniffer: 31.0.0
• mediawiki/minus-x: 1.0.0
• mwstake/mediawiki-component-manifestregistry: ~2.0

GPL-3.0-only

• Hallo Welt! GmbH
• Patric Wirth

README

Lockdown for MediaWiki

Provides a service and classes for permission lockdown on single pages

This code is meant to be executed within the MediaWiki application context. No standalone usage is intended.

Use in a MediaWiki extension

Add "mwstake/mediawiki-component-lockdown": "~1.0" to the require section of your composer.json file.

Explicit initialization is required. This can be archived by

• either adding "callback": "mwsInitComponents" to your extension.json/skin.json
• or calling mwsInitComponents(); within you extensions/skins custom callback method

See also mwstake/mediawiki-componentloader.

Implement a module

Create a class that implements MWStake\MediaWiki\Component\Lockdown\IModule. For convenience you may want to derive directly from the abstract base class MWStake\MediaWiki\Component\Lockdown\Module.

Register a module

ObjectFactory specification should be provided.

Example 1:

$GLOBALS['mwsgLockdownRegistry']['mymodulename'] = [
    'class' => "\\MediaWiki\Extension\\MyExt\\Lockdown\\LockThisDown",
    'services' => [ 'MainConfig', 'MyOtherService' ]
];

Example 2: (legacy) This provides the following services

$GLOBALS['mwsgLockdownRegistry']['mymodulename'][] = "\\MediaWiki\Extension\\MyExt\\Lockdown\\LockThisDown::myCallback"