Merge pull request #1597 from schmittjoh/type-array-phpstan-type

Add PHPStan type for JMS serialization Type

Author: scyzoryck

src/AbstractVisitor.php

@@ -7,9 +7,12 @@
 use JMS\Serializer\Exception\NonFloatCastableTypeException;
 use JMS\Serializer\Exception\NonIntCastableTypeException;
 use JMS\Serializer\Exception\NonStringCastableTypeException;
+use JMS\Serializer\Type\Type;
 
 /**
  * @internal
+ *
+ * @phpstan-import-type TypeArray from Type
  */
 abstract class AbstractVisitor implements VisitorInterface
 {
@@ -31,6 +34,9 @@ public function prepare($data)
         return $data;
     }
 
+    /**
+     * @param TypeArray $typeArray
+     */
     protected function getElementType(array $typeArray): ?array
     {
         if (false === isset($typeArray['params'][0])) {

src/Construction/ObjectConstructorInterface.php

@@ -6,12 +6,15 @@
 
 use JMS\Serializer\DeserializationContext;
 use JMS\Serializer\Metadata\ClassMetadata;
+use JMS\Serializer\Type\Type;
 use JMS\Serializer\Visitor\DeserializationVisitorInterface;
 
 /**
  * Implementations of this interface construct new objects during deserialization.
  *
  * @author Johannes M. Schmitt <[email protected]>
+ *
+ * @phpstan-import-type TypeArray from Type
  */
 interface ObjectConstructorInterface
 {
@@ -22,7 +25,7 @@ interface ObjectConstructorInterface
      * "unserialize" techniques, reflection, or other means.
      *
      * @param mixed $data
-     * @param array $type ["name" => string, "params" => array]
+     * @param TypeArray $type
      */
     public function construct(DeserializationVisitorInterface $visitor, ClassMetadata $metadata, $data, array $type, DeserializationContext $context): ?object;
 }

src/EventDispatcher/Event.php

@@ -5,8 +5,12 @@
 namespace JMS\Serializer\EventDispatcher;
 
 use JMS\Serializer\Context;
+use JMS\Serializer\Type\Type;
 use JMS\Serializer\VisitorInterface;
 
+/**
+ * @phpstan-import-type TypeArray from Type
+ */
 class Event
 {
     /**
@@ -15,7 +19,7 @@ class Event
     private $propagationStopped = false;
 
     /**
-     * @var array
+     * @var TypeArray
      */
     protected $type;
 
@@ -24,6 +28,9 @@ class Event
      */
     private $context;
 
+    /**
+     * @param TypeArray $type
+     */
     public function __construct(Context $context, array $type)
     {
         $this->context = $context;

src/EventDispatcher/ObjectEvent.php

@@ -5,7 +5,11 @@
 namespace JMS\Serializer\EventDispatcher;
 
 use JMS\Serializer\Context;
+use JMS\Serializer\Type\Type;
 
+/**
+ * @phpstan-import-type TypeArray from Type
+ */
 class ObjectEvent extends Event
 {
     /**
@@ -15,6 +19,7 @@ class ObjectEvent extends Event
 
     /**
      * @param mixed $object
+     * @param TypeArray $type
      */
     public function __construct(Context $context, $object, array $type)
     {

src/EventDispatcher/PreDeserializeEvent.php

@@ -5,7 +5,11 @@
 namespace JMS\Serializer\EventDispatcher;
 
 use JMS\Serializer\DeserializationContext;
+use JMS\Serializer\Type\Type;
 
+/**
+ * @phpstan-import-type TypeArray from Type
+ */
 class PreDeserializeEvent extends Event
 {
     /**
@@ -15,7 +19,7 @@ class PreDeserializeEvent extends Event
 
     /**
      * @param mixed $data
-     * @param array $type
+     * @param TypeArray $type
      */
     public function __construct(DeserializationContext $context, $data, array $type)
     {

src/Exception/NonVisitableTypeException.php

@@ -4,13 +4,18 @@
 
 namespace JMS\Serializer\Exception;
 
+use JMS\Serializer\Type\Type;
+
 use function get_debug_type;
 
+/**
+ * @phpstan-import-type TypeArray from Type
+ */
 final class NonVisitableTypeException extends RuntimeException
 {
     /**
      * @param mixed $data
-     * @param array{name: string} $type
+     * @param TypeArray $type
      * @param RuntimeException|null $previous
      *
      * @return NonVisitableTypeException

src/GraphNavigator/DeserializationGraphNavigator.php

@@ -23,6 +23,7 @@
 use JMS\Serializer\Handler\HandlerRegistryInterface;
 use JMS\Serializer\Metadata\ClassMetadata;
 use JMS\Serializer\NullAwareVisitorInterface;
+use JMS\Serializer\Type\Type;
 use JMS\Serializer\Visitor\DeserializationVisitorInterface;
 use Metadata\MetadataFactoryInterface;
 
@@ -33,6 +34,8 @@
  * on visitors, or custom handlers to process its nodes.
  *
  * @author Johannes M. Schmitt <[email protected]>
+ *
+ * @phpstan-import-type TypeArray from Type
  */
 final class DeserializationGraphNavigator extends GraphNavigator implements GraphNavigatorInterface
 {
@@ -97,7 +100,7 @@ public function __construct(
      * Called for each node of the graph that is being traversed.
      *
      * @param mixed $data the data depends on the direction, and type of visitor
-     * @param array|null $type array has the format ["name" => string, "params" => array]
+     * @param TypeArray|null $type array has the format ["name" => string, "params" => array]
      *
      * @return mixed the return value depends on the direction, and type of visitor
      */
@@ -252,6 +255,9 @@ private function resolveMetadata($data, ClassMetadata $metadata): ?ClassMetadata
         return $this->metadataFactory->getMetadataForClass($metadata->discriminatorMap[$typeValue]);
     }
 
+    /**
+     * @param TypeArray $type
+     */
     private function afterVisitingObject(ClassMetadata $metadata, object $object, array $type): void
     {
         $this->context->decreaseDepth();

src/GraphNavigator/SerializationGraphNavigator.php

@@ -27,6 +27,7 @@
 use JMS\Serializer\Metadata\ClassMetadata;
 use JMS\Serializer\NullAwareVisitorInterface;
 use JMS\Serializer\SerializationContext;
+use JMS\Serializer\Type\Type;
 use JMS\Serializer\Visitor\SerializationVisitorInterface;
 use JMS\Serializer\VisitorInterface;
 use Metadata\MetadataFactoryInterface;
@@ -40,6 +41,8 @@
  * on visitors, or custom handlers to process its nodes.
  *
  * @author Johannes M. Schmitt <[email protected]>
+ *
+ * @phpstan-import-type TypeArray from Type
  */
 final class SerializationGraphNavigator extends GraphNavigator
 {
@@ -112,7 +115,7 @@ public function initialize(VisitorInterface $visitor, Context $context): void
      * Called for each node of the graph that is being traversed.
      *
      * @param mixed $data the data depends on the direction, and type of visitor
-     * @param array|null $type array has the format ["name" => string, "params" => array]
+     * @param TypeArray|null $type array has the format ["name" => string, "params" => array]
      *
      * @return mixed the return value depends on the direction, and type of visitor
      */
@@ -296,6 +299,9 @@ private function isRootNullAllowed(): bool
         return $this->context->hasAttribute('allows_root_null') && $this->context->getAttribute('allows_root_null') && 0 === $this->context->getVisitingSet()->count();
     }
 
+    /**
+     * @param TypeArray $type
+     */
     private function afterVisitingObject(ClassMetadata $metadata, object $object, array $type): void
     {
         $this->context->stopVisiting($object);

src/GraphNavigatorInterface.php

@@ -5,7 +5,11 @@
 namespace JMS\Serializer;
 
 use JMS\Serializer\Exception\NotAcceptableException;
+use JMS\Serializer\Type\Type;
 
+/**
+ * @phpstan-import-type TypeArray from Type
+ */
 interface GraphNavigatorInterface
 {
     public const DIRECTION_SERIALIZATION = 1;
@@ -21,7 +25,7 @@ public function initialize(VisitorInterface $visitor, Context $context): void;
      * Called for each node of the graph that is being traversed.
      *
      * @param mixed $data the data depends on the direction, and type of visitor
-     * @param array|null $type array has the format ["name" => string, "params" => array]
+     * @param TypeArray|null $type array has the format ["name" => string, "params" => array]
      *
      * @return mixed the return value depends on the direction, and type of visitor
      *

src/Handler/ArrayCollectionHandler.php

@@ -14,9 +14,13 @@
 use JMS\Serializer\GraphNavigatorInterface;
 use JMS\Serializer\Metadata\PropertyMetadata;
 use JMS\Serializer\SerializationContext;
+use JMS\Serializer\Type\Type;
 use JMS\Serializer\Visitor\DeserializationVisitorInterface;
 use JMS\Serializer\Visitor\SerializationVisitorInterface;
 
+/**
+ * @phpstan-import-type TypeArray from Type
+ */
 final class ArrayCollectionHandler implements SubscribingHandlerInterface
 {
     public const COLLECTION_TYPES = [
@@ -75,6 +79,8 @@ public static function getSubscribingMethods()
     }
 
     /**
+     * @param TypeArray $type
+     *
      * @return array|\ArrayObject
      */
     public function serializeCollection(SerializationVisitorInterface $visitor, Collection $collection, array $type, SerializationContext $context)
@@ -102,6 +108,7 @@ public function serializeCollection(SerializationVisitorInterface $visitor, Coll
 
     /**
      * @param mixed $data
+     * @param TypeArray $type
      */
     public function deserializeCollection(
         DeserializationVisitorInterface $visitor,