Skip to content

Commit b5c39e5

Browse files
DanielEScherzerDanielEScherzer
committed
[RFC] Allow #[\Deprecated] on traits
1 parent 5a2a150 commit b5c39e5

15 files changed

+194
-10
lines changed

‎Zend/tests/attributes/constants/constant_listed_as_target-internal.phpt‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ Constants listed in valid targets when used wrong (internal attribute)
44
<?php
55

66
#[Deprecated]
7-
class Example {}
7+
function demo(
8+
#[Deprecated] $v
9+
) {}
810

911
?>
1012
--EXPECTF--
11-
Fatal error: Attribute "Deprecated" cannot target class (allowed targets: function, method, class constant, constant) in %s on line %d
13+
Fatal error: Attribute "Deprecated" cannot target parameter (allowed targets: class, function, method, class constant, constant) in %s on line %d

‎Zend/tests/attributes/deprecated/traits/basic.phpt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
--TEST--
2+
#[\Deprecated]: Basic trait deprecation
3+
--FILE--
4+
<?php
5+
6+
#[\Deprecated]
7+
trait DemoTrait {}
8+
9+
class DemoClass {
10+
use DemoTrait;
11+
}
12+
13+
?>
14+
--EXPECTF--
15+
Deprecated: Trait DemoTrait used by DemoClass is deprecated in %s on line %d

‎Zend/tests/attributes/deprecated/traits/class_not_trait.phpt‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
--TEST--
2+
#[\Deprecated]: Using on a class
3+
--FILE--
4+
<?php
5+
6+
#[\Deprecated]
7+
class Demo {}
8+
9+
?>
10+
--EXPECTF--
11+
Fatal error: Cannot apply #[Deprecated] to class Demo in %s on line %d

‎Zend/tests/attributes/deprecated/traits/enum_not_trait.phpt‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
--TEST--
2+
#[\Deprecated]: Using on an enum
3+
--FILE--
4+
<?php
5+
6+
#[\Deprecated]
7+
enum Demo {}
8+
9+
?>
10+
--EXPECTF--
11+
Fatal error: Cannot apply #[Deprecated] to enum Demo in %s on line %d

‎Zend/tests/attributes/deprecated/traits/exception.phpt‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
--TEST--
2+
#[\Deprecated]: Deprecation converted to ErrorException does not break
3+
--FILE--
4+
<?php
5+
6+
function my_error_handler(int $errno, string $errstr, ?string $errfile = null, ?int $errline = null) {
7+
throw new \ErrorException($errstr, 0, $errno, $errfile, $errline);
8+
}
9+
10+
set_error_handler('my_error_handler');
11+
12+
#[\Deprecated]
13+
trait DemoTrait {}
14+
15+
class DemoClass {
16+
use DemoTrait;
17+
}
18+
19+
?>
20+
--EXPECTF--
21+
Fatal error: Uncaught ErrorException: Trait DemoTrait used by DemoClass is deprecated in %s:%d
22+
Stack trace:
23+
#0 %s: my_error_handler(16384, 'Trait DemoTrait...', '%s', %d)
24+
#1 {main}
25+
thrown in %s on line %d

‎Zend/tests/attributes/deprecated/traits/inheritance.phpt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
--TEST--
2+
#[\Deprecated]: Deprecated traits only apply to direct use, not inheritance
3+
--FILE--
4+
<?php
5+
6+
#[\Deprecated]
7+
trait DemoTrait {}
8+
9+
class DemoClass {
10+
use DemoTrait;
11+
}
12+
13+
class ChildClass extends DemoClass {
14+
}
15+
16+
?>
17+
--EXPECTF--
18+
Deprecated: Trait DemoTrait used by DemoClass is deprecated in %s on line %d

‎Zend/tests/attributes/deprecated/traits/interface_not_trait.phpt‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
--TEST--
2+
#[\Deprecated]: Using on an interface
3+
--FILE--
4+
<?php
5+
6+
#[\Deprecated]
7+
interface Demo {}
8+
9+
?>
10+
--EXPECTF--
11+
Fatal error: Cannot apply #[Deprecated] to interface Demo in %s on line %d

