Improve TypeError messages for non-numeric/empty strings in coercions

Implements proposal from #20632

Author: rizwan3d

Zend/tests/non_numarix_string_operand_error.phpt

@@ -0,0 +1,35 @@
+--TEST--
+Error message for non-numaric strings in arithmetic contexts
+--FILE--
+<?php
+declare(strict_types=0);
+
+function foo(int $a) { echo $a; }
+
+function msg(TypeError $e){
+    $split = explode(', called in', $e->getMessage(), 2);
+    return $split[0];
+}
+
+var_dump(1 + "1");
+try { var_dump(1 + "hello"); } catch (TypeError $e) { echo $e->getMessage(), "\n"; }
+try { var_dump(1 + ""); } catch (TypeError $e) { echo $e->getMessage(), "\n"; }
+try { var_dump("hello" + 1); } catch (TypeError $e) { echo $e->getMessage(), "\n"; }
+try { var_dump("" +  1); } catch (TypeError $e) { echo $e->getMessage(), "\n"; }
+
+foo("1"); 
+echo "\n";
+try { foo("hello"); } catch (TypeError $e) { echo msg($e), "\n"; }
+try { foo(""); } catch (TypeError $e) { echo msg($e), "\n"; }
+?>
+===DONE===
+--EXPECT--
+int(2)
+Unsupported operand types: int + non-numeric string
+Unsupported operand types: int + empty string
+Unsupported operand types: non-numeric string + int
+Unsupported operand types: empty string + int
+1
+foo(): Argument #1 ($a) must be of type int, non-numeric string given
+foo(): Argument #1 ($a) must be of type int, empty string given
+===DONE===

Zend/zend_API.c

@@ -149,6 +149,26 @@ ZEND_API const char *zend_zval_value_name(const zval *arg)
 	return zend_get_type_by_const(Z_TYPE_P(arg));
 }
 
+ZEND_API const char *zend_zval_namaric_string_value_name(const zval *arg)
+{
+    const zval *val = arg;
+
+    if (Z_TYPE_P(val) == IS_REFERENCE) {
+        val = Z_REFVAL_P(val);
+    }
+
+    if (Z_TYPE_P(val) == IS_STRING) {
+        if (Z_STRLEN_P(val) == 0) {
+            return "empty string";
+        }
+
+        return "non-numeric string";
+    }
+
+    return zend_zval_type_name(val);
+}
+
+
 ZEND_API const char *zend_zval_type_name(const zval *arg)
 {
 	ZVAL_DEREF(arg);
@@ -164,6 +184,8 @@ ZEND_API const char *zend_zval_type_name(const zval *arg)
 	return zend_get_type_by_const(Z_TYPE_P(arg));
 }
 
+
+
 /* This API exists *only* for use in gettype().
  * For anything else, you likely want zend_zval_type_name(). */
 ZEND_API zend_string *zend_zval_get_legacy_type(const zval *arg) /* {{{ */

Zend/zend_API.h

@@ -365,6 +365,7 @@ ZEND_API zend_result zend_parse_parameters_ex(int flags, uint32_t num_args, cons
 	zend_parse_parameters(num_args, __VA_ARGS__)
 ZEND_API const char *zend_zval_type_name(const zval *arg);
 ZEND_API const char *zend_zval_value_name(const zval *arg);
+ZEND_API const char *zend_zval_namaric_string_value_name(const zval *arg);
 ZEND_API zend_string *zend_zval_get_legacy_type(const zval *arg);
 
 ZEND_API zend_result zend_parse_method_parameters(uint32_t num_args, zval *this_ptr, const char *type_spec, ...);

Zend/zend_execute.c

@@ -718,6 +718,9 @@ ZEND_API ZEND_COLD void zend_verify_arg_error(
 
 	ZEND_ASSERT(zf->common.type == ZEND_USER_FUNCTION
 		&& "Arginfo verification is not performed for internal functions");
+	
+	given_msg = zend_zval_namaric_string_value_name(value);
+
 	if (ptr && ptr->func && ZEND_USER_CODE(ptr->func->common.type)) {
 		zend_argument_type_error(arg_num, "must be of type %s, %s given, called in %s on line %d",
 			ZSTR_VAL(need_msg), given_msg,

Zend/zend_operators.c

@@ -1122,7 +1122,7 @@ static ZEND_COLD zend_never_inline void ZEND_FASTCALL zend_binop_error(const cha
 	}
 
 	zend_type_error("Unsupported operand types: %s %s %s",
-		zend_zval_type_name(op1), operator, zend_zval_type_name(op2));
+		zend_zval_namaric_string_value_name(op1), operator, zend_zval_namaric_string_value_name(op2));
 }
 /* }}} */