qa: set Psalm baseline and apply autofixes

Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
laminas-api-tools · Mar 2, 2021 · e52c8df · e52c8df
1 parent 41b1a4c
commit e52c8df
Show file tree

Hide file tree

Showing 24 changed files with 1,763 additions and 108 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -4,6 +4,7 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    errorBaseline="psalm-baseline.xml"
 >
     <projectFiles>
         <directory name="config"/>

diff --git a/src/Collection.php b/src/Collection.php
@@ -525,7 +525,7 @@ public function getCollectionRoute()
     /**
      * Collection Route Options
      *
-     * @return string
+     * @return array
      */
     public function getCollectionRouteOptions()
     {
@@ -535,7 +535,7 @@ public function getCollectionRouteOptions()
     /**
      * Collection Route Params
      *
-     * @return string
+     * @return array
      */
     public function getCollectionRouteParams()
     {

diff --git a/src/EntityHydratorManager.php b/src/EntityHydratorManager.php
@@ -122,6 +122,7 @@ public function getHydratorForEntity($entity)
 
         if ($this->metadataMap->has($entity)) {
             $metadata = $this->metadataMap->get($class);
+            /** @psalm-suppress PossiblyFalseReference */
             $hydrator = $metadata->getHydrator();
             if ($hydrator instanceof ExtractionInterface) {
                 $this->addHydrator($class, $hydrator);

diff --git a/src/Extractor/LinkCollectionExtractor.php b/src/Extractor/LinkCollectionExtractor.php
@@ -33,6 +33,9 @@ public function getLinkExtractor()
         return $this->linkExtractor;
     }
 
+    /**
+     * @return void
+     */
     public function setLinkExtractor(LinkExtractorInterface $linkExtractor)
     {
         $this->linkExtractor = $linkExtractor;

diff --git a/src/Link/PaginationInjector.php b/src/Link/PaginationInjector.php
@@ -45,7 +45,7 @@ public function injectPaginationLinks(Collection $halCollection)
         return true;
     }
 
-    private function configureCollection(Collection $halCollection)
+    private function configureCollection(Collection $halCollection): void
     {
         $collection = $halCollection->getCollection();
         $page       = $halCollection->getPage();
@@ -55,7 +55,7 @@ private function configureCollection(Collection $halCollection)
         $collection->setCurrentPageNumber($page);
     }
 
-    private function injectLinks(Collection $halCollection)
+    private function injectLinks(Collection $halCollection): void
     {
         $this->injectSelfLink($halCollection);
         $this->injectFirstLink($halCollection);
@@ -64,27 +64,27 @@ private function injectLinks(Collection $halCollection)
         $this->injectNextLink($halCollection);
     }
 
-    private function injectSelfLink(Collection $halCollection)
+    private function injectSelfLink(Collection $halCollection): void
     {
         $page = $halCollection->getPage();
         $link = $this->createPaginationLink('self', $halCollection, $page);
         $halCollection->getLinks()->add($link, true);
     }
 
-    private function injectFirstLink(Collection $halCollection)
+    private function injectFirstLink(Collection $halCollection): void
     {
         $link = $this->createPaginationLink('first', $halCollection);
         $halCollection->getLinks()->add($link);
     }
 
-    private function injectLastLink(Collection $halCollection)
+    private function injectLastLink(Collection $halCollection): void
     {
         $page = $halCollection->getCollection()->count();
         $link = $this->createPaginationLink('last', $halCollection, $page);
         $halCollection->getLinks()->add($link);
     }
 
-    private function injectPrevLink(Collection $halCollection)
+    private function injectPrevLink(Collection $halCollection): void
     {
         $page = $halCollection->getPage();
         $prev = $page > 1 ? $page - 1 : false;
@@ -95,7 +95,7 @@ private function injectPrevLink(Collection $halCollection)
         }
     }
 
-    private function injectNextLink(Collection $halCollection)
+    private function injectNextLink(Collection $halCollection): void
     {
         $page      = $halCollection->getPage();
         $pageCount = $halCollection->getCollection()->count();

diff --git a/src/Link/SelfLinkInjector.php b/src/Link/SelfLinkInjector.php
@@ -16,7 +16,7 @@
 class SelfLinkInjector implements SelfLinkInjectorInterface
 {
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     public function injectSelfLink(LinkCollectionAwareInterface $resource, $route, $routeIdentifier = 'id')
     {
@@ -62,7 +62,8 @@ private function createSelfLink($resource, $route, $routeIdentifier)
     /**
      * @param null|array|Entity|Collection $resource
      * @param string $routeIdentifier
-     * @return array
+     * @return array|string
+     * @psalm-return array<empty, empty>|array<array-key, mixed>|string
      */
     private function getRouteParams($resource, $routeIdentifier)
     {
@@ -86,7 +87,8 @@ private function getRouteParams($resource, $routeIdentifier)
 
     /**
      * @param null|array|Entity|Collection $resource
-     * @return array
+     * @return array|string
+     * @psalm-return array<empty, empty>|array<array-key, mixed>|string
      */
     private function getRouteOptions($resource)
     {

diff --git a/src/Link/SelfLinkInjectorInterface.php b/src/Link/SelfLinkInjectorInterface.php
@@ -15,6 +15,7 @@ interface SelfLinkInjectorInterface
      *
      * @param  string $route
      * @param  string $routeIdentifier
+     * @return void
      */
     public function injectSelfLink(LinkCollectionAwareInterface $resource, $route, $routeIdentifier = 'id');
 }
diff --git a/src/Metadata/Metadata.php b/src/Metadata/Metadata.php
@@ -622,7 +622,7 @@ public function setForceSelfLink($forceSelfLink)
      * @param HydratorPluginManager|HydratorPluginManagerInterface $hydrators
      * @throws Exception\InvalidArgumentException If $hydrators is an invaild type.
      */
-    private function setHydrators($hydrators)
+    private function setHydrators($hydrators): void
     {
         if ($hydrators instanceof HydratorPluginManagerInterface) {
             $this->hydrators = $hydrators;

diff --git a/src/Metadata/MetadataMap.php b/src/Metadata/MetadataMap.php
@@ -142,8 +142,8 @@ public function has($class)
      *
      * Lazy-loads the Metadata instance if one is not present for a matching class.
      *
-     * @param  object|string $class Object or classname for which to retrieve metadata
-     * @return Metadata
+     * @param object|string $class Object or classname for which to retrieve metadata
+     * @return Metadata|false
      */
     public function get($class)
     {

diff --git a/src/Plugin/Hal.php b/src/Plugin/Hal.php
@@ -309,6 +309,8 @@ public function setLinkUrlBuilder(LinkUrlBuilder $builder)
      * @deprecated Since 1.4.0; use setLinkUrlBuilder() instead.
      *
      * @throws Exception\DeprecatedMethodException
+     *
+     * @return void
      */
     public function setServerUrlHelper(callable $helper)
     {
@@ -326,6 +328,8 @@ public function setServerUrlHelper(callable $helper)
      * @deprecated Since 1.4.0; use setLinkUrlBuilder() instead.
      *
      * @throws Exception\DeprecatedMethodException
+     *
+     * @return void
      */
     public function setUrlHelper(callable $helper)
     {
@@ -581,8 +585,10 @@ public function renderCollection(Collection $halCollection)
 
         $metadataMap = $this->getMetadataMap();
 
-        $maxDepth = is_object($collection) && $metadataMap->has($collection) ?
-            $metadataMap->get($collection)->getMaxDepth() : null;
+        /** @psalm-suppress PossiblyFalseReference */
+        $maxDepth = is_object($collection) && $metadataMap->has($collection)
+            ? $metadataMap->get($collection)->getMaxDepth()
+            : null;
 
         $payload              = $halCollection->getAttributes();
         $payload['_links']    = $this->fromResource($halCollection);
@@ -660,6 +666,7 @@ public function renderEntity(Entity $halEntity, $renderEntity = true, $depth = 0
 
         if (is_object($entity)) {
             if ($maxDepth === null && $metadataMap->has($entity)) {
+                /** @psalm-suppress PossiblyFalseReference */
                 $maxDepth = $metadataMap->get($entity)->getMaxDepth();
             }
 
@@ -690,6 +697,7 @@ public function renderEntity(Entity $halEntity, $renderEntity = true, $depth = 0
 
         foreach ($entity as $key => $value) {
             if (is_object($value) && $metadataMap->has($value)) {
+                /** @psalm-suppress PossiblyFalseArgument */
                 $value = $this->getResourceFactory()->createEntityFromMetadata(
                     $value,
                     $metadataMap->get($value),
@@ -856,7 +864,7 @@ public function createEntityFromMetadata($object, Metadata $metadata, $renderEmb
      * @param  Entity|array|object $resource
      * @param  string $route
      * @param  string $routeIdentifierName
-     * @return Entity
+     * @return Collection|Entity
      */
     public function createResource($resource, $route, $routeIdentifierName)
     {
@@ -871,16 +879,17 @@ public function createResource($resource, $route, $routeIdentifierName)
     /**
      * Create an Entity instance and inject it with a self relational link if necessary
      *
-     * @param  Entity|array|object $entity
-     * @param  string $route
-     * @param  string $routeIdentifierName
-     * @return Entity
+     * @param Entity|array|object $entity
+     * @param string $route
+     * @param string $routeIdentifierName
+     * @return Collection|Entity
      */
     public function createEntity($entity, $route, $routeIdentifierName)
     {
         $metadataMap = $this->getMetadataMap();
 
         if (is_object($entity) && $metadataMap->has($entity)) {
+            /** @psalm-suppress PossiblyFalseArgument */
             $halEntity = $this->getResourceFactory()->createEntityFromMetadata(
                 $entity,
                 $metadataMap->get($entity)
@@ -914,6 +923,7 @@ public function createCollection($collection, $route = null)
     {
         $metadataMap = $this->getMetadataMap();
         if (is_object($collection) && $metadataMap->has($collection)) {
+            /** @psalm-suppress PossiblyFalseArgument */
             $collection = $this->getResourceFactory()->createCollectionFromMetadata(
                 $collection,
                 $metadataMap->get($collection)
@@ -944,8 +954,9 @@ public function createCollectionFromMetadata($object, Metadata $metadata)
     /**
      * Inject a "self" relational link based on the route and identifier
      *
-     * @param  string $route
-     * @param  string $routeIdentifier
+     * @param string $route
+     * @param string $routeIdentifier
+     * @return void
      */
     public function injectSelfLink(LinkCollectionAwareInterface $resource, $route, $routeIdentifier = 'id')
     {
@@ -969,10 +980,11 @@ protected function injectPaginationLinks(Collection $halCollection)
      * Removes the key from the parent representation, and creates a
      * representation for the key in the _embedded object.
      *
-     * @param  array $parent
-     * @param  string $key
-     * @param  int $depth           depth of the current rendering recursion
-     * @param  int $maxDepth        maximum rendering depth for the current metadata
+     * @param array $parent
+     * @param string $key
+     * @param int $depth           depth of the current rendering recursion
+     * @param int $maxDepth        maximum rendering depth for the current metadata
+     * @return void
      */
     protected function extractEmbeddedEntity(array &$parent, $key, Entity $entity, $depth = 0, $maxDepth = null)
     {
@@ -994,10 +1006,11 @@ protected function extractEmbeddedEntity(array &$parent, $key, Entity $entity, $
      * Removes the key from the parent representation, and creates a
      * representation for the key in the _embedded object.
      *
-     * @param  array      $parent
-     * @param  string     $key
-     * @param  int        $depth        depth of the current rendering recursion
-     * @param  int        $maxDepth     maximum rendering depth for the current metadata
+     * @param array      $parent
+     * @param string     $key
+     * @param int        $depth        depth of the current rendering recursion
+     * @param int        $maxDepth     maximum rendering depth for the current metadata
+     * @return void
      */
     protected function extractEmbeddedCollection(
         array &$parent,
@@ -1050,6 +1063,7 @@ protected function extractCollection(Collection $halCollection, $depth = 0, $max
             $entity = $eventParams['entity'];
 
             if (is_object($entity) && $metadataMap->has($entity)) {
+                /** @psalm-suppress PossiblyFalseArgument */
                 $entity = $this->getResourceFactory()->createEntityFromMetadata($entity, $metadataMap->get($entity));
             }
 
@@ -1065,6 +1079,7 @@ protected function extractCollection(Collection $halCollection, $depth = 0, $max
 
             foreach ($entity as $key => $value) {
                 if (is_object($value) && $metadataMap->has($value)) {
+                    /** @psalm-suppress PossiblyFalseArgument */
                     $value = $this->getResourceFactory()->createEntityFromMetadata($value, $metadataMap->get($value));
                 }
 
@@ -1136,6 +1151,10 @@ protected function getIdFromEntity($entity)
             'resource' => $entity,
         ];
 
+        /**
+         * @param mixed $r
+         * @return bool
+         */
         $callback = function ($r) {
             return null !== $r && false !== $r;
         };
@@ -1218,6 +1237,8 @@ protected function marshalLinkFromMetadata(
      * Inject any links found in the metadata into the resource's link collection
      *
      * @deprecated
+     *
+     * @return void
      */
     protected function marshalMetadataLinks(Metadata $metadata, LinkCollection $links)
     {

diff --git a/src/RendererOptions.php b/src/RendererOptions.php
@@ -26,6 +26,7 @@ class RendererOptions extends AbstractOptions
 
     /**
      * @param string $hydrator
+     * @return void
      */
     public function setDefaultHydrator($hydrator)
     {
@@ -42,14 +43,15 @@ public function getDefaultHydrator()
 
     /**
      * @param bool $flag
+     * @return void
      */
     public function setRenderEmbeddedEntities($flag)
     {
         $this->renderEmbeddedEntities = (bool) $flag;
     }
 
     /**
-     * @return string
+     * @return bool
      */
     public function getRenderEmbeddedEntities()
     {
@@ -58,14 +60,15 @@ public function getRenderEmbeddedEntities()
 
     /**
      * @param bool $flag
+     * @return void
      */
     public function setRenderEmbeddedCollections($flag)
     {
         $this->renderEmbeddedCollections = (bool) $flag;
     }
 
     /**
-     * @return string
+     * @return bool
      */
     public function getRenderEmbeddedCollections()
     {
@@ -74,6 +77,7 @@ public function getRenderEmbeddedCollections()
 
     /**
      * @param array $hydrators
+     * @return void
      */
     public function setHydrators(array $hydrators)
     {

diff --git a/src/ResourceFactory.php b/src/ResourceFactory.php
@@ -170,6 +170,8 @@ public function marshalLinkFromMetadata(
 
     /**
      * Inject any links found in the metadata into the resource's link collection
+     *
+     * @return void
      */
     public function marshalMetadataLinks(Metadata $metadata, LinkCollection $links)
     {

diff --git a/src/View/HalJsonRenderer.php b/src/View/HalJsonRenderer.php
@@ -42,6 +42,8 @@ public function __construct(ApiProblemRenderer $apiProblemRenderer)
      * Set helper plugin manager instance.
      *
      * Also ensures that the 'Hal' helper is present.
+     *
+     * @return void
      */
     public function setHelperPluginManager(HelperPluginManager $helpers)
     {
-Original file line number
+Diff line change
@@ Expand Up / @@ -170,6 +170,8 @@ public function marshalLinkFromMetadata( @@
         /**
          * Inject any links found in the metadata into the resource's link collection
+         *
+         * @return void
          */
         public function marshalMetadataLinks(Metadata $metadata, LinkCollection $links)
         {
@@ Expand Down @@