RFC: Add #[\Deprecated] Attribute

Zend/Optimizer/optimize_func_calls.c

@@ -78,7 +78,7 @@ static void zend_delete_call_instructions(zend_op_array *op_array, zend_op *opli
 static void zend_try_inline_call(zend_op_array *op_array, zend_op *fcall, zend_op *opline, zend_function *func)
 {
 	if (func->type == ZEND_USER_FUNCTION
-	 && !(func->op_array.fn_flags & (ZEND_ACC_ABSTRACT|ZEND_ACC_HAS_TYPE_HINTS))
+	 && !(func->op_array.fn_flags & (ZEND_ACC_ABSTRACT|ZEND_ACC_HAS_TYPE_HINTS|ZEND_ACC_DEPRECATED))
 		/* TODO: function copied from trait may be inconsistent ??? */
 	 && !(func->op_array.fn_flags & (ZEND_ACC_TRAIT_CLONE))
 	 && fcall->extended_value >= func->op_array.required_num_args

Zend/tests/attributes/deprecated/001.phpt

@@ -0,0 +1,15 @@
+--TEST--
+#[\Deprecated]: $message property is readonly.
+--FILE--
+<?php
+
+$d = new \Deprecated("foo");
+$d->__construct("bar");
+
+?>
+--EXPECTF--
+Fatal error: Uncaught Error: Cannot modify readonly property Deprecated::$message in %s:%d
+Stack trace:
+#0 %s(%d): Deprecated->__construct('bar')
+#1 {main}
+  thrown in %s on line %d

Zend/tests/attributes/deprecated/class_constants/001.phpt

@@ -0,0 +1,43 @@
+--TEST--
+#[\Deprecated]: Class Constants.
+--FILE--
+<?php
+
+class Clazz {
+    #[\Deprecated]
+    public const TEST = 1;
+
+    #[\Deprecated()]
+    public const TEST2 = 2;
+
+    #[\Deprecated("use Clazz::TEST instead")]
+    public const TEST3 = 3;
+
+    #[\Deprecated]
+    public const TEST4 = 4;
+
+    #[\Deprecated]
+    public const TEST5 = 5;
+}
+
+var_dump(Clazz::TEST);
+var_dump(Clazz::TEST2);
+var_dump(Clazz::TEST3);
+
+var_dump(constant('Clazz::TEST4'));
+var_dump(defined('Clazz::TEST5'));
+
+?>
+--EXPECTF--
+Deprecated: Constant Clazz::TEST is deprecated in %s on line %d
+int(1)
+
+Deprecated: Constant Clazz::TEST2 is deprecated in %s on line %d
+int(2)
+
+Deprecated: Constant Clazz::TEST3 is deprecated, use Clazz::TEST instead in %s on line %d
+int(3)
+
+Deprecated: Constant Clazz::TEST4 is deprecated in %s on line %d
+int(4)
+bool(true)

Zend/tests/attributes/deprecated/class_constants/002.phpt

@@ -0,0 +1,21 @@
+--TEST--
+#[\Deprecated]: Enum cases.
+--FILE--
+<?php
+
+enum E {
+	#[\Deprecated]
+	case Test;
+
+	#[\Deprecated("use E::Test instead")]
+	case Test2;
+}
+
+E::Test;
+E::Test2;
+
+?>
+--EXPECTF--
+Deprecated: Enum case E::Test is deprecated in %s on line %d
+
+Deprecated: Enum case E::Test2 is deprecated, use E::Test instead in %s on line %d

Zend/tests/attributes/deprecated/class_constants/003.phpt

@@ -0,0 +1,17 @@
+--TEST--
+#[\Deprecated]: ReflectionClassConstant::isDeprecated() returns true.
+--FILE--
+<?php
+
+class Clazz {
+	#[\Deprecated]
+	public const TEST = 'test';
+}
+
+
+$r = new ReflectionClassConstant('Clazz', 'TEST');
+var_dump($r->isDeprecated());
+
+?>
+--EXPECTF--
+bool(true)

Zend/tests/attributes/deprecated/class_constants/004.phpt

@@ -0,0 +1,21 @@
+--TEST--
+#[\Deprecated]: Code is E_USER_DEPRECATED for class constants.
+--FILE--
+<?php
+
+set_error_handler(function (int $errno, string $errstr, ?string $errfile = null, ?int $errline = null) {
+    var_dump($errno, E_USER_DEPRECATED, $errno === E_USER_DEPRECATED);
+});
+
+class Clazz {
+    #[\Deprecated]
+    public const TEST = 1;
+}
+
+Clazz::TEST;
+
+?>
+--EXPECT--
+int(16384)
+int(16384)
+bool(true)

Zend/tests/attributes/deprecated/class_constants/005.phpt

@@ -0,0 +1,26 @@
+--TEST--
+#[\Deprecated]: Using the value of a deprecated class constant as the deprecation message.
+--FILE--
+<?php
+
+class Clazz {
+    #[\Deprecated(self::TEST)]
+    public const TEST = "from itself";
+
+    #[\Deprecated]
+    public const TEST2 = "from another";
+
+    #[\Deprecated(self::TEST2)]
+    public const TEST3 = 1;
+}
+
+Clazz::TEST;
+Clazz::TEST3;
+
+?>
+--EXPECTF--
+Deprecated: Constant Clazz::TEST is deprecated, from itself in %s on line %d
+
+Deprecated: Constant Clazz::TEST2 is deprecated in %s on line %d
+
+Deprecated: Constant Clazz::TEST3 is deprecated, from another in %s on line %d

Zend/tests/attributes/deprecated/class_constants/006.phpt

@@ -0,0 +1,36 @@
+--TEST--
+#[\Deprecated]: Using the value of a deprecated class constant as the deprecation message with a throwing error handler.
+--FILE--
+<?php
+
+set_error_handler(function (int $errno, string $errstr, ?string $errfile = null, ?int $errline = null) {
+    throw new \ErrorException($errstr, 0, $errno, $errfile, $errline);
+});
+
+class Clazz {
+    #[\Deprecated(self::TEST)]
+    public const TEST = "from itself";
+
+    #[\Deprecated]
+    public const TEST2 = "from another";
+
+    #[\Deprecated(self::TEST2)]
+    public const TEST3 = 1;
+}
+
+try {
+    Clazz::TEST;
+} catch (ErrorException $e) {
+    echo "Caught: ", $e->getMessage(), PHP_EOL;
+}
+
+try {
+    Clazz::TEST3;
+} catch (ErrorException $e) {
+    echo "Caught: ", $e->getMessage(), PHP_EOL;
+}
+
+?>
+--EXPECT--
+Caught: Constant Clazz::TEST is deprecated, from itself
+Caught: Constant Clazz::TEST2 is deprecated

Zend/tests/attributes/deprecated/class_constants/007.phpt

@@ -0,0 +1,23 @@
+--TEST--
+#[\Deprecated]: Using the value of a deprecated class constant in a constant expression.
+--FILE--
+<?php
+
+class Clazz {
+    #[\Deprecated("prefix")]
+    public const PREFIX = "prefix";
+
+    #[\Deprecated("suffix")]
+    public const SUFFIX = "suffix";
+
+    public const CONSTANT = self::PREFIX . self::SUFFIX;
+}
+
+var_dump(Clazz::CONSTANT);
+
+?>
+--EXPECTF--
+Deprecated: Constant Clazz::PREFIX is deprecated, prefix in %s on line %d
+
+Deprecated: Constant Clazz::SUFFIX is deprecated, suffix in %s on line %d
+string(12) "prefixsuffix"

Zend/tests/attributes/deprecated/class_constants/008.phpt

@@ -0,0 +1,21 @@
+--TEST--
+#[\Deprecated]: Class constant with value unknown at compile time.
+--FILE--
+<?php
+
+define('SUFFIX', random_int(1, 2) == 1 ? 'a' : 'b');
+
+class Clazz {
+    #[\Deprecated]
+    public const CONSTANT = self::class . '-' . SUFFIX;
+}
+
+$value = Clazz::CONSTANT;
+var_dump($value);
+var_dump($value === 'Clazz-' . SUFFIX);
+
+?>
+--EXPECTF--
+Deprecated: Constant Clazz::CONSTANT is deprecated in %s on line %d
+string(7) "Clazz-%c"
+bool(true)

Zend/tests/attributes/deprecated/functions/001.phpt

@@ -0,0 +1,79 @@
+--TEST--
+#[\Deprecated]: Functions and Methods.
+--FILE--
+<?php
+
+error_reporting(E_ALL | E_DEPRECATED);
+ini_set('display_errors', true);
+
+#[\Deprecated]
+function test() {
+}
+
+#[\Deprecated("use test() instead")]
+function test2() {
+}
+
+class Clazz {
+    #[\Deprecated]
+    function test() {
+    }
+
+    #[\Deprecated("use test() instead")]
+    function test2() {
+    }
+}
+
+$closure = #[\Deprecated] function() {
+};
+
+$closure2 = #[\Deprecated] function() {
+};
+
+class Constructor {
+    #[\Deprecated]
+    public function __construct() {
+    }
+
+    #[\Deprecated]
+    public function __destruct() {
+    }
+}
+
+test();
+test2();
+call_user_func("test");
+
+$cls = new Clazz();
+$cls->test();
+$cls->test2();
+
+call_user_func([$cls, "test"]);
+
+$closure();
+
+$closure2();
+
+new Constructor();
+
+?>
+--EXPECTF--
+Deprecated: Function test() is deprecated in %s
+
+Deprecated: Function test2() is deprecated, use test() instead in %s
+
+Deprecated: Function test() is deprecated in %s
+
+Deprecated: Method Clazz::test() is deprecated in %s
+
+Deprecated: Method Clazz::test2() is deprecated, use test() instead in %s
+
+Deprecated: Method Clazz::test() is deprecated in %s
+
+Deprecated: Function {closure:%s:%d}() is deprecated in %s on line %d
+
+Deprecated: Function {closure:%s:%d}() is deprecated in %s on line %d
+
+Deprecated: Method Constructor::__construct() is deprecated in %s on line %d
+
+Deprecated: Method Constructor::__destruct() is deprecated in %s on line %d

Zend/tests/attributes/deprecated/functions/002.phpt

@@ -0,0 +1,40 @@
+--TEST--
+#[\Deprecated]: Instantiating via Reflection.
+--FILE--
+<?php
+
+#[\Deprecated]
+function test1() {
+}
+
+#[\Deprecated()]
+function test2() {
+}
+
+#[\Deprecated("use test() instead")]
+function test3() {
+}
+
+$reflection = new ReflectionFunction('test1');
+var_dump($reflection->getAttributes()[0]->newInstance());
+
+$reflection = new ReflectionFunction('test2');
+var_dump($reflection->getAttributes()[0]->newInstance());
+
+$reflection = new ReflectionFunction('test3');
+var_dump($reflection->getAttributes()[0]->newInstance());
+
+?>
+--EXPECTF--
+object(Deprecated)#%d (1) {
+  ["message"]=>
+  NULL
+}
+object(Deprecated)#%d (1) {
+  ["message"]=>
+  NULL
+}
+object(Deprecated)#%d (1) {
+  ["message"]=>
+  string(18) "use test() instead"
+}

Zend/tests/attributes/deprecated/functions/003.phpt

@@ -0,0 +1,14 @@
+--TEST--
+#[\Deprecated]: Type validation of $message parameter with int.
+--FILE--
+<?php
+
+#[\Deprecated(1234)]
+function test() {
+}
+
+test();
+
+?>
+--EXPECTF--
+Deprecated: Function test() is deprecated, 1234 in %s on line %d