@annotations are deprecated (BC break)

dg · dg · commit 101effea5311 · 2024-04-07T04:51:14.000+02:00
diff --git a/src/Application/UI/ComponentReflection.php b/src/Application/UI/ComponentReflection.php
@@ -26,7 +26,7 @@ final class ComponentReflection extends \ReflectionClass
 
 
 	/**
-	 * Returns array of class properties that are public and have attribute #[Persistent] or #[Parameter] or annotation @persistent.
+	 * Returns array of class properties that are public and have attribute #[Persistent] or #[Parameter].
 	 */
 	public function getParameters(): array
 	{
@@ -72,7 +72,7 @@ public function getParameters(): array
 
 
 	/**
-	 * Returns array of persistent properties. They are public and have attribute #[Persistent] or annotation @persistent.
+	 * Returns array of persistent properties. They are public and have attribute #[Persistent].
 	 */
 	public function getPersistentParams(): array
 	{
@@ -251,6 +251,7 @@ private static function castScalar(mixed &$val, string $type): bool
 
 	/**
 	 * Returns an annotation value.
+	 * @deprecated
 	 */
 	public static function parseAnnotation(\Reflector $ref, string $name): ?array
 	{
@@ -268,6 +269,13 @@ public static function parseAnnotation(\Reflector $ref, string $name): ?array
 			}
 		}
 
+		$alt = match ($name) {
+			'persistent' => '#[Nette\Application\Attributes\Persistent]',
+			'deprecated' => '#[Nette\Application\Attributes\Deprecated]',
+			'crossOrigin' => '#[Nette\Application\Attributes\Request(sameOrigin: false)]',
+			default => 'alternative'
+		};
+		trigger_error("Annotation @$name is deprecated, use $alt (used in " . Nette\Utils\Reflection::toString($ref) . ')', E_USER_DEPRECATED);
 		return $res;
 	}
 
