Add temporary stubs for cursor classes in 2.x

Author: alcaeus

psalm.xml.dist

@@ -21,6 +21,8 @@
         <file name="stubs/BSON/Document.stub.php"/>
         <file name="stubs/BSON/Iterator.stub.php"/>
         <file name="stubs/BSON/PackedArray.stub.php"/>
+        <file name="stubs/Driver/Cursor.stub.php"/>
+        <file name="stubs/Driver/CursorInterface.stub.php"/>
     </stubs>
 
     <issueHandlers>

stubs/Driver/Cursor.stub.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace MongoDB\Driver;
+
+/**
+ * @template-covariant TValue of array|object
+ *
+ * @template-implements CursorInterface<TValue>
+ */
+final class Cursor implements CursorInterface
+{
+    /**
+     * @return TValue|null
+     * @psalm-ignore-nullable-return
+     */
+    public function current(): array|object|null
+    {
+    }
+
+    public function next(): void
+    {
+    }
+
+    /** @psalm-ignore-nullable-return */
+    public function key(): ?int
+    {
+    }
+
+    public function valid(): bool
+    {
+    }
+
+    public function rewind(): void
+    {
+    }
+
+    /** @return array<TValue> */
+    public function toArray(): array
+    {
+    }
+}

stubs/Driver/CursorInterface.stub.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace MongoDB\Driver;
+
+use Iterator;
+
+/**
+ * @template TValue of array|object
+ * @template-implements Iterator<int, TValue>
+ */
+interface CursorInterface extends Iterator
+{
+    /**
+     * @return TValue|null
+     * @psalm-ignore-nullable-return
+     */
+    public function current(): array|object|null;
+
+    public function getId(): \MongoDB\BSON\Int64;
+
+    public function getServer(): Server;
+
+    public function isDead(): bool;
+
+    /** @psalm-ignore-nullable-return */
+    public function key(): ?int;
+
+    public function setTypeMap(array $typemap): void;
+
+    /** @return array<TValue> */
+    public function toArray(): array;
+}