MediaWiki\DomainEvent\DomainEventDispatcher Interface Reference

Service for sending domain events to registered listeners. More...

Inherited by MediaWiki\DomainEvent\EventDispatchEngine.

Public Member Functions
	dispatch (DomainEvent $event, IConnectionProvider $dbProvider)
	Dispatch the given event to any listeners that have been registered for the given event type.

Detailed Description

Service for sending domain events to registered listeners.

Since

1.44

See also

docs/Events.md

https://www.mediawiki.org/wiki/Manual:Domain_events

Definition at line 14 of file DomainEventDispatcher.php.

Member Function Documentation

dispatch()

MediaWiki\DomainEvent\DomainEventDispatcher::dispatch	(	DomainEvent	$event,
		IConnectionProvider	$dbProvider )

Dispatch the given event to any listeners that have been registered for the given event type.

The event will be dispatched to registered listeners later, after (and if) the current transaction in $dbw has been committed successfully. No listeners will be invoked within the current transaction.

Implementations should aim to provide at-least-once delivery semantics, but guaranteed delivery is not a hard requirement of this interface. An application may guarantee delivery of domain events by providing an appropriate implementation (a transactional outbox).

Implemented in MediaWiki\DomainEvent\EventDispatchEngine.

---

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

• includes/DomainEvent/DomainEventDispatcher.php