Implemented revision check on replacing a document.

frankmayer · frankmayer · commit 79d88adffb72 · 2012-10-23T11:21:34.000+03:00
Signed-off-by: Frank Mayer &lt;frank@frankmayer.net&gt;
diff --git a/lib/triagens/ArangoDb/ConnectionOptions.php b/lib/triagens/ArangoDb/ConnectionOptions.php
@@ -61,6 +61,11 @@ class ConnectionOptions implements \ArrayAccess {
    */
   const OPTION_CREATE        = 'createCollection';
   
+  /**
+   * Update revision constant
+   */
+  const OPTION_REVISION = 'rev';
+  
   /**
    * Update policy index constant
    */
@@ -195,6 +200,7 @@ private static function getDefaults() {
       self::OPTION_TIMEOUT       => DefaultValues::DEFAULT_TIMEOUT,
       self::OPTION_CREATE        => DefaultValues::DEFAULT_CREATE,
       self::OPTION_UPDATE_POLICY => DefaultValues::DEFAULT_UPDATE_POLICY,
+      self::OPTION_REVISION      => NULL,
       self::OPTION_WAIT_SYNC     => DefaultValues::DEFAULT_WAIT_SYNC,
       self::OPTION_CONNECTION    => DefaultValues::DEFAULT_CONNECTION,
       self::OPTION_TRACE         => NULL,
diff --git a/lib/triagens/ArangoDb/DocumentHandler.php b/lib/triagens/ArangoDb/DocumentHandler.php
@@ -160,6 +160,9 @@ public function save($collectionId, Document $document, $create = NULL) {
    * 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
+   * If policy is set to error (locally or globally through the connectionoptions)
+   * and the passed document has a _rev value set, the database will check 
+   * that the revision of the to-be-replaced document is the same as the one given.
    *
    * @throws Exception
    * @param Document $document - document to be updated
@@ -176,6 +179,9 @@ public function update(Document $document, $policy = NULL) {
    * Replace 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 replaced
+   * If policy is set to error (locally or globally through the connectionoptions)
+   * and the passed document has a _rev value set, the database will check 
+   * that the revision of the to-be-replaced document is the same as the one given.
    *
    * @throws Exception
    * @param Document $document - document to be updated
@@ -193,6 +199,9 @@ public function replace(Document $document, $policy = NULL) {
    * 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
+   * If policy is set to error (locally or globally through the connectionoptions)
+   * and the passed document has a _rev value set, the database will check 
+   * that the revision of the to-be-replaced document is the same as the one given.
    *
    * @throws Exception
    * @param mixed $collectionId - collection id as string or number
@@ -212,6 +221,9 @@ public function updateById($collectionId, $documentId, Document $document, $poli
    * Replace 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 Replaced
+   * If policy is set to error (locally or globally through the connectionoptions)
+   * and the passed document has a _rev value set, the database will check 
+   * that the revision of the to-be-replaced document is the same as the one given.
    *
    * @throws Exception
    * @param mixed $collectionId - collection id as string or number
@@ -221,15 +233,24 @@ public function updateById($collectionId, $documentId, Document $document, $poli
    * @return bool - always true, will throw if there is an error
    */
   public function replaceById($collectionId, $documentId, Document $document, $policy = NULL) {
+    $rev = $document->getRevision();
+   if (!is_null($rev)) {
+       $params[ConnectionOptions::OPTION_REVISION]=$rev;
+    } 
+
+
+
     if ($policy === NULL) {
       $policy = $this->getConnection()->getOption(ConnectionOptions::OPTION_UPDATE_POLICY);
     }
-
+    $params[ConnectionOptions::OPTION_UPDATE_POLICY]=$policy;
+    
+    
     UpdatePolicy::validate($policy);
     
     $data = $document->getAll();
     $url = UrlHelper::buildUrl(Urls::URL_DOCUMENT, $collectionId, $documentId);
-    $url = UrlHelper::appendParamsUrl($url, array(ConnectionOptions::OPTION_UPDATE_POLICY => $policy));
+    $url = UrlHelper::appendParamsUrl($url, $params);
     $result = $this->getConnection()->put($url, json_encode($data));
 
     return true;
