mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add psalm types for the event dispatcher 

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
This commit is contained in:
Christoph Wurst 2020-10-15 16:23:26 +02:00 committed by backportbot[bot]
parent 904396c5d2
commit dff399973f
3 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/public/AppFramework/Bootstrap/IRegistrationContext.php
View File

@ -113,10 +113,11 @@ interface IRegistrationContext {
* *
* This is equivalent to calling IEventDispatcher::addServiceListener * 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 * @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<T> $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 * @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<T>> $listener fully qualified class name that can be built by the DI container
* @param int $priority * @param int $priority
* *
* @see IEventDispatcher::addServiceListener() * @see IEventDispatcher::addServiceListener()

10
lib/public/EventDispatcher/IEventDispatcher.php
View File

@ -35,7 +35,9 @@ namespace OCP\EventDispatcher;
interface IEventDispatcher { interface IEventDispatcher {
/** /**
* @template T of \OCP\EventDispatcher\Event
* @param string $eventName preferably the fully-qualified class name of the Event sub class * @param string $eventName preferably the fully-qualified class name of the Event sub class
* @psalm-param string|class-string<T> $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 callable $listener the object that is invoked when a matching event is dispatched
* @param int $priority * @param int $priority
* *
@ -44,7 +46,9 @@ interface IEventDispatcher {
public function addListener(string $eventName, callable $listener, int $priority = 0): void; 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 * @param string $eventName preferably the fully-qualified class name of the Event sub class
* @psalm-param string|class-string<T> $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 callable $listener the object that is invoked when a matching event is dispatched
* *
* @since 19.0.0 * @since 19.0.0
@ -52,8 +56,11 @@ interface IEventDispatcher {
public function removeListener(string $eventName, callable $listener): void; 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 * @param string $eventName preferably the fully-qualified class name of the Event sub class to listen for
* @psalm-param string|class-string<T> $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 * @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<T>> $className fully qualified class name that can be built by the DI container
* @param int $priority * @param int $priority
* *
* @since 17.0.0 * @since 17.0.0
@ -61,8 +68,11 @@ interface IEventDispatcher {
public function addServiceListener(string $eventName, string $className, int $priority = 0): void; public function addServiceListener(string $eventName, string $className, int $priority = 0): void;
/** /**
* @template T of \OCP\EventDispatcher\Event
* @param string $eventName * @param string $eventName
* @psalm-param string|class-string<T> $eventName
* @param Event $event * @param Event $event
* @psalm-param T $event
* *
* @since 17.0.0 * @since 17.0.0
*/ */

3
lib/public/EventDispatcher/IEventListener.php
View File

@ -28,11 +28,14 @@ namespace OCP\EventDispatcher;
/** /**
* @since 17.0.0 * @since 17.0.0
*
* @template T of Event
*/ */
interface IEventListener { interface IEventListener {
/** /**
* @param Event $event * @param Event $event
* @psalm-param T $event
* *
* @since 17.0.0 * @since 17.0.0
*/ */