cosmetic changes

jsteemann · jsteemann · commit c42e98fab90f · 2019-08-06T09:21:52.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 Release notes for the ArangoDB-PHP driver 3.5.x
 ===============================================
 
+Made `DocumentHandler::save()` an alias for `DocumentHandler::insert()`, to more closely
+match the function names used in arangosh/arangod.
+
 Added support for streaming transactions (i.e. transactions that can be composed of multiple
 operations on the client side piece-by-piece without specifying the full transaction operations 
 in advance).
diff --git a/lib/ArangoDBClient/DocumentHandler.php b/lib/ArangoDBClient/DocumentHandler.php
@@ -317,7 +317,7 @@ public function store(Document $document, $collection = null, array $options = [
 
 
     /**
-     * save a document to a collection
+     * insert a document into a collection
      *
      * This will add the document to the collection and return the document's id
      *
@@ -339,7 +339,7 @@ public function store(Document $document, $collection = null, array $options = [
      * @return mixed - id of document created
      * @since 1.0
      */
-    public function save($collection, $document, array $options = [])
+    public function insert($collection, $document, array $options = [])
     {
         $headers = [];
         $this->addTransactionHeader($headers, $collection);
@@ -409,11 +409,11 @@ public function save($collection, $document, array $options = [])
     /**
      * Insert a document into a collection
      * 
-     * This is an alias for save().
+     * This is an alias for insert().
      */
-    public function insert($collection, $document, array $options = []) 
+    public function save($collection, $document, array $options = []) 
     {
-        return $this->save($collection, $document, $options);
+        return $this->insert($collection, $document, $options);
     }
 
     /**
@@ -548,30 +548,28 @@ protected function patch($url, $collection, $documentId, Document $document, arr
     /**
      * Replace an existing document in a collection, identified by the document itself
      *
-     * This will update the document on the server
+     * This will replace the document on the server
      *
-     * This will throw if the document cannot be updated
+     * 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
+     * @param Document $document - document to be replaced
      * @param array    $options  - optional, array of options
      *                           <p>Options are :
-     *                           <li>'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])</li>
+     *                           <li>'policy' - replace policy to be used in case of conflict ('error', 'last' or NULL [use default])</li>
      *                           <li>'waitForSync' - can be used to force synchronisation of the document update operation to disk even in case that the waitForSync flag had been disabled for the entire collection</li>
      *                           </p>
      *
      * @return bool - always true, will throw if there is an error
      */
     public function replace(Document $document, array $options = [])
     {
-        $documentId = $this->getDocumentId($document);
-
-        return $this->replaceById($document, $documentId, $document, $options);
+        return $this->replaceById($document, $this->getDocumentId($document), $document, $options);
     }
 
 
diff --git a/tests/DocumentBasicTest.php b/tests/DocumentBasicTest.php
@@ -206,8 +206,8 @@ public function testCreateAndDeleteDocumentWithoutCreatedCollectionAndOptionCrea
         $document        = new Document();
         $documentHandler = new DocumentHandler($connection);
 
-	$options = $connection->getOptions();
-	$connection->setOption(ConnectionOptions::OPTION_CREATE, true);
+        $options = $connection->getOptions();
+        $connection->setOption(ConnectionOptions::OPTION_CREATE, true);
 
         try {
             $this->collectionHandler->drop('ArangoDB_PHP_TestSuite_TestCollection_01' . '_' . static::$testsTimestamp);

Original file line number	Diff line number	Diff line change
`@@ -317,7 +317,7 @@ public function store(Document $document, $collection = null, array $options = [`
`317`	`317`
`318`	`318`
`319`	`319`	`/**`
`320`		`- * save a document to a collection`
	`320`	`+ * insert a document into a collection`
`321`	`321`	`*`
`322`	`322`	`* This will add the document to the collection and return the document's id`
`323`	`323`	`*`
`@@ -339,7 +339,7 @@ public function store(Document $document, $collection = null, array $options = [`
`339`	`339`	`* @return mixed - id of document created`
`340`	`340`	`* @since 1.0`
`341`	`341`	`*/`
`342`		`- public function save($collection, $document, array $options = [])`
	`342`	`+ public function insert($collection, $document, array $options = [])`
`343`	`343`	`{`
`344`	`344`	`$headers = [];`
`345`	`345`	`$this->addTransactionHeader($headers, $collection);`
`@@ -409,11 +409,11 @@ public function save($collection, $document, array $options = [])`
`409`	`409`	`/**`
`410`	`410`	`* Insert a document into a collection`
`411`	`411`	`*`
`412`		`- * This is an alias for save().`
	`412`	`+ * This is an alias for insert().`
`413`	`413`	`*/`
`414`		`- public function insert($collection, $document, array $options = [])`
	`414`	`+ public function save($collection, $document, array $options = [])`
`415`	`415`	`{`
`416`		`- return $this->save($collection, $document, $options);`
	`416`	`+ return $this->insert($collection, $document, $options);`
`417`	`417`	`}`
`418`	`418`
`419`	`419`	`/**`
`@@ -548,30 +548,28 @@ protected function patch($url, $collection, $documentId, Document $document, arr`
`548`	`548`	`/**`
`549`	`549`	`* Replace an existing document in a collection, identified by the document itself`
`550`	`550`	`*`
`551`		`- * This will update the document on the server`
	`551`	`+ * This will replace the document on the server`
`552`	`552`	`*`
`553`		`- * This will throw if the document cannot be updated`
	`553`	`+ * This will throw if the document cannot be replaced`
`554`	`554`	`*`
`555`	`555`	`* If policy is set to error (locally or globally through the ConnectionOptions)`
`556`	`556`	`* and the passed document has a _rev value set, the database will check`
`557`	`557`	`* that the revision of the to-be-replaced document is the same as the one given.`
`558`	`558`	`*`
`559`	`559`	`* @throws Exception`
`560`	`560`	`*`
`561`		`- * @param Document $document - document to be updated`
	`561`	`+ * @param Document $document - document to be replaced`
`562`	`562`	`* @param array $options - optional, array of options`
`563`	`563`	`* <p>Options are :`
`564`		`- * <li>'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])</li>`
	`564`	`+ * <li>'policy' - replace policy to be used in case of conflict ('error', 'last' or NULL [use default])</li>`
`565`	`565`	`* <li>'waitForSync' - can be used to force synchronisation of the document update operation to disk even in case that the waitForSync flag had been disabled for the entire collection</li>`
`566`	`566`	`* </p>`
`567`	`567`	`*`
`568`	`568`	`* @return bool - always true, will throw if there is an error`
`569`	`569`	`*/`
`570`	`570`	`public function replace(Document $document, array $options = [])`
`571`	`571`	`{`
`572`		`- $documentId = $this->getDocumentId($document);`
`573`		`-`
`574`		`- return $this->replaceById($document, $documentId, $document, $options);`
	`572`	`+ return $this->replaceById($document, $this->getDocumentId($document), $document, $options);`
`575`	`573`	`}`
`576`	`574`
`577`	`575`