Merge pull request #7 from gsteel/offset-get-issues-notice

Fix uncaught PHP 8.1 Incompatibility
gsteel · Feb 18, 2022 · 63b085d · 63b085d
2 parents 9d08a8a + 00cf055
commit 63b085d
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -22,4 +22,8 @@
             <directory suffix=".php">./src</directory>
         </include>
     </coverage>
+
+    <php>
+        <ini name="error_reporting" value="E_ALL" />
+    </php>
 </phpunit>
diff --git a/src/Postmark/Models/CaseInsensitiveArray.php b/src/Postmark/Models/CaseInsensitiveArray.php
@@ -6,6 +6,7 @@
 
 use ArrayAccess;
 use Iterator;
+use ReturnTypeWillChange; // phpcs:ignore
 
 use function array_change_key_case;
 use function array_keys;
@@ -86,6 +87,7 @@ public function offsetUnset($offset): void
      *
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         if (is_string($offset)) {
@@ -96,6 +98,7 @@ public function offsetGet($offset)
     }
 
     /** @return mixed */
+    #[ReturnTypeWillChange]
     public function current()
     {
         // use "offsetGet" instead of indexes
@@ -104,6 +107,7 @@ public function current()
     }
 
     /** @return array-key */
+    #[ReturnTypeWillChange]
     public function key()
     {
         return array_keys($this->data)[$this->pointer];

diff --git a/tests/Unit/Models/CaseInsensitiveArrayTest.php b/tests/Unit/Models/CaseInsensitiveArrayTest.php
@@ -19,6 +19,12 @@ public function testValuesCanBeRetrievedInAnyCase(): void
         self::assertSame(1, $data['value']);
     }
 
+    public function testThatOffsetGetDoesNotIssueANoticeOnPHP81(): void
+    {
+        $data = new CaseInsensitiveArray(['hey' => 'there']);
+        self::assertEquals('there', $data->offsetGet('hey'));
+    }
+
     public function testValuesCanBeMutatedInACaseInsensitiveWay(): void
     {
         $data = new CaseInsensitiveArray(['value' => 1]);