Spelling fixes and a variable rename

frankmayer · jsteemann · commit 8d709dd92a51 · 2016-11-04T08:46:46.000+01:00
diff --git a/lib/triagens/ArangoDb/AqlUserFunction.php b/lib/triagens/ArangoDb/AqlUserFunction.php
@@ -14,7 +14,7 @@
  *
  * AqlUserFunction object<br>
  * An AqlUserFunction is an object that is used to manage AQL User Functions.<br>
- * It registers, unregisters and lists user functions on the server<br>
+ * It registers, un-registers and lists user functions on the server<br>
  * <br>
  * The object encapsulates:<br>
  * <br>
@@ -145,7 +145,7 @@ public function register($name = null, $code = null)
 
 
     /**
-     * Unregister the user function
+     * Un-register the user function
      *
      * If no parameter ($name) is passed, it will use the property of the object.
      *
diff --git a/lib/triagens/ArangoDb/CollectionHandler.php b/lib/triagens/ArangoDb/CollectionHandler.php
@@ -785,7 +785,7 @@ public function importFromFile(
      *                                   <br>
      *
      *                                   </li>
-     *                                   <li>'createCollection' - If true, create the collection if it doesn't exist. Defaults to false </li>
+     *                                   <li>'createCollection' - If true, create the collection if it does not exist. Defaults to false </li>
      *                                   </p>
      *
      * @return array
@@ -1126,7 +1126,7 @@ public function any($collectionId)
      *                                <li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
      *                                <p>
      *                                This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.<br>
-     *                                The difference is, that if you're returning a resultset of documents, the getAll() is already called<br>
+     *                                The difference is, that if you're returning a result set of documents, the getAll() is already called<br>
      *                                and the hidden attributes would not be applied to the attributes.<br>
      *                                </p>
      *
@@ -1209,7 +1209,7 @@ public function getAllIds($collection)
      *                                 <li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
      *                                 <p>
      *                                 This is actually the same as setting hidden attributes using setHiddenAttributes() on a document. <br>
-     *                                 The difference is, that if you're returning a resultset of documents, the getAll() is already called <br>
+     *                                 The difference is, that if you're returning a result set of documents, the getAll() is already called <br>
      *                                 and the hidden attributes would not be applied to the attributes.<br>
      *                                 </p>
      *                                 </li>
@@ -1270,7 +1270,7 @@ public function byExample($collectionId, $document, array $options = [])
      *                                 <li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
      *                                 <p>
      *                                 This is actually the same as setting hidden attributes using setHiddenAttributes() on a document. <br>
-     *                                 The difference is, that if you're returning a resultset of documents, the getAll() is already called <br>
+     *                                 The difference is, that if you're returning a result set of documents, the getAll() is already called <br>
      *                                 and the hidden attributes would not be applied to the attributes.<br>
      *                                 </p>
      *                                 </li>
@@ -1321,7 +1321,7 @@ public function firstExample($collectionId, $document, array $options = [])
      *                                 <li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
      *                                 <p>
      *                                 This is actually the same as setting hidden attributes using setHiddenAttributes() on a document. <br>
-     *                                 The difference is, that if you're returning a resultset of documents, the getAll() is already called <br>
+     *                                 The difference is, that if you're returning a result set of documents, the getAll() is already called <br>
      *                                 and the hidden attributes would not be applied to the attributes.<br>
      *                                 </p>
      *                                 </li>
@@ -1652,7 +1652,7 @@ public function lookupByKeys($collectionId, array $keys, array $options = [])
      *                                <li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
      *                                <p>
      *                                This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.<br>
-     *                                The difference is, that if you're returning a resultset of documents, the getAll() is already called<br>
+     *                                The difference is, that if you're returning a result set of documents, the getAll() is already called<br>
      *                                and the hidden attributes would not be applied to the attributes.<br>
      *                                </p>
      *
@@ -1716,7 +1716,7 @@ public function range($collectionId, $attribute, $left, $right, array $options =
      *                                <li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
      *                                <p>
      *                                This is actually the same as setting hidden attributes using setHiddenAttributes() on a document. <br>
-     *                                The difference is, that if you're returning a resultset of documents, the getAll() is already called <br>
+     *                                The difference is, that if you're returning a result set of documents, the getAll() is already called <br>
      *                                and the hidden attributes would not be applied to the attributes.<br>
      *                                </p>
      *
@@ -1771,7 +1771,7 @@ public function near($collectionId, $latitude, $longitude, array $options = [])
      *                                <li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
      *                                <p>
      *                                This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.<br>
-     *                                The difference is, that if you're returning a resultset of documents, the getAll() is already called <br>
+     *                                The difference is, that if you're returning a result set of documents, the getAll() is already called <br>
      *                                and the hidden attributes would not be applied to the attributes.<br>
      *                                </p>
      *
diff --git a/lib/triagens/ArangoDb/Connection.php b/lib/triagens/ArangoDb/Connection.php
@@ -32,7 +32,7 @@ class Connection
 
     /**
      * Pre-assembled HTTP headers string for connection
-     * This is precalculated when connection options are set/changed, to avoid
+     * This is pre-calculated when connection options are set/changed, to avoid
      * calculation of the same HTTP header values in each request done via the
      * connection
      *
@@ -42,7 +42,7 @@ class Connection
 
     /**
      * Pre-assembled base URL for the current database
-     * This is precalculated when connection options are set/changed, to avoid
+     * This is pre-calculated when connection options are set/changed, to avoid
      * calculation of the same base URL in each request done via the
      * connection
      *
@@ -621,7 +621,7 @@ public function getBatches()
      *
      * This checks if we're in batch mode and returns a placeholder object,
      * since we need to return some object that is expected by the caller.
-     * if we're not in batch mode it doesn't return anything, and
+     * if we're not in batch mode it does not return anything, and
      *
      * @return mixed Batchpart or null if not in batch capturing mode
      * @throws \triagens\ArangoDb\ClientException
diff --git a/lib/triagens/ArangoDb/DocumentHandler.php b/lib/triagens/ArangoDb/DocumentHandler.php
@@ -752,7 +752,7 @@ private function getRevision($document)
      * @param       $collection   mixed collection name or id
      * @param array $options      - optional, array of options
      *                            <p>Options are :
-     *                            <li>'createCollection' - true to create the collection if it doesn't exist</li>
+     *                            <li>'createCollection' - true to create the collection if it does not exist</li>
      *                            <li>'createCollectionType' - "document" or 2 for document collection</li>
      *                            <li>                         "edge" or 3 for edge collection</li>
      *                            </p>
diff --git a/lib/triagens/ArangoDb/EdgeHandler.php b/lib/triagens/ArangoDb/EdgeHandler.php
@@ -242,7 +242,7 @@ public function outEdges($collection, $vertexHandle)
      * @param       $collection   mixed collection name or id
      * @param array $options      - optional, array of options
      *                            <p>Options are :
-     *                            <li>'createCollection' - true to create the collection if it doesn't exist</li>
+     *                            <li>'createCollection' - true to create the collection if it does not exist</li>
      *                            <li>'createCollectionType' - "document" or 2 for document collection</li>
      *                            <li>                         "edge" or 3 for edge collection</li>
      *                            </p>
diff --git a/lib/triagens/ArangoDb/GraphHandler.php b/lib/triagens/ArangoDb/GraphHandler.php
@@ -189,7 +189,7 @@ public function getGraph($graph, array $options = [])
 
     /**
      * Sets the batchsize for any method creating a cursor.
-     * Will be reseted after the cursor has been created.
+     * Will be reset after the cursor has been created.
      *
      * @param int $batchsize
      */
