chore: Unify user related events to always provide a getUid method

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
nextcloud · Oct 15, 2024 · 0be66d1 · 0be66d1
1 parent 52d581f
commit 0be66d1
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 6 deletions.
diff --git a/apps/encryption/lib/Listeners/UserEventsListener.php b/apps/encryption/lib/Listeners/UserEventsListener.php
@@ -52,15 +52,15 @@ public function handle(Event $event): void {
 			$this->onUserDeleted($event->getUid());
 		} elseif ($event instanceof UserLoggedInEvent) {
 			$this->onUserLogin($event->getUser(), $event->getPassword());
-		} elseif($event instanceof UserLoggedOutEvent) {
+		} elseif ($event instanceof UserLoggedOutEvent) {
 			$this->onUserLogout();
-		} elseif($event instanceof BeforePasswordUpdatedEvent) {
+		} elseif ($event instanceof BeforePasswordUpdatedEvent) {
 			$this->onBeforePasswordUpdated($event->getUser(), $event->getPassword(), $event->getRecoveryPassword());
-		} elseif($event instanceof PasswordUpdatedEvent) {
+		} elseif ($event instanceof PasswordUpdatedEvent) {
 			$this->onPasswordUpdated($event->getUid(), $event->getPassword(), $event->getRecoveryPassword());
-		} elseif($event instanceof BeforePasswordResetEvent) {
+		} elseif ($event instanceof BeforePasswordResetEvent) {
 			$this->onBeforePasswordReset($event->getUid());
-		} elseif($event instanceof PasswordResetEvent) {
+		} elseif ($event instanceof PasswordResetEvent) {
 			$this->onPasswordReset($event->getUid(), $event->getPassword());
 		}
 	}

diff --git a/core/Events/BeforePasswordResetEvent.php b/core/Events/BeforePasswordResetEvent.php
@@ -34,6 +34,13 @@ public function getUser(): IUser {
 		return $this->user;
 	}
 
+	/**
+	 * @since 31.0.0
+	 */
+	public function getUid(): string {
+		return $this->user->getUID();
+	}
+
 	/**
 	 * @since 25.0.0
 	 */

diff --git a/core/Events/PasswordResetEvent.php b/core/Events/PasswordResetEvent.php
@@ -34,6 +34,13 @@ public function getUser(): IUser {
 		return $this->user;
 	}
 
+	/**
+	 * @since 31.0.0
+	 */
+	public function getUid(): string {
+		return $this->user->getUID();
+	}
+
 	/**
 	 * @since 25.0.0
 	 */

diff --git a/lib/public/AppFramework/Bootstrap/IRegistrationContext.php b/lib/public/AppFramework/Bootstrap/IRegistrationContext.php
@@ -69,7 +69,7 @@ public function registerDashboardWidget(string $widgetClass): void;
 	 * @param string $name
 	 * @param callable $factory
 	 * @psalm-param callable(\Psr\Container\ContainerInterface): mixed $factory
-	 * @param bool $shared
+	 * @param bool $shared If set to true the factory result will be cached otherwise every query will call the factory again
 	 *
 	 * @return void
 	 * @see IContainer::registerService()

diff --git a/lib/public/User/Events/PasswordUpdatedEvent.php b/lib/public/User/Events/PasswordUpdatedEvent.php
@@ -49,6 +49,13 @@ public function getUser(): IUser {
 		return $this->user;
 	}
 
+	/**
+	 * @since 31.0.0
+	 */
+	public function getUid(): string {
+		return $this->user->getUID();
+	}
+
 	/**
 	 * @return string
 	 * @since 18.0.0

diff --git a/lib/public/User/Events/UserDeletedEvent.php b/lib/public/User/Events/UserDeletedEvent.php
@@ -34,4 +34,11 @@ public function __construct(IUser $user) {
 	public function getUser(): IUser {
 		return $this->user;
 	}
+
+	/**
+	 * @since 31.0.0
+	 */
+	public function getUid(): string {
+		return $this->user->getUID();
+	}
 }
diff --git a/lib/public/User/Events/UserLoggedInEvent.php b/lib/public/User/Events/UserLoggedInEvent.php
@@ -45,6 +45,13 @@ public function getUser(): IUser {
 		return $this->user;
 	}
 
+	/**
+	 * @since 31.0.0
+	 */
+	public function getUid(): string {
+		return $this->user->getUID();
+	}
+
 	/**
 	 * @since 21.0.0
 	 */