mwstake/mediawiki-component-events

Mechanism for firing events

Maintainers

Details

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

Source

Issues

Installs: 9 402

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 4

Forks: 1

Open Issues: 0

3.0.5 2024-11-07 15:06 UTC

Requires

Requires (Dev)

GPL-3.0-only 9c4393eacfc42bec114883ec136606b5b932e8e4

This package is auto-updated.

Last update: 2024-11-07 15:07:34 UTC

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 )