Merge pull request #143 from Beldur/devel

frankmayer · frankmayer · commit 8c86eee47709 · 2013-08-11T01:57:26.000-07:00
Added 'all' Method which corresponds to /simple/all
diff --git a/lib/triagens/ArangoDb/CollectionHandler.php b/lib/triagens/ArangoDb/CollectionHandler.php
@@ -1211,6 +1211,52 @@ public function range($collectionId, $attribute, $left, $right, $options = array
         return new Cursor($this->getConnection(), $response->getJson(), $options);
     }
 
+    /**
+	 * Returns all documents of a collection
+	 *
+	 * @param mixed  $collectionId    - collection id as string or number
+	 * @param array  $options         - optional array of options.
+	 * <p>Options are :<br>
+	 * <li>'_sanitize'         - True to remove _id and _rev attributes from result documents. Defaults to false.</li>
+	 * <li>'sanitize'          - Deprecated, please use '_sanitize'.</li>
+	 * <li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
+	 * <li>'hiddenAttributes'  - Deprecated, please use '_hiddenAttributes'.</li>
+	 * <p>
+	 *                                This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.<br>
+	 *                                The difference is, that if you're returning a resultset of documents, the getAll() is already called<br>
+	 *                                and the hidden attributes would not be applied to the attributes.<br>
+	 * </p>
+	 *
+	 * <li>'batchSize' - can optionally be used to tell the server to limit the number of results to be transferred in one batch</li>
+	 * <li>'skip'      -  Optional, The number of documents to skip in the query.</li>
+	 * <li>'limit'     -  Optional, The maximal amount of documents to return. 'skip' is applied before the limit restriction.</li>
+	 * </li>
+	 * </p>
+	 *
+	 * @return Cursor - documents
+	 */
+	public function all($collectionId, $options = array())
+	{
+		$options = array_merge($options, $this->getCursorOptions($options));
+
+		$body = array(
+			self::OPTION_COLLECTION => $collectionId,
+		);
+
+		$body = $this->includeOptionsInBody(
+            $options,
+			$body,
+            array(
+                 self::OPTION_LIMIT  => null,
+                 self::OPTION_SKIP   => null,
+            )
+        );
+
+		$response = $this->getConnection()->put(Urls::URL_ALL, $this->json_encode_wrapper($body));
+
+		return new Cursor($this->getConnection(), $response->getJson(), $options);
+	}
+
 
     /**
      * Get document(s) by specifying near
diff --git a/lib/triagens/ArangoDb/Urls.php b/lib/triagens/ArangoDb/Urls.php
@@ -117,6 +117,11 @@ abstract class Urls
      */
     const URL_RANGE = '/_api/simple/range';
 
+    /**
+     * base URL part for select-all
+     */
+    const URL_ALL = '/_api/simple/all';
+    
     /**
      * base URL part for select-range
      */
diff --git a/tests/CollectionExtendedTest.php b/tests/CollectionExtendedTest.php
@@ -1093,6 +1093,116 @@ public function testCreateGetAllIdsAndDeleteCollectionThroughCreateFromArray()
     }
 
 
+    /**
+     * test for creation, all, and delete of a collection
+     */
+    public function testCreateAndAllAndDeleteCollection()
+    {
+        $collectionHandler = $this->collectionHandler;
+
+        $collection = Collection::createFromArray(array('name' => 'ArangoDB_PHP_TestSuite_TestCollection_01'));
+        $collectionHandler->add($collection);
+
+        $documentHandler = $this->documentHandler;
+
+        $document = Document::createFromArray(
+            array('someAttribute' => 'someValue', 'someOtherAttribute' => 'someOtherValue')
+        );
+        $documentHandler->add($collection->getId(), $document);
+
+        $document = Document::createFromArray(
+            array('someAttribute' => 'someValue2', 'someOtherAttribute' => 'someOtherValue2')
+        );
+        $documentHandler->add($collection->getId(), $document);
+        
+        $cursor = $collectionHandler->all($collection->getId());
+
+        $resultingDocument = null;
+
+        foreach ($cursor as $key => $value) {
+            $resultingDocument[$key] = $value;
+        }
+
+        $this->assertTrue(count($resultingDocument) == 2, 'Should be 2, was: ' . count($resultingDocument));
+
+        $response = $collectionHandler->delete($collection);
+        $this->assertTrue($response, 'Delete should return true!');
+    }
+
+    
+    /**
+     * test for creation, all with limit, and delete of a collection
+     */
+    public function testCreateAndAllWithLimitAndDeleteCollection()
+    {
+        $collectionHandler = $this->collectionHandler;
+
+        $collection = Collection::createFromArray(array('name' => 'ArangoDB_PHP_TestSuite_TestCollection_01'));
+        $collectionHandler->add($collection);
+
+        $documentHandler = $this->documentHandler;
+
+        $document = Document::createFromArray(
+            array('someAttribute' => 'someValue', 'someOtherAttribute' => 'someOtherValue')
+        );
+        $documentHandler->add($collection->getId(), $document);
+
+        $document = Document::createFromArray(
+            array('someAttribute' => 'someValue2', 'someOtherAttribute' => 'someOtherValue2')
+        );
+        $documentHandler->add($collection->getId(), $document);
+        
+        $cursor = $collectionHandler->all($collection->getId(), array( 'limit' => 1 ));
+
+        $resultingDocument = null;
+
+        foreach ($cursor as $key => $value) {
+            $resultingDocument[$key] = $value;
+        }
+
+        // 2 Documents limited to 1, the result should be 1
+        $this->assertTrue(count($resultingDocument) == 1, 'Should be 1, was: ' . count($resultingDocument));
+
+        $response = $collectionHandler->delete($collection);
+        $this->assertTrue($response, 'Delete should return true!');
+    }
+
+    
+    /**
+     * test for creation, all with skip, and delete of a collection
+     */
+    public function testCreateAndAllWithSkipAndDeleteCollection()
+    {
+        $collectionHandler = $this->collectionHandler;
+
+        $collection = Collection::createFromArray(array('name' => 'ArangoDB_PHP_TestSuite_TestCollection_01'));
+        $collectionHandler->add($collection);
+
+        $documentHandler = $this->documentHandler;
+
+        for ($i = 0; $i < 3; $i++) {
+            $document = Document::createFromArray(
+                array('someAttribute' => 'someValue ' . $i, 'someOtherAttribute' => 'someValue ' . $i)
+            );
+            $documentHandler->add($collection->getId(), $document);
+        }
+
+        $cursor = $collectionHandler->all($collection->getId(), array( 'skip' => 1 ));
+
+        $resultingDocument = null;
+
+        foreach ($cursor as $key => $value) {
+            $resultingDocument[$key] = $value;
+        }
+
+        // With 3 Documents and skipping 1, the result should be 2
+        $this->assertTrue(count($resultingDocument) == 2, 'Should be 2, was: ' . count($resultingDocument));
+
+        $response = $collectionHandler->delete($collection);
+        $this->assertTrue($response, 'Delete should return true!');
+    }
+    
+
     /**
      * test for creating, filling with documents and truncating the collection.
      */
