Merge pull request #2327 from W0rma/param-attributes

Add support for native PHP8 QueryParam, FileParam and RequestParam attributes

Controller/Annotations/FileParam.php

@@ -21,10 +21,12 @@
  * Represents a file that must be present.
  *
  * @Annotation
+ * @NamedArgumentConstructor
  * @Target("METHOD")
  *
  * @author Ener-Getick <[email protected]>
  */
+#[\Attribute(\Attribute::IS_REPEATABLE | \Attribute::TARGET_METHOD)]
 class FileParam extends AbstractParam
 {
  /** @var bool */
@@ -39,6 +41,32 @@ class FileParam extends AbstractParam
  /** @var bool */
  public $map = false;
 
+ /**
+ * @param mixed $requirements
+ * @param mixed $default
+ */
+ public function __construct(
+ string $name = '',
+ bool $strict = true,
+ $requirements = null,
+ bool $image = false,
+ bool $map = false,
+ ?string $key = null,
+ $default = null,
+ string $description = '',
+ bool $nullable = false
+ ) {
+ $this->strict = $strict;
+ $this->requirements = $requirements;
+ $this->image = $image;
+ $this->map = $map;
+ $this->name = $name;
+ $this->key = $key;
+ $this->default = $default;
+ $this->description = $description;
+ $this->nullable = $nullable;
+ }
+
  /**
  * {@inheritdoc}
  */

Controller/Annotations/QueryParam.php

@@ -17,12 +17,42 @@
  * Represents a parameter that must be present in GET data.
  *
  * @Annotation
+ * @NamedArgumentConstructor
  * @Target({"CLASS", "METHOD"})
  *
  * @author Alexander <[email protected]>
  */
+#[\Attribute(\Attribute::IS_REPEATABLE | \Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD)]
 class QueryParam extends AbstractScalarParam
 {
+ /**
+ * @param mixed $requirements
+ * @param mixed $default
+ */
+ public function __construct(
+ string $name = '',
+ ?string $key = null,
+ $requirements = null,
+ $default = null,
+ array $incompatibles = [],
+ string $description = '',
+ bool $strict = false,
+ bool $map = false,
+ bool $nullable = false,
+ bool $allowBlank = true
+ ) {
+ $this->name = $name;
+ $this->key = $key;
+ $this->requirements = $requirements;
+ $this->default = $default;
+ $this->incompatibles = $incompatibles;
+ $this->description = $description;
+ $this->strict = $strict;
+ $this->map = $map;
+ $this->nullable = $nullable;
+ $this->allowBlank = $allowBlank;
+ }
+
  /**
  * {@inheritdoc}
  */

Controller/Annotations/RequestParam.php

@@ -17,16 +17,46 @@
  * Represents a parameter that must be present in POST data.
  *
  * @Annotation
+ * @NamedArgumentConstructor
  * @Target("METHOD")
  *
  * @author Jordi Boggiano <[email protected]>
  * @author Boris Guéry <[email protected]>
  */
+#[\Attribute(\Attribute::IS_REPEATABLE | \Attribute::TARGET_METHOD)]
 class RequestParam extends AbstractScalarParam
 {
  /** @var bool */
  public $strict = true;
 
+ /**
+ * @param mixed $requirements
+ * @param mixed $default
+ */
+ public function __construct(
+ string $name = '',
+ ?string $key = null,
+ $requirements = null,
+ $default = null,
+ string $description = '',
+ array $incompatibles = [],
+ bool $strict = false,
+ bool $map = false,
+ bool $nullable = false,
+ bool $allowBlank = true
+ ) {
+ $this->name = $name;
+ $this->key = $key;
+ $this->requirements = $requirements;
+ $this->default = $default;
+ $this->description = $description;
+ $this->incompatibles = $incompatibles;
+ $this->strict = $strict;
+ $this->map = $map;
+ $this->nullable = $nullable;
+ $this->allowBlank = $allowBlank;
+ }
+
  /**
  * {@inheritdoc}
  */

Request/ParamReader.php

@@ -23,9 +23,12 @@
  */
 final class ParamReader implements ParamReaderInterface
 {
+ /**
+ * @var Reader|null
+ */
  private $annotationReader;
 
- public function __construct(Reader $annotationReader)
+ public function __construct(?Reader $annotationReader = null)
  {
  $this->annotationReader = $annotationReader;
  }
@@ -50,7 +53,17 @@ public function read(\ReflectionClass $reflection, string $method): array
  */
  public function getParamsFromMethod(\ReflectionMethod $method): array
  {
- $annotations = $this->annotationReader->getMethodAnnotations($method);
+ $annotations = [];
+ if (\PHP_VERSION_ID >= 80000) {
+ $annotations = $this->getParamsFromAttributes($method);
+ }
+
+ if (null !== $this->annotationReader) {
+ $annotations = array_merge(
+ $annotations,
+ $this->annotationReader->getMethodAnnotations($method) ?? []
+ );
+ }
 
  return $this->getParamsFromAnnotationArray($annotations);
  }
@@ -60,7 +73,17 @@ public function getParamsFromMethod(\ReflectionMethod $method): array
  */
  public function getParamsFromClass(\ReflectionClass $class): array
  {
- $annotations = $this->annotationReader->getClassAnnotations($class);
+ $annotations = [];
+ if (\PHP_VERSION_ID >= 80000) {
+ $annotations = $this->getParamsFromAttributes($class);
+ }
+
+ if (null !== $this->annotationReader) {
+ $annotations = array_merge(
+ $annotations,
+ $this->annotationReader->getClassAnnotations($class) ?? []
+ );
+ }
 
  return $this->getParamsFromAnnotationArray($annotations);
  }
@@ -79,4 +102,20 @@ private function getParamsFromAnnotationArray(array $annotations): array
 
  return $params;
  }
+
+ /**
+ * @param \ReflectionClass|\ReflectionMethod $reflection
+ *
+ * @return ParamInterface[]
+ */
+ private function getParamsFromAttributes($reflection): array
+ {
+ $params = [];
+ foreach ($reflection->getAttributes(ParamInterface::class, \ReflectionAttribute::IS_INSTANCEOF) as $attribute) {
+ $param = $attribute->newInstance();
+ $params[$param->getName()] = $param;
+ }
+
+ return $params;
+ }
 }

Resources/config/request.xml

@@ -16,7 +16,7 @@
  <service id="FOS\RestBundle\Request\ParamFetcherInterface" alias="fos_rest.request.param_fetcher" />
 
  <service id="fos_rest.request.param_fetcher.reader" class="FOS\RestBundle\Request\ParamReader" public="false">
- <argument type="service" id="annotation_reader"/>
+ <argument type="service" id="annotation_reader" on-invalid="null"/>
  </service>
 
  </services>

Resources/doc/annotations-reference.rst

@@ -7,63 +7,126 @@ Param fetcher
 QueryParam
 ~~~~~~~~~~
 
-.. code-block:: php
-
- use FOS\RestBundle\Controller\Annotations\QueryParam;
-
- /**
- * @QueryParam(
- * name="",
- * key=null,
- * requirements="",
- * incompatibles={},
- * default=null,
- * description="",
- * strict=false,
- * map=false,
- * nullable=false
- * )
- */
+.. tabs::
+
+ .. tab:: Annotations
+
+ .. code-block:: php
+
+ use FOS\RestBundle\Controller\Annotations\QueryParam;
+
+ /**
+ * @QueryParam(
+ * name="",
+ * key=null,
+ * requirements="",
+ * incompatibles={},
+ * default=null,
+ * description="",
+ * strict=false,
+ * map=false,
+ * nullable=false
+ * )
+ */
+
+ .. tab:: Attributes
+
+ .. code-block:: php
+
+ use FOS\RestBundle\Controller\Annotations\QueryParam;
+
+ #[QueryParam(
+ name: '',
+ key: null,
+ requirements: '',
+ incompatibles: [],
+ default: null,
+ description: '',
+ strict: false,
+ map: false,
+ nullable: false
+ )]
 
 RequestParam
 ~~~~~~~~~~~~
 
