fix coding standards issues

willdurand · Jan 31, 2023 · ac5771e · ac5771e
1 parent e13be25
commit ac5771e
Show file tree

Hide file tree

Showing 9 changed files with 57 additions and 40 deletions.
diff --git a/src/Configuration/Annotation/Embedded.php b/src/Configuration/Annotation/Embedded.php
@@ -40,7 +40,11 @@ class Embedded
      */
     public $exclusion = null;
 
-    public function __construct($values = [], $content = null, ?string $type = null, $xmlElementName = null, $exclusion = null)
+    /**
+     * @param string|array $content
+     * @param Exclusion|null $exclusion
+     */
+    public function __construct(array $values = [], $content = null, ?string $type = null, ?string $xmlElementName = null, $exclusion = null)
     {
         $this->loadAnnotationParameters(get_defined_vars());
     }

diff --git a/src/Configuration/Annotation/Exclusion.php b/src/Configuration/Annotation/Exclusion.php
@@ -44,7 +44,7 @@ final class Exclusion
      */
     public $excludeIf = null;
 
-    public function __construct($values = [], ?array $groups = null, ?string $sinceVersion = null, ?string $untilVersion = null, ?int $maxDepth = null, ?string $excludeIf = null)
+    public function __construct(array $values = [], ?array $groups = null, ?string $sinceVersion = null, ?string $untilVersion = null, ?int $maxDepth = null, ?string $excludeIf = null)
     {
         $this->loadAnnotationParameters(get_defined_vars());
     }

diff --git a/src/Configuration/Annotation/Relation.php b/src/Configuration/Annotation/Relation.php
@@ -45,7 +45,11 @@ final class Relation
      */
     public $exclusion = null;
 
-    public function __construct($values = [], ?string $name = null, $href = null, $embedded = null, array $attributes = [], ?Exclusion $exclusion = null)
+    /**
+     * @param string|Route $href
+     * @param string|Embedded $embedded
+     */
+    public function __construct(array $values = [], ?string $name = null, $href = null, $embedded = null, array $attributes = [], ?Exclusion $exclusion = null)
     {
         $this->loadAnnotationParameters(get_defined_vars());
     }

diff --git a/src/Configuration/Annotation/RelationProvider.php b/src/Configuration/Annotation/RelationProvider.php
@@ -20,7 +20,7 @@ class RelationProvider
      */
     public $name;
 
-    public function __construct($values = [], ?string $name = null)
+    public function __construct(array $values = [], ?string $name = null)
     {
         $this->loadAnnotationParameters(get_defined_vars());
     }

diff --git a/src/Configuration/Annotation/Route.php b/src/Configuration/Annotation/Route.php
@@ -40,7 +40,11 @@ class Route
      */
     public $generator = null;
 
-    public function __construct($values = [], ?string $name = null, $parameters = null, $absolute = false, ?string $generator = null)
+    /**
+     * @param array|string $parameters
+     * @param bool|string $absolute
+     */
+    public function __construct(array $values = [], ?string $name = null, $parameters = null, $absolute = false, ?string $generator = null)
     {
         $this->loadAnnotationParameters(get_defined_vars());
     }

