Make DateTime::modify() behaviour less annoying

phpstan · May 4, 2022 · 7bd9fb7 · 7bd9fb7 · VincentLanglet · May 5, 2022
1 parent b5da7ce
commit 7bd9fb7
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 2 deletions.
diff --git a/resources/functionMap.php b/resources/functionMap.php
@@ -1604,7 +1604,7 @@
 'DateTime::getOffset' => ['int'],
 'DateTime::getTimestamp' => ['int'],
 'DateTime::getTimezone' => ['DateTimeZone'],
-'DateTime::modify' => ['static|false', 'modify'=>'string'],
+'DateTime::modify' => ['__benevolent<static|false>', 'modify'=>'string'],
 'DateTime::setDate' => ['static', 'year'=>'int', 'month'=>'int', 'day'=>'int'],
 'DateTime::setISODate' => ['static', 'year'=>'int', 'week'=>'int', 'day='=>'int'],
 'DateTime::setTime' => ['static', 'hour'=>'int', 'minute'=>'int', 'second='=>'int', 'microseconds='=>'int'],
@@ -1623,7 +1623,7 @@
 'DateTimeImmutable::getOffset' => ['int'],
 'DateTimeImmutable::getTimestamp' => ['int'],
 'DateTimeImmutable::getTimezone' => ['DateTimeZone'],
-'DateTimeImmutable::modify' => ['static|false', 'modify'=>'string'],
+'DateTimeImmutable::modify' => ['__benevolent<static|false>', 'modify'=>'string'],
 'DateTimeImmutable::setDate' => ['static', 'year'=>'int', 'month'=>'int', 'day'=>'int'],
 'DateTimeImmutable::setISODate' => ['static', 'year'=>'int', 'week'=>'int', 'day='=>'int'],
 'DateTimeImmutable::setTime' => ['static', 'hour'=>'int', 'minute'=>'int', 'second='=>'int', 'microseconds='=>'int'],

diff --git a/tests/PHPStan/Analyser/data/bug-6609.php b/tests/PHPStan/Analyser/data/bug-6609.php
@@ -23,4 +23,36 @@ function modify(\DateTimeInterface $date) {
 		return $date;
 	}
 
+	/**
+	 * This method should return the same type as a parameter passed.
+	 *
+	 * @template T of \DateTime|\DateTimeImmutable
+	 *
+	 * @param T $date
+	 *
+	 * @return T
+	 */
+	function modify2(\DateTimeInterface $date) {
+		$date = $date->modify('invalidd');
+		assertType('false', $date);
+
+		return $date;
+	}
+
+	/**
+	 * This method should return the same type as a parameter passed.
+	 *
+	 * @template T of \DateTime|\DateTimeImmutable
+	 *
+	 * @param T $date
+	 *
+	 * @return T
+	 */
+	function modify3(\DateTimeInterface $date, string $s) {
+		$date = $date->modify($s);
+		assertType('(DateTime|DateTimeImmutable|false)', $date);
+
+		return $date;
+	}
+
 }