Merge pull request #736 from nextcloud/carl/modern-event

refactor: Use modern SabrePluginAddEvent

Author: oleksandr-nc

lib/AppInfo/Application.php

@@ -24,6 +24,7 @@
 use OCA\AppAPI\Notifications\ExAppNotifier;
 use OCA\AppAPI\PublicCapabilities;
 use OCA\AppAPI\SetupChecks\DaemonCheck;
+use OCA\DAV\Events\SabrePluginAddEvent;
 use OCA\DAV\Events\SabrePluginAuthInitEvent;
 use OCA\Files\Event\LoadAdditionalScriptsEvent;
 use OCP\AppFramework\App;
@@ -32,7 +33,6 @@
 use OCP\AppFramework\Bootstrap\IRegistrationContext;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Navigation\Events\LoadAdditionalEntriesEvent;
-use OCP\SabrePluginEvent;
 use OCP\Settings\Events\DeclarativeSettingsGetValueEvent;
 use OCP\Settings\Events\DeclarativeSettingsRegisterFormEvent;
 use OCP\Settings\Events\DeclarativeSettingsSetValueEvent;
@@ -77,9 +77,9 @@ public function boot(IBootContext $context): void {
 	public function registerDavAuth(): void {
 		$container = $this->getContainer();
 
-		$dispatcher = $container->query(IEventDispatcher::class);
-		$dispatcher->addListener('OCA\DAV\Connector\Sabre::addPlugin', function (SabrePluginEvent $event) use ($container) {
-			$event->getServer()->addPlugin($container->query(DavPlugin::class));
+		$dispatcher = $container->get(IEventDispatcher::class);
+		$dispatcher->addListener(SabrePluginAddEvent::class, function (SabrePluginAddEvent $event) use ($container) {
+			$event->getServer()->addPlugin($container->get(DavPlugin::class));
 		});
 	}
 }

psalm.xml

@@ -54,4 +54,7 @@
 			</errorLevel>
 		</UndefinedDocblockClass>
 	</issueHandlers>
+	<stubs>
+		<file name="tests/stubs/oca_dav_events_sabrepluginaddevent.php"/>
+	</stubs>
 </psalm>

tests/stubs/oca_dav_events_sabrepluginaddevent.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\DAV\Events;
+
+use OCP\EventDispatcher\Event;
+use Sabre\DAV\Server;
+
+/**
+ * This event is triggered during the setup of the SabreDAV server to allow the
+ * registration of additional plugins.
+ *
+ * @since 28.0.0
+ */
+class SabrePluginAddEvent extends Event {
+
+	/**
+	 * @since 28.0.0
+	 */
+	public function __construct(
+		private Server $server,
+	) {
+	}
+
+	/**
+	 * @since 28.0.0
+	 */
+	public function getServer(): Server {
+	}
+}