Corrects and updates phpdoc references/errors (#329)

* Corrects and updates phpdoc references/errors

* Lint fixes

Author: Benjamin Wilson Friedman

.gitignore

@@ -12,3 +12,6 @@ phpunit-test-results
 *.log
 
 coverage.xml
+
+# ignore phpdoc
+output/

composer.json

@@ -19,7 +19,7 @@
     "require-dev": {
         "phpunit/phpunit": "~4.0",
         "squizlabs/php_codesniffer": "^3.0.1",
-        "phpdocumentor/phpdocumentor": "~2.5"
+        "phpdocumentor/phpdocumentor": "~2.9"
     },
     "autoload": {
         "psr-4": {

package.json

@@ -6,7 +6,8 @@
     "lint": "./vendor/bin/phpcs --standard=./phpcs.xml.dist ./src/Parse ./tests/Parse",
     "lint:fix": "./vendor/bin/phpcbf --standard=./phpcs.xml.dist ./src/Parse ./tests/Parse",
     "start" : "./node_modules/parse-server-test/run-server",
-    "stop"  : "./node_modules/parse-server-test/stop-server"
+    "stop"  : "./node_modules/parse-server-test/stop-server",
+    "document" : "./vendor/bin/phpdoc -d ./src/ --title 'Parse PHP SDK API Reference' --template='responsive-twig'"
   },
   "repository": {
     "type": "git",

src/Parse/HttpClients/ParseCurl.php

@@ -1,22 +1,23 @@
 <?php
 /**
- * ParseCurl - Wrapper for abstracted curl usage
- *
- * @author Ben Friedman <ben@axolsoft.com>
+ * Class ParseCurl | Parse/HttpClients/ParseCurl.php
  */
 
 namespace Parse\HttpClients;
 
 use Parse\ParseException;
 
 /**
- * Class ParseCurl
+ * Class ParseCurl - Wrapper for abstracted curl usage
+ *
+ * @author Ben Friedman <ben@axolsoft.com>
  * @package Parse\HttpClients
  */
 class ParseCurl
 {
     /**
      * Curl handle
+     *
      * @var resource
      */
     private $curl;

src/Parse/HttpClients/ParseCurlHttpClient.php

@@ -1,58 +1,65 @@
 <?php
 /**
- * ParseCurlHttpClient - Curl http client
- *
- * @author Ben Friedman <ben@axolsoft.com>
+ * Class ParseCurlHttpClient | Parse/HttpClients/ParseCurlHttpClient.php
  */
 
 namespace Parse\HttpClients;
 
 use Parse\ParseException;
 
 /**
- * Class ParseCurlHttpClient
+ * Class ParseCurlHttpClient - Curl http client
+ *
+ * @author Ben Friedman <ben@axolsoft.com>
  * @package Parse\HttpClients
  */
 class ParseCurlHttpClient implements ParseHttpable
 {
     /**
      * Curl handle
+     *
      * @var ParseCurl
      */
     private $parseCurl;
 
     /**
      * Request Headers
+     *
      * @var array
      */
     private $headers = array();
 
     /**
      * Response headers
+     *
      * @var array
      */
     private $responseHeaders = array();
 
     /**
      * Response code
+     *
      * @var int
      */
     private $responseCode = 0;
 
     /**
      * Content type of our response
+     *
      * @var string|null
      */
     private $responseContentType;
 
     /**
      * cURL error code
+     *
      * @var int
      */
     private $curlErrorCode;
 
     /**
      * cURL error message
+     *
      * @var string
      */
     private $curlErrorMessage;
@@ -69,11 +76,14 @@ class ParseCurlHttpClient implements ParseHttpable
 
     /**
      * Response from our request
+     *
      * @var string
      */
     private $response;
 
-
+    /**
+     * ParseCurlHttpClient constructor.
+     */
     public function __construct()
     {
         if (!isset($this->parseCurl)) {

src/Parse/HttpClients/ParseHttpable.php

@@ -1,12 +1,16 @@
 <?php
 /**
- * ParseHttpable - Interface for an HTTPable client
- *
- * @author Ben Friedman <ben@axolsoft.com>
+ * Class ParseHttpable | Parse/HttpClients/ParseHttpable.php
  */
 
 namespace Parse\HttpClients;
 
+/**
+ * Class ParseHttpable - Interface for an HTTPable client
+ *
+ * @author Ben Friedman <ben@axolsoft.com>
+ * @package Parse\HttpClients
+ */
 interface ParseHttpable
 {
     /**

src/Parse/HttpClients/ParseStream.php

@@ -1,38 +1,42 @@
 <?php
 /**
- * ParseStream - Wrapper for abstracted stream usage
- *
- * @author Ben Friedman <ben@axolsoft.com>
+ * Class ParseStream | Parse/HttpClients/ParseStream.php
  */
 
 namespace Parse\HttpClients;
 
 /**
- * Class ParseStream
+ * Class ParseStream - Wrapper for abstracted stream usage
+ *
+ * @author Ben Friedman <ben@axolsoft.com>
  * @package Parse\HttpClients
  */
 class ParseStream
 {
     /**
+     * Stream context
      *
      * @var resource
      */
     private $stream;
 
     /**
      * Response headers
+     *
      * @var array|null
      */
     private $responseHeaders;
 
     /**
      * Error message
+     *
      * @var string
      */
     private $errorMessage;
 
     /**
      * Error code
+     *
      * @var int
      */
     private $errorCode;

src/Parse/HttpClients/ParseStreamHttpClient.php

@@ -1,76 +1,93 @@
 <?php
 /**
- * ParseStreamHttpClient - Stream http client
- *
- * @author Ben Friedman <ben@axolsoft.com>
+ * Class ParseStreamHttpClient | Parse/HttpClients/ParseStreamHttpClient.php
  */
 
 namespace Parse\HttpClients;
 
 use Parse\ParseException;
 
+/**
+ * Class ParseStreamHttpClient - Stream http client
+ *
+ * @author Ben Friedman <ben@axolsoft.com>
+ * @package Parse\HttpClients
+ */
 class ParseStreamHttpClient implements ParseHttpable
 {
     /**
      * Stream handle
+     *
      * @var ParseStream
      */
     private $parseStream;
 
     /**
      * Request Headers
+     *
      * @var array
      */
     private $headers = array();
 
     /**
      * Response headers
+     *
      * @var array
      */
     private $responseHeaders = array();
 
     /**
      * Response code
+     *
      * @var int
      */
     private $responseCode = 0;
 
     /**
      * Content type of our response
+     *
      * @var string|null
      */
     private $responseContentType;
 
     /**
      * Stream error code
+     *
      * @var int
      */
     private $streamErrorCode;
 
     /**
      * Stream error message
+     *
      * @var string
      */
     private $streamErrorMessage;
 
     /**
      * Options to pass to our stream
+     *
      * @var array
      */
     private $options = array();
 
     /**
      * Optional CA file to verify our peers with
+     *
      * @var string
      */
     private $caFile;
 
     /**
      * Response from our request
+     *
      * @var string
      */
     private $response;
 
+    /**
+     * ParseStreamHttpClient constructor.
+     */
     public function __construct()
     {
         if (!isset($this->parseStream)) {
@@ -143,6 +160,9 @@ private function buildRequestHeaders()
         return implode("\r\n", $headers);
     }
 
+    /**
+     * Sets up ssl related options for the stream context
+     */
     public function setup()
     {
         // setup ssl options
@@ -154,6 +174,15 @@ public function setup()
         );
     }
 
+    /**
+     * Sends an HTTP request
+     *
+     * @param string $url       Url to send this request to
+     * @param string $method    Method to send this request via
+     * @param array $data       Data to send in this request
+     * @return string
+     * @throws ParseException
+     */
     public function send($url, $method = 'GET', $data = array())
     {
 
@@ -287,6 +316,11 @@ public function getErrorMessage()
         return $this->streamErrorMessage;
     }
 
+    /**
+     * Sets a connection timeout. UNUSED in the stream client.
+     *
+     * @param int $timeout  Timeout to set
+     */
     public function setConnectionTimeout($timeout)
     {
         // do nothing

src/Parse/Internal/AddOperation.php

@@ -1,4 +1,7 @@
 <?php
+/**
+ * Class AddOperation | Parse/Internal/AddOperation.php
+ */
 
 namespace Parse\Internal;
 
@@ -9,6 +12,7 @@
  * Class AddOperation - FieldOperation for adding object(s) to array fields.
  *
  * @author Fosco Marotto <fjm@fb.com>
+ * @package Parse\Internal
  */
 class AddOperation implements FieldOperation
 {

src/Parse/Internal/AddUniqueOperation.php

@@ -1,4 +1,7 @@
 <?php
+/**
+ * Class AddUniqueOperation | Parse/Internal/AddUniqueOperation.php
+ */
 
 namespace Parse\Internal;
 
@@ -10,6 +13,7 @@
  * Class AddUniqueOperation - Operation to add unique objects to an array key.
  *
  * @author Fosco Marotto <fjm@fb.com>
+ * @package Parse\Internal
  */
 class AddUniqueOperation implements FieldOperation
 {
@@ -126,6 +130,13 @@ public function _apply($oldValue, $obj, $key)
         return $oldValue;
     }
 
+    /**
+     * Checks if a parse object is contained in a given array of values
+     *
+     * @param ParseObject $parseObject  ParseObject to check for existence of
+     * @param array $oldValue           Array to check if ParseObject is present in
+     * @return bool
+     */
     private function isParseObjectInArray($parseObject, $oldValue)
     {
         foreach ($oldValue as $object) {