ext/mysqli: Deprecate passing the parameter to mysqli_store_result() (#15311)

And deprecate the MYSQLI_STORE_RESULT_COPY_DATA constant.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_the_second_parameter_to_mysqli_store_result

Author: Girgias

NEWS

@@ -41,6 +41,9 @@ PHP                                                                        NEWS
   . The mysqli_refresh() function and mysqli::refresh() method are now deprecated.
     If this functionality is needed a SQL "FLUSH" command can be used instead.
     (Kamil Tekiela)
+  . Passing explicitly the $mode parameter to mysqli_store_result() has been
+    deprecated. As the MYSQLI_STORE_RESULT_COPY_DATA constant was only used in
+    conjunction with this function it has also been deprecated. (Girgias)
 
 - PHPDBG:
   . array out of bounds, stack overflow handled for segfault handler on windows.

UPGRADING

@@ -457,6 +457,10 @@ PHP 8.4 UPGRADE NOTES
   . The mysqli_refresh() function and mysqli::refresh() method are now deprecated.
     If this functionality is needed a SQL "FLUSH" command can be used instead.
     RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_mysqli_refresh
+  . Passing explicitly the $mode parameter to mysqli_store_result() has been
+    deprecated. As the MYSQLI_STORE_RESULT_COPY_DATA constant was only used in
+    conjunction with this function it has also been deprecated.
+    RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_the_second_parameter_to_mysqli_store_result
 
 - PDO_PGSQL:
   . Using escaped question marks (??) inside dollar-quoted strings is deprecated.

ext/mysqli/mysqli.stub.php

@@ -138,6 +138,7 @@
 /**
  * @var int
  * @cvalue MYSQLI_STORE_RESULT_COPY_DATA
+ * @deprecated
  */
 const MYSQLI_STORE_RESULT_COPY_DATA = UNKNOWN;
 

ext/mysqli/mysqli_api.c

@@ -1957,6 +1957,14 @@ PHP_FUNCTION(mysqli_store_result)
 	if (zend_parse_method_parameters(ZEND_NUM_ARGS(), getThis(), "O|l", &mysql_link, mysqli_link_class_entry, &flags) == FAILURE) {
 		RETURN_THROWS();
 	}
+
+	if ((hasThis() && ZEND_NUM_ARGS() == 1) || ZEND_NUM_ARGS() == 2) {
+		zend_error(E_DEPRECATED, "Passing the $mode parameter is deprecated since 8.4, as it has been ignored since 8.1");
+		if (UNEXPECTED(EG(exception))) {
+			RETURN_THROWS();
+		}
+	}
+
 	MYSQLI_FETCH_RESOURCE_CONN(mysql, mysql_link, MYSQLI_STATUS_VALID);
 	result = mysql_store_result(mysql->mysql);
 	if (!result) {

ext/mysqli/tests/bug77597.phpt

@@ -18,7 +18,7 @@ $mysqli->query('INSERT INTO test VALUES (1),(2),(3),(4),(5),(6),(7),(8),(9)');
 
 $mysqli->real_query("SELECT * FROM test");
 
-$result = $mysqli->store_result(MYSQLI_STORE_RESULT_COPY_DATA);
+$result = $mysqli->store_result();
 
 $field = $result->fetch_field();
 var_dump($field->name);

ext/mysqli/tests/mysqli_store_result_buffered_c.phpt

@@ -13,7 +13,7 @@ require_once 'skipifconnectfailure.inc';
     if (!$res = mysqli_real_query($link, "SELECT id, label FROM test ORDER BY id"))
         printf("[003] [%d] %s\n", mysqli_errno($link), mysqli_error($link));
 
-    if (!is_object($res = mysqli_store_result($link, MYSQLI_STORE_RESULT_COPY_DATA)))
+    if (!is_object($res = mysqli_store_result($link)))
         printf("[004] Expecting object, got %s/%s. [%d] %s\n",
             gettype($res), $res, mysqli_errno($link), mysqli_error($link));