feat: deprecate Date::toDateTime() method (#749)

Co-authored-by: Ben Challis <ben-challis@users.noreply.github.com>
Lendable · Aug 20, 2024 · 0114ecf · 0114ecf
1 parent 8e199a4
commit 0114ecf
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/lib/Date.php b/lib/Date.php
@@ -131,6 +131,9 @@ public function offsetByYears(int $years): self
 
     /**
      * Provides a date time representation of this date in UTC.
+     *
+     * @deprecated Converting a date with no time to a datetime with time of 00:00:00 in a certain timezone assumes
+     * too much and should be handled downstream where the default/assumed time and the timezone is well known.
      */
     public function toDateTime(): \DateTimeImmutable
     {

diff --git a/phpstan.neon b/phpstan.neon
@@ -18,3 +18,4 @@ parameters:
         - '#Dynamic call to static method PHPUnit\\Framework\\.*#'
         - '#^Call to an undefined static method DateTime(?:Immutable)?::createFromInterface\(\)\.$#'
         - '#^Attribute class PHPUnit\\Framework\\Attributes\\CodeCoverageIgnore is deprecated: https://github.com/sebastianbergmann/phpunit/issues/5236$#'
+        - '#Call to deprecated method toDateTime\(\) of class Lendable\\Clock\\Date:.*#'