Initial draft of suggested API

Author: bjori

docs/api/BSON/types.php

@@ -0,0 +1,61 @@
+<?php
+/* C interfaces */
+namespace BSON\Types {
+    interface Object {
+    }
+
+    interface ArrayObj {
+    }
+
+    interface ObjectID {
+    }
+
+    interface Binary {
+        const TYPE_GENERIC      = 0x00;
+        const TYPE_FUNCTION     = 0x01;
+        const TYPE_OLD_BINARY   = 0x02;
+        const TYPE_OLD_UUID     = 0x03;
+        const TYPE_UUID         = 0x04;
+        const TYPE_MD5          = 0x05;
+        const TYPE_USER_DEFINED = 0x80;
+
+        function getSubType();
+    }
+
+    interface DateTime {
+    }
+}
+
+/* C objects */
+namespace BSON {
+
+    class Object implements \BSON\Types\Object {
+    }
+
+    class ArrayDynamic extends \ArrayObject implements \BSON\Types\ArrayObj {
+    }
+
+    class ArrayFixed extends \SplFixedArray implements \BSON\Types\ArrayObj {
+    }
+
+    class ObjectID implements \BSON\Types\ObjectID {
+    }
+
+    class DateTime extends \DateTime implements \BSON\Types\DateTime {
+    }
+
+
+
+    function encode($arrayOrObject) {
+        /* Scalar not allowed */
+    }
+
+    function decode($bson) {
+    }
+
+    function toJSON($bson, $extendedJSON = false) {
+    }
+}
+
+
+

docs/api/MongoDB/CRUD.php

@@ -0,0 +1,61 @@
+<?php
+namespace MongoDB;
+
+interface WriteBatch {
+    function add($document);
+}
+
+
+class InsertBatch implements WriteBatch {
+    function add($document) {
+        $this->documents[] = $document;
+    }
+}
+
+class UpdateBatch implements WriteBatch {
+    function add($document) {
+        $this->documents[] = $document;
+    }
+}
+
+class DeleteBatch implements WriteBatch {
+    function add($document) {
+        $this->documents[] = $document;
+    }
+}
+
+class Query {
+    function __construct($query) {}
+}
+class Command {
+    function __construct($command) {}
+}
+
+
+
+
+class WriteResults {
+
+    /* Returns nModified, n, nUserted, .. */
+    function getNumbers() {
+    }
+
+    /* Returns how many operations were executed */
+    function getOpCount() {
+    }
+
+    /* Returns the server that the operation was executed on */
+    function getServer() {
+    }
+
+    /* Any stats available from the server */
+    function getTimer() {
+    }
+}
+
+class QueryResults {
+    function __construct(Server $server, $cursor_id, $firstBatch) {
+    }
+}
+
+

docs/api/MongoDB/Management.php

@@ -0,0 +1,55 @@
+<?php
+namespace MongoDB;
+
+class Server {
+    const TYPE_MONGOS     = 0x01;
+    const TYPE_STANDALONE = 0x02;
+    const TYPE_ARBITER    = 0x03;
+    const TYPE_SECONDARY  = 0x04;
+    const TYPE_PRIMARY    = 0x05;
+
+    /* These need to be final as they will not be called by the driver to retrieve the 
+     * information, these getters are only useful for userland */
+    final function getHostname() {}
+    final function getPort() {}
+    final function getLatency() {}
+    final function getMaxWireVersion() {}
+    final function getMinWireVersion() {}
+    final function getServerType() {}
+
+    /* extracting config info */
+    final function isPassive() {}
+    final function isDelayed() {}
+
+    final function executeQuery($namespace, \MongoDB\Query $query) {}
+    final function executeWrite($namespace, \MongoDB\WriteBatch $batch, WriteOptions $wo) {}
+}
+
+
+class Manager extends \SplObjectStorage {
+    function __construct(array $servers, $dbname, $connection_options) {
+    }
+
+    static function fromDSN($dsn) {
+    }
+
+    final function executeQuery($namespace, \MongoDB\Query $query, ReadPreference $rp) {
+        foreach($this->getConnectedServers() as $server) {
+            if ($server->matchesReadPreference($rp)) {
+                return $server->executeQuery($namespace, $query);
+            }
+        }
+        throw new NoServerMatchingReadPreference($rp);
+    }
+
+    final function executeWrite($namespace, \MongoDB\WriteBatch $batch, WriteOptions $wo) {
+        foreach($this->getConnectedServers() as $server) {
+            if ($server->isPrimary()) {
+                return $server->executeWrite($namespace, $batch, $wo);
+            }
+        }
+
+        throw new NoPrimaryAvailable;
+    }
+}
+