diff options
| -rw-r--r-- | autoload.php | 5 | ||||
| -rw-r--r-- | docs/extension.schema.v2.json | 2 | ||||
| -rw-r--r-- | includes/DomainEvent/DomainEventIngress.php (renamed from includes/DomainEvent/EventIngressBase.php) | 12 | ||||
| -rw-r--r-- | includes/DomainEvent/DomainEventSubscriber.php | 2 | ||||
| -rw-r--r-- | includes/ResourceLoader/ResourceLoaderEventIngress.php | 4 | ||||
| -rw-r--r-- | includes/language/LanguageEventIngress.php | 4 | ||||
| -rw-r--r-- | includes/page/Event/PageRevisionUpdatedEvent.php | 4 | ||||
| -rw-r--r-- | includes/recentchanges/ChangeTrackingEventIngress.php | 4 | ||||
| -rw-r--r-- | includes/search/SearchEventIngress.php | 4 | ||||
| -rw-r--r-- | tests/phpunit/unit/includes/DomainEvent/DomainEventIngressTest.php (renamed from tests/phpunit/unit/includes/DomainEvent/EventIngressBaseTest.php) | 10 | ||||
| -rw-r--r-- | tests/phpunit/unit/includes/DomainEvent/EventDispatchEngineTest.php | 4 |
11 files changed, 29 insertions, 26 deletions
diff --git a/autoload.php b/autoload.php index 4571495fb692..ffcec57a34b9 100644 --- a/autoload.php +++ b/autoload.php @@ -1286,11 +1286,12 @@ $wgAutoloadLocalClasses = [ 'MediaWiki\\Diff\\WordAccumulator' => __DIR__ . '/includes/libs/Diff/WordAccumulator.php', 'MediaWiki\\DomainEvent\\DomainEvent' => __DIR__ . '/includes/DomainEvent/DomainEvent.php', 'MediaWiki\\DomainEvent\\DomainEventDispatcher' => __DIR__ . '/includes/DomainEvent/DomainEventDispatcher.php', + 'MediaWiki\\DomainEvent\\DomainEventIngress' => __DIR__ . '/includes/DomainEvent/DomainEventIngress.php', 'MediaWiki\\DomainEvent\\DomainEventSource' => __DIR__ . '/includes/DomainEvent/DomainEventSource.php', 'MediaWiki\\DomainEvent\\DomainEventSubscriber' => __DIR__ . '/includes/DomainEvent/DomainEventSubscriber.php', 'MediaWiki\\DomainEvent\\EventDispatchEngine' => __DIR__ . '/includes/DomainEvent/EventDispatchEngine.php', - 'MediaWiki\\DomainEvent\\EventIngressBase' => __DIR__ . '/includes/DomainEvent/EventIngressBase.php', - 'MediaWiki\\DomainEvent\\EventSubscriberBase' => __DIR__ . '/includes/DomainEvent/EventIngressBase.php', + 'MediaWiki\\DomainEvent\\EventIngressBase' => __DIR__ . '/includes/DomainEvent/DomainEventIngress.php', + 'MediaWiki\\DomainEvent\\EventSubscriberBase' => __DIR__ . '/includes/DomainEvent/DomainEventIngress.php', 'MediaWiki\\DomainEvent\\InitializableDomainEventSubscriber' => __DIR__ . '/includes/DomainEvent/InitializableDomainEventSubscriber.php', 'MediaWiki\\EditPage\\Constraint\\AccidentalRecreationConstraint' => __DIR__ . '/includes/editpage/Constraint/AccidentalRecreationConstraint.php', 'MediaWiki\\EditPage\\Constraint\\BrokenRedirectConstraint' => __DIR__ . '/includes/editpage/Constraint/BrokenRedirectConstraint.php', diff --git a/docs/extension.schema.v2.json b/docs/extension.schema.v2.json index 5d40ba73624b..5eaf21303bcc 100644 --- a/docs/extension.schema.v2.json +++ b/docs/extension.schema.v2.json @@ -1203,7 +1203,7 @@ }, "DomainEventIngresses": { "type": "array", - "description": "ObjectFactory specifications for domain event ingress objects. Since MW 1.44. Event ingress objects must extend EventIngressBase.", + "description": "ObjectFactory specifications for domain event ingress objects. Since MW 1.44. Event ingress objects must extend DomainEventIngress.", "items": { "allOf": [ { diff --git a/includes/DomainEvent/EventIngressBase.php b/includes/DomainEvent/DomainEventIngress.php index fb4d65ee0002..5d44552d14bd 100644 --- a/includes/DomainEvent/EventIngressBase.php +++ b/includes/DomainEvent/DomainEventIngress.php @@ -13,13 +13,13 @@ use LogicException; * which event should trigger which logic in the component and for mapping from * the model used by the emitter of the event to the component's own model. * - * EventIngressBase implements InitializableDomainEventSubscriber so it can be + * DomainEventIngress implements InitializableDomainEventSubscriber so it can be * registered with and initialized by a DomainEventSource. Registration is * typically done in the form of an object spec for lazy instantiation. For * extensions' ingress objects that object spec can be provided in the * DomainEventSubscribers section of extension.json. * - * After instantiating a subscriber (typically a subclass of EventIngressBase), + * After instantiating a subscriber (typically a subclass of DomainEventIngress), * the event source will call initSubscriber() to initialize the subscriber and * then registerListeners() to allow the subscriber to register listeners for * the events it is interested in. @@ -39,7 +39,7 @@ use LogicException; * @since 1.44 * @unstable until 1.45, should become stable to extend */ -abstract class EventIngressBase implements InitializableDomainEventSubscriber { +abstract class DomainEventIngress implements InitializableDomainEventSubscriber { /** * @var string[] @@ -153,7 +153,7 @@ abstract class EventIngressBase implements InitializableDomainEventSubscriber { if ( !$this->eventTypes ) { throw new LogicException( - 'Subclassed of EventIngressBase must either override ' . + 'Subclassed of DomainEventIngress must either override ' . 'registerListeners or provide a list of event types via ' . 'initSubscriber() or initEvents().' ); @@ -167,4 +167,6 @@ abstract class EventIngressBase implements InitializableDomainEventSubscriber { } /** @deprecated temporary alias, remove before 1.44 release (T389033) */ -class_alias( EventIngressBase::class, 'MediaWiki\DomainEvent\EventSubscriberBase' ); +class_alias( DomainEventIngress::class, 'MediaWiki\DomainEvent\EventSubscriberBase' ); +/** @deprecated temporary alias, remove before 1.44 release (T389033) */ +class_alias( DomainEventIngress::class, 'MediaWiki\DomainEvent\EventIngressBase' ); diff --git a/includes/DomainEvent/DomainEventSubscriber.php b/includes/DomainEvent/DomainEventSubscriber.php index 93778de5a000..e4c4d69b1473 100644 --- a/includes/DomainEvent/DomainEventSubscriber.php +++ b/includes/DomainEvent/DomainEventSubscriber.php @@ -9,7 +9,7 @@ namespace MediaWiki\DomainEvent; * @since 1.44 * @stable to type * @note Extensions should not implement this interface directly but should - * extend EventIngressBase. + * extend DomainEventIngress. */ interface DomainEventSubscriber { diff --git a/includes/ResourceLoader/ResourceLoaderEventIngress.php b/includes/ResourceLoader/ResourceLoaderEventIngress.php index aa1711bcff29..2ae9800afddd 100644 --- a/includes/ResourceLoader/ResourceLoaderEventIngress.php +++ b/includes/ResourceLoader/ResourceLoaderEventIngress.php @@ -2,7 +2,7 @@ namespace MediaWiki\ResourceLoader; -use MediaWiki\DomainEvent\EventIngressBase; +use MediaWiki\DomainEvent\DomainEventIngress; use MediaWiki\Page\Event\PageDeletedEvent; use MediaWiki\Page\Event\PageDeletedListener; use MediaWiki\Page\Event\PageRevisionUpdatedEvent; @@ -18,7 +18,7 @@ use Wikimedia\Rdbms\LBFactory; * @internal */ class ResourceLoaderEventIngress - extends EventIngressBase + extends DomainEventIngress implements PageRevisionUpdatedListener, PageDeletedListener { diff --git a/includes/language/LanguageEventIngress.php b/includes/language/LanguageEventIngress.php index 18e083a47f39..d5960e04968e 100644 --- a/includes/language/LanguageEventIngress.php +++ b/includes/language/LanguageEventIngress.php @@ -2,7 +2,7 @@ namespace MediaWiki\Languages; -use MediaWiki\DomainEvent\EventIngressBase; +use MediaWiki\DomainEvent\DomainEventIngress; use MediaWiki\Page\Event\PageDeletedEvent; use MediaWiki\Page\Event\PageDeletedListener; use MediaWiki\Page\Event\PageRevisionUpdatedEvent; @@ -17,7 +17,7 @@ use MessageCache; * @internal */ class LanguageEventIngress - extends EventIngressBase + extends DomainEventIngress implements PageDeletedListener, PageRevisionUpdatedListener { diff --git a/includes/page/Event/PageRevisionUpdatedEvent.php b/includes/page/Event/PageRevisionUpdatedEvent.php index c65487d01570..7d8cab6ec4ff 100644 --- a/includes/page/Event/PageRevisionUpdatedEvent.php +++ b/includes/page/Event/PageRevisionUpdatedEvent.php @@ -48,11 +48,11 @@ use Wikimedia\Assert\Assert; * * Extensions that want to subscribe to this event should list * "PageRevisionUpdated" as a subscribed event type. - * Subscribers based on EventIngressBase should implement the + * Subscribers based on DomainEventIngress should implement the * handlePageRevisionUpdatedEvent() listener method to be informed when * a page update has been committed to the database. * - * See the documentation of EventIngressBase and DomainEventSource for + * See the documentation of DomainEventIngress and DomainEventSource for * more options and details. * * @unstable until 1.45 diff --git a/includes/recentchanges/ChangeTrackingEventIngress.php b/includes/recentchanges/ChangeTrackingEventIngress.php index f4efe4136820..eaa85f53df74 100644 --- a/includes/recentchanges/ChangeTrackingEventIngress.php +++ b/includes/recentchanges/ChangeTrackingEventIngress.php @@ -5,7 +5,7 @@ namespace MediaWiki\RecentChanges; use LogicException; use MediaWiki\ChangeTags\ChangeTagsStore; use MediaWiki\Config\Config; -use MediaWiki\DomainEvent\EventIngressBase; +use MediaWiki\DomainEvent\DomainEventIngress; use MediaWiki\HookContainer\HookContainer; use MediaWiki\HookContainer\HookRunner; use MediaWiki\JobQueue\JobQueueGroup; @@ -30,7 +30,7 @@ use MediaWiki\User\UserNameUtils; * @internal */ class ChangeTrackingEventIngress - extends EventIngressBase + extends DomainEventIngress implements PageRevisionUpdatedListener { diff --git a/includes/search/SearchEventIngress.php b/includes/search/SearchEventIngress.php index 5ee81f4150eb..f6aff749f797 100644 --- a/includes/search/SearchEventIngress.php +++ b/includes/search/SearchEventIngress.php @@ -2,7 +2,7 @@ namespace MediaWiki\Search; -use MediaWiki\DomainEvent\EventIngressBase; +use MediaWiki\DomainEvent\DomainEventIngress; use MediaWiki\Page\Event\PageDeletedEvent; use MediaWiki\Page\Event\PageDeletedListener; use MediaWiki\Page\Event\PageRevisionUpdatedEvent; @@ -17,7 +17,7 @@ use MediaWiki\Revision\SlotRecord; * @internal */ class SearchEventIngress - extends EventIngressBase + extends DomainEventIngress implements PageDeletedListener, PageRevisionUpdatedListener { diff --git a/tests/phpunit/unit/includes/DomainEvent/EventIngressBaseTest.php b/tests/phpunit/unit/includes/DomainEvent/DomainEventIngressTest.php index 7bc57d4d8a60..3ba1c935f801 100644 --- a/tests/phpunit/unit/includes/DomainEvent/EventIngressBaseTest.php +++ b/tests/phpunit/unit/includes/DomainEvent/DomainEventIngressTest.php @@ -2,17 +2,17 @@ namespace MediaWiki\Tests\DomainEvent; +use MediaWiki\DomainEvent\DomainEventIngress; use MediaWiki\DomainEvent\DomainEventSource; use MediaWiki\DomainEvent\EventDispatchEngine; -use MediaWiki\DomainEvent\EventIngressBase; use MediaWikiUnitTestCase; use Wikimedia\ObjectFactory\ObjectFactory; use Wikimedia\Services\ServiceContainer; /** - * @covers \MediaWiki\DomainEvent\EventIngressBase + * @covers \MediaWiki\DomainEvent\DomainEventIngress */ -class EventIngressBaseTest extends MediaWikiUnitTestCase { +class DomainEventIngressTest extends MediaWikiUnitTestCase { private function newSpyEventSource( &$trace ): DomainEventSource { $objectFactory = new ObjectFactory( @@ -37,7 +37,7 @@ class EventIngressBaseTest extends MediaWikiUnitTestCase { $source = $this->newSpyEventSource( $trace ); // Pass the list of events as a constructor parameter - $subscriber = new class extends EventIngressBase { + $subscriber = new class extends DomainEventIngress { public function handleFooEvent() { // no-op @@ -72,7 +72,7 @@ class EventIngressBaseTest extends MediaWikiUnitTestCase { $events = [ 'Foo', 'Bar' ]; // Pass nothing to the constructor, rely on initSubscriber() - $subscriber = new class () extends EventIngressBase { + $subscriber = new class () extends DomainEventIngress { public function handleFooEvent() { // no-op } diff --git a/tests/phpunit/unit/includes/DomainEvent/EventDispatchEngineTest.php b/tests/phpunit/unit/includes/DomainEvent/EventDispatchEngineTest.php index 4ac3026e5104..3a96dc96dbd0 100644 --- a/tests/phpunit/unit/includes/DomainEvent/EventDispatchEngineTest.php +++ b/tests/phpunit/unit/includes/DomainEvent/EventDispatchEngineTest.php @@ -4,10 +4,10 @@ namespace MediaWiki\Tests\DomainEvent; use MediaWiki\Deferred\DeferredUpdates; use MediaWiki\DomainEvent\DomainEvent; +use MediaWiki\DomainEvent\DomainEventIngress; use MediaWiki\DomainEvent\DomainEventSource; use MediaWiki\DomainEvent\DomainEventSubscriber; use MediaWiki\DomainEvent\EventDispatchEngine; -use MediaWiki\DomainEvent\EventIngressBase; use MediaWiki\Tests\MockDatabase; use MediaWikiUnitTestCase; use Wikimedia\ObjectFactory\ObjectFactory; @@ -274,7 +274,7 @@ class EventDispatchEngineTest extends MediaWikiUnitTestCase { $trace = []; - $subscriber = new class ( $trace ) extends EventIngressBase { + $subscriber = new class ( $trace ) extends DomainEventIngress { private $trace; public function __construct( &$trace ) { |