-.. code-block:: php
+.. tabs::
 
-  use FOS\RestBundle\Controller\Annotations\RequestParam;
+ .. tab:: Annotations
 
- /**
- * @RequestParam(
- * name="",
- * key=null,
- * requirements="",
- * default=null,
- * description="",
- * strict=true,
- * map=false,
- * nullable=false
- * )
- */
+ .. code-block:: php
+
+ use FOS\RestBundle\Controller\Annotations\RequestParam;
+
+ /**
+ * @RequestParam(
+ * name="",
+ * key=null,
+ * requirements="",
+ * default=null,
+ * description="",
+ * strict=true,
+ * map=false,
+ * nullable=false
+ * )
+ */
+
+ .. tab:: Attributes
+
+ .. code-block:: php
+
+ use FOS\RestBundle\Controller\Annotations\RequestParam;
+
+ #[RequestParam(
+ name: '',
+ key: null,
+ requirements: '',
+ default: null,
+ description: '',
+ strict: true,
+ map: false,
+ nullable: false
+ )]
 
 FileParam
 ~~~~~~~~~
 
-.. code-block:: php
-
- use FOS\RestBundle\Controller\Annotations\FileParam;
-
- /**
- * @FileParam(
- * name="",
- * key=null,
- * requirements={},
- * default=null,
- * description="",
- * strict=true,
- * nullable=false,
- * image=false
- * )
- */
+.. tabs::
+
+ .. tab:: Annotations
+
+ .. code-block:: php
+
+ use FOS\RestBundle\Controller\Annotations\FileParam;
+
+ /**
+ * @FileParam(
+ * name="",
+ * key=null,
+ * requirements={},
+ * default=null,
+ * description="",
+ * strict=true,
+ * nullable=false,
+ * image=false
+ * )
+ */
+ .. tab:: Attributes
+
+ .. code-block:: php
+
+ use FOS\RestBundle\Controller\Annotations\FileParam;
+
+ #[FileParam(
+ name: '',
+ key: null,
+ requirements: [],
+ default: null,
+ description: '',
+ strict: true,
+ nullable: false,
+ image: false
+ )]
 
 View
 ----