Deprecate disabling report_memleaks INI directive

Author: alexandre-daubois

NEWS

@@ -29,6 +29,7 @@ PHP                                                                        NEWS
     (timwolla)
   . Returning null from __debugInfo() has been deprecated. (DanielEScherzer)
   . Support #[\Override] on properties. (Jiří Pudil)
+  . The report_memleaks INI directive has been deprecated. (alexandre-daubois)
 
 - Curl:
   . The curl_close() function has been deprecated. (DanielEScherzer)

UPGRADING

@@ -337,6 +337,7 @@ PHP 8.5 UPGRADE NOTES
   . Returning null from __debugInfo() has been deprecated.
     Return an empty array instead.
     RFC: https://wiki.php.net/rfc/deprecations_php_8_5#deprecate_debuginfo_returning_null
+  . The report_memleaks INI directive has been deprecated.
 
 - Curl:
   . The curl_close() function has been deprecated, as CurlHandle objects are

main/main.c

@@ -698,6 +698,19 @@ static PHP_INI_MH(OnUpdateInputEncoding)
 }
 /* }}} */
 
+static PHP_INI_MH(OnUpdateReportMemleaks)
+{
+	bool *p = (bool *) ZEND_INI_GET_ADDR();
+	bool new_bool_value = zend_ini_parse_bool(new_value);
+
+	if (!new_bool_value) {
+		php_error_docref(NULL, E_DEPRECATED, "Directive 'report_memleaks' is deprecated");
+	}
+
+	*p = new_bool_value;
+	return SUCCESS;
+}
+
 /* {{{ PHP_INI_MH */
 static PHP_INI_MH(OnUpdateOutputEncoding)
 {
@@ -801,7 +814,7 @@ PHP_INI_BEGIN()
 	STD_PHP_INI_BOOLEAN("log_errors",			"0",		PHP_INI_ALL,		OnUpdateBool,			log_errors,				php_core_globals,	core_globals)
 	STD_PHP_INI_BOOLEAN("ignore_repeated_errors",	"0",	PHP_INI_ALL,		OnUpdateBool,			ignore_repeated_errors,	php_core_globals,	core_globals)
 	STD_PHP_INI_BOOLEAN("ignore_repeated_source",	"0",	PHP_INI_ALL,		OnUpdateBool,			ignore_repeated_source,	php_core_globals,	core_globals)
-	STD_PHP_INI_BOOLEAN("report_memleaks",		"1",		PHP_INI_ALL,		OnUpdateBool,			report_memleaks,		php_core_globals,	core_globals)
+	STD_PHP_INI_BOOLEAN("report_memleaks",		"1",		PHP_INI_ALL,		OnUpdateReportMemleaks,	report_memleaks,		php_core_globals,	core_globals)
 	STD_PHP_INI_BOOLEAN("report_zend_debug",	"0",		PHP_INI_ALL,		OnUpdateBool,			report_zend_debug,		php_core_globals,	core_globals)
 	STD_PHP_INI_ENTRY("output_buffering",		"0",		PHP_INI_PERDIR|PHP_INI_SYSTEM,	OnUpdateLong,	output_buffering,		php_core_globals,	core_globals)
 	STD_PHP_INI_ENTRY("output_handler",			NULL,		PHP_INI_PERDIR|PHP_INI_SYSTEM,	OnUpdateString,	output_handler,		php_core_globals,	core_globals)

php.ini-development

@@ -537,11 +537,12 @@ ignore_repeated_errors = Off
 ; https://php.net/ignore-repeated-source
 ignore_repeated_source = Off
 
+; Use of this INI entry is deprecated, it will be removed in PHP 9.0.
 ; If this parameter is set to Off, then memory leaks will not be shown (on
 ; stdout or in the log). This is only effective in a debug compile, and if
 ; error reporting includes E_WARNING in the allowed list
 ; https://php.net/report-memleaks
-report_memleaks = On
+;report_memleaks = On
 
 ; This setting is off by default.
 ;report_zend_debug = 0

php.ini-production

@@ -539,11 +539,12 @@ ignore_repeated_errors = Off
 ; https://php.net/ignore-repeated-source
 ignore_repeated_source = Off
 
+; Use of this INI entry is deprecated, it will be removed in PHP 9.0.
 ; If this parameter is set to Off, then memory leaks will not be shown (on
 ; stdout or in the log). This is only effective in a debug compile, and if
 ; error reporting includes E_WARNING in the allowed list
 ; https://php.net/report-memleaks
-report_memleaks = On
+;report_memleaks = On
 
 ; This setting is off by default.
 ;report_zend_debug = 0

run-tests.php

@@ -278,7 +278,6 @@ function main(): void
         'log_errors=0',
         'html_errors=0',
         'track_errors=0',
-        'report_memleaks=1',
         'report_zend_debug=0',
         'docref_root=',
         'docref_ext=.html',

tests/basic/ini_directive_deprecated_report_memleaks.phpt

@@ -0,0 +1,11 @@
+--TEST--
+Deprecated INI directive report_memleaks warning
+--INI--
+report_memleaks=0
+--FILE--
+<?php
+echo "Testing deprecated report_memleaks INI directive.\n";
+?>
+--EXPECT--
+Deprecated: PHP Startup: Directive 'report_memleaks' is deprecated in Unknown on line 0
+Testing deprecated report_memleaks INI directive.