Some more types and annotations cleanup and additions of @throws annotations

frankmayer · frankmayer · commit c8f2a5a05c0b · 2016-10-26T01:50:10.000+03:00
diff --git a/lib/triagens/ArangoDb/AqlUserFunction.php b/lib/triagens/ArangoDb/AqlUserFunction.php
@@ -97,6 +97,7 @@ class AqlUserFunction
      * @param Connection $connection      - the connection to be used
      * @param array      $attributesArray - user function initialization data
      *
+     * @throws \triagens\ArangoDb\ClientException
      */
     public function __construct(Connection $connection, array $attributesArray = null)
     {
diff --git a/lib/triagens/ArangoDb/Cursor.php b/lib/triagens/ArangoDb/Cursor.php
@@ -172,6 +172,7 @@ class Cursor implements
      * @param array      $data       - initial result data as returned by the server
      * @param array      $options    - cursor options
      *
+     * @throws \triagens\ArangoDb\ClientException
      */
     public function __construct(Connection $connection, array $data, array $options)
     {
diff --git a/lib/triagens/ArangoDb/DocumentHandler.php b/lib/triagens/ArangoDb/DocumentHandler.php
@@ -314,7 +314,7 @@ public function store(Document $document, $collection = null, array $options = [
      * @return mixed - id of document created
      * @since 1.0
      */
-    public function save($collection, $document, $options = [])
+    public function save($collection, $document, array $options = [])
     {
         $collection = $this->makeCollection($collection);
 
diff --git a/lib/triagens/ArangoDb/EdgeDefinition.php b/lib/triagens/ArangoDb/EdgeDefinition.php
@@ -48,9 +48,9 @@ class EdgeDefinition
     /**
      * Constructs an new edge definition
      *
-     * @param string $relation        - name of the relation (the underlying edge collection).
-     * @param array  $fromCollections - a list of collections providing the edges start vertices.
-     * @param array  $toCollections   - a list of collections providing the edges end vertices.
+     * @param string       $relation        - name of the relation (the underlying edge collection).
+     * @param array|string $fromCollections - a list of collections providing the edges start vertices or a string holding a single collection name.
+     * @param array|string $toCollections   - a list of collections providing the edges end vertices or a string holding a single collection name.
      *
      * @since     2.2
      *
@@ -193,9 +193,9 @@ public static function createUndirectedRelation($relation, $vertexCollections)
      * Constructs a directed relation. This relation is an edge definition where the edges can start only in the
      * vertices defined in 'fromCollections' and end in vertices defined in 'toCollections'.
      *
-     * @param string $relation        - name of the relation (the underlying edge collection).
-     * @param array  $fromCollections - a list of collections providing the edges start vertices.
-     * @param array  $toCollections   - a list of collections providing the edges end vertices.
+     * @param string       $relation        - name of the relation (the underlying edge collection).
+     * @param array|string $fromCollections - a list of collections providing the edges start vertices or a string holding a single collection name.
+     * @param array|string $toCollections   - a list of collections providing the edges end vertices or a string holding a single collection name.
      *
      * @return EdgeDefinition
      * @since     2.2
diff --git a/lib/triagens/ArangoDb/EdgeHandler.php b/lib/triagens/ArangoDb/EdgeHandler.php
@@ -85,17 +85,18 @@ public function createFromArrayWithContext($data, $options)
      * Just throw an exception if save() is called on edges.
      *
      * @internal
-     * @throws Exception
      *
      * @param mixed    $collection - collection id as string or number
      * @param Document $document   - the document to be added
-     * @param bool     $create     - create the collection if it does not yet exist
-     *
-     * @see EdgeHandler::saveEdge()
+     * @param array    $options
      *
      * @return mixed|void
+     * @throws ClientException
+     *
+     * @see      EdgeHandler::saveEdge()
+     *
      */
-    public function save($collection, $document, $create = null)
+    public function save($collection, $document, array $options = [])
     {
         throw new ClientException("Edges don't have a save() method. Please use saveEdge()");
     }
diff --git a/lib/triagens/ArangoDb/Handler.php b/lib/triagens/ArangoDb/Handler.php
@@ -88,6 +88,7 @@ protected function json_encode_wrapper($body)
      * @param array $includeArray - The array that defines which options are allowed to be included, and what their default value is. for example: 'waitForSync'=>true
      *
      * @return array $params - array of parameters for use in a url
+     * @throws \triagens\ArangoDb\ClientException
      * @internal param array $params - The parameters into which the options will be included.
      */
     protected function includeOptionsInParams($options, array $includeArray = [])
diff --git a/lib/triagens/ArangoDb/Transaction.php b/lib/triagens/ArangoDb/Transaction.php
@@ -132,6 +132,7 @@ class Transaction
      * @param Connection $connection       - the connection to be used
      * @param array      $transactionArray - transaction initialization data
      *
+     * @throws \triagens\ArangoDb\ClientException
      */
     public function __construct(Connection $connection, array $transactionArray = null)
     {

Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,7 @@ class AqlUserFunction`
`97`	`97`	`* @param Connection $connection - the connection to be used`
`98`	`98`	`* @param array $attributesArray - user function initialization data`
`99`	`99`	`*`
	`100`	`+ * @throws \triagens\ArangoDb\ClientException`
`100`	`101`	`*/`
`101`	`102`	`public function __construct(Connection $connection, array $attributesArray = null)`
`102`	`103`	`{`
Original file line number	Diff line number	Diff line change
`@@ -172,6 +172,7 @@ class Cursor implements`
`172`	`172`	`* @param array $data - initial result data as returned by the server`
`173`	`173`	`* @param array $options - cursor options`
`174`	`174`	`*`
	`175`	`+ * @throws \triagens\ArangoDb\ClientException`
`175`	`176`	`*/`
`176`	`177`	`public function __construct(Connection $connection, array $data, array $options)`
`177`	`178`	`{`
Original file line number	Diff line number	Diff line change
`@@ -314,7 +314,7 @@ public function store(Document $document, $collection = null, array $options = [`
`314`	`314`	`* @return mixed - id of document created`
`315`	`315`	`* @since 1.0`
`316`	`316`	`*/`
`317`		`- public function save($collection, $document, $options = [])`
	`317`	`+ public function save($collection, $document, array $options = [])`
`318`	`318`	`{`
`319`	`319`	`$collection = $this->makeCollection($collection);`
`320`	`320`
Original file line number	Diff line number	Diff line change
`@@ -48,9 +48,9 @@ class EdgeDefinition`
`48`	`48`	`/**`
`49`	`49`	`* Constructs an new edge definition`
`50`	`50`	`*`
`51`		`- * @param string $relation - name of the relation (the underlying edge collection).`
`52`		`- * @param array $fromCollections - a list of collections providing the edges start vertices.`
`53`		`- * @param array $toCollections - a list of collections providing the edges end vertices.`
	`51`	`+ * @param string $relation - name of the relation (the underlying edge collection).`
	`52`	`+ * @param array\|string $fromCollections - a list of collections providing the edges start vertices or a string holding a single collection name.`
	`53`	`+ * @param array\|string $toCollections - a list of collections providing the edges end vertices or a string holding a single collection name.`
`54`	`54`	`*`
`55`	`55`	`* @since 2.2`
`56`	`56`	`*`
`@@ -193,9 +193,9 @@ public static function createUndirectedRelation($relation, $vertexCollections)`
`193`	`193`	`* Constructs a directed relation. This relation is an edge definition where the edges can start only in the`
`194`	`194`	`* vertices defined in 'fromCollections' and end in vertices defined in 'toCollections'.`
`195`	`195`	`*`
`196`		`- * @param string $relation - name of the relation (the underlying edge collection).`
`197`		`- * @param array $fromCollections - a list of collections providing the edges start vertices.`
`198`		`- * @param array $toCollections - a list of collections providing the edges end vertices.`
	`196`	`+ * @param string $relation - name of the relation (the underlying edge collection).`
	`197`	`+ * @param array\|string $fromCollections - a list of collections providing the edges start vertices or a string holding a single collection name.`
	`198`	`+ * @param array\|string $toCollections - a list of collections providing the edges end vertices or a string holding a single collection name.`
`199`	`199`	`*`
`200`	`200`	`* @return EdgeDefinition`
`201`	`201`	`* @since 2.2`
Original file line number	Diff line number	Diff line change
`@@ -85,17 +85,18 @@ public function createFromArrayWithContext($data, $options)`
`85`	`85`	`* Just throw an exception if save() is called on edges.`
`86`	`86`	`*`
`87`	`87`	`* @internal`
`88`		`- * @throws Exception`
`89`	`88`	`*`
`90`	`89`	`* @param mixed $collection - collection id as string or number`
`91`	`90`	`* @param Document $document - the document to be added`
`92`		`- * @param bool $create - create the collection if it does not yet exist`
`93`		`- *`
`94`		`- * @see EdgeHandler::saveEdge()`
	`91`	`+ * @param array $options`
`95`	`92`	`*`
`96`	`93`	`* @return mixed\|void`
	`94`	`+ * @throws ClientException`
	`95`	`+ *`
	`96`	`+ * @see EdgeHandler::saveEdge()`
	`97`	`+ *`
`97`	`98`	`*/`
`98`		`- public function save($collection, $document, $create = null)`
	`99`	`+ public function save($collection, $document, array $options = [])`
`99`	`100`	`{`
`100`	`101`	`throw new ClientException("Edges don't have a save() method. Please use saveEdge()");`
`101`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,7 @@ protected function json_encode_wrapper($body)`
`88`	`88`	`* @param array $includeArray - The array that defines which options are allowed to be included, and what their default value is. for example: 'waitForSync'=>true`
`89`	`89`	`*`
`90`	`90`	`* @return array $params - array of parameters for use in a url`
	`91`	`+ * @throws \triagens\ArangoDb\ClientException`
`91`	`92`	`* @internal param array $params - The parameters into which the options will be included.`
`92`	`93`	`*/`
`93`	`94`	`protected function includeOptionsInParams($options, array $includeArray = [])`
Original file line number	Diff line number	Diff line change
`@@ -132,6 +132,7 @@ class Transaction`
`132`	`132`	`* @param Connection $connection - the connection to be used`
`133`	`133`	`* @param array $transactionArray - transaction initialization data`
`134`	`134`	`*`
	`135`	`+ * @throws \triagens\ArangoDb\ClientException`
`135`	`136`	`*/`
`136`	`137`	`public function __construct(Connection $connection, array $transactionArray = null)`
`137`	`138`	`{`