From e646d7d5a9ba8c8cf5c09bc0b67b66d7b162e52b Mon Sep 17 00:00:00 2001 From: Christoph Wurst Date: Thu, 15 Oct 2020 16:23:26 +0200 Subject: [PATCH] Add psalm types for the event dispatcher Signed-off-by: Christoph Wurst --- .../AppFramework/Bootstrap/IRegistrationContext.php | 5 +++-- lib/public/EventDispatcher/IEventDispatcher.php | 10 ++++++++++ lib/public/EventDispatcher/IEventListener.php | 3 +++ 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/lib/public/AppFramework/Bootstrap/IRegistrationContext.php b/lib/public/AppFramework/Bootstrap/IRegistrationContext.php index b164fda5e6..aaf5ef00bf 100644 --- a/lib/public/AppFramework/Bootstrap/IRegistrationContext.php +++ b/lib/public/AppFramework/Bootstrap/IRegistrationContext.php @@ -113,10 +113,11 @@ interface IRegistrationContext { * * This is equivalent to calling IEventDispatcher::addServiceListener * + * @template T of \OCP\EventDispatcher\Event * @param string $event preferably the fully-qualified class name of the Event sub class to listen for - * @psalm-param string|class-string<\OCP\EventDispatcher\Event> $event preferably the fully-qualified class name of the Event sub class to listen for + * @psalm-param string|class-string $event preferably the fully-qualified class name of the Event sub class to listen for * @param string $listener fully qualified class name (or ::class notation) of a \OCP\EventDispatcher\IEventListener that can be built by the DI container - * @psalm-param class-string<\OCP\EventDispatcher\IEventListener> $listener fully qualified class name that can be built by the DI container + * @psalm-param class-string<\OCP\EventDispatcher\IEventListener> $listener fully qualified class name that can be built by the DI container * @param int $priority * * @see IEventDispatcher::addServiceListener() diff --git a/lib/public/EventDispatcher/IEventDispatcher.php b/lib/public/EventDispatcher/IEventDispatcher.php index 997834ad7b..471447e4b9 100644 --- a/lib/public/EventDispatcher/IEventDispatcher.php +++ b/lib/public/EventDispatcher/IEventDispatcher.php @@ -35,7 +35,9 @@ namespace OCP\EventDispatcher; interface IEventDispatcher { /** + * @template T of \OCP\EventDispatcher\Event * @param string $eventName preferably the fully-qualified class name of the Event sub class + * @psalm-param string|class-string $eventName preferably the fully-qualified class name of the Event sub class * @param callable $listener the object that is invoked when a matching event is dispatched * @param int $priority * @@ -44,7 +46,9 @@ interface IEventDispatcher { public function addListener(string $eventName, callable $listener, int $priority = 0): void; /** + * @template T of \OCP\EventDispatcher\Event * @param string $eventName preferably the fully-qualified class name of the Event sub class + * @psalm-param string|class-string $eventName preferably the fully-qualified class name of the Event sub class * @param callable $listener the object that is invoked when a matching event is dispatched * * @since 19.0.0 @@ -52,8 +56,11 @@ interface IEventDispatcher { public function removeListener(string $eventName, callable $listener): void; /** + * @template T of \OCP\EventDispatcher\Event * @param string $eventName preferably the fully-qualified class name of the Event sub class to listen for + * @psalm-param string|class-string $eventName preferably the fully-qualified class name of the Event sub class to listen for * @param string $className fully qualified class name (or ::class notation) of a \OCP\EventDispatcher\IEventListener that can be built by the DI container + * @psalm-param class-string<\OCP\EventDispatcher\IEventListener> $className fully qualified class name that can be built by the DI container * @param int $priority * * @since 17.0.0 @@ -61,8 +68,11 @@ interface IEventDispatcher { public function addServiceListener(string $eventName, string $className, int $priority = 0): void; /** + * @template T of \OCP\EventDispatcher\Event * @param string $eventName + * @psalm-param string|class-string $eventName * @param Event $event + * @psalm-param T $event * * @since 17.0.0 */ diff --git a/lib/public/EventDispatcher/IEventListener.php b/lib/public/EventDispatcher/IEventListener.php index 25906fa798..fcf44133af 100644 --- a/lib/public/EventDispatcher/IEventListener.php +++ b/lib/public/EventDispatcher/IEventListener.php @@ -28,11 +28,14 @@ namespace OCP\EventDispatcher; /** * @since 17.0.0 + * + * @template T of Event */ interface IEventListener { /** * @param Event $event + * @psalm-param T $event * * @since 17.0.0 */