refactor: fix phpstan errors in I18n

Author: paulbalandan

system/I18n/Time.php

@@ -34,6 +34,7 @@
  * @property-read string $quarter
  * @property-read string $second
  * @property-read int    $timestamp
+ * @property-read string $timezoneName
  * @property-read bool   $utc
  * @property-read string $weekOfMonth
  * @property-read string $weekOfYear

system/I18n/TimeLegacy.php

@@ -23,22 +23,23 @@
  * This is not immutable! Some methods are immutable,
  * but some methods can alter the state.
  *
- * @property int    $age         read-only
- * @property string $day         read-only
- * @property string $dayOfWeek   read-only
- * @property string $dayOfYear   read-only
- * @property bool   $dst         read-only
- * @property string $hour        read-only
- * @property bool   $local       read-only
- * @property string $minute      read-only
- * @property string $month       read-only
- * @property string $quarter     read-only
- * @property string $second      read-only
- * @property int    $timestamp   read-only
- * @property bool   $utc         read-only
- * @property string $weekOfMonth read-only
- * @property string $weekOfYear  read-only
- * @property string $year        read-only
+ * @property int    $age          read-only
+ * @property string $day          read-only
+ * @property string $dayOfWeek    read-only
+ * @property string $dayOfYear    read-only
+ * @property bool   $dst          read-only
+ * @property string $hour         read-only
+ * @property bool   $local        read-only
+ * @property string $minute       read-only
+ * @property string $month        read-only
+ * @property string $quarter      read-only
+ * @property string $second       read-only
+ * @property int    $timestamp    read-only
+ * @property string $timezoneName read-only
+ * @property bool   $utc          read-only
+ * @property string $weekOfMonth  read-only
+ * @property string $weekOfYear   read-only
+ * @property string $year         read-only
  *
  * @phpstan-consistent-constructor
  *

tests/system/I18n/TimeLegacyTest.php

@@ -317,7 +317,7 @@ public function testMagicIssetFalse(): void
     {
         $time = TimeLegacy::parse('January 1, 2016');
 
-        $this->assertFalse(isset($time->foobar));
+        $this->assertFalse(isset($time->foobar)); // @phpstan-ignore property.notFound
     }
 
     public function testGetYear(): void
@@ -1128,7 +1128,7 @@ public function testGetter(): void
     {
         $time = TimeLegacy::parse('August 12, 2016 4:15:23pm');
 
-        $this->assertNull($time->weekOfWeek);
+        $this->assertNull($time->weekOfWeek); // @phpstan-ignore property.notFound
     }
 
     public function testUnserializeTimeObject(): void
@@ -1163,6 +1163,9 @@ public function testToStringDoesNotDependOnLocale(string $locale): void
         $this->assertSame('2017-03-10 12:00:00', (string) $time);
     }
 
+    /**
+     * @return iterable<int, array{0: string}>
+     */
     public static function provideToStringDoesNotDependOnLocale(): iterable
     {
         yield from [

tests/system/I18n/TimeTest.php

@@ -346,7 +346,7 @@ public function testMagicIssetFalse(): void
     {
         $time = Time::parse('January 1, 2016');
 
-        $this->assertFalse(isset($time->foobar));
+        $this->assertFalse(isset($time->foobar)); // @phpstan-ignore property.notFound
     }
 
     public function testGetYear(): void
@@ -1280,7 +1280,7 @@ public function testGetter(): void
     {
         $time = Time::parse('August 12, 2016 4:15:23pm');
 
-        $this->assertNull($time->weekOfWeek);
+        $this->assertNull($time->weekOfWeek); // @phpstan-ignore property.notFound
     }
 
     public function testUnserializeTimeObject(): void
@@ -1324,6 +1324,9 @@ public function testToStringDoesNotDependOnLocale(string $locale): void
         $this->assertSame('2017-03-10 12:00:00', (string) $time);
     }
 
+    /**
+     * @return iterable<int, array{0: string}>
+     */
     public static function provideToStringDoesNotDependOnLocale(): iterable
     {
         yield from [

utils/phpstan-baseline/loader.neon

@@ -1,4 +1,4 @@
-# total 153 errors
+# total 145 errors
 
 includes:
     - argument.type.neon
@@ -12,5 +12,4 @@ includes:
     - missingType.iterableValue.neon
     - missingType.parameter.neon
     - property.defaultValue.neon
-    - property.notFound.neon
     - property.phpDocType.neon

utils/phpstan-baseline/missingType.iterableValue.neon

@@ -1,4 +1,4 @@
-# total 95 errors
+# total 93 errors
 
 parameters:
     ignoreErrors:
@@ -422,16 +422,6 @@ parameters:
             count: 1
             path: ../../tests/system/Database/Live/UpdateTest.php
 
-        -
-            message: '#^Method CodeIgniter\\I18n\\TimeLegacyTest\:\:provideToStringDoesNotDependOnLocale\(\) return type has no value type specified in iterable type iterable\.$#'
-            count: 1
-            path: ../../tests/system/I18n/TimeLegacyTest.php
-
-        -
-            message: '#^Method CodeIgniter\\I18n\\TimeTest\:\:provideToStringDoesNotDependOnLocale\(\) return type has no value type specified in iterable type iterable\.$#'
-            count: 1
-            path: ../../tests/system/I18n/TimeTest.php
-
         -
             message: '#^Method CodeIgniter\\Models\\FindModelTest\:\:provideAggregateAndGroupBy\(\) return type has no value type specified in iterable type iterable\.$#'
             count: 1