mwstake/mediawiki-component-lockdown

Provides classes and services to lockdown pages

Maintainers

Details

github.com/hallowelt/mwstake-mediawiki-component-lockdown

Source

Issues

Installs: 14

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 8

Forks: 0

Open Issues: 1

1.0.1 2023-01-18 15:30 UTC

Requires

Requires (Dev)

GPL-3.0-only cd1df5a1f081c7f6e9e68862efd04c7ad9a6aac1

This package is auto-updated.

Last update: 2024-11-22 13:20:27 UTC

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"