‎Zend/tests/attributes/deprecated/traits/messages.phpt‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
--TEST--
2+
#[\Deprecated]: Messages for deprecated traits
3+
--FILE--
4+
<?php
5+
6+
#[\Deprecated("please do not use")]
7+
trait DemoTrait1 {}
8+
9+
#[\Deprecated("will be removed in 3.0", since: "2.7")]
10+
trait DemoTrait2 {}
11+
12+
#[\Deprecated(message: "going away")]
13+
trait DemoTrait3 {}
14+
15+
#[\Deprecated(since: "3.5")]
16+
trait DemoTrait4 {}
17+
18+
class DemoClass {
19+
use DemoTrait1;
20+
use DemoTrait2;
21+
use DemoTrait3;
22+
use DemoTrait4;
23+
}
24+
25+
?>
26+
--EXPECTF--
27+
Deprecated: Trait DemoTrait1 used by DemoClass is deprecated, please do not use in %s on line %d
28+
29+
Deprecated: Trait DemoTrait2 used by DemoClass is deprecated since 2.7, will be removed in 3.0 in %s on line %d
30+
31+
Deprecated: Trait DemoTrait3 used by DemoClass is deprecated, going away in %s on line %d
32+
33+
Deprecated: Trait DemoTrait4 used by DemoClass is deprecated since 3.5 in %s on line %d

‎Zend/zend_attributes.c‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,34 @@ static void validate_allow_dynamic_properties(
9595
scope->ce_flags |= ZEND_ACC_ALLOW_DYNAMIC_PROPERTIES;
9696
}
9797

98+
static void validate_deprecated(
99+
zend_attribute *attr,
100+
uint32_t target,
101+
zend_class_entry *scope
102+
) {
103+
if (target != ZEND_ATTRIBUTE_TARGET_CLASS) {
104+
// Being used for a method or something, validation does not apply
105+
return;
106+
}
107+
if (scope->ce_flags & ZEND_ACC_TRAIT) {
108+
scope->ce_flags |= ZEND_ACC_DEPRECATED;
109+
return;
110+
}
111+
112+
const char *type = "class";
113+
if (scope->ce_flags & ZEND_ACC_INTERFACE) {
114+
type = "interface";
115+
} else if (scope->ce_flags & ZEND_ACC_ENUM) {
116+
type = "enum";
117+
}
118+
zend_error_noreturn(
119+
E_ERROR,
120+
"Cannot apply #[Deprecated] to %s %s",
121+
type,
122+
ZSTR_VAL(scope->name)
123+
);
124+
}
125+
98126
ZEND_METHOD(Attribute, __construct)
99127
{
100128
zend_long flags = ZEND_ATTRIBUTE_TARGET_ALL;
@@ -545,6 +573,7 @@ void zend_register_attribute_ce(void)
545573

546574
zend_ce_deprecated = register_class_Deprecated();
547575
attr = zend_mark_internal_attribute(zend_ce_deprecated);
576+
attr->validator = validate_deprecated;
548577

549578
zend_ce_nodiscard = register_class_NoDiscard();
550579
attr = zend_mark_internal_attribute(zend_ce_nodiscard);

‎Zend/zend_attributes.stub.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public function __construct() {}
7777
/**
7878
* @strict-properties
7979
*/
80-
#[Attribute(Attribute::TARGET_METHOD|Attribute::TARGET_FUNCTION|Attribute::TARGET_CLASS_CONSTANT|Attribute::TARGET_CONSTANT)]
80+
#[Attribute(Attribute::TARGET_METHOD|Attribute::TARGET_FUNCTION|Attribute::TARGET_CLASS_CONSTANT|Attribute::TARGET_CONSTANT|Attribute::TARGET_CLASS)]
8181
final class Deprecated
8282
{
8383
public readonly ?string $message;

0 commit comments

Comments
 (0)