Add support for PHP8 and phpstan

.travis.yml

@@ -5,6 +5,7 @@ dist: bionic
 language: php
 php:
     - '7.4'
+    - '8.0'
 
 
 before_script: 

LICENSE.MD

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Platine
+Copyright (c) 2020 Platine Event Dispatcher
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

composer.json

@@ -24,10 +24,10 @@
 
     "require-dev": {
         "phpmd/phpmd": "@stable",
-        "phpunit/phpunit": "^9",
-        "platine-php/test-tools": "1.0.x-dev",
+        "phpunit/phpunit": "^9.5",
+        "platine-php/dev": "1.0.x-dev",
         "squizlabs/php_codesniffer": "3.*",
-        "vimeo/psalm": "4.x-dev"
+        "phpstan/phpstan": "0.12.x-dev"
     },
 
     "autoload": {
@@ -55,11 +55,12 @@
 
     "scripts": {
         "test": "phpunit --colors=always",
-        "static": "psalm",
+        "static": "phpstan analyze",
         "check": "phpcs",
         "check-fix": "phpcbf",
         "analyze": "phpmd src xml phpmd.xml"
     },
 
-    "minimum-stability": "dev"
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }

phpstan.neon.dist

@@ -0,0 +1,7 @@
+parameters:
+    level: 8
+    paths:
+        - src
+    parallel:
+        jobSize: 50
+        maximumNumberOfProcesses: 4

src/CallableListener.php

@@ -57,7 +57,7 @@ class CallableListener implements ListenerInterface
 
     /**
      * The listeners
-     * @var array
+     * @var array<$this>
      */
     protected static $listeners = [];
 
@@ -87,7 +87,8 @@ public function getCallable(): callable
      */
     public static function fromCallable(callable $callable): self
     {
-        $listener = new static($callable);
+        $listener = new self($callable);
+
         return $listener;
     }
 
@@ -103,6 +104,7 @@ public static function getListener(callable $callable)
                 return $listener;
             }
         }
+
         return false;
     }
 

src/Dispatcher.php

@@ -53,7 +53,7 @@ class Dispatcher implements DispatcherInterface
 
     /**
      * The list of listener
-     * @var array
+     * @var array<string, ListenerPriorityQueue>
      */
     protected array $listeners = [];
 
@@ -67,11 +67,13 @@ public function dispatch($eventName, EventInterface $event = null): void
         } elseif (is_null($event)) {
             $event = new Event($eventName);
         }
+
         if (isset($this->listeners[$event->getName()])) {
             foreach ($this->listeners[$event->getName()] as $listener) {
                 if ($event->isStopPropagation()) {
                     break;
                 }
+
                 ([$listener, 'handle'])($event);
             }
         }
@@ -88,15 +90,18 @@ public function addListener(
         if (!isset($this->listeners[$eventName])) {
             $this->listeners[$eventName] = new ListenerPriorityQueue();
         }
+
         if (is_callable($listener)) {
             $listener = CallableListener::fromCallable($listener);
         }
+
         if (!$listener instanceof ListenerInterface) {
             throw new DispatcherException(
                 'The listener should be the implementation of '
                             . 'the ListenerInterface or callable'
             );
         }
+
         $this->listeners[$eventName]->insert($listener, $priority);
     }
 
@@ -118,9 +123,15 @@ public function removeListener(string $eventName, $listener): void
         if (empty($this->listeners[$eventName])) {
             return;
         }
-        if (is_callable($listener) && ($listener = CallableListener::getListener($listener)) === false) {
+
+        if (is_callable($listener)) {
+            $listener = CallableListener::getListener($listener);
+        }
+
+        if ($listener === false) {
             return;
         }
+
         $this->listeners[$eventName]->detach($listener);
     }
 
@@ -156,9 +167,15 @@ public function hasListener(string $eventName, $listener): bool
         if (!isset($this->listeners[$eventName])) {
             return false;
         }
+
         if (is_callable($listener)) {
             $listener = CallableListener::getListener($listener);
         }
+
+        if ($listener === false) {
+            return false;
+        }
+
         return $this->listeners[$eventName]->contains($listener);
     }
 
@@ -168,12 +185,15 @@ public function hasListener(string $eventName, $listener): bool
     public function getListeners(string $eventName = null): array
     {
         if (!is_null($eventName)) {
-            return isset($this->listeners[$eventName]) ? $this->listeners[$eventName]->all() : [];
+            return isset($this->listeners[$eventName])
+                    ? $this->listeners[$eventName]->all()
+                    : [];
         } else {
             $listeners = [];
             foreach ($this->listeners as $queue) {
                 $listeners = array_merge($listeners, $queue->all());
             }
+
             return $listeners;
         }
     }

src/DispatcherInterface.php

@@ -46,6 +46,8 @@
 
 namespace Platine\Event;
 
+use SplPriorityQueue;
+
 interface DispatcherInterface
 {
 
@@ -79,17 +81,21 @@ public function dispatch($eventName, EventInterface $event = null): void;
      * Register a listener for the given event.
      *
      * @param string $eventName the name of event
-     * @param ListenerInterface|callable $listener the ListenerInterface or any callable
+     * @param ListenerInterface|callable $listener the Listener interface or any callable
      * @param int $priority the listener execution priority
      */
-    public function addListener(string $eventName, $listener, int $priority = self::PRIORITY_DEFAULT): void;
+    public function addListener(
+        string $eventName,
+        $listener,
+        int $priority = self::PRIORITY_DEFAULT
+    ): void;
 
     /**
      * Register a subscriber.
      *
-     * @param subscriberInterface $subscriber the subscriberInterface instance
+     * @param SubscriberInterface $subscriber the subscriberInterface instance
      */
-    public function addSubscriber(subscriberInterface $subscriber): void;
+    public function addSubscriber(SubscriberInterface $subscriber): void;
 
     /**
      * Remove a listener for the given event.
@@ -102,9 +108,9 @@ public function removeListener(string $eventName, $listener): void;
     /**
      * Remove a subscriber.
      *
-     * @param subscriberInterface $subscriber the subscriberInterface instance
+     * @param SubscriberInterface $subscriber the subscriberInterface instance
      */
-    public function removeSubscriber(subscriberInterface $subscriber): void;
+    public function removeSubscriber(SubscriberInterface $subscriber): void;
 
     /**
      * Remove all listener for the given event.
@@ -127,7 +133,7 @@ public function hasListener(string $eventName, $listener): bool;
      * Get all listeners for the given event or all registered listeners.
      *
      * @param string $eventName the name of event
-     * @return array
+     * @return SplPriorityQueue<int, ListenerInterface>[]
      */
     public function getListeners(string $eventName = null): array;
 }

src/Event.php

@@ -58,7 +58,7 @@ class Event implements EventInterface
 
     /**
      * The event data
-     * @var array
+     * @var array<string, mixed>
      */
     protected array $arguments = [];
 
@@ -71,7 +71,7 @@ class Event implements EventInterface
     /**
      * Create the new instance of the Event
      * @param string $name       the event name
-     * @param array  $arguments the event data
+     * @param array<string, mixed>  $arguments the event data
      */
     public function __construct(string $name, array $arguments = [])
     {
@@ -102,7 +102,7 @@ public function setName(string $name): self
 
     /**
      * Get all event data or arguments.
-     * @return array
+     * @return array<string, mixed>
      */
     public function getArguments(): array
     {
@@ -112,9 +112,9 @@ public function getArguments(): array
     /**
      * Set array of arguments.
      *
-     * @param array $arguments
+     * @param array<string, mixed> $arguments
      *
-     * @return self
+     * @return $this
      */
     public function setArguments(array $arguments): self
     {
@@ -125,11 +125,13 @@ public function setArguments(array $arguments): self
     /**
      * Get event data for the given key.
      * @param string $key
-     * @return mixed
+     * @return mixed|null
      */
     public function getArgument(string $key)
     {
-        return array_key_exists($key, $this->arguments) ? $this->arguments[$key] : null;
+        return array_key_exists($key, $this->arguments)
+               ? $this->arguments[$key]
+                : null;
     }
 
     /**
@@ -138,7 +140,7 @@ public function getArgument(string $key)
      * @param string $key
      * @param mixed $value the event value
      *
-     * @return self
+     * @return $this
      */
     public function setArgument(string $key, $value): self
     {
@@ -160,6 +162,7 @@ public function isStopPropagation(): bool
     public function stopPropagation(): self
     {
         $this->stopPropagation = true;
+
         return $this;
     }
 }