@@ -286,6 +294,7 @@ public static function getType(\ReflectionParameter|\ReflectionProperty $item):
 
 	/**
 	 * Has class specified annotation?
+	 * @deprecated
 	 */
 	public function hasAnnotation(string $name): bool
 	{
@@ -295,6 +304,7 @@ public function hasAnnotation(string $name): bool
 
 	/**
 	 * Returns an annotation value.
+	 * @deprecated
 	 */
 	public function getAnnotation(string $name): mixed
 	{
diff --git a/src/Application/UI/MethodReflection.php b/src/Application/UI/MethodReflection.php
@@ -17,18 +17,22 @@ final class MethodReflection extends \ReflectionMethod
 {
 	/**
 	 * Has method specified annotation?
+	 * @deprecated
 	 */
 	public function hasAnnotation(string $name): bool
 	{
+		trigger_error(__METHOD__ . '() is deprecated', E_USER_DEPRECATED);
 		return (bool) ComponentReflection::parseAnnotation($this, $name);
 	}
 
 
 	/**
 	 * Returns an annotation value.
+	 * @deprecated
 	 */
 	public function getAnnotation(string $name): mixed
 	{
+		trigger_error(__METHOD__ . '() is deprecated', E_USER_DEPRECATED);
 		$res = ComponentReflection::parseAnnotation($this, $name);
 		return $res ? end($res) : null;
 	}
diff --git a/src/Application/UI/Presenter.php b/src/Application/UI/Presenter.php
@@ -1212,7 +1212,7 @@ public function restoreRequest(string $key): void
 
 	/**
 	 * Returns array of persistent components.
-	 * This default implementation detects components by class-level annotation @persistent(cmp1, cmp2).
+	 * This default implementation detects components by class-level attribute #[Persistent(cmp1, cmp2)].
 	 */
 	public static function getPersistentComponents(): array
 	{
diff --git a/tests/UI/ComponentReflection.parseAnnotation.phpt b/tests/UI/ComponentReflection.parseAnnotation.phpt
@@ -34,11 +34,11 @@ class TestClass
 
 $rc = new ReflectionClass('TestClass');
 
-Assert::same(['value ="Johno\'s addendum"', 'mode=True', true, true], Reflection::parseAnnotation($rc, 'title'));
-Assert::null(Reflection::parseAnnotation($rc, 'public'));
-Assert::null(Reflection::parseAnnotation($rc, 'private'));
-Assert::same(['item 1'], Reflection::parseAnnotation($rc, 'components'));
-Assert::same([true, false, null], Reflection::parseAnnotation($rc, 'persistent'));
-Assert::same([true], Reflection::parseAnnotation($rc, 'renderable'));
-Assert::same(['loggedIn'], Reflection::parseAnnotation($rc, 'Secured\User'));
-Assert::null(Reflection::parseAnnotation($rc, 'missing'));
+Assert::same(['value ="Johno\'s addendum"', 'mode=True', true, true], @Reflection::parseAnnotation($rc, 'title'));
+Assert::null(@Reflection::parseAnnotation($rc, 'public'));
+Assert::null(@Reflection::parseAnnotation($rc, 'private'));
+Assert::same(['item 1'], @Reflection::parseAnnotation($rc, 'components'));
+Assert::same([true, false, null], @Reflection::parseAnnotation($rc, 'persistent'));
+Assert::same([true], @Reflection::parseAnnotation($rc, 'renderable'));
+Assert::same(['loggedIn'], @Reflection::parseAnnotation($rc, 'Secured\User'));
+Assert::null(@Reflection::parseAnnotation($rc, 'missing'));
diff --git a/tests/UI/Presenter.getParameters.phpt b/tests/UI/Presenter.getParameters.phpt
@@ -20,7 +20,7 @@ class OnePresenter extends Presenter
 	public static $no1;
 	public $no2;
 
-	/** @persistent */
+	#[Persistent]
 	public $yes1;
 
 	#[Persistent, Parameter]
diff --git a/tests/UI/Presenter.getPersistentComponents.phpt b/tests/UI/Presenter.getPersistentComponents.phpt
@@ -19,22 +19,12 @@ class OnePresenter extends Presenter
 }
 
 
-/**
- * @persistent(a, b)
- */
-class TwoPresenter extends Presenter
-{
-}
-
-
 #[Persistent('a', 'b')]
-class ThreePresenter extends Presenter
+class TwoPresenter extends Presenter
 {
 }
 
 
 Assert::same([], OnePresenter::getPersistentComponents());
 
 Assert::same(['a', 'b'], TwoPresenter::getPersistentComponents());
-
-Assert::same(['a', 'b'], ThreePresenter::getPersistentComponents());
diff --git a/tests/UI/Presenter.link().persistent.phpt b/tests/UI/Presenter.link().persistent.phpt
@@ -7,6 +7,7 @@
 declare(strict_types=1);
 
 use Nette\Application;
+use Nette\Application\Attributes\Persistent;
 use Nette\Http;
 use Tester\Assert;
 
@@ -16,13 +17,13 @@ require __DIR__ . '/../bootstrap.php';
 
 trait PersistentParam1
 {
-	/** @persistent */
+	#[Persistent]
 	public $t1;
 }
 
 trait PersistentParam2A
 {
-	/** @persistent */
+	#[Persistent]
 	public $t2;
 }
 
@@ -33,15 +34,15 @@ trait PersistentParam2B
 
 trait PersistentParam3
 {
-	/** @persistent */
+	#[Persistent]
 	public $t3;
 }
 
 class BasePresenter extends Application\UI\Presenter
 {
 	use PersistentParam1;
 
-	/** @persistent */
+	#[Persistent]
 	public $p1;
 }
 
@@ -50,7 +51,7 @@ class TestPresenter extends BasePresenter
 {
 	use PersistentParam2B;
 
-	/** @persistent */
+	#[Persistent]
 	public $p2;
 
 
@@ -81,10 +82,10 @@ class SecondPresenter extends BasePresenter
 {
 	use PersistentParam3;
 
-	/** @persistent */
+	#[Persistent]
 	public $p1 = 20;
 
-	/** @persistent */
+	#[Persistent]
 	public $p3;
 }
 
@@ -97,7 +98,7 @@ class ThirdPresenter extends BasePresenter
 
 class FourthPresenter extends BasePresenter
 {
-	#[Application\Attributes\Persistent]
+	#[Persistent]
 	public $p1;
 }
 
diff --git a/tests/UI/Presenter.link().phpt b/tests/UI/Presenter.link().phpt
@@ -7,6 +7,7 @@
 declare(strict_types=1);
 
 use Nette\Application;
+use Nette\Application\Attributes\Persistent;
 use Nette\Http;
 use Tester\Assert;
 
@@ -16,11 +17,11 @@ require __DIR__ . '/../bootstrap.php';
 
 class TestControl extends Application\UI\Control
 {
-	/** @persistent array */
-	public $order = [];
+	#[Persistent]
+	public array $order = [];
 
-	/** @persistent int */
-	public $round = 0;
+	#[Persistent]
+	public int $round = 0;
 
 
 	public function handleClick($x, $y)
@@ -50,22 +51,22 @@ class TestControl extends Application\UI\Control
 
 class TestPresenter extends Application\UI\Presenter
 {
-	/** @persistent */
+	#[Persistent]
 	public $p;
 
-	/** @persistent */
+	#[Persistent]
 	public $pint = 10;
 
-	/** @persistent */
+	#[Persistent]
 	public $parr = [];
 
-	/** @persistent */
+	#[Persistent]
 	public $pbool = true;
 
-	/** @persistent */
+	#[Persistent]
 	public array $parrn;
 
-	/** @persistent */
+	#[Persistent]
 	public ?bool $pbooln = null;
 
 
@@ -294,7 +295,7 @@ class TestPresenter extends Application\UI\Presenter
 
 class OtherPresenter extends TestPresenter
 {
-	/** @persistent */
+	#[Persistent]
 	public $p = 20;
 }
 
diff --git a/tests/UI/fixtures/ParamPresenter.php b/tests/UI/fixtures/ParamPresenter.php
@@ -4,7 +4,7 @@
 
 class ParamPresenter extends Nette\Application\UI\Presenter
 {
-	/** @persistent */
+	#[Nette\Application\Attributes\Persistent]
 	public $bool = true;
 
 

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ final class ComponentReflection extends \ReflectionClass`
`26`	`26`
`27`	`27`
`28`	`28`	`/**`
`29`		`- * Returns array of class properties that are public and have attribute #[Persistent] or #[Parameter] or annotation @persistent.`
	`29`	`+ * Returns array of class properties that are public and have attribute #[Persistent] or #[Parameter].`
`30`	`30`	`*/`
`31`	`31`	`public function getParameters(): array`
`32`	`32`	`{`
`@@ -72,7 +72,7 @@ public function getParameters(): array`
`72`	`72`
`73`	`73`
`74`	`74`	`/**`
`75`		`- * Returns array of persistent properties. They are public and have attribute #[Persistent] or annotation @persistent.`
	`75`	`+ * Returns array of persistent properties. They are public and have attribute #[Persistent].`
`76`	`76`	`*/`
`77`	`77`	`public function getPersistentParams(): array`
`78`	`78`	`{`
`@@ -251,6 +251,7 @@ private static function castScalar(mixed &$val, string $type): bool`
`251`	`251`
`252`	`252`	`/**`
`253`	`253`	`* Returns an annotation value.`
	`254`	`+ * @deprecated`
`254`	`255`	`*/`
`255`	`256`	`public static function parseAnnotation(\Reflector $ref, string $name): ?array`
`256`	`257`	`{`
`@@ -268,6 +269,13 @@ public static function parseAnnotation(\Reflector $ref, string $name): ?array`
`268`	`269`	`}`
`269`	`270`	`}`
`270`	`271`
	`272`	`+ $alt = match ($name) {`
	`273`	`+ 'persistent' => '#[Nette\Application\Attributes\Persistent]',`
	`274`	`+ 'deprecated' => '#[Nette\Application\Attributes\Deprecated]',`
	`275`	`+ 'crossOrigin' => '#[Nette\Application\Attributes\Request(sameOrigin: false)]',`
	`276`	`+ default => 'alternative'`
	`277`	`+ };`
	`278`	`+ trigger_error("Annotation @$name is deprecated, use $alt (used in " . Nette\Utils\Reflection::toString($ref) . ')', E_USER_DEPRECATED);`
`271`	`279`	`return $res;`
`272`	`280`	`}`
`273`	`281`
`@@ -286,6 +294,7 @@ public static function getType(\ReflectionParameter\|\ReflectionProperty $item):`
`286`	`294`
`287`	`295`	`/**`
`288`	`296`	`* Has class specified annotation?`
	`297`	`+ * @deprecated`
`289`	`298`	`*/`
`290`	`299`	`public function hasAnnotation(string $name): bool`
`291`	`300`	`{`
`@@ -295,6 +304,7 @@ public function hasAnnotation(string $name): bool`
`295`	`304`
`296`	`305`	`/**`
`297`	`306`	`* Returns an annotation value.`
	`307`	`+ * @deprecated`
`298`	`308`	`*/`
`299`	`309`	`public function getAnnotation(string $name): mixed`
`300`	`310`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,18 +17,22 @@ final class MethodReflection extends \ReflectionMethod`
`17`	`17`	`{`
`18`	`18`	`/**`
`19`	`19`	`* Has method specified annotation?`
	`20`	`+ * @deprecated`
`20`	`21`	`*/`
`21`	`22`	`public function hasAnnotation(string $name): bool`
`22`	`23`	`{`
	`24`	`+ trigger_error(__METHOD__ . '() is deprecated', E_USER_DEPRECATED);`
`23`	`25`	`return (bool) ComponentReflection::parseAnnotation($this, $name);`
`24`	`26`	`}`
`25`	`27`
`26`	`28`
`27`	`29`	`/**`
`28`	`30`	`* Returns an annotation value.`
	`31`	`+ * @deprecated`
`29`	`32`	`*/`
`30`	`33`	`public function getAnnotation(string $name): mixed`
`31`	`34`	`{`
	`35`	`+ trigger_error(__METHOD__ . '() is deprecated', E_USER_DEPRECATED);`
`32`	`36`	`$res = ComponentReflection::parseAnnotation($this, $name);`
`33`	`37`	`return $res ? end($res) : null;`
`34`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1212,7 +1212,7 @@ public function restoreRequest(string $key): void`
`1212`	`1212`
`1213`	`1213`	`/**`
`1214`	`1214`	`* Returns array of persistent components.`
`1215`		`- * This default implementation detects components by class-level annotation @persistent(cmp1, cmp2).`
	`1215`	`+ * This default implementation detects components by class-level attribute #[Persistent(cmp1, cmp2)].`
`1216`	`1216`	`*/`
`1217`	`1217`	`public static function getPersistentComponents(): array`
`1218`	`1218`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,22 +19,12 @@ class OnePresenter extends Presenter`
`19`	`19`	`}`
`20`	`20`
`21`	`21`
`22`		`-/**`
`23`		`- * @persistent(a, b)`
`24`		`- */`
`25`		`-class TwoPresenter extends Presenter`
`26`		`-{`
`27`		`-}`
`28`		`-`
`29`		`-`
`30`	`22`	`#[Persistent('a', 'b')]`
`31`		`-class ThreePresenter extends Presenter`
	`23`	`+class TwoPresenter extends Presenter`
`32`	`24`	`{`
`33`	`25`	`}`
`34`	`26`
`35`	`27`
`36`	`28`	`Assert::same([], OnePresenter::getPersistentComponents());`
`37`	`29`
`38`	`30`	`Assert::same(['a', 'b'], TwoPresenter::getPersistentComponents());`
`39`		`-`
`40`		`-Assert::same(['a', 'b'], ThreePresenter::getPersistentComponents());`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`declare(strict_types=1);`
`8`	`8`
`9`	`9`	`use Nette\Application;`
	`10`	`+use Nette\Application\Attributes\Persistent;`
`10`	`11`	`use Nette\Http;`
`11`	`12`	`use Tester\Assert;`
`12`	`13`
`@@ -16,13 +17,13 @@ require __DIR__ . '/../bootstrap.php';`
`16`	`17`
`17`	`18`	`trait PersistentParam1`
`18`	`19`	`{`
`19`		`- /** @persistent */`
	`20`	`+ #[Persistent]`
`20`	`21`	`public $t1;`
`21`	`22`	`}`
`22`	`23`
`23`	`24`	`trait PersistentParam2A`
`24`	`25`	`{`
`25`		`- /** @persistent */`
	`26`	`+ #[Persistent]`
`26`	`27`	`public $t2;`
`27`	`28`	`}`
`28`	`29`
`@@ -33,15 +34,15 @@ trait PersistentParam2B`
`33`	`34`
`34`	`35`	`trait PersistentParam3`
`35`	`36`	`{`
`36`		`- /** @persistent */`
	`37`	`+ #[Persistent]`
`37`	`38`	`public $t3;`
`38`	`39`	`}`
`39`	`40`
`40`	`41`	`class BasePresenter extends Application\UI\Presenter`
`41`	`42`	`{`
`42`	`43`	`use PersistentParam1;`
`43`	`44`
`44`		`- /** @persistent */`
	`45`	`+ #[Persistent]`
`45`	`46`	`public $p1;`
`46`	`47`	`}`
`47`	`48`
`@@ -50,7 +51,7 @@ class TestPresenter extends BasePresenter`
`50`	`51`	`{`
`51`	`52`	`use PersistentParam2B;`
`52`	`53`
`53`		`- /** @persistent */`
	`54`	`+ #[Persistent]`
`54`	`55`	`public $p2;`
`55`	`56`
`56`	`57`
`@@ -81,10 +82,10 @@ class SecondPresenter extends BasePresenter`
`81`	`82`	`{`
`82`	`83`	`use PersistentParam3;`
`83`	`84`
`84`		`- /** @persistent */`
	`85`	`+ #[Persistent]`
`85`	`86`	`public $p1 = 20;`
`86`	`87`
`87`		`- /** @persistent */`
	`88`	`+ #[Persistent]`
`88`	`89`	`public $p3;`
`89`	`90`	`}`
`90`	`91`
`@@ -97,7 +98,7 @@ class ThirdPresenter extends BasePresenter`
`97`	`98`
`98`	`99`	`class FourthPresenter extends BasePresenter`
`99`	`100`	`{`
`100`		`- #[Application\Attributes\Persistent]`
	`101`	`+ #[Persistent]`
`101`	`102`	`public $p1;`
`102`	`103`	`}`
`103`	`104`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`class ParamPresenter extends Nette\Application\UI\Presenter`
`6`	`6`	`{`
`7`		`- /** @persistent */`
	`7`	`+ #[Nette\Application\Attributes\Persistent]`
`8`	`8`	`public $bool = true;`
`9`	`9`
`10`	`10`