diff --git a/src/Configuration/Metadata/Driver/AttributeDriver/AttributeReader.php b/src/Configuration/Metadata/Driver/AttributeDriver/AttributeReader.php
@@ -24,41 +24,59 @@ public function __construct(Reader $reader)
         $this->reader = $reader;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function getClassAnnotations(ReflectionClass $class): array
     {
         $attributes = $class->getAttributes();
 
         return array_merge($this->reader->getClassAnnotations($class), $this->buildAnnotations($attributes));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function getClassAnnotation(ReflectionClass $class, $annotationName): ?object
     {
         $attributes = $class->getAttributes($annotationName);
 
         return $this->reader->getClassAnnotation($class, $annotationName) ?? $this->buildAnnotation($attributes);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function getMethodAnnotations(ReflectionMethod $method): array
     {
         $attributes = $method->getAttributes();
 
         return array_merge($this->reader->getMethodAnnotations($method), $this->buildAnnotations($attributes));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function getMethodAnnotation(ReflectionMethod $method, $annotationName): ?object
     {
         $attributes = $method->getAttributes($annotationName);
 
         return $this->reader->getMethodAnnotation($method, $annotationName) ?? $this->buildAnnotation($attributes);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function getPropertyAnnotations(ReflectionProperty $property): array
     {
         $attributes = $property->getAttributes();
 
         return array_merge($this->reader->getPropertyAnnotations($property), $this->buildAnnotations($attributes));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function getPropertyAnnotation(ReflectionProperty $property, $annotationName): ?object
     {
         $attributes = $property->getAttributes($annotationName);

diff --git a/tests/Hateoas/Tests/Configuration/Metadata/Driver/AttributeDriver/AttributeReaderTest.php b/tests/Hateoas/Tests/Configuration/Metadata/Driver/AttributeDriver/AttributeReaderTest.php
@@ -31,8 +31,7 @@ public function testGetClassAnnotations()
             ->expects($this->once())
             ->method('getClassAnnotations')
             ->with($refl)
-            ->willReturn([])
-        ;
+            ->willReturn([]);
 
         $result = $reader->getClassAnnotations($refl);
 
@@ -50,8 +49,7 @@ public function testGetClassAnnotationsDelegated()
             ->expects($this->once())
             ->method('getClassAnnotations')
             ->with($refl)
-            ->willReturn([$annotation])
-        ;
+            ->willReturn([$annotation]);
 
         $result = $reader->getClassAnnotations($refl);
 
@@ -68,8 +66,7 @@ public function testGetClassAnnotation()
             ->expects($this->once())
             ->method('getClassAnnotation')
             ->with($refl, Annotation\RelationProvider::class)
-            ->willReturn(null)
-        ;
+            ->willReturn(null);
 
         $result = $reader->getClassAnnotation($refl, Annotation\RelationProvider::class);
 
@@ -87,8 +84,7 @@ public function testGetClassAnnotationDelegated()
             ->expects($this->once())
             ->method('getClassAnnotation')
             ->with($refl, Annotation\RelationProvider::class)
-            ->willReturn($annotation)
-        ;
+            ->willReturn($annotation);
 
         $result = $reader->getClassAnnotation($refl, Annotation\RelationProvider::class);
 
@@ -105,8 +101,7 @@ public function testGetMethodAnnotations()
             ->expects($this->once())
             ->method('getMethodAnnotations')
             ->with($refl)
-            ->willReturn([])
-        ;
+            ->willReturn([]);
 
         $result = $reader->getMethodAnnotations($refl);
 
@@ -124,8 +119,7 @@ public function testGetMethodAnnotationsDelegated()
             ->expects($this->once())
             ->method('getMethodAnnotations')
             ->with($refl)
-            ->willReturn([$annotation])
-        ;
+            ->willReturn([$annotation]);
 
         $result = $reader->getMethodAnnotations($refl);
 
@@ -142,8 +136,7 @@ public function testGetMethodAnnotation()
             ->expects($this->once())
             ->method('getMethodAnnotation')
             ->with($refl, Annotation\RelationProvider::class)
-            ->willReturn(null)
-        ;
+            ->willReturn(null);
 
         $result = $reader->getMethodAnnotation($refl, Annotation\RelationProvider::class);
 
@@ -161,8 +154,7 @@ public function testGetMethodAnnotationDelegated()
             ->expects($this->once())
             ->method('getMethodAnnotation')
             ->with($refl, Annotation\RelationProvider::class)
-            ->willReturn($annotation)
-        ;
+            ->willReturn($annotation);
 
         $result = $reader->getMethodAnnotation($refl, Annotation\RelationProvider::class);
 
@@ -179,8 +171,7 @@ public function testGetPropertyAnnotations()
             ->expects($this->once())
             ->method('getPropertyAnnotations')
             ->with($refl)
-            ->willReturn([])
-        ;
+            ->willReturn([]);
 
         $result = $reader->getPropertyAnnotations($refl);
 
@@ -198,8 +189,7 @@ public function testGetPropertyAnnotationsDelegated()
             ->expects($this->once())
             ->method('getPropertyAnnotations')
             ->with($refl)
-            ->willReturn([$annotation])
-        ;
+            ->willReturn([$annotation]);
 
         $result = $reader->getPropertyAnnotations($refl);
 
@@ -216,8 +206,7 @@ public function testGetPropertyAnnotation()
             ->expects($this->once())
             ->method('getPropertyAnnotation')
             ->with($refl, Annotation\RelationProvider::class)
-            ->willReturn(null)
-        ;
+            ->willReturn(null);
 
         $result = $reader->getPropertyAnnotation($refl, Annotation\RelationProvider::class);
 
@@ -235,8 +224,7 @@ public function testGetPropertyAnnotationDelegated()
             ->expects($this->once())
             ->method('getPropertyAnnotation')
             ->with($refl, Annotation\RelationProvider::class)
-            ->willReturn($annotation)
-        ;
+            ->willReturn($annotation);
 
         $result = $reader->getPropertyAnnotation($refl, Annotation\RelationProvider::class);
 

diff --git a/tests/Hateoas/Tests/Configuration/Metadata/Driver/AttributeDriverTest.php b/tests/Hateoas/Tests/Configuration/Metadata/Driver/AttributeDriverTest.php
@@ -23,8 +23,7 @@ public function createDriver()
         $driver
             ->expects($this->once())
             ->method('getClassAnnotations')
-            ->willReturn([])
-        ;
+            ->willReturn([]);
 
         return new AnnotationDriver(
             new AttributeReader($driver),

diff --git a/tests/Hateoas/Tests/Fixtures/User.php b/tests/Hateoas/Tests/Fixtures/User.php
@@ -39,15 +39,15 @@
  * @Hateoas\Relation("attribute_with_expression", href = "baz", attributes = {"baz" = "expr(object.getId())"})
  * @Hateoas\RelationProvider("Hateoas\Tests\Fixtures\User::getRelations")
  */
-#[Hateoas\Relation(name: "self", href: "http://hateoas.web/user/42", attributes: ["type" => "application/json"])]
-#[Hateoas\Relation(name: "foo", href: new Hateoas\Route(name: "user_get", parameters: ["id" => "expr(object.getId())"]), embedded: "expr(object.getFoo())")]
-#[Hateoas\Relation(name: "bar", href: "foo", embedded: new Hateoas\Embedded(content: "data", xmlElementName: "barTag"))]
-#[Hateoas\Relation(name: "baz", href: new Hateoas\Route(name: "user_get", parameters: ["id" => "expr(object.getId())"], absolute: true), embedded: "expr(object.getFoo())")]
-#[Hateoas\Relation(name: "boom", href: new Hateoas\Route(name: "user_get", parameters: ["id" => "expr(object.getId())"], absolute: false), embedded: "expr(object.getFoo())")]
-#[Hateoas\Relation(name: "badaboom", embedded: "expr(object.getFoo())")]
-#[Hateoas\Relation(name: "hello", href: "/hello", embedded: new Hateoas\Embedded(content: "hello", type: "string", xmlElementName: "barTag", exclusion: new Hateoas\Exclusion(groups: ["group3", "group4"], sinceVersion: "1.1", untilVersion: "2.3", maxDepth: 43, excludeIf: "bar")), exclusion: new Hateoas\Exclusion(groups: ["group1", "group2"], sinceVersion: "1", untilVersion: "2.2", maxDepth: 42, excludeIf: "foo"))]
-#[Hateoas\Relation(name: "attribute_with_expression", href: "baz", attributes: ["baz" => "expr(object.getId())"])]
-#[Hateoas\RelationProvider(name: "Hateoas\Tests\Fixtures\User::getRelations")]
+#[Hateoas\Relation(name: 'self', href: 'http://hateoas.web/user/42', attributes: ['type' => 'application/json'])]
+#[Hateoas\Relation(name: 'foo', href: new Hateoas\Route(name: 'user_get', parameters: ['id' => 'expr(object.getId())']), embedded: 'expr(object.getFoo())')]
+#[Hateoas\Relation(name: 'bar', href: 'foo', embedded: new Hateoas\Embedded(content: 'data', xmlElementName: 'barTag'))]
+#[Hateoas\Relation(name: 'baz', href: new Hateoas\Route(name: 'user_get', parameters: ['id' => 'expr(object.getId())'], absolute: true), embedded: 'expr(object.getFoo())')]
+#[Hateoas\Relation(name: 'boom', href: new Hateoas\Route(name: 'user_get', parameters: ['id' => 'expr(object.getId())'], absolute: false), embedded: 'expr(object.getFoo())')]
+#[Hateoas\Relation(name: 'badaboom', embedded: 'expr(object.getFoo())')]
+#[Hateoas\Relation(name: 'hello', href: '/hello', embedded: new Hateoas\Embedded(content: 'hello', type: 'string', xmlElementName: 'barTag', exclusion: new Hateoas\Exclusion(groups: ['group3', 'group4'], sinceVersion: '1.1', untilVersion: '2.3', maxDepth: 43, excludeIf: 'bar')), exclusion: new Hateoas\Exclusion(groups: ['group1', 'group2'], sinceVersion: '1', untilVersion: '2.2', maxDepth: 42, excludeIf: 'foo'))]
+#[Hateoas\Relation(name: 'attribute_with_expression', href: 'baz', attributes: ['baz' => 'expr(object.getId())'])]
+#[Hateoas\RelationProvider(name: 'Hateoas\Tests\Fixtures\User::getRelations')]
 class User
 {
     /**