From 7d881b1bc35e24cba29184f11d4b28188fe487ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=B4me=20Chilliet?= Date: Tue, 10 Sep 2024 16:20:30 +0200 Subject: [PATCH] chore: Add descriptions for new events and fix copyright year MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Côme Chilliet --- lib/public/User/Events/BeforeUserIdUnassignedEvent.php | 5 +++-- lib/public/User/Events/UserIdAssignedEvent.php | 5 +++-- lib/public/User/Events/UserIdUnassignedEvent.php | 5 +++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/lib/public/User/Events/BeforeUserIdUnassignedEvent.php b/lib/public/User/Events/BeforeUserIdUnassignedEvent.php index 744ecd8909f..2dee62521aa 100644 --- a/lib/public/User/Events/BeforeUserIdUnassignedEvent.php +++ b/lib/public/User/Events/BeforeUserIdUnassignedEvent.php @@ -3,7 +3,7 @@ declare(strict_types=1); /** - * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors * SPDX-License-Identifier: AGPL-3.0-or-later */ @@ -12,6 +12,7 @@ namespace OCP\User\Events; use OCP\EventDispatcher\Event; /** + * Emitted before removing the mapping between an external user and an internal userid * @since 31.0.0 */ class BeforeUserIdUnassignedEvent extends Event { @@ -19,7 +20,7 @@ class BeforeUserIdUnassignedEvent extends Event { * @since 31.0.0 */ public function __construct( - private string $userId, + private readonly string $userId, ) { parent::__construct(); } diff --git a/lib/public/User/Events/UserIdAssignedEvent.php b/lib/public/User/Events/UserIdAssignedEvent.php index 63daca09820..829bd50c0d0 100644 --- a/lib/public/User/Events/UserIdAssignedEvent.php +++ b/lib/public/User/Events/UserIdAssignedEvent.php @@ -3,7 +3,7 @@ declare(strict_types=1); /** - * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors * SPDX-License-Identifier: AGPL-3.0-or-later */ @@ -12,6 +12,7 @@ namespace OCP\User\Events; use OCP\EventDispatcher\Event; /** + * Emitted by backends (like user_ldap) when a user created externally is mapped for the first time and assigned a userid * @since 31.0.0 */ class UserIdAssignedEvent extends Event { @@ -19,7 +20,7 @@ class UserIdAssignedEvent extends Event { * @since 31.0.0 */ public function __construct( - private string $userId, + private readonly string $userId, ) { parent::__construct(); } diff --git a/lib/public/User/Events/UserIdUnassignedEvent.php b/lib/public/User/Events/UserIdUnassignedEvent.php index db8861b98a4..128648a0753 100644 --- a/lib/public/User/Events/UserIdUnassignedEvent.php +++ b/lib/public/User/Events/UserIdUnassignedEvent.php @@ -3,7 +3,7 @@ declare(strict_types=1); /** - * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors * SPDX-License-Identifier: AGPL-3.0-or-later */ @@ -12,6 +12,7 @@ namespace OCP\User\Events; use OCP\EventDispatcher\Event; /** + * Emitted after removing the mapping between an external user and an internal userid * @since 31.0.0 */ class UserIdUnassignedEvent extends Event { @@ -19,7 +20,7 @@ class UserIdUnassignedEvent extends Event { * @since 31.0.0 */ public function __construct( - private string $userId, + private readonly string $userId, ) { parent::__construct(); }