Deprecation notice of method which is only used for old deprecated options, which should have been removed in 2.x but are still available now, and will finally be removed in 3.1

frankmayer · frankmayer · commit de4156f29cb6 · 2016-10-25T00:51:27.000+03:00
Also corrected some silly grammar :D
diff --git a/lib/triagens/ArangoDb/Handler.php b/lib/triagens/ArangoDb/Handler.php
@@ -68,6 +68,7 @@ protected function getConnectionOption($optionName)
      *
      * @param mixed $options - $options might be a boolean sanitize value, or an array of options, with or without a '_sanitize' key.
      *
+     * @deprecated To be removed in a future version (probably even in some 3.x version). It's used up until now because of usage of old deprecated options, which will be removed in 3.1.
      * @return array - array of options
      */
     protected function getCursorOptions($options)
@@ -109,7 +110,7 @@ protected function json_encode_wrapper($body)
     }
 
 
-    //todo: (@frankmayer) check if refactoring a bit more if it makes sense...
+    //todo: (@frankmayer) check if refactoring a bit more makes sense...
 	/**
 	 * Helper function that validates and includes an old single method parameter setting into the parameters array given.
 	 * This is only for keeping backwards-compatibility where methods had for example a parameter which was called 'policy' and
@@ -147,7 +148,7 @@ protected function validateAndIncludeOldSingleParameterInParams($options, $param
     }
 
 
-    //todo: (@frankmayer) check if refactoring a bit more if it makes sense...
+    //todo: (@frankmayer) check if refactoring a bit more makes sense...
     /**
      * Helper function that runs through the options given and includes them into the parameters array given.
      * Only options that are set in $includeArray will be included.
@@ -176,7 +177,7 @@ protected function includeOptionsInParams($options, $params, array $includeArray
     }
 
 
-    //todo: (@frankmayer) check if refactoring a bit more if it makes sense...
+    //todo: (@frankmayer) check if refactoring a bit more makes sense...
     /**
      * Helper function that runs through the options given and includes them into the parameters array given.
      * Only options that are set in $includeArray will be included.

Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,7 @@ protected function getConnectionOption($optionName)`
`68`	`68`	`*`
`69`	`69`	`* @param mixed $options - $options might be a boolean sanitize value, or an array of options, with or without a '_sanitize' key.`
`70`	`70`	`*`
	`71`	`+ * @deprecated To be removed in a future version (probably even in some 3.x version). It's used up until now because of usage of old deprecated options, which will be removed in 3.1.`
`71`	`72`	`* @return array - array of options`
`72`	`73`	`*/`
`73`	`74`	`protected function getCursorOptions($options)`
`@@ -109,7 +110,7 @@ protected function json_encode_wrapper($body)`
`109`	`110`	`}`
`110`	`111`
`111`	`112`
`112`		`- //todo: (@frankmayer) check if refactoring a bit more if it makes sense...`
	`113`	`+ //todo: (@frankmayer) check if refactoring a bit more makes sense...`
`113`	`114`	`/**`
`114`	`115`	`* Helper function that validates and includes an old single method parameter setting into the parameters array given.`
`115`	`116`	`* This is only for keeping backwards-compatibility where methods had for example a parameter which was called 'policy' and`
`@@ -147,7 +148,7 @@ protected function validateAndIncludeOldSingleParameterInParams($options, $param`
`147`	`148`	`}`
`148`	`149`
`149`	`150`
`150`		`- //todo: (@frankmayer) check if refactoring a bit more if it makes sense...`
	`151`	`+ //todo: (@frankmayer) check if refactoring a bit more makes sense...`
`151`	`152`	`/**`
`152`	`153`	`* Helper function that runs through the options given and includes them into the parameters array given.`
`153`	`154`	`* Only options that are set in $includeArray will be included.`
`@@ -176,7 +177,7 @@ protected function includeOptionsInParams($options, $params, array $includeArray`
`176`	`177`	`}`
`177`	`178`
`178`	`179`
`179`		`- //todo: (@frankmayer) check if refactoring a bit more if it makes sense...`
	`180`	`+ //todo: (@frankmayer) check if refactoring a bit more makes sense...`
`180`	`181`	`/**`
`181`	`182`	`* Helper function that runs through the options given and includes them into the parameters array given.`
`182`	`183`	`* Only options that are set in $includeArray will be included.`