added API methods to allow more flexible updating and deleting

jsteemann · jsteemann · commit 17ff36361871 · 2012-04-11T14:12:56.000+02:00
diff --git a/examples/collection.php b/examples/collection.php
@@ -8,37 +8,37 @@
   $connection = new Connection($connectionOptions);
   $handler = new CollectionHandler($connection);
   
+  // create a new collection
+  $col = new Collection();
+  $col->setName("hihi");
+  $result = $handler->add($col);
+  var_dump($result);
+  
+  // get an existing collection
+  $result = $handler->get("hihi");
+  var_dump($result);
+
   // get an existing collection
-  $result = $handler->get("peng");
+  $result = $handler->get("hihi");
   var_dump($result);
   
   // get number of documents from an existing collection
-  $result = $handler->getCount("peng");
+  $result = $handler->getCount("hihi");
   var_dump($result);
   
   // get figures for an existing collection
-  $result = $handler->getFigures("peng");
+  $result = $handler->getFigures("hihi");
   var_dump($result);
   
-  // create a new collection
-  $col = new Collection();
-  $col->setName("hihi2");
-  $result = $handler->add($col);
-  var_dump($result);
-  
-  // get an existing collection
-  $result = $handler->get("hihi2");
-  var_dump($result);
-
   // delete the collection
-  $result = $handler->delete("hihi2");
+  $result = $handler->delete("hihi");
   var_dump($result);
   
   // rename a collection
-  // $handler->rename($col,"hihi30");
+  // $handler->rename($col, "hihi30");
   
   // truncate an existing collection
-  // $result = $handler->truncate("foo");
+  // $result = $handler->truncate("hihi");
 }
 catch (ConnectException $e) {
   var_dump($e->getMessage());
diff --git a/examples/document.php b/examples/document.php
@@ -14,34 +14,34 @@
   var_dump($result);
 
   // get the ids of all documents in the collection
-  $result = $handler->getAllIds("fux");
+  $result = $handler->getAllIds("users");
   var_dump($result);
 
   // create a new document
-  $document = new Document();
-  $document->set("name", "fux");
-  $document->level = 1;
-  $document->vists = array(1, 2, 3);
+  $user = new Document();
+  $user->set("name", "users");
+  $user->level = 1;
+  $user->vists = array(1, 2, 3);
 
-  $id = $handler->add("fux", $document);
+  $id = $handler->add("users", $user);
   var_dump("CREATED A NEW DOCUMENT WITH ID: ", $id);
 
   // get this document from the server
-  $result = $handler->get("fux", $id);
-  var_dump($result);
+  $userFromServer = $handler->getById("users", $id);
+  var_dump($userFromServer);
 
   // update this document
-  $document->nonsense = "hihi";
-  unset($document->name);
-  $result = $handler->update("fux", $document);
+  $userFromServer->nonsense = "hihi";
+  unset($userFromServer->name);
+  $result = $handler->update($userFromServer);
   var_dump($result);
   
   // get the updated document back
-  $result = $handler->get("fux", $id);
+  $result = $handler->get("users", $id);
   var_dump($result);
 
   // delete the document
-  $result = $handler->delete("fux", $id);
+  $result = $handler->deleteById("users", $id);
   var_dump($result);
 
 }
diff --git a/examples/select.php b/examples/select.php
@@ -6,7 +6,7 @@
 
 /* set up some example statements */
 $statements = array(
-  "select f from fux f" => array(),
+  "select u from users u" => array(),
   "select u from users u" => NULL,
   "select u from users u where u.id == 1 +@id@" => array("id" => 6),
   "select u from users u where u.id == 2+ @id@" => array("id" => 6),
diff --git a/lib/triagens/Avocado/DocumentHandler.php b/lib/triagens/Avocado/DocumentHandler.php
@@ -35,14 +35,27 @@ class DocumentHandler extends Handler {
   
   /**
    * Get a single document from a collection
-   * This will throw if the document cannot be fetched from the server
+   * Alias method for getById()
    *
    * @throws Exception
    * @param mixed $collectionId - collection id as a string or number
    * @param mixed $documentId - document identifier
    * @return Document - the document fetched from the server
    */
   public function get($collectionId, $documentId) {
+    return $this->getById($collectionId, $documentId);
+  }
+
+  /**
+   * Get a single document from a collection
+   * This will throw if the document cannot be fetched from the server
+   *
+   * @throws Exception
+   * @param mixed $collectionId - collection id as a string or number
+   * @param mixed $documentId - document identifier
+   * @return Document - the document fetched from the server
+   */
+  public function getById($collectionId, $documentId) {
     $url = UrlHelper::buildUrl(Urls::URL_DOCUMENT, $collectionId, $documentId);
     $response = $this->getConnection()->get($url);
 
@@ -151,20 +164,35 @@ public function add($collectionId, Document $document, $create = NULL) {
   }
 
   /**
-   * Update an existing document in a collection
+   * Update an existing document in a collection, identified by the document itself
    * This will update the document on the server
    * This will throw if the document cannot be updated
    *
    * @throws Exception
-   * @param mixed $collectionId - collection id as string or number
    * @param Document $document - document to be updated
    * @param bool $policy - update policy to be used in case of conflict
    * @return bool - always true, will throw if there is an error
    */
-  public function update($collectionId, Document $document, $policy = NULL) {
+  public function update(Document $document, $policy = NULL) {
     $collectionId = $this->getCollectionId($document);
     $documentId   = $this->getDocumentId($document);
 
+    return $this->updateById($collectionId, $documentId, $document, $policy);
+  }
+  
+  /**
+   * Update an existing document in a collection, identified by collection id and document id
+   * This will update the document on the server
+   * This will throw if the document cannot be updated
+   *
+   * @throws Exception
+   * @param mixed $collectionId - collection id as string or number
+   * @param mixed $documentId - document id as string or number
+   * @param Document $document - document to be updated
+   * @param bool $policy - update policy to be used in case of conflict
+   * @return bool - always true, will throw if there is an error
+   */
+  public function updateById($collectionId, $documentId, Document $document, $policy = NULL) {
     if ($policy === NULL) {
       $policy = $this->getConnection()->getOption(ConnectionOptions::OPTION_UPDATE_POLICY);
     }
@@ -180,16 +208,28 @@ public function update($collectionId, Document $document, $policy = NULL) {
   }
 
   /**
-   * Delete a document from a collection
+   * Delete a document from a collection, identified by the document itself
    *
    * @throws Exception
-   * @param mixed $collectionId - collection id as string or number
-   * @param mixed $document - document id OR document to be updated
+   * @param Document $document - document to be updated
    * @return bool - always true, will throw if there is an error
    */
-  public function delete($collectionId, $document) {
-    $documentId = $this->getDocumentId($document);
+  public function delete(Document $document) {
+    $collectionId = $this->getCollectionId($document);
+    $documentId   = $this->getDocumentId($document);
 
+    return $this->deleteById($collectionId, $documentId);
+  }
+  
+  /**
+   * Delete a document from a collection, identified by the collection id and document id
+   *
+   * @throws Exception
+   * @param mixed $collectionId - collection id as string or number
+   * @param mixed $documentId - document id as string or number
+   * @return bool - always true, will throw if there is an error
+   */
+  public function deleteById($collectionId, $documentId) {
     $result = $this->getConnection()->delete(UrlHelper::buildUrl(Urls::URL_DOCUMENT, $collectionId, $documentId));
 
     return true;
