Deprecate strftime() and gmstrftime()

These are deprecated in favor of date()/DateTime::format() (for locale-indendent formatting) and IntlDateFormatter::format() (for locale-dependent formatting). Part of https://wiki.php.net/rfc/deprecations_php_8_1.
php · Jul 14, 2021 · 4b3615a · 4b3615a
1 parent 9491694
commit 4b3615a
Show file tree

Hide file tree

Showing 53 changed files with 483 additions and 34 deletions.
diff --git a/UPGRADING b/UPGRADING
@@ -359,6 +359,9 @@ PHP 8.1 UPGRADE NOTES
   . The date_sunrise() and date_sunset() functions have been deprecated in
     favor of date_sun_info().
     RFC: https://wiki.php.net/rfc/deprecations_php_8_1
+  . The strftime() and gmstrftime() functions have been deprecated in favor of
+    date()/DateTime::format() (for locale-independent formatting) or
+    IntlDateFormatter::format() (for locale-dependent formatting).
 
 - Filter:
   . The FILTER_SANITIZE_STRING and FILTER_SANITIZE_STRIPPED filters have been

diff --git a/ext/date/php_date.stub.php b/ext/date/php_date.stub.php
@@ -20,8 +20,10 @@ function gmmktime(
 
 function checkdate(int $month, int $day, int $year): bool {}
 
+/** @deprecated */
 function strftime(string $format, ?int $timestamp = null): string|false {}
 
+/** @deprecated */
 function gmstrftime(string $format, ?int $timestamp = null): string|false {}
 
 function time(): int {}

diff --git a/ext/date/php_date_arginfo.h b/ext/date/php_date_arginfo.h
@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: fbec11a67d5cc04667a012f25894f0d9e18833a6 */
+ * Stub hash: bc0634c149cda640616f7ecd7e173a0d6497a911 */
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_strtotime, 0, 1, MAY_BE_LONG|MAY_BE_FALSE)
 	ZEND_ARG_TYPE_INFO(0, datetime, IS_STRING, 0)
