MediaWiki\DomainEvent\DomainEventSource Interface Reference

Service object for registering listeners for domain events. More...

Inherited by MediaWiki\DomainEvent\EventDispatchEngine.

Public Member Functions
	registerListener (string $eventType, $listener)
	Add a listener that will be notified on events of the given type, triggered by changed to the persistent state of the local wiki.
	registerSubscriber ( $subscriber)
	Register the given subscriber to this event source.

Detailed Description

Service object for registering listeners for domain events.

Since

1.44

Stability: unstable

until 1.45

Definition at line 10 of file DomainEventSource.php.

Member Function Documentation

registerListener()

MediaWiki\DomainEvent\DomainEventSource::registerListener	(	string	$eventType,
			$listener )

Add a listener that will be notified on events of the given type, triggered by changed to the persistent state of the local wiki.

Listeners should be implemented to be idempotent, that is, calling them multiple times with the same parameters should produce the same outcome.

Listeners will be invoked after the transaction that produced the event was committed successfully. Delivery guarantees depend on the implementation of DomainEvent sink used.

Parameters

string	$eventType
callable	$listener

Implemented in MediaWiki\DomainEvent\EventDispatchEngine.

Referenced by MediaWiki\DomainEvent\EventSubscriberBase\registerListenerMethod().

registerSubscriber()

MediaWiki\DomainEvent\DomainEventSource::registerSubscriber

(

$subscriber

)

Register the given subscriber to this event source.

A subscriber is a way to bundle related listeners, typically by implementing them as methods on the subscriber object.

If the subscriber is supplied as a spec array, instantiation and application may be deferred until one of the relevant events is triggered.

Parameters

DomainEventSubscriber | array

$subscriber

object: a DomainEventSubscriber array: An object spec suitable for use with ObjectFactory. The array must use the key 'events' to specify which events will trigger application of the subscriber.

Implemented in MediaWiki\DomainEvent\EventDispatchEngine.

Referenced by MediaWiki\Registration\ExtensionRegistry\registerListeners().

---

The documentation for this interface was generated from the following file:

• includes/DomainEvent/DomainEventSource.php