Merge pull request #235 from koriym/named_arg

Compatibility of Annotation classes with the PHP 8 attribute feature

Author: koriym

README.md

@@ -709,6 +709,7 @@ protected function configure()
 
 Ray.Di can be used either with [doctrine/annotation](https://github.com/doctrine/annotations) in PHP 7/8 or with an [Attributes](https://www.php.net/manual/en/language.attributes.overview.php) in PHP8.
 See the annotation code examples in the older [README(v2.10)](https://github.com/ray-di/Ray.Di/tree/2.10.5/README.md).
+To make forward-compatible annotations for attributes, see [Custom Annotation Classes](https://github.com/kerveros12v/sacinta4/blob/e976c143b3b7d42497334e76c00fdf38717af98e/vendor/doctrine/annotations/docs/en/custom.rst#optional-constructors-with-named-parameters).
 
 ## Installation ##
 

composer.json

@@ -11,7 +11,7 @@
     ],
     "require": {
         "php": "^7.2 || ^8.0",
-        "doctrine/annotations": "^1.10",
+        "doctrine/annotations": "^1.11",
         "doctrine/cache": "^1.10",
         "ray/aop": "^2.10",
         "koriym/printo": "^1.0",

src/di/Di/Assisted.php

@@ -5,6 +5,7 @@
 namespace Ray\Di\Di;
 
 use Attribute;
+use Doctrine\Common\Annotations\NamedArgumentConstructorAnnotation;
 use Ray\Aop\Annotation\AbstractAssisted;
 
 /**
@@ -13,6 +14,17 @@
  * @Annotation
  * @Target("METHOD")
  */
-final class Assisted extends AbstractAssisted
+#[Attribute(Attribute::TARGET_METHOD)]
+final class Assisted extends AbstractAssisted implements NamedArgumentConstructorAnnotation
 {
+    /** @var array<string> */
+    public $values;
+
+    /**
+     * @param array<string> $value
+     */
+    public function __construct($value)
+    {
+        $this->values = $value;
+    }
 }

src/di/Di/Inject.php

@@ -5,6 +5,7 @@
 namespace Ray\Di\Di;
 
 use Attribute;
+use Doctrine\Common\Annotations\NamedArgumentConstructorAnnotation;
 
 /**
  * Annotates your class methods into which the Injector should inject values
@@ -13,7 +14,7 @@
  * @Target("METHOD")
  */
 #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_PARAMETER)]
-final class Inject implements InjectInterface
+final class Inject implements InjectInterface, NamedArgumentConstructorAnnotation
 {
     /**
      * If true, and the appropriate binding is not found, the Injector will skip injection of this method or field rather than produce an error.
@@ -23,13 +24,11 @@ final class Inject implements InjectInterface
     public $optional = false;
 
     /**
-     * @param array{optional?: bool} $values
-     *
      * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
      */
-    public function __construct(array $values = [], bool $optional = false)
+    public function __construct(bool $optional = false)
     {
-        $this->optional = $values['optional'] ?? $optional;
+        $this->optional = $optional;
     }
 
     /**

src/di/Di/Named.php

@@ -5,6 +5,7 @@
 namespace Ray\Di\Di;
 
 use Attribute;
+use Doctrine\Common\Annotations\NamedArgumentConstructorAnnotation;
 
 use function is_array;
 use function is_string;
@@ -15,25 +16,14 @@
  * @Annotation
  * @Target("METHOD")
  */
-#[Attribute(Attribute::TARGET_PARAMETER)]
-final class Named
+#[Attribute(Attribute::TARGET_PARAMETER | Attribute::TARGET_METHOD)]
+final class Named implements NamedArgumentConstructorAnnotation
 {
     /** @var string */
     public $value = '';
 
-    /**
-     * @param array{value: string}|string $value
-     */
-    public function __construct($value)
+    public function __construct(string $value)
     {
-        if (is_array($value) && isset($value['value'])) {
-            // doctrine/annotations
-            $this->value = $value['value'];
-        }
-
-        if (is_string($value)) {
-            // php8 attribute
-            $this->value = $value;
-        }
+        $this->value = $value;
     }
 }

tests/di/Fake/FakeAssistedParamsConsumer.php

@@ -11,7 +11,7 @@ class FakeAssistedParamsConsumer
     /**
      * @return array [int, FakeAbstractDb]
      *
-     * @Assisted("db")
+     * @Assisted({"db"})
      */
     public function getUser($id, ?FakeAbstractDb $db = null)
     {