Add type hints for all event listeners

Signed-off-by: jld3103 <jld3103yt@gmail.com>
nextcloud · Mar 31, 2023 · 85d542e · 85d542e
1 parent 9f1eacd
commit 85d542e
Show file tree

Hide file tree

Showing 57 changed files with 163 additions and 3 deletions.
diff --git a/apps/admin_audit/lib/Listener/CriticalActionPerformedEventListener.php b/apps/admin_audit/lib/Listener/CriticalActionPerformedEventListener.php
@@ -30,6 +30,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\Log\Audit\CriticalActionPerformedEvent;
 
+/**
+ * @template-implements IEventListener<CriticalActionPerformedEvent>
+ */
 class CriticalActionPerformedEventListener extends Action implements IEventListener {
 	public function handle(Event $event): void {
 		if (!($event instanceof CriticalActionPerformedEvent)) {

diff --git a/apps/comments/lib/Listener/CommentsEntityEventListener.php b/apps/comments/lib/Listener/CommentsEntityEventListener.php
@@ -29,6 +29,9 @@
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 
+/**
+ * @template-implements IEventListener<CommentsEntityEvent>
+ */
 class CommentsEntityEventListener implements IEventListener {
 	public function handle(Event $event): void {
 		if (!($event instanceof CommentsEntityEvent)) {

diff --git a/apps/comments/lib/Listener/LoadAdditionalScripts.php b/apps/comments/lib/Listener/LoadAdditionalScripts.php
@@ -33,6 +33,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\Util;
 
+/**
+ * @template-implements IEventListener<LoadAdditionalScriptsEvent>
+ */
 class LoadAdditionalScripts implements IEventListener {
 	public function handle(Event $event): void {
 		if (!($event instanceof LoadAdditionalScriptsEvent)) {

diff --git a/apps/comments/lib/Listener/LoadSidebarScripts.php b/apps/comments/lib/Listener/LoadSidebarScripts.php
@@ -33,6 +33,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\Util;
 
+/**
+ * @template-implements IEventListener<LoadSidebar>
+ */
 class LoadSidebarScripts implements IEventListener {
 
 	private ICommentsManager $commentsManager;

diff --git a/apps/contactsinteraction/lib/Listeners/ContactInteractionListener.php b/apps/contactsinteraction/lib/Listeners/ContactInteractionListener.php
@@ -40,6 +40,9 @@
 use Sabre\VObject\UUIDUtil;
 use Throwable;
 
+/**
+ * @template-implements IEventListener<ContactInteractedWithEvent>
+ */
 class ContactInteractionListener implements IEventListener {
 	private RecentContactMapper $mapper;
 	private CardSearchDao $cardSearchDao;

diff --git a/apps/dav/lib/Listener/ActivityUpdaterListener.php b/apps/dav/lib/Listener/ActivityUpdaterListener.php
@@ -44,6 +44,9 @@
 use Throwable;
 use function sprintf;
 
+/**
+ * @template-implements IEventListener<CalendarCreatedEvent|CalendarUpdatedEvent|CalendarMovedToTrashEvent|CalendarRestoredEvent|CalendarDeletedEvent|CalendarObjectCreatedEvent|CalendarObjectUpdatedEvent|CalendarObjectMovedEvent|CalendarObjectMovedToTrashEvent|CalendarObjectRestoredEvent|CalendarObjectDeletedEvent>
+ */
 class ActivityUpdaterListener implements IEventListener {
 
 	/** @var ActivityBackend */

diff --git a/apps/dav/lib/Listener/AddressbookListener.php b/apps/dav/lib/Listener/AddressbookListener.php
@@ -36,6 +36,9 @@
 use Throwable;
 use function sprintf;
 
+/**
+ * @template-implements IEventListener<AddressBookCreatedEvent|AddressBookUpdatedEvent|AddressBookDeletedEvent|AddressBookShareUpdatedEvent>
+ */
 class AddressbookListener implements IEventListener {
 	/** @var ActivityBackend */
 	private $activityBackend;

diff --git a/apps/dav/lib/Listener/BirthdayListener.php b/apps/dav/lib/Listener/BirthdayListener.php
@@ -32,6 +32,9 @@
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 
+/**
+ * @template-implements IEventListener<CardCreatedEvent|CardUpdatedEvent|CardDeletedEvent>
+ */
 class BirthdayListener implements IEventListener {
 	private BirthdayService $birthdayService;
 

diff --git a/apps/dav/lib/Listener/CalendarContactInteractionListener.php b/apps/dav/lib/Listener/CalendarContactInteractionListener.php
@@ -46,6 +46,9 @@
 use function strpos;
 use function substr;
 
+/**
+ * @template-implements IEventListener<CalendarObjectCreatedEvent|CalendarObjectUpdatedEvent|CalendarShareUpdatedEvent>
+ */
 class CalendarContactInteractionListener implements IEventListener {
 	private const URI_USERS = 'principals/users/';
 

diff --git a/apps/dav/lib/Listener/CalendarDeletionDefaultUpdaterListener.php b/apps/dav/lib/Listener/CalendarDeletionDefaultUpdaterListener.php
@@ -34,7 +34,7 @@
 use function strpos;
 
 /**
- * @template-implements IEventListener<\OCA\DAV\Events\CalendarDeletedEvent>
+ * @template-implements IEventListener<CalendarDeletedEvent>
  */
 class CalendarDeletionDefaultUpdaterListener implements IEventListener {
 

diff --git a/apps/dav/lib/Listener/CalendarObjectReminderUpdaterListener.php b/apps/dav/lib/Listener/CalendarObjectReminderUpdaterListener.php
@@ -42,6 +42,9 @@
 use Throwable;
 use function sprintf;
 
+/**
+ * @template-implements IEventListener<CalendarMovedToTrashEvent>
+ */
 class CalendarObjectReminderUpdaterListener implements IEventListener {
 
 	/** @var ReminderBackend */

diff --git a/apps/dav/lib/Listener/CalendarPublicationListener.php b/apps/dav/lib/Listener/CalendarPublicationListener.php
@@ -32,6 +32,9 @@
 use OCP\EventDispatcher\IEventListener;
 use Psr\Log\LoggerInterface;
 
+/**
+ * @template-implements IEventListener<CalendarPublishedEvent>
+ */
 class CalendarPublicationListener implements IEventListener {
 	private Backend $activityBackend;
 	private LoggerInterface $logger;

diff --git a/apps/dav/lib/Listener/CalendarShareUpdateListener.php b/apps/dav/lib/Listener/CalendarShareUpdateListener.php
@@ -31,6 +31,9 @@
 use OCP\EventDispatcher\IEventListener;
 use Psr\Log\LoggerInterface;
 
+/**
+ * @template-implements IEventListener<CalendarShareUpdatedEvent>
+ */
 class CalendarShareUpdateListener implements IEventListener {
 	private Backend $activityBackend;
 	private LoggerInterface $logger;

diff --git a/apps/dav/lib/Listener/CardListener.php b/apps/dav/lib/Listener/CardListener.php
@@ -36,6 +36,9 @@
 use Throwable;
 use function sprintf;
 
+/**
+ * @template-implements IEventListener<CardCreatedEvent|CardUpdatedEvent|CardDeletedEvent>
+ */
 class CardListener implements IEventListener {
 	/** @var ActivityBackend */
 	private $activityBackend;

diff --git a/apps/dav/lib/Listener/ClearPhotoCacheListener.php b/apps/dav/lib/Listener/ClearPhotoCacheListener.php
@@ -31,6 +31,9 @@
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 
+/**
+ * @template-implements IEventListener<CardUpdatedEvent|CardDeletedEvent>
+ */
 class ClearPhotoCacheListener implements IEventListener {
 	private PhotoCache $photoCache;
 

diff --git a/apps/dav/lib/Listener/SubscriptionListener.php b/apps/dav/lib/Listener/SubscriptionListener.php
@@ -35,6 +35,9 @@
 use OCP\EventDispatcher\IEventListener;
 use Psr\Log\LoggerInterface;
 
+/**
+ * @template-implements IEventListener<SubscriptionCreatedEvent|SubscriptionDeletedEvent>
+ */
 class SubscriptionListener implements IEventListener {
 	private IJobList $jobList;
 	private RefreshWebcalService $refreshWebcalService;

diff --git a/apps/dav/lib/Listener/TrustedServerRemovedListener.php b/apps/dav/lib/Listener/TrustedServerRemovedListener.php
@@ -30,6 +30,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\Federation\Events\TrustedServerRemovedEvent;
 
+/**
+ * @template-implements IEventListener<TrustedServerRemovedEvent>
+ */
 class TrustedServerRemovedListener implements IEventListener {
 	private CardDavBackend $cardDavBackend;
 

diff --git a/apps/dav/lib/Listener/UserPreferenceListener.php b/apps/dav/lib/Listener/UserPreferenceListener.php
@@ -31,6 +31,9 @@
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 
+/**
+ * @template-implements IEventListener<BeforePreferenceSetEvent|BeforePreferenceDeletedEvent>
+ */
 class UserPreferenceListener implements IEventListener {
 
 	protected IJobList $jobList;

diff --git a/apps/federatedfilesharing/lib/Listeners/LoadAdditionalScriptsListener.php b/apps/federatedfilesharing/lib/Listeners/LoadAdditionalScriptsListener.php
@@ -30,6 +30,9 @@
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 
+/**
+ * @template-implements IEventListener<LoadAdditionalScriptsEvent>
+ */
 class LoadAdditionalScriptsListener implements IEventListener {
 	/** @var FederatedShareProvider */
 	protected $federatedShareProvider;

diff --git a/apps/federation/lib/Listener/SabrePluginAuthInitListener.php b/apps/federation/lib/Listener/SabrePluginAuthInitListener.php
@@ -33,6 +33,8 @@
 
 /**
  * @since 20.0.0
+ *
+ * @template-implements IEventListener<SabrePluginAuthInitEvent>
  */
 class SabrePluginAuthInitListener implements IEventListener {
 	private FedAuth $fedAuth;

diff --git a/apps/files/lib/Listener/LegacyLoadAdditionalScriptsAdapter.php b/apps/files/lib/Listener/LegacyLoadAdditionalScriptsAdapter.php
@@ -32,6 +32,9 @@
 use OCP\EventDispatcher\IEventListener;
 use Symfony\Component\EventDispatcher\GenericEvent;
 
+/**
+ * @template-implements IEventListener<LoadAdditionalScriptsEvent>
+ */
 class LegacyLoadAdditionalScriptsAdapter implements IEventListener {
 
 	/** @var SymfonyAdapter */

diff --git a/apps/files/lib/Listener/LoadSidebarListener.php b/apps/files/lib/Listener/LoadSidebarListener.php
@@ -31,6 +31,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\Util;
 
+/**
+ * @template-implements IEventListener<LoadSidebar>
+ */
 class LoadSidebarListener implements IEventListener {
 	public function handle(Event $event): void {
 		if (!($event instanceof LoadSidebar)) {

diff --git a/apps/files/lib/Listener/RenderReferenceEventListener.php b/apps/files/lib/Listener/RenderReferenceEventListener.php
@@ -28,6 +28,9 @@
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 
+/**
+ * @template-implements IEventListener<RenderReferenceEvent>
+ */
 class RenderReferenceEventListener implements IEventListener {
 	public function handle(Event $event): void {
 		if (!$event instanceof RenderReferenceEvent) {

diff --git a/apps/files_external/lib/Listener/GroupDeletedListener.php b/apps/files_external/lib/Listener/GroupDeletedListener.php
@@ -28,6 +28,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\Group\Events\GroupDeletedEvent;
 
+/**
+ * @template-implements IEventListener<GroupDeletedEvent>
+ */
 class GroupDeletedListener implements IEventListener {
 	/** @var DBConfigService */
 	private $config;

diff --git a/apps/files_external/lib/Listener/StorePasswordListener.php b/apps/files_external/lib/Listener/StorePasswordListener.php
@@ -33,6 +33,9 @@
 use OCP\User\Events\PasswordUpdatedEvent;
 use OCP\User\Events\UserLoggedInEvent;
 
+/**
+ * @template-implements IEventListener<UserLoggedInEvent|PasswordUpdatedEvent>
+ */
 class StorePasswordListener implements IEventListener {
 	/** @var ICredentialsManager */
 	private $credentialsManager;

diff --git a/apps/files_external/lib/Listener/UserDeletedListener.php b/apps/files_external/lib/Listener/UserDeletedListener.php
@@ -28,6 +28,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\User\Events\UserDeletedEvent;
 
+/**
+ * @template-implements IEventListener<UserDeletedEvent>
+ */
 class UserDeletedListener implements IEventListener {
 	/** @var DBConfigService */
 	private $config;

diff --git a/apps/files_sharing/lib/Listener/LegacyBeforeTemplateRenderedListener.php b/apps/files_sharing/lib/Listener/LegacyBeforeTemplateRenderedListener.php
@@ -31,6 +31,9 @@
 use OCP\EventDispatcher\IEventListener;
 use Symfony\Component\EventDispatcher\GenericEvent;
 
+/**
+ * @template-implements IEventListener<BeforeTemplateRenderedEvent>
+ */
 class LegacyBeforeTemplateRenderedListener implements IEventListener {
 
 	/** @var SymfonyAdapter */

diff --git a/apps/files_sharing/lib/Listener/LoadAdditionalListener.php b/apps/files_sharing/lib/Listener/LoadAdditionalListener.php
@@ -31,6 +31,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\Util;
 
+/**
+ * @template-implements IEventListener<LoadAdditionalScriptsEvent>
+ */
 class LoadAdditionalListener implements IEventListener {
 	public function handle(Event $event): void {
 		if (!($event instanceof LoadAdditionalScriptsEvent)) {

diff --git a/apps/files_sharing/lib/Listener/LoadSidebarListener.php b/apps/files_sharing/lib/Listener/LoadSidebarListener.php
@@ -31,6 +31,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\Util;
 
+/**
+ * @template-implements IEventListener<LoadSidebar>
+ */
 class LoadSidebarListener implements IEventListener {
 	public function handle(Event $event): void {
 		if (!($event instanceof LoadSidebar)) {

diff --git a/apps/files_sharing/lib/Listener/ShareInteractionListener.php b/apps/files_sharing/lib/Listener/ShareInteractionListener.php
@@ -36,6 +36,9 @@
 use OCP\Share\IShare;
 use function in_array;
 
+/**
+ * @template-implements IEventListener<ShareCreatedEvent>
+ */
 class ShareInteractionListener implements IEventListener {
 	private const SUPPORTED_SHARE_TYPES = [
 		IShare::TYPE_USER,

diff --git a/apps/files_sharing/lib/Listener/UserAddedToGroupListener.php b/apps/files_sharing/lib/Listener/UserAddedToGroupListener.php
@@ -33,6 +33,9 @@
 use OCP\Share\IManager;
 use OCP\Share\IShare;
 
+/**
+ * @template-implements IEventListener<UserAddedEvent>
+ */
 class UserAddedToGroupListener implements IEventListener {
 
 	/** @var IManager */

diff --git a/apps/files_sharing/lib/Listener/UserShareAcceptanceListener.php b/apps/files_sharing/lib/Listener/UserShareAcceptanceListener.php
@@ -36,6 +36,9 @@
 use OCP\Share\IManager;
 use OCP\Share\IShare;
 
+/**
+ * @template-implements IEventListener<ShareCreatedEvent>
+ */
 class UserShareAcceptanceListener implements IEventListener {
 
 	/** @var IConfig */

diff --git a/apps/files_versions/lib/Listener/FileEventsListener.php b/apps/files_versions/lib/Listener/FileEventsListener.php
@@ -58,6 +58,9 @@
 use OCP\Files\IRootFolder;
 use OCP\Files\Node;
 
+/**
+ * @template-implements IEventListener<NodeCreatedEvent|BeforeNodeTouchedEvent|NodeTouchedEvent|BeforeNodeWrittenEvent|NodeWrittenEvent|BeforeNodeDeletedEvent|NodeDeletedEvent|NodeRenamedEvent|NodeCopiedEvent|BeforeNodeRenamedEvent>
+ */
 class FileEventsListener implements IEventListener {
 	private IRootFolder $rootFolder;
 	private VersionsMapper $versionsMapper;

diff --git a/apps/files_versions/lib/Listener/LoadAdditionalListener.php b/apps/files_versions/lib/Listener/LoadAdditionalListener.php
@@ -33,6 +33,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\Util;
 
+/**
+ * @template-implements IEventListener<LoadAdditionalScriptsEvent>
+ */
 class LoadAdditionalListener implements IEventListener {
 	public function handle(Event $event): void {
 		if (!($event instanceof LoadAdditionalScriptsEvent)) {

diff --git a/apps/files_versions/lib/Listener/LoadSidebarListener.php b/apps/files_versions/lib/Listener/LoadSidebarListener.php
@@ -33,6 +33,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\Util;
 
+/**
+ * @template-implements IEventListener<LoadSidebar>
+ */
 class LoadSidebarListener implements IEventListener {
 	public function handle(Event $event): void {
 		if (!($event instanceof LoadSidebar)) {

diff --git a/apps/provisioning_api/lib/Listener/UserDeletedListener.php b/apps/provisioning_api/lib/Listener/UserDeletedListener.php
@@ -30,6 +30,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\User\Events\UserDeletedEvent;
 
+/**
+ * @template-implements IEventListener<UserDeletedEvent>
+ */
 class UserDeletedListener implements IEventListener {
 
 	/** @var KnownUserService */

diff --git a/apps/settings/lib/Listener/GroupRemovedListener.php b/apps/settings/lib/Listener/GroupRemovedListener.php
@@ -28,6 +28,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\Group\Events\GroupDeletedEvent;
 
+/**
+ * @template-implements IEventListener<GroupDeletedEvent>
+ */
 class GroupRemovedListener implements IEventListener {
 
 	/** @var AuthorizedGroupService $authorizedGroupService */

diff --git a/apps/settings/lib/Listener/UserAddedToGroupActivityListener.php b/apps/settings/lib/Listener/UserAddedToGroupActivityListener.php
@@ -34,6 +34,9 @@
 use OCP\IUser;
 use OCP\IUserSession;
 
+/**
+ * @template-implements IEventListener<UserAddedEvent>
+ */
 class UserAddedToGroupActivityListener implements IEventListener {
 
 	/** @var Manager */

diff --git a/apps/settings/lib/Listener/UserRemovedFromGroupActivityListener.php b/apps/settings/lib/Listener/UserRemovedFromGroupActivityListener.php
@@ -34,6 +34,9 @@
 use OCP\IUser;
 use OCP\IUserSession;
 
+/**
+ * @template-implements IEventListener<UserRemovedEvent>
+ */
 class UserRemovedFromGroupActivityListener implements IEventListener {
 
 	/** @var Manager */

diff --git a/apps/theming/lib/Listener/BeforePreferenceListener.php b/apps/theming/lib/Listener/BeforePreferenceListener.php
@@ -31,6 +31,9 @@
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 
+/**
+ * @template-implements IEventListener<BeforePreferenceSetEvent|BeforePreferenceDeletedEvent>
+ */
 class BeforePreferenceListener implements IEventListener {
 	public function handle(Event $event): void {
 		if (!$event instanceof BeforePreferenceSetEvent