deprecate some functionality

jsteemann · jsteemann · commit cd4ed23ca08b · 2021-04-22T20:40:25.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,17 +2,6 @@
 
 ## Release notes for the ArangoDB-PHP driver 3.8.x
 
-This version of the PHP driver removes support for the MMFiles storage engine, which was
-deprecated in the arangod server in version 3.6.0, and removed in version 3.7.0..
-
-Updating, replacing or removing documents in the database using a revision id guard value
-may return a different error message in case the revision id value of the found document is
-not as expected.
-Previous versions before 3.7 returned HTTP error 412, an ArangoDB error code 1200 and the 
-error message string "precondition failed". This was changed in version 3.7 to return the 
-same error codes, but an error message string of "conflict". Version 3.8 changes this again
-so the error message string is now "conflict, _rev values do not match".
-
 The `Cursor` class will now fetch outstanding cursor result data via HTTP POST requests to
 `/_api/cursor/<cursor-id>`. It previously fetched further results via HTTP PUT requests from
 the same address. The change is necessary because fetching further results is not an 
@@ -21,6 +10,11 @@ idempotent operation, but the HTTP standard requires PUT operations to be idempo
 Extended maximum valid length for collection names to 256, up from 64 before. This follows a
 change in the ArangoDB server.
 
+The driver now supports the following options for document CRUD operations:
+- "overwriteMode"
+- "silent"
+- "keepNull", "mergeObjects" (for insert API if overwriteMode=update)
+
 ## Release notes for the ArangoDB-PHP driver 3.7.x
 
 The corresponding ArangoDB version, ArangoDB 3.7 has dropped support for the MMFiles storage
diff --git a/lib/ArangoDBClient/CollectionHandler.php b/lib/ArangoDBClient/CollectionHandler.php
@@ -228,7 +228,7 @@ class CollectionHandler extends Handler
     const OPTION_FIGURES = 'figures';
 
     /**
-     * load option
+     * load option (deprecated)
      */
     const OPTION_LOAD = 'load';
 
@@ -341,7 +341,7 @@ public function create($collection, array $options = [])
     }
 
     /**
-     * unload option
+     * unload option (deprecated)
      */
     const OPTION_UNLOAD = 'unload';
 
@@ -567,6 +567,8 @@ public function rename($collection, $name)
      *
      * @param mixed $collection - collection as string or object
      *
+     * @deprecated not necessary anymore
+     *
      * @return HttpResponse - HTTP response object
      */
     public function load($collection)
@@ -588,6 +590,8 @@ public function load($collection)
      *
      * @param mixed $collection - collection as string or object
      *
+     * @deprecated not necessary anymore
+     *
      * @return HttpResponse - HTTP response object
      */
     public function unload($collection)
diff --git a/lib/ArangoDBClient/Traversal.php b/lib/ArangoDBClient/Traversal.php
@@ -20,6 +20,7 @@
  *
  * @link      https://www.arangodb.com/docs/stable/http/traversal.html
  *
+ * @deprecated use AQL traversals instead
  * @package   ArangoDBClient
  * @since     1.4
  */

Original file line number	Diff line number	Diff line change
`@@ -228,7 +228,7 @@ class CollectionHandler extends Handler`
`228`	`228`	`const OPTION_FIGURES = 'figures';`
`229`	`229`
`230`	`230`	`/**`
`231`		`- * load option`
	`231`	`+ * load option (deprecated)`
`232`	`232`	`*/`
`233`	`233`	`const OPTION_LOAD = 'load';`
`234`	`234`
`@@ -341,7 +341,7 @@ public function create($collection, array $options = [])`
`341`	`341`	`}`
`342`	`342`
`343`	`343`	`/**`
`344`		`- * unload option`
	`344`	`+ * unload option (deprecated)`
`345`	`345`	`*/`
`346`	`346`	`const OPTION_UNLOAD = 'unload';`
`347`	`347`
`@@ -567,6 +567,8 @@ public function rename($collection, $name)`
`567`	`567`	`*`
`568`	`568`	`* @param mixed $collection - collection as string or object`
`569`	`569`	`*`
	`570`	`+ * @deprecated not necessary anymore`
	`571`	`+ *`
`570`	`572`	`* @return HttpResponse - HTTP response object`
`571`	`573`	`*/`
`572`	`574`	`public function load($collection)`
`@@ -588,6 +590,8 @@ public function load($collection)`
`588`	`590`	`*`
`589`	`591`	`* @param mixed $collection - collection as string or object`
`590`	`592`	`*`
	`593`	`+ * @deprecated not necessary anymore`
	`594`	`+ *`
`591`	`595`	`* @return HttpResponse - HTTP response object`
`592`	`596`	`*/`
`593`	`597`	`public function unload($collection)`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`*`
`21`	`21`	`* @link https://www.arangodb.com/docs/stable/http/traversal.html`
`22`	`22`	`*`
	`23`	`+ * @deprecated use AQL traversals instead`
`23`	`24`	`* @package ArangoDBClient`
`24`	`25`	`* @since 1.4`
`25`	`26`	`*/`