mwstake/mediawiki-component-events

Mechanism for firing events

3.0.5 2024-11-07 15:06 UTC

Requires

• composer/installers: ~1.0|~2
• mwstake/mediawiki-componentloader: ~1

Requires (Dev)

• mediawiki/mediawiki-codesniffer: 41.0.0
• mediawiki/minus-x: 1.1.1
• php-parallel-lint/php-console-highlighter: 1.0.0
• php-parallel-lint/php-parallel-lint: 1.3.2
• phpunit/phpunit: ^8.5

GPL-3.0-only

• HalloWelt! GmbH

README

This component allows you to emit notification events to consumers

Use in a MediaWiki extension

MediaWiki 1.35

• Add "mwstake/mediawiki-component-events": "~1" to the require section of your composer.json file.

MediaWiki 1.39

• Add "mwstake/mediawiki-component-events": "~2" to the require section of your composer.json file.

Register consumer

$GLOBALS['wgMWStakeNotificationEventConsumers'][] = [
	'class' => MyConsumer::class,
	'services' => [
		'UserFactory'
	]
];

Create Event

class MyEvent implements \MWStake\MediaWiki\Component\Events\INotificationEvent {
 ....
}

$event = new MyEvent( $user );

Emit Event

$notifier = MediaWikiServices::getInstance()->getService( 'MWStake.Notifier' );
$notifier->emit( $event );

// Will call MyConsumer::consume( $event )