Use conditional return type for getId method in CursorInterface classes (mongodb#1388)

alcaeus · web-flow · commit c5a384a18f9c · 2024-09-12T07:46:05.000Z
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="5.25.0@01a8eb06b9e9cc6cfb6a320bf9fb14331919d505">
+<files psalm-version="5.26.1@d747f6500b38ac4f7dfc5edbcae6e4b637d7add0">
   <file src="examples/atlas_search.php">
     <MixedArgument>
       <code><![CDATA[$document['name']]]></code>
@@ -145,9 +145,6 @@
     </PossiblyNullArgument>
   </file>
   <file src="src/Model/CodecCursor.php">
-    <ImplementedReturnTypeMismatch>
-      <code><![CDATA[CursorId|Int64]]></code>
-    </ImplementedReturnTypeMismatch>
     <TooManyArguments>
       <code><![CDATA[getId]]></code>
     </TooManyArguments>
diff --git a/src/ChangeStream.php b/src/ChangeStream.php
@@ -110,7 +110,10 @@ public function current()
         return $this->codec->decode($value);
     }
 
-    /** @return CursorId|Int64 */
+    /**
+     * @return CursorId|Int64
+     * @psalm-return ($asInt64 is true ? Int64 : CursorId)
+     */
     #[ReturnTypeWillChange]
     public function getCursorId(bool $asInt64 = false)
     {
diff --git a/src/Model/CodecCursor.php b/src/Model/CodecCursor.php
@@ -76,7 +76,10 @@ public static function fromCursor(Cursor $cursor, DocumentCodec $codec): self
         return new self($cursor, $codec);
     }
 
-    /** @return CursorId|Int64 */
+    /**
+     * @return CursorId|Int64
+     * @psalm-return ($asInt64 is true ? Int64 : CursorId)
+     */
     #[ReturnTypeWillChange]
     public function getId(bool $asInt64 = false)
     {

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,10 @@ public function current()`
`110`	`110`	`return $this->codec->decode($value);`
`111`	`111`	`}`
`112`	`112`
`113`		`- /** @return CursorId\|Int64 */`
	`113`	`+ /**`
	`114`	`+ * @return CursorId\|Int64`
	`115`	`+ * @psalm-return ($asInt64 is true ? Int64 : CursorId)`
	`116`	`+ */`
`114`	`117`	`#[ReturnTypeWillChange]`
`115`	`118`	`public function getCursorId(bool $asInt64 = false)`
`116`	`119`	`{`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,10 @@ public static function fromCursor(Cursor $cursor, DocumentCodec $codec): self`
`76`	`76`	`return new self($cursor, $codec);`
`77`	`77`	`}`
`78`	`78`
`79`		`- /** @return CursorId\|Int64 */`
	`79`	`+ /**`
	`80`	`+ * @return CursorId\|Int64`
	`81`	`+ * @psalm-return ($asInt64 is true ? Int64 : CursorId)`
	`82`	`+ */`
`80`	`83`	`#[ReturnTypeWillChange]`
`81`	`84`	`public function getId(bool $asInt64 = false)`
`82`	`85`	`{`