Merge pull request #2 from bjori/split-classes

Split API classes and interfaces

Author: jmikola

docs/api/MongoDB/CRUD.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace MongoDB\Command;
+
+/**
+ * Value object for a database command document.
+ */
+final class Command
+{
+    private $document;
+
+    /**
+     * @param array|object $document Command document
+     */
+    public function __construct($document)
+    {
+        $this->document = $document;
+    }
+}

docs/api/MongoDB/Command/Command.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace MongoDB\Command;
+
+use MongoDB\Cursor;
+use MongoDB\CursorId;
+
+/**
+ * Cursor implementation that may be constructed from values found in a
+ * CommandResult's response document.
+ *
+ * The iteration and internal logic is very similar to QueryCursor, so both
+ * classes should likely share code. The first batch is comparable to the
+ * documents found in the OP_REPLY message returned by a QueryCursor's original
+ * OP_QUERY, in that both may be available at the time the cursor is
+ * constructed.
+ */
+final class CommandCursor implements Cursor
+{
+    private $server;
+    private $batchSize;
+    private $cursorId;
+    private $firstBatch;
+
+    /**
+     * @param Server   $server
+     * @param CursorId $cursorId
+     * @param array    $firstBatch
+     */
+    public function __construct(Server $server, CursorId $cursorId, array $firstBatch)
+    {
+        $this->server = $server;
+        $this->cursorId = $cursorId;
+        $this->firstBatch = $firstBatch;
+    }
+
+    // Iterator methods...
+
+    /**
+     * @return Cursor::getId()
+     */
+    public function getId()
+    {
+        return $this->cursorId;
+    }
+
+    /**
+     * @see Cursor::getServer()
+     */
+    public function getServer()
+    {
+        return $this->server;
+    }
+
+    /**
+     * @see Cursor::isDead()
+     */
+    public function isDead()
+    {
+        // Return whether the cursor is exhausted and has no more results
+    }
+
+    /**
+     * @see \MongoDB\Cursor::setBatchSize()
+     */
+    public function setBatchSize($batchSize)
+    {
+        $this->batchSize = (integer) $batchSize;
+    }
+}

docs/api/MongoDB/Command/CommandCursor.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace MongoDB\Command;
+
+use MongoDB\Server;
+
+/**
+ * Result returned by Server and Manager executeCommand() methods.
+ */
+final class CommandResult
+{
+    private $server;
+    private $responseDocument;
+
+    /**
+     * @param Server       $server
+     * @param array|object $responseDocument
+     */
+    public function __construct(Server $server, $responseDocument)
+    {
+        $this->server = $server;
+        $this->responseDocument = $responseDocument;
+    }
+
+    /**
+     * @return array Original response document from the server
+     */
+    public function getResponseDocument()
+    {
+        return $this->responseDocument;
+    }
+
+    /**
+     * @return Server Server from which the result originated
+     */
+    public function getServer()
+    {
+        return $this->server;
+    }
+}

docs/api/MongoDB/Command/CommandResult.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace MongoDB;
+
+interface Cursor extends \Iterator
+{
+    /**
+     * @return CursorId
+     */
+    function getId();
+
+    /**
+     * @return Server Server from which the cursor originated
+     */
+    function getServer();
+
+    /**
+     * @return boolean Whether the cursor is exhausted and has no more results
+     */
+    function isDead();
+
+    /**
+     * @param integer $batchSize
+     */
+    function setBatchSize($batchSize);
+}

docs/api/MongoDB/Cursor.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace MongoDB;
+
+/**
+ * Value object for the 64-bit cursor identifier.
+ *
+ * This is useful for compatibility with 32-bit platforms, and also allows
+ * Cursor constructors to type-hint against a class.
+ */
+final class CursorId
+{
+    // $id is an internal uint64_t value instead of a class property
+
+    /**
+     * @param integer|string $id
+     */
+    public function __construct($id)
+    {
+        // Set internal uint64_t value
+    }
+
+    /**
+     * @return string
+     */
+    public function __toString()
+    {
+        /* Return string representation of internal uint64_t value.
+         *
+         * This can be used to compare two CursorIds on a 32-bit platform. Is
+         * this functionality necessary, or should we do without any "getter"
+         * method?
+         */
+    }
+}