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

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
nextcloud · Sep 25, 2024 · 8a5b39d · 8a5b39d
1 parent f9295bb
commit 8a5b39d
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 1 deletion.
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
 	 */