refactor: [5.x] add void return types (#2395)

## Description Add void return types where possible ## What type of PR is this? (check all applicable) - [ ] Bug Fix - [ ] Feature - [x] Refactor - [ ] Deprecation - [x] Breaking Change - [ ] Documentation Update - [ ] CI ## Checklist - [ ] I have made corresponding changes to the documentation (`docs/`) - [ ] I have made corresponding changes to the changelog (`CHANGELOG.md`)
nelmio · Nov 15, 2024 · 4e94b3a · 4e94b3a
1 parent 006cba9
commit 4e94b3a
Show file tree

Hide file tree

Showing 25 changed files with 44 additions and 59 deletions.
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -76,11 +76,22 @@ Future proofing for potential future changes and keeping it consistent with `des
 ## BC BREAK: `Nelmio\ApiDocBundle\Command` has been made final
 
 ## BC BREAK: Made classes implementing  `Nelmio\ApiDocBundle\PropertyDescriber\PropertyDescriberInterface` final
-`Nelmio\ApiDocBundle\PropertyDescriber\ArrayPropertyDescriber`
-`Nelmio\ApiDocBundle\PropertyDescriber\BooleanPropertyDescriber`
-`Nelmio\ApiDocBundle\PropertyDescriber\DateTimePropertyDescriber`
-`Nelmio\ApiDocBundle\PropertyDescriber\CompoundPropertyDescriber`
-`Nelmio\ApiDocBundle\PropertyDescriber\FloatPropertyDescriber`
-`Nelmio\ApiDocBundle\PropertyDescriber\IntegerPropertyDescriber`
-`Nelmio\ApiDocBundle\PropertyDescriber\ObjectPropertyDescriber`
-`Nelmio\ApiDocBundle\PropertyDescriber\StringPropertyDescriber`
+- `Nelmio\ApiDocBundle\PropertyDescriber\ArrayPropertyDescriber`
+- `Nelmio\ApiDocBundle\PropertyDescriber\BooleanPropertyDescriber`
+- `Nelmio\ApiDocBundle\PropertyDescriber\DateTimePropertyDescriber`
+- `Nelmio\ApiDocBundle\PropertyDescriber\CompoundPropertyDescriber`
+- `Nelmio\ApiDocBundle\PropertyDescriber\FloatPropertyDescriber`
+- `Nelmio\ApiDocBundle\PropertyDescriber\IntegerPropertyDescriber`
+- `Nelmio\ApiDocBundle\PropertyDescriber\ObjectPropertyDescriber`
+- `Nelmio\ApiDocBundle\PropertyDescriber\StringPropertyDescriber`
+
+## BC BREAK: Added `void` return type to:
+- `Nelmio\ApiDocBundle\Describer\DescriberInterface::describe()`
+- `Nelmio\ApiDocBundle\Describer\ExternalDocDescriber::describe()`
+- `Nelmio\ApiDocBundle\ModelDescriber\ModelDescriberInterface::describe()`
+- `Nelmio\ApiDocBundle\ModelDescriber\FallbackObjectModelDescriber::describe()`
+- `Nelmio\ApiDocBundle\ModelDescriber\JMSModelDescriber::describe()`
+- `Nelmio\ApiDocBundle\Describer\ModelRegistryAwareInterface::setModelRegistry()`
+- `Nelmio\ApiDocBundle\Describer\ModelRegistryAwareTrait::setModelRegistry()`
+- `Nelmio\ApiDocBundle\PropertyDescriber\PropertyDescriberInterface::describe()`
+- `Nelmio\ApiDocBundle\RouteDescriber\RouteDescriberInterface::describe()`
diff --git a/src/Describer/DescriberInterface.php b/src/Describer/DescriberInterface.php
@@ -15,8 +15,5 @@
 
 interface DescriberInterface
 {
-    /**
-     * @return void
-     */
-    public function describe(OpenApi $api);
+    public function describe(OpenApi $api): void;
 }
diff --git a/src/Describer/ExternalDocDescriber.php b/src/Describer/ExternalDocDescriber.php
@@ -32,10 +32,7 @@ public function __construct($externalDoc, bool $overwrite = false)
         $this->overwrite = $overwrite;
     }
 
-    /**
-     * @return void
-     */
-    public function describe(OA\OpenApi $api)
+    public function describe(OA\OpenApi $api): void
     {
         $externalDoc = $this->getExternalDoc();
 
@@ -47,7 +44,7 @@ public function describe(OA\OpenApi $api)
     /**
      * @return mixed The external doc
      */
-    private function getExternalDoc()
+    private function getExternalDoc(): mixed
     {
         if (is_callable($this->externalDoc)) {
             return call_user_func($this->externalDoc);

diff --git a/src/Describer/ModelRegistryAwareInterface.php b/src/Describer/ModelRegistryAwareInterface.php
@@ -15,8 +15,5 @@
 
 interface ModelRegistryAwareInterface
 {
-    /**
-     * @return void
-     */
-    public function setModelRegistry(ModelRegistry $modelRegistry);
+    public function setModelRegistry(ModelRegistry $modelRegistry): void;
 }
diff --git a/src/Describer/ModelRegistryAwareTrait.php b/src/Describer/ModelRegistryAwareTrait.php
@@ -17,10 +17,7 @@ trait ModelRegistryAwareTrait
 {
     private ModelRegistry $modelRegistry;
 
-    /**
-     * @return void
-     */
-    public function setModelRegistry(ModelRegistry $modelRegistry)
+    public function setModelRegistry(ModelRegistry $modelRegistry): void
     {
         $this->modelRegistry = $modelRegistry;
     }

diff --git a/src/ModelDescriber/BazingaHateoasModelDescriber.php b/src/ModelDescriber/BazingaHateoasModelDescriber.php
@@ -35,7 +35,7 @@ public function __construct(MetadataFactoryInterface $factory, JMSModelDescriber
         $this->JMSModelDescriber = $JMSModelDescriber;
     }
 
-    public function setModelRegistry(ModelRegistry $modelRegistry)
+    public function setModelRegistry(ModelRegistry $modelRegistry): void
     {
         $this->modelRegistry = $modelRegistry;
         $this->JMSModelDescriber->setModelRegistry($modelRegistry);

diff --git a/src/ModelDescriber/EnumModelDescriber.php b/src/ModelDescriber/EnumModelDescriber.php
@@ -19,7 +19,7 @@ class EnumModelDescriber implements ModelDescriberInterface
 {
     public const FORCE_NAMES = '_nelmio_enum_force_names';
 
-    public function describe(Model $model, Schema $schema)
+    public function describe(Model $model, Schema $schema): void
     {
         $enumClass = $model->getType()->getClassName();
         $forceName = isset($model->getSerializationContext()[self::FORCE_NAMES]) && true === $model->getSerializationContext()[self::FORCE_NAMES];

diff --git a/src/ModelDescriber/FallbackObjectModelDescriber.php b/src/ModelDescriber/FallbackObjectModelDescriber.php
@@ -17,10 +17,7 @@
 
 class FallbackObjectModelDescriber implements ModelDescriberInterface
 {
-    /**
-     * @return void
-     */
-    public function describe(Model $model, OA\Schema $schema)
+    public function describe(Model $model, OA\Schema $schema): void
     {
     }
 

diff --git a/src/ModelDescriber/JMSModelDescriber.php b/src/ModelDescriber/JMSModelDescriber.php
@@ -80,10 +80,7 @@ public function __construct(
         $this->contextFactory = $contextFactory;
     }
 
-    /**
-     * @return void
-     */
-    public function describe(Model $model, OA\Schema $schema)
+    public function describe(Model $model, OA\Schema $schema): void
     {
         $className = $model->getType()->getClassName();
         $metadata = $this->factory->getMetadataForClass($className);

diff --git a/src/ModelDescriber/ModelDescriberInterface.php b/src/ModelDescriber/ModelDescriberInterface.php
@@ -16,10 +16,7 @@
 
 interface ModelDescriberInterface
 {
-    /**
-     * @return void
-     */
-    public function describe(Model $model, Schema $schema);
+    public function describe(Model $model, Schema $schema): void;
 
     public function supports(Model $model): bool;
 }
diff --git a/src/ModelDescriber/ObjectModelDescriber.php b/src/ModelDescriber/ObjectModelDescriber.php
@@ -59,7 +59,7 @@ public function __construct(
         $this->classMetadataFactory = $classMetadataFactory;
     }
 
-    public function describe(Model $model, OA\Schema $schema)
+    public function describe(Model $model, OA\Schema $schema): void
     {
         $class = $model->getType()->getClassName();
         $schema->_context->class = $class;

diff --git a/src/PropertyDescriber/ArrayPropertyDescriber.php b/src/PropertyDescriber/ArrayPropertyDescriber.php
@@ -25,7 +25,7 @@ final class ArrayPropertyDescriber implements PropertyDescriberInterface, ModelR
     /**
      * @param array<string, mixed> $context Context options for describing the property
      */
-    public function describe(array $types, OA\Schema $property, array $context = [])
+    public function describe(array $types, OA\Schema $property, array $context = []): void
     {
         $property->type = 'array';
         /** @var OA\Items $property */

diff --git a/src/PropertyDescriber/BooleanPropertyDescriber.php b/src/PropertyDescriber/BooleanPropertyDescriber.php
@@ -19,7 +19,7 @@ final class BooleanPropertyDescriber implements PropertyDescriberInterface
     /**
      * @param array<string, mixed> $context Context options for describing the property
      */
-    public function describe(array $types, OA\Schema $property, array $context = [])
+    public function describe(array $types, OA\Schema $property, array $context = []): void
     {
         $property->type = 'boolean';
     }

diff --git a/src/PropertyDescriber/CompoundPropertyDescriber.php b/src/PropertyDescriber/CompoundPropertyDescriber.php
@@ -25,7 +25,7 @@ final class CompoundPropertyDescriber implements PropertyDescriberInterface, Mod
     /**
      * @param array<string, mixed> $context Context options for describing the property
      */
-    public function describe(array $types, OA\Schema $property, array $context = [])
+    public function describe(array $types, OA\Schema $property, array $context = []): void
     {
         $property->oneOf = Generator::UNDEFINED !== $property->oneOf ? $property->oneOf : [];
 

diff --git a/src/PropertyDescriber/DateTimePropertyDescriber.php b/src/PropertyDescriber/DateTimePropertyDescriber.php
@@ -19,7 +19,7 @@ final class DateTimePropertyDescriber implements PropertyDescriberInterface
     /**
      * @param array<string, mixed> $context Context options for describing the property
      */
-    public function describe(array $types, OA\Schema $property, array $context = [])
+    public function describe(array $types, OA\Schema $property, array $context = []): void
     {
         $property->type = 'string';
         $property->format = 'date-time';

diff --git a/src/PropertyDescriber/DictionaryPropertyDescriber.php b/src/PropertyDescriber/DictionaryPropertyDescriber.php
@@ -25,7 +25,7 @@ final class DictionaryPropertyDescriber implements PropertyDescriberInterface, M
     /**
      * @param array<string, mixed> $context Context options for describing the property
      */
-    public function describe(array $types, OA\Schema $property, array $context = [])
+    public function describe(array $types, OA\Schema $property, array $context = []): void
     {
         $property->type = 'object';
         /** @var OA\AdditionalProperties $additionalProperties */

diff --git a/src/PropertyDescriber/FloatPropertyDescriber.php b/src/PropertyDescriber/FloatPropertyDescriber.php
@@ -19,7 +19,7 @@ final class FloatPropertyDescriber implements PropertyDescriberInterface
     /**
      * @param array<string, mixed> $context Context options for describing the property
      */
-    public function describe(array $types, OA\Schema $property, array $context = [])
+    public function describe(array $types, OA\Schema $property, array $context = []): void
     {
         $property->type = 'number';
         $property->format = 'float';

diff --git a/src/PropertyDescriber/IntegerPropertyDescriber.php b/src/PropertyDescriber/IntegerPropertyDescriber.php
@@ -19,7 +19,7 @@ final class IntegerPropertyDescriber implements PropertyDescriberInterface
     /**
      * @param array<string, mixed> $context Context options for describing the property
      */
-    public function describe(array $types, OA\Schema $property, array $context = [])
+    public function describe(array $types, OA\Schema $property, array $context = []): void
     {
         $property->type = 'integer';
     }

diff --git a/src/PropertyDescriber/NullablePropertyDescriber.php b/src/PropertyDescriber/NullablePropertyDescriber.php
@@ -21,7 +21,7 @@ final class NullablePropertyDescriber implements PropertyDescriberInterface, Pro
     /**
      * @param array<string, mixed> $context Context options for describing the property
      */
-    public function describe(array $types, OA\Schema $property, array $context = [])
+    public function describe(array $types, OA\Schema $property, array $context = []): void
     {
         if (Generator::UNDEFINED === $property->nullable) {
             $property->nullable = true;

diff --git a/src/PropertyDescriber/ObjectPropertyDescriber.php b/src/PropertyDescriber/ObjectPropertyDescriber.php
@@ -25,7 +25,7 @@ final class ObjectPropertyDescriber implements PropertyDescriberInterface, Model
     /**
      * @param array<string, mixed> $context Context options for describing the property
      */
-    public function describe(array $types, OA\Schema $property, array $context = [])
+    public function describe(array $types, OA\Schema $property, array $context = []): void
     {
         $type = new Type(
             $types[0]->getBuiltinType(),

diff --git a/src/PropertyDescriber/PropertyDescriberInterface.php b/src/PropertyDescriber/PropertyDescriberInterface.php
@@ -19,10 +19,8 @@ interface PropertyDescriberInterface
     /**
      * @param Type[]               $types
      * @param array<string, mixed> $context Context options for describing the property
-     *
-     * @return void
      */
-    public function describe(array $types, Schema $property, array $context = []);
+    public function describe(array $types, Schema $property, array $context = []): void;
 
     /**
      * @param Type[]               $types

diff --git a/src/PropertyDescriber/StringPropertyDescriber.php b/src/PropertyDescriber/StringPropertyDescriber.php
@@ -19,7 +19,7 @@ final class StringPropertyDescriber implements PropertyDescriberInterface
     /**
      * @param array<string, mixed> $context Context options for describing the property
      */
-    public function describe(array $types, OA\Schema $property, array $context = [])
+    public function describe(array $types, OA\Schema $property, array $context = []): void
     {
         $property->type = 'string';
     }

diff --git a/src/PropertyDescriber/UuidPropertyDescriber.php b/src/PropertyDescriber/UuidPropertyDescriber.php
@@ -20,7 +20,7 @@ final class UuidPropertyDescriber implements PropertyDescriberInterface
     /**
      * @param array<string, mixed> $context Context options for describing the property
      */
-    public function describe(array $types, OA\Schema $property, array $context = [])
+    public function describe(array $types, OA\Schema $property, array $context = []): void
     {
         $property->type = 'string';
         $property->format = 'uuid';

diff --git a/src/RouteDescriber/RouteDescriberInterface.php b/src/RouteDescriber/RouteDescriberInterface.php
@@ -16,8 +16,5 @@
 
 interface RouteDescriberInterface
 {
-    /**
-     * @return void
-     */
-    public function describe(OpenApi $api, Route $route, \ReflectionMethod $reflectionMethod);
+    public function describe(OpenApi $api, Route $route, \ReflectionMethod $reflectionMethod): void;
 }
diff --git a/tests/Functional/ModelDescriber/VirtualTypeClassDoesNotExistsHandlerDefinedDescriber.php b/tests/Functional/ModelDescriber/VirtualTypeClassDoesNotExistsHandlerDefinedDescriber.php
@@ -19,7 +19,7 @@
 
 class VirtualTypeClassDoesNotExistsHandlerDefinedDescriber implements ModelDescriberInterface
 {
-    public function describe(Model $model, OA\Schema $schema)
+    public function describe(Model $model, OA\Schema $schema): void
     {
         $schema->type = 'object';
         $property = Util::getProperty($schema, 'custom_prop');