@@ -201,7 +201,7 @@ public function setBatchsize($batchsize)
 
     /**
      * Sets the count for any method creating a cursor.
-     * Will be reseted after the cursor has been created.
+     * Will be reset after the cursor has been created.
      *
      * @param int $count
      */
@@ -213,7 +213,7 @@ public function setCount($count)
 
     /**
      * Sets the limit for any method creating a cursor.
-     * Will be reseted after the cursor has been created.
+     * Will be reset after the cursor has been created.
      *
      * @param int $limit
      */
diff --git a/lib/triagens/ArangoDb/HttpHelper.php b/lib/triagens/ArangoDb/HttpHelper.php
@@ -100,7 +100,7 @@ public static function createConnection(ConnectionOptions $options)
 
         $fp = @stream_socket_client(
             $endpoint,
-            $errno,
+            $errNo,
             $message,
             $options[ConnectionOptions::OPTION_TIMEOUT],
             STREAM_CLIENT_CONNECT,
@@ -110,7 +110,7 @@ public static function createConnection(ConnectionOptions $options)
         if (!$fp) {
             throw new ConnectException(
                 'cannot connect to endpoint \'' .
-                $options[ConnectionOptions::OPTION_ENDPOINT] . '\': ' . $message, $errno
+                $options[ConnectionOptions::OPTION_ENDPOINT] . '\': ' . $message, $errNo
             );
         }
 
@@ -133,7 +133,7 @@ public static function createConnection(ConnectionOptions $options)
      * Create a request string (header and body)
      *
      * @param ConnectionOptions $options          - connection options
-     * @param string            $connectionHeader - preassembled header string for connection
+     * @param string            $connectionHeader - pre-assembled header string for connection
      * @param string            $method           - HTTP method
      * @param string            $url              - HTTP URL
      * @param string            $body             - optional body to post
diff --git a/lib/triagens/ArangoDb/Statement.php b/lib/triagens/ArangoDb/Statement.php
@@ -13,7 +13,7 @@
 /**
  * Container for an AQL query
  *
- * Optional bind parameters can be used when issuing thei AQL query to separate
+ * Optional bind parameters can be used when issuing the AQL query to separate
  * the query from the values.
  * Executing a query will result in a cursor being created.
  *

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`*`
`15`	`15`	`* AqlUserFunction object<br>`
`16`	`16`	`* An AqlUserFunction is an object that is used to manage AQL User Functions.<br>`
`17`		`- * It registers, unregisters and lists user functions on the server<br>`
	`17`	`+ * It registers, un-registers and lists user functions on the server<br>`
`18`	`18`	`* <br>`
`19`	`19`	`* The object encapsulates:<br>`
`20`	`20`	`* <br>`
`@@ -145,7 +145,7 @@ public function register($name = null, $code = null)`
`145`	`145`
`146`	`146`
`147`	`147`	`/**`
`148`		`- * Unregister the user function`
	`148`	`+ * Un-register the user function`
`149`	`149`	`*`
`150`	`150`	`* If no parameter ($name) is passed, it will use the property of the object.`
`151`	`151`	`*`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ class Connection`
`32`	`32`
`33`	`33`	`/**`
`34`	`34`	`* Pre-assembled HTTP headers string for connection`
`35`		`- * This is precalculated when connection options are set/changed, to avoid`
	`35`	`+ * This is pre-calculated when connection options are set/changed, to avoid`
`36`	`36`	`* calculation of the same HTTP header values in each request done via the`
`37`	`37`	`* connection`
`38`	`38`	`*`
`@@ -42,7 +42,7 @@ class Connection`
`42`	`42`
`43`	`43`	`/**`
`44`	`44`	`* Pre-assembled base URL for the current database`
`45`		`- * This is precalculated when connection options are set/changed, to avoid`
	`45`	`+ * This is pre-calculated when connection options are set/changed, to avoid`
`46`	`46`	`* calculation of the same base URL in each request done via the`
`47`	`47`	`* connection`
`48`	`48`	`*`
`@@ -621,7 +621,7 @@ public function getBatches()`
`621`	`621`	`*`
`622`	`622`	`* This checks if we're in batch mode and returns a placeholder object,`
`623`	`623`	`* since we need to return some object that is expected by the caller.`
`624`		`- * if we're not in batch mode it doesn't return anything, and`
	`624`	`+ * if we're not in batch mode it does not return anything, and`
`625`	`625`	`*`
`626`	`626`	`* @return mixed Batchpart or null if not in batch capturing mode`
`627`	`627`	`* @throws \triagens\ArangoDb\ClientException`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`/**`
`14`	`14`	`* Container for an AQL query`
`15`	`15`	`*`
`16`		`- * Optional bind parameters can be used when issuing thei AQL query to separate`
	`16`	`+ * Optional bind parameters can be used when issuing the AQL query to separate`
`17`	`17`	`* the query from the values.`
`18`	`18`	`* Executing a query will result in a cursor being created.`
`19`	`19`	`*`