annotations @Inject is deprecated (BC break)

nette · Apr 28, 2024 · 5f9473e · 5f9473e
1 parent 23664f3
commit 5f9473e
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 28 deletions.
diff --git a/src/DI/Helpers.php b/src/DI/Helpers.php
@@ -210,6 +210,7 @@ public static function prefixServiceName(mixed $config, string $namespace): mixe
 
 	/**
 	 * Returns an annotation value.
+	 * @deprecated
 	 */
 	public static function parseAnnotation(\Reflector $ref, string $name): ?string
 	{
@@ -219,6 +220,8 @@ public static function parseAnnotation(\Reflector $ref, string $name): ?string
 
 		$re = '#[\s*]@' . preg_quote($name, '#') . '(?=\s|$)(?:[ \t]+([^@\s]\S*))?#';
 		if ($ref->getDocComment() && preg_match($re, trim($ref->getDocComment(), '/*'), $m)) {
+			$alt = $name === 'inject' ? '#[Nette\DI\Attributes\Inject]' : 'alternative';
+			trigger_error("Annotation @$name is deprecated, use $alt (used in " . Reflection::toString($ref) . ')', E_USER_DEPRECATED);
 			return $m[1] ?? '';
 		}
 

diff --git a/tests/DI/Container.inject.properties.phpt b/tests/DI/Container.inject.properties.phpt
@@ -7,6 +7,7 @@
 declare(strict_types=1);
 
 use Nette\DI;
+use Nette\DI\Attributes\Inject;
 use Tester\Assert;
 
 
@@ -23,16 +24,16 @@ class Foo implements IFoo
 
 class Test1
 {
-	/** @inject */
+	#[Inject]
 	public stdClass $varA;
 }
 
 class Test2 extends Test1
 {
-	/** @inject */
+	#[Inject]
 	public stdClass $varC;
 
-	/** @inject */
+	#[Inject]
 	public IFoo $varD;
 }
 

diff --git a/tests/DI/Helpers.parseAnnotation().phpt b/tests/DI/Helpers.parseAnnotation().phpt
@@ -1,9 +1,5 @@
 <?php
 
-/**
- * Test: Nette\DI\Helpers::expand()
- */
-
 declare(strict_types=1);
 
 use Nette\DI\Helpers;
@@ -22,10 +18,10 @@ class TestClass
 
 $rc = new ReflectionClass(TestClass::class);
 
-Assert::same('', Helpers::parseAnnotation($rc, 'inject'));
-Assert::same(null, Helpers::parseAnnotation($rc, 'injec'));
-Assert::same('type', Helpers::parseAnnotation($rc, 'var'));
-Assert::same('bool|int', Helpers::parseAnnotation($rc, 'return'));
+Assert::same('', @Helpers::parseAnnotation($rc, 'inject'));
+Assert::same(null, @Helpers::parseAnnotation($rc, 'injec'));
+Assert::same('type', @Helpers::parseAnnotation($rc, 'var'));
+Assert::same('bool|int', @Helpers::parseAnnotation($rc, 'return'));
 
 
 /** @return*/
@@ -35,7 +31,7 @@ class TestClass2
 
 $rc = new ReflectionClass(TestClass2::class);
 
-Assert::same('', Helpers::parseAnnotation($rc, 'return'));
+Assert::same('', @Helpers::parseAnnotation($rc, 'return'));
 
 
 /** @return
@@ -47,7 +43,7 @@ class TestClass3
 
 $rc = new ReflectionClass(TestClass3::class);
 
-Assert::same('', Helpers::parseAnnotation($rc, 'return'));
+Assert::same('', @Helpers::parseAnnotation($rc, 'return'));
 
 
 /**
@@ -59,6 +55,6 @@ class TestClass4
 
 $rc = new ReflectionClass(TestClass4::class);
 
-Assert::same(null, Helpers::parseAnnotation($rc, 'inject'));
-Assert::same(null, Helpers::parseAnnotation($rc, 'injec'));
-Assert::same(null, Helpers::parseAnnotation($rc, 'var'));
+Assert::same(null, @Helpers::parseAnnotation($rc, 'inject'));
+Assert::same(null, @Helpers::parseAnnotation($rc, 'injec'));
+Assert::same(null, @Helpers::parseAnnotation($rc, 'var'));
diff --git a/tests/DI/InjectExtension.basic.phpt b/tests/DI/InjectExtension.basic.phpt
@@ -7,6 +7,7 @@
 declare(strict_types=1);
 
 use Nette\DI;
+use Nette\DI\Attributes\Inject;
 use Nette\DI\Definitions\Reference;
 use Nette\DI\Definitions\Statement;
 use Tester\Assert;
@@ -31,7 +32,7 @@ class ConcreteDependencyB extends AbstractDependency
 
 class ParentClass
 {
-	/** @inject */
+	#[Inject]
 	public stdClass $a;
 
 
@@ -47,10 +48,10 @@ class ParentClass
 
 class Service extends ParentClass
 {
-	/** @inject */
+	#[Inject]
 	public stdClass $c;
 
-	/** @inject */
+	#[Inject]
 	public AbstractDependency $e;
 
 

diff --git a/tests/DI/InjectExtension.errors.phpt b/tests/DI/InjectExtension.errors.phpt
@@ -7,6 +7,7 @@
 declare(strict_types=1);
 
 use Nette\DI;
+use Nette\DI\Attributes\Inject;
 use Nette\InvalidStateException;
 use Tester\Assert;
 
@@ -16,35 +17,35 @@ require __DIR__ . '/../bootstrap.php';
 
 class ServiceA
 {
-	/** @inject */
+	#[Inject]
 	public DateTimeImmutable $a;
 }
 
 
 class ServiceB
 {
-	/** @inject */
+	#[Inject]
 	public Unknown $a;
 }
 
 
 class ServiceC
 {
-	/** @inject */
+	#[Inject]
 	public $a;
 }
 
 
 class ServiceD
 {
-	/** @inject */
+	#[Inject]
 	protected $a;
 }
 
 
 class ServiceE
 {
-	/** @inject */
+	#[Inject]
 	public static $a;
 }
 

diff --git a/tests/DI/InjectExtension.getInjectProperties().phpt b/tests/DI/InjectExtension.getInjectProperties().phpt
@@ -13,10 +13,10 @@ use Tester\Assert;
 
 class AClass
 {
-	/** @inject */
+	#[Inject]
 	public AInjected $varA;
 
-	/** @inject */
+	#[Inject]
 	public BInjected $varB;
 
 	public $varD;
@@ -27,7 +27,7 @@ class AClass
 
 class BadClass
 {
-	/** @inject */
+	#[Inject]
 	public AClass|stdClass $var;
 }
 

diff --git a/tests/DI/InjectExtension.getInjectProperties().traits.phpt b/tests/DI/InjectExtension.getInjectProperties().traits.phpt
@@ -16,10 +16,11 @@ namespace A
 namespace B
 {
 	use A\AInjected;
+	use Nette\DI\Attributes\Inject;
 
 	trait BTrait
 	{
-		/** @inject */
+		#[Inject]
 		public AInjected $varA;
 	}
 }