refactor: Use native return types instead of using #[ReturnTypeWillChange] (#9900)

* refactor: Use native return types instead of using `#[ReturnTypeWillChange]`

* Add changelog

* Fix some errors in psalm

Author: paulbalandan

psalm-baseline.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="6.13.0@70cdf647255a1362b426bb0f522a85817b8c791c">
+<files psalm-version="6.14.3@d0b040a91f280f071c1abcb1b77ce3822058725a">
   <file src="app/Config/View.php">
     <UndefinedDocblockClass>
       <code><![CDATA[array<string, list<parser_callable_string>|parser_callable_string|parser_callable>]]></code>
@@ -64,8 +64,7 @@
   </file>
   <file src="system/I18n/TimeTrait.php">
     <MissingImmutableAnnotation>
-      <code><![CDATA[#[ReturnTypeWillChange]]]></code>
-      <code><![CDATA[#[ReturnTypeWillChange]]]></code>
+      <code><![CDATA[public function setTimezone($timezone): static]]></code>
     </MissingImmutableAnnotation>
   </file>
   <file src="system/Language/Language.php">

system/Cookie/Cookie.php

@@ -20,7 +20,6 @@
 use CodeIgniter\I18n\Time;
 use Config\Cookie as CookieConfig;
 use DateTimeInterface;
-use ReturnTypeWillChange;
 
 /**
  * A `Cookie` class represents an immutable HTTP cookie value object.
@@ -606,12 +605,9 @@ public function offsetExists($offset): bool
      *
      * @param string $offset
      *
-     * @return bool|int|string
-     *
      * @throws InvalidArgumentException
      */
-    #[ReturnTypeWillChange]
-    public function offsetGet($offset)
+    public function offsetGet($offset): bool|int|string
     {
         if (! $this->offsetExists($offset)) {
             throw new InvalidArgumentException(sprintf('Undefined offset "%s".', $offset));

system/Entity/Entity.php

@@ -33,7 +33,6 @@
 use DateTimeInterface;
 use Exception;
 use JsonSerializable;
-use ReturnTypeWillChange;
 use Traversable;
 use UnitEnum;
 
@@ -602,8 +601,7 @@ protected function dataCaster(): ?DataCaster
      *
      * @return array<string, mixed>
      */
-    #[ReturnTypeWillChange]
-    public function jsonSerialize()
+    public function jsonSerialize(): array
     {
         return $this->toArray();
     }

system/Files/File.php

@@ -17,7 +17,7 @@
 use CodeIgniter\Files\Exceptions\FileNotFoundException;
 use CodeIgniter\I18n\Time;
 use Config\Mimes;
-use ReturnTypeWillChange;
+use RuntimeException;
 use SplFileInfo;
 
 /**
@@ -59,13 +59,11 @@ public function __construct(string $path, bool $checkFile = false)
      *
      * Implementations SHOULD return the value stored in the "size" key of
      * the file in the $_FILES array if available, as PHP calculates this based
-     * on the actual size transmitted. A RuntimeException will be thrown if the file
-     * does not exist or an error occurs.
+     * on the actual size transmitted.
      *
-     * @return false|int The file size in bytes, or false on failure
+     * @throws RuntimeException if the file does not exist or an error occurs
      */
-    #[ReturnTypeWillChange]
-    public function getSize()
+    public function getSize(): false|int
     {
         return $this->size ?? ($this->size = parent::getSize());
     }

system/I18n/TimeLegacy.php

@@ -15,7 +15,6 @@
 
 use DateTime;
 use Exception;
-use ReturnTypeWillChange;
 
 /**
  * Legacy Time class.
@@ -55,12 +54,9 @@ class TimeLegacy extends DateTime
      *
      * @param int $timestamp
      *
-     * @return static
-     *
      * @throws Exception
      */
-    #[ReturnTypeWillChange]
-    public function setTimestamp($timestamp)
+    public function setTimestamp($timestamp): static
     {
         $time = date('Y-m-d H:i:s', $timestamp);
 

system/I18n/TimeTrait.php

@@ -23,7 +23,6 @@
 use IntlCalendar;
 use IntlDateFormatter;
 use Locale;
-use ReturnTypeWillChange;
 
 /**
  * This trait has properties and methods for Time and TimeLegacy.
@@ -238,16 +237,15 @@ public static function create(
      * Provides a replacement for DateTime's own createFromFormat function, that provides
      * more flexible timeZone handling
      *
+     * @psalm-external-mutation-free
+     *
      * @param string                   $format
      * @param string                   $datetime
      * @param DateTimeZone|string|null $timezone
      *
-     * @return static
-     *
      * @throws Exception
      */
-    #[ReturnTypeWillChange]
-    public static function createFromFormat($format, $datetime, $timezone = null)
+    public static function createFromFormat($format, $datetime, $timezone = null): static
     {
         if (! $date = parent::createFromFormat($format, $datetime)) {
             throw I18nException::forInvalidFormat($format);
@@ -673,16 +671,14 @@ protected function setValue(string $name, $value)
      *
      * @param DateTimeZone|string $timezone
      *
-     * @return static
-     *
      * @throws Exception
      */
-    #[ReturnTypeWillChange]
-    public function setTimezone($timezone)
+    public function setTimezone($timezone): static
     {
         $timezone = $timezone instanceof DateTimeZone ? $timezone : new DateTimeZone($timezone);
+        $dateTime = $this->toDateTime()->setTimezone($timezone);
 
-        return static::createFromInstance($this->toDateTime()->setTimezone($timezone), $this->locale);
+        return static::createFromInstance($dateTime, $this->locale);
     }
 
     // --------------------------------------------------------------------

system/Session/Handlers/ArrayHandler.php

@@ -13,8 +13,6 @@
 
 namespace CodeIgniter\Session\Handlers;
 
-use ReturnTypeWillChange;
-
 /**
  * Session handler using static array for storage.
  * Intended only for use during testing.
@@ -41,12 +39,8 @@ public function open($path, $name): bool
      * Reads the session data from the session storage, and returns the results.
      *
      * @param string $id The session ID.
-     *
-     * @return false|string Returns an encoded string of the read data.
-     *                      If nothing was read, it must return false.
      */
-    #[ReturnTypeWillChange]
-    public function read($id)
+    public function read($id): string
     {
         return '';
     }
@@ -85,11 +79,8 @@ public function destroy($id): bool
      *
      * @param int $max_lifetime Sessions that have not updated
      *                          for the last max_lifetime seconds will be removed.
-     *
-     * @return false|int Returns the number of deleted sessions on success, or false on failure.
      */
-    #[ReturnTypeWillChange]
-    public function gc($max_lifetime)
+    public function gc($max_lifetime): int
     {
         return 1;
     }

system/Session/Handlers/Database/PostgreHandler.php

@@ -15,7 +15,6 @@
 
 use CodeIgniter\Database\BaseBuilder;
 use CodeIgniter\Session\Handlers\DatabaseHandler;
-use ReturnTypeWillChange;
 
 /**
  * Session handler for Postgre
@@ -59,11 +58,8 @@ protected function prepareData(string $data): string
      *
      * @param int $max_lifetime Sessions that have not updated
      *                          for the last max_lifetime seconds will be removed.
-     *
-     * @return false|int Returns the number of deleted sessions on success, or false on failure.
      */
-    #[ReturnTypeWillChange]
-    public function gc($max_lifetime)
+    public function gc($max_lifetime): false|int
     {
         $separator = '\'';
         $interval  = implode($separator, ['', "{$max_lifetime} second", '']);

system/Session/Handlers/DatabaseHandler.php

@@ -18,7 +18,6 @@
 use CodeIgniter\Session\Exceptions\SessionException;
 use Config\Database;
 use Config\Session as SessionConfig;
-use ReturnTypeWillChange;
 
 /**
  * Base database session handler.
@@ -107,12 +106,8 @@ public function open($path, $name): bool
      * Reads the session data from the session storage, and returns the results.
      *
      * @param string $id The session ID
-     *
-     * @return false|string Returns an encoded string of the read data.
-     *                      If nothing was read, it must return false.
      */
-    #[ReturnTypeWillChange]
-    public function read($id)
+    public function read($id): false|string
     {
         if ($this->lockSession($id) === false) {
             $this->fingerprint = md5('');
@@ -281,8 +276,7 @@ public function destroy($id): bool
      *
      * @return false|int Returns the number of deleted sessions on success, or false on failure.
      */
-    #[ReturnTypeWillChange]
-    public function gc($max_lifetime)
+    public function gc($max_lifetime): false|int
     {
         return $this->db->table($this->table)->where(
             'timestamp <',

system/Session/Handlers/FileHandler.php

@@ -16,7 +16,6 @@
 use CodeIgniter\I18n\Time;
 use CodeIgniter\Session\Exceptions\SessionException;
 use Config\Session as SessionConfig;
-use ReturnTypeWillChange;
 
 /**
  * Session handler using file system for storage.
@@ -115,12 +114,8 @@ public function open($path, $name): bool
      * Reads the session data from the session storage, and returns the results.
      *
      * @param string $id The session ID.
-     *
-     * @return false|string Returns an encoded string of the read data.
-     *                      If nothing was read, it must return false.
      */
-    #[ReturnTypeWillChange]
-    public function read($id)
+    public function read($id): false|string
     {
         // This might seem weird, but PHP 5.6 introduced session_reset(),
         // which re-reads session data
@@ -267,11 +262,8 @@ public function destroy($id): bool
      *
      * @param int $max_lifetime Sessions that have not updated
      *                          for the last max_lifetime seconds will be removed.
-     *
-     * @return false|int Returns the number of deleted sessions on success, or false on failure.
      */
-    #[ReturnTypeWillChange]
-    public function gc($max_lifetime)
+    public function gc($max_lifetime): false|int
     {
         if (! is_dir($this->savePath) || ($directory = opendir($this->savePath)) === false) {
             $this->logger->debug("Session: Garbage collector couldn't list files under directory '" . $this->savePath . "'.");