Make SubscribingHandlerInterface::getSubscribingMethods() return iter…

…able
schmittjoh · Jul 4, 2020 · a45c665 · a45c665
1 parent c3fbc76
commit a45c665
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 11 deletions.
diff --git a/src/Handler/ArrayCollectionHandler.php b/src/Handler/ArrayCollectionHandler.php
@@ -27,7 +27,7 @@ public function __construct(bool $initializeExcluded = true)
     /**
      * {@inheritdoc}
      */
-    public static function getSubscribingMethods()
+    public static function getSubscribingMethods(): iterable
     {
         $methods = [];
         $formats = ['json', 'xml', 'yml'];

diff --git a/src/Handler/ConstraintViolationHandler.php b/src/Handler/ConstraintViolationHandler.php
@@ -16,7 +16,7 @@ final class ConstraintViolationHandler implements SubscribingHandlerInterface
     /**
      * {@inheritdoc}
      */
-    public static function getSubscribingMethods()
+    public static function getSubscribingMethods(): iterable
     {
         $methods = [];
         $formats = ['xml', 'json'];

diff --git a/src/Handler/DateHandler.php b/src/Handler/DateHandler.php
@@ -31,7 +31,7 @@ final class DateHandler implements SubscribingHandlerInterface
     /**
      * {@inheritdoc}
      */
-    public static function getSubscribingMethods()
+    public static function getSubscribingMethods(): iterable
     {
         $methods = [];
         $types = ['DateTime', 'DateTimeImmutable', 'DateInterval'];

diff --git a/src/Handler/FormErrorHandler.php b/src/Handler/FormErrorHandler.php
@@ -28,7 +28,7 @@ final class FormErrorHandler implements SubscribingHandlerInterface
     /**
      * {@inheritdoc}
      */
-    public static function getSubscribingMethods()
+    public static function getSubscribingMethods(): iterable
     {
         $methods = [];
         foreach (['xml', 'json'] as $format) {

diff --git a/src/Handler/IteratorHandler.php b/src/Handler/IteratorHandler.php
@@ -21,7 +21,7 @@ final class IteratorHandler implements SubscribingHandlerInterface
     /**
      * {@inheritdoc}
      */
-    public static function getSubscribingMethods()
+    public static function getSubscribingMethods(): iterable
     {
         $methods = [];
 

diff --git a/src/Handler/StdClassHandler.php b/src/Handler/StdClassHandler.php
@@ -17,7 +17,7 @@ final class StdClassHandler implements SubscribingHandlerInterface
     /**
      * {@inheritdoc}
      */
-    public static function getSubscribingMethods()
+    public static function getSubscribingMethods(): iterable
     {
         $methods = [];
         $formats = ['json', 'xml', 'yml'];

diff --git a/src/Handler/SubscribingHandlerInterface.php b/src/Handler/SubscribingHandlerInterface.php
@@ -20,9 +20,7 @@ interface SubscribingHandlerInterface
      *
      * The direction and method keys can be omitted.
      *
-     * @return array
-     *
-     * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingReturnTypeHint
+     * @return iterable<string, int|string>
      */
-    public static function getSubscribingMethods();
+    public static function getSubscribingMethods(): iterable;
 }
diff --git a/tests/Serializer/GraphNavigatorTest.php b/tests/Serializer/GraphNavigatorTest.php
@@ -209,7 +209,7 @@ class TestSubscribingHandler implements SubscribingHandlerInterface
 {
     public const FORMAT = 'foo';
 
-    public static function getSubscribingMethods()
+    public static function getSubscribingMethods(): iterable
     {
         return [
             [