@@ -559,8 +559,8 @@ static const zend_function_entry ext_functions[] = {
 	ZEND_FE(mktime, arginfo_mktime)
 	ZEND_FE(gmmktime, arginfo_gmmktime)
 	ZEND_FE(checkdate, arginfo_checkdate)
-	ZEND_FE(strftime, arginfo_strftime)
-	ZEND_FE(gmstrftime, arginfo_gmstrftime)
+	ZEND_DEP_FE(strftime, arginfo_strftime)
+	ZEND_DEP_FE(gmstrftime, arginfo_gmstrftime)
 	ZEND_FE(time, arginfo_time)
 	ZEND_FE(localtime, arginfo_localtime)
 	ZEND_FE(getdate, arginfo_getdate)

diff --git a/ext/date/tests/009.phpt b/ext/date/tests/009.phpt
@@ -23,14 +23,29 @@ var_dump(gmstrftime("blah", $t));
 echo "Done\n";
 ?>
 --EXPECTF--
+Deprecated: Function strftime() is deprecated in %s on line %d
 bool(false)
+
+Deprecated: Function strftime() is deprecated in %s on line %d
 string(%d) "Tue Tuesday Jun June Tue Jun 27 00:00:00 2006 %s
 %s %"
+
+Deprecated: Function strftime() is deprecated in %s on line %d
 string(5) "%q %a"
+
+Deprecated: Function strftime() is deprecated in %s on line %d
 string(4) "blah"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 bool(false)
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "Mon Monday Jun June Mon Jun 26 21:00:00 2006 %s
 %s %"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(5) "%q %a"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(4) "blah"
 Done
diff --git a/ext/date/tests/009_win32.phpt b/ext/date/tests/009_win32.phpt
@@ -35,12 +35,27 @@ echo "Done\n";
 setlocale(LC_TIME, $loc);
 ?>
 --EXPECTF--
+Deprecated: Function strftime() is deprecated in %s on line %d
 bool(false)
+
+Deprecated: Function strftime() is deprecated in %s on line %d
 string(%d) "Tue Tuesday Jun June 6/27/2006 12:00:00 AM 27 00 12 178 06 00 AM 00 26 26 2 6/27/2006 12:00:00 AM 06 2006 %s"
+
+Deprecated: Function strftime() is deprecated in %s on line %d
 string(5) "%q %a"
+
+Deprecated: Function strftime() is deprecated in %s on line %d
 string(4) "blah"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 bool(false)
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "Mon Monday Jun June 6/26/2006 9:00:00 PM 26 21 09 177 06 00 PM 00 26 26 1 6/26/2006 9:00:00 PM 06 2006 %s"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(5) "%q %a"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(4) "blah"
 Done
diff --git a/ext/date/tests/bug33532.phpt b/ext/date/tests/bug33532.phpt
@@ -6,7 +6,7 @@ date.timezone=UTC
 --SKIPIF--
 <?php
 if(PHP_OS == 'Darwin' || defined('PHP_WINDOWS_VERSION_MAJOR')) die("skip strftime uses system TZ on Darwin and Windows");
-if (!strftime('%Z')) die('skip strftime does not support %Z');
+if (!@strftime('%Z')) die('skip strftime does not support %Z');
 ?>
 --FILE--
 <?php

diff --git a/ext/date/tests/bug65184.phpt b/ext/date/tests/bug65184.phpt
@@ -8,6 +8,7 @@ if (strtoupper(substr(PHP_OS, 0, 3)) != 'WIN') {
 ?>
 --INI--
 date.timezone = UTC
+error_reporting=E_ALL&~E_DEPRECATED
 --FILE--
 <?php
     setlocale(LC_ALL, 'Japanese_Japan.932');

diff --git a/ext/date/tests/bug65371.phpt b/ext/date/tests/bug65371.phpt
@@ -16,8 +16,12 @@ function p($str)
 setlocale(LC_ALL, 'C');
 p('あ');
 ?>
---EXPECT--
+--EXPECTF--
 あ
+
+Deprecated: Function strftime() is deprecated in %s on line %d
 あ
 e38182
+
+Deprecated: Function strftime() is deprecated in %s on line %d
 e38182
diff --git a/ext/date/tests/gmstrftime_basic.phpt b/ext/date/tests/gmstrftime_basic.phpt
@@ -17,5 +17,9 @@ var_dump( gmstrftime($format) );
 ?>
 --EXPECTF--
 *** Testing gmstrftime() : basic functionality ***
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(20) "Aug 08 2008 08:08:08"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%s %d %d %d:%d:%d"
diff --git a/ext/date/tests/gmstrftime_variation10.phpt b/ext/date/tests/gmstrftime_variation10.phpt
@@ -34,9 +34,17 @@ foreach($inputs as $key =>$value) {
 *** Testing gmstrftime() : usage variation ***
 
 --The ISO 8601:1988 week number--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(2) "32"
 
 --Weekday as decimal--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(1) "5"
diff --git a/ext/date/tests/gmstrftime_variation11.phpt b/ext/date/tests/gmstrftime_variation11.phpt
@@ -19,5 +19,9 @@ var_dump( gmstrftime($format, $timestamp) );
 *** Testing gmstrftime() : usage variation ***
 
 -- Testing gmstrftime() function with  Abbreviated month name format %h --
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%s"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(3) "Aug"
diff --git a/ext/date/tests/gmstrftime_variation12.phpt b/ext/date/tests/gmstrftime_variation12.phpt
@@ -25,5 +25,9 @@ var_dump( gmstrftime($format, $timestamp) );
 *** Testing gmstrftime() : usage variation ***
 
 -- Testing gmstrftime() function with  Abbreviated month name format %h --
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%s"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(3) "Aug"
diff --git a/ext/date/tests/gmstrftime_variation13.phpt b/ext/date/tests/gmstrftime_variation13.phpt
@@ -30,17 +30,33 @@ foreach($inputs as $key =>$value) {
 *** Testing gmstrftime() : usage variation ***
 
 --Century number--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(2) "%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(2) "20"
 
 --Month Date Year--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d/%d/%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(8) "08/08/08"
 
 --Year with century--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(4) "2008"
 
 --Year without century--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(2) "%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(2) "08"
diff --git a/ext/date/tests/gmstrftime_variation14.phpt b/ext/date/tests/gmstrftime_variation14.phpt
@@ -36,17 +36,33 @@ foreach($inputs as $key =>$value) {
 *** Testing gmstrftime() : usage variation ***
 
 --Century number--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(2) "20"
 
 --Month Date Year--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d/%d/%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(8) "08/08/08"
 
 --Year with century--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(4) "2008"
 
 --Year without century--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(2) "08"
diff --git a/ext/date/tests/gmstrftime_variation15.phpt b/ext/date/tests/gmstrftime_variation15.phpt
@@ -29,13 +29,25 @@ foreach($inputs as $key =>$value) {
 *** Testing gmstrftime() : usage variation ***
 
 --Time in a.m/p.m notation--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d:%d:%d %c%c"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(11) "08:08:08 AM"
 
 --Time in 24 hour notation--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d:%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(5) "08:08"
 
 --Current time %H:%M:%S format--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d:%d:%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(8) "08:08:08"
diff --git a/ext/date/tests/gmstrftime_variation16.phpt b/ext/date/tests/gmstrftime_variation16.phpt
@@ -35,13 +35,25 @@ foreach($inputs as $key =>$value) {
 *** Testing gmstrftime() : usage variation ***
 
 --Time in a.m/p.m notation--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d:%d:%d %s"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(11) "02:08:08 PM"
 
 --Time in 24 hour notation--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d:%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(5) "14:08"
 
 --Current time %H:%M:%S format--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d:%d:%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(8) "14:08:08"
diff --git a/ext/date/tests/gmstrftime_variation17.phpt b/ext/date/tests/gmstrftime_variation17.phpt
@@ -19,5 +19,9 @@ var_dump( gmstrftime($format, $timestamp) );
 *** Testing gmstrftime() : usage variation ***
 
 -- Testing gmstrftime() function with Day of the month as decimal single digit format --
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(2) "%A%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(2) " 8"
diff --git a/ext/date/tests/gmstrftime_variation18.phpt b/ext/date/tests/gmstrftime_variation18.phpt
@@ -25,5 +25,9 @@ var_dump( gmstrftime($format, $timestamp) );
 *** Testing gmstrftime() : usage variation ***
 
 -- Testing gmstrftime() function with Day of the month as decimal single digit format --
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%s"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(2) " 8"
diff --git a/ext/date/tests/gmstrftime_variation19.phpt b/ext/date/tests/gmstrftime_variation19.phpt
@@ -24,15 +24,23 @@ foreach($inputs as $key =>$value) {
 };
 
 ?>
---EXPECT--
+--EXPECTF--
 *** Testing gmstrftime() : usage variation ***
 
 --Newline character--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(1) "
 "
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(1) "
 "
 
 --Tab character--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(1) "	"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(1) "	"
diff --git a/ext/date/tests/gmstrftime_variation20.phpt b/ext/date/tests/gmstrftime_variation20.phpt
@@ -30,15 +30,23 @@ foreach($inputs as $key =>$value) {
 };
 
 ?>
---EXPECTREGEX--
-\*\*\* Testing gmstrftime\(\) : usage variation \*\*\*
+--EXPECTF--
+*** Testing gmstrftime() : usage variation ***
 
 --Newline character--
-string\(1\) "
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
+string(1) "
 "
-string\(1\) "
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
+string(1) "
 "
 
 --Tab character--
-string\(1\) "\s"
-string\(1\) "\s"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
+string(1) "%r\s%r"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
+string(1) "%r\s%r"
diff --git a/ext/date/tests/gmstrftime_variation21.phpt b/ext/date/tests/gmstrftime_variation21.phpt
@@ -29,13 +29,25 @@ foreach($inputs as $key =>$value) {
 *** Testing gmstrftime() : usage variation ***
 
 --Preferred date and time representation--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%s %s %d %d:%d:%d %d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(24) "Fri Aug  8 08:08:08 2008"
 
 --Preferred date representation--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d/%d/%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(8) "08/08/08"
 
 --Preferred time representation--
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(%d) "%d:%d:%d"
+
+Deprecated: Function gmstrftime() is deprecated in %s on line %d
 string(8) "08:08:08"