Add psalm stubs for new BSON classes

Author: alcaeus

psalm.xml.dist

@@ -14,4 +14,9 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+    <stubs>
+        <file name="stubs/BSON/Document.stub.php"/>
+        <file name="stubs/BSON/Iterator.stub.php"/>
+        <file name="stubs/BSON/PackedArray.stub.php"/>
+    </stubs>
 </psalm>

stubs/BSON/Document.stub.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace MongoDB\BSON;
+
+/**
+ * @template TValue
+ * @template-implements \IteratorAggregate<string, TValue>
+ */
+final class Document implements \IteratorAggregate, \Serializable
+{
+    private function __construct() {}
+
+    final static public function fromBSON(string $bson): Document {}
+
+    final static public function fromJSON(string $json): Document {}
+
+    /** @param array|object $value */
+    final static public function fromPHP($value): Document {}
+
+    /** @return TValue */
+    final public function get(string $key) {}
+
+    /** @return Iterator<string, TValue> */
+    final public function getIterator(): Iterator {}
+
+    final public function has(string $key): bool {}
+
+    /** @return array|object */
+    final public function toPHP(?array $typeMap = null) {}
+
+    final public function toCanonicalExtendedJSON(): string {}
+
+    final public function toRelaxedExtendedJSON(): string {}
+
+    final public function __toString(): string {}
+
+    final public static function __set_state(array $properties): Document {}
+
+    final public function serialize(): string {}
+
+    /** @param string $serialized */
+    final public function unserialize($serialized): void {}
+
+    final public function __unserialize(array $data): void {}
+
+    final public function __serialize(): array {}
+}

stubs/BSON/Iterator.stub.php

@@ -0,0 +1,32 @@
+<?php
+
+/**
+  * @generate-class-entries static
+  * @generate-function-entries static
+  */
+
+namespace MongoDB\BSON;
+
+/**
+ * @psalm-template TKey of int|string
+ * @psalm-template TValue
+ * $psalm-implements \Iterator<TKey, TValue>
+ */
+final class Iterator implements \Iterator
+{
+    final private function __construct() {}
+
+    /** @return TValue */
+    final public function current() {}
+
+    /** @return TKey */
+    final public function key() {}
+
+    final public function next(): void {}
+
+    final public function rewind(): void {}
+
+    final public function valid(): bool {}
+
+    final public function __wakeup(): void {}
+}

stubs/BSON/PackedArray.stub.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace MongoDB\BSON;
+
+/**
+ * @template TValue
+ * @template-implements \IteratorAggregate<int, TValue>
+ */
+final class PackedArray implements \IteratorAggregate, \Serializable
+{
+    private function __construct() {}
+
+    final static public function fromPHP(array $value): PackedArray {}
+
+    /** @return TValue */
+    final public function get(int $index) {}
+
+    /** @return Iterator<int, TValue> */
+    final public function getIterator(): Iterator {}
+
+    final public function has(int $index): bool {}
+
+    /** @return array|object */
+    final public function toPHP(?array $typeMap = null) {}
+
+    final public function __toString(): string {}
+
+    final public static function __set_state(array $properties): PackedArray {}
+
+    final public function serialize(): string {}
+
+    /** @param string $serialized */
+    final public function unserialize($serialized): void {}
+
+    final public function __unserialize(array $data): void {}
+
+    final public function __serialize(): array {}
+}