formatting and comment tweaks

.gitattributes

@@ -2,5 +2,6 @@
 /.gitattributes                     export-ignore
 /.gitignore                         export-ignore
 /.travis.yml                        export-ignore
+/bin                                export-ignore
 /phpunit.xml                        export-ignore
 /tests                              export-ignore

src/http/HeaderCollection.php

@@ -17,6 +17,8 @@ class HeaderCollection
     protected $keyMap = [];
 
     /**
+     * Retrieve a key that can be used in a hashmap to prevent duplicate keys
+     *
      * @param string $key
      * @param bool $register Whether to register a new key
      * @return string
@@ -26,8 +28,7 @@ protected function getKey(string $key, bool $register = false): string
         $lowercaseKey = strtolower($key);
         if (isset($this->keyMap[$lowercaseKey])) {
             $key = $this->keyMap[$lowercaseKey];
-        }
-        elseif ($register) {
+        } elseif ($register) {
             $this->keyMap[$lowercaseKey] = $key;
         }
         return $key;
@@ -62,7 +63,7 @@ public function setMultiple(array $headers): HeaderCollection
      * Add a request header
      *
      * @param string $key
-     * @param string|integer $value
+     * @param string $value
      */
     public function add(string $key, string $value): HeaderCollection
     {
@@ -99,7 +100,7 @@ public function get(string $key): string
     /**
      * Get multiple header values
      *
-     * @param string $key
+     * @param string ...$keys
      * @return array<string>
      */
     public function getMultiple(string ...$keys): array

src/http/Request.php

@@ -23,7 +23,7 @@ class Request implements RequestParameterDecoderInterface
     /**
      * Headers are parsed and cached here
      *
-     * @var array<string>
+     * @var array<string,string>
      */
     protected $headers;
 
@@ -85,8 +85,7 @@ public function getPath(): string
             if (isset($this->server["REQUEST_URI"])) {
                 $path = parse_url($this->server["REQUEST_URI"], PHP_URL_PATH);
                 $this->path = rawurldecode($path);
-            }
-            else {
+            } else {
                 $this->path = "/";
             }
         }
@@ -135,11 +134,9 @@ public function getIp(): string
      */
     public function getHeader(string $name, string $default = ""): string
     {
-        if (!$this->headers) {
-            $this->headers = $this->readHeaders();
-        }
-        $name = strtolower($name);
-        return $this->headers[$name] ?? $default;
+        $lowercaseName = strtolower($name);
+        $headers = $this->getHeaders();
+        return $headers[$lowercaseName] ?? $default;
     }
 
     /**

src/http/RequestParameterDecoderInterface.php

@@ -5,12 +5,14 @@
 interface RequestParameterDecoderInterface
 {
     /**
+     * Retrieve request query parameters
+     *
      * @return array<string,mixed>
      */
     public function getQueryParameters(): array;
 
     /**
-     * Get the request data using the content type
+     * Retrieve request body parameters
      *
      * @return array
      */

src/http/Response.php

@@ -25,6 +25,11 @@ class Response
      */
     protected $statusText = "OK";
 
+    /**
+     * @var \sndsgd\http\HeaderCollection
+     */
+    protected $headers;
+
     /**
      * Once the body has been generated it is stored here
      *
@@ -140,7 +145,7 @@ public function setBody(string $body): Response
      */
     public function getBody()
     {
-       return $this->body;
+        return $this->body;
     }
 
     public function send()

src/http/UploadedFileError.php

@@ -33,7 +33,7 @@ public function __construct(int $code)
                 break;
             default:
                 throw new \InvalidArgumentException(
-                    "invalid value provided for 'code'; " . 
+                    "invalid value provided for 'code'; ".
                     "expecting one of the php `UPLOAD_ERR_*` constants"
                 );
         }

src/http/data/Collection.php

@@ -64,7 +64,7 @@ public function getValues(): array
     /**
      * Add a value to the collection
      *
-     * @param string|number $name The index/key to add the value under
+     * @param string|number $key The index/key to add the value under
      * @param string|\sndsgd\http\UploadedFile $value The value to add
      */
     public function addValue(string $key, $value)
@@ -82,8 +82,7 @@ public function addValue(string $key, $value)
             $openPos < $closePos
         ) {
             $this->addNestedValue($key, $value, $openPos);
-        }
-        else {
+        } else {
             \sndsgd\Arr::addValue($this->values, $key, $value);
         }
 

src/http/data/decoder/MultipartDataDecoder.php

@@ -109,8 +109,7 @@ public function decode(): array
                 if ($this->fileCount < $this->maxFileCount) {
                     $value = $this->getFileFromField($name, $filename, $contentType);
                     $this->values->addValue($name, $value);
-                }
-                else {
+                } else {
 
                 }
 
@@ -224,7 +223,8 @@ protected function getFieldHeader()
             );
         }
 
-        list($match, $name, $filename) = array_pad($matches, 3, "");
+        # we have no need for the entire match, so we drop it here
+        list( , $name, $filename) = array_pad($matches, 3, "");
 
         # if a filename was in the content disposition
         # attempt to find its content type in the field header
@@ -264,7 +264,7 @@ private function getValueFromField()
     /**
      * Allow for stubbing the result of tempnam using reflection
      *
-     * @return bool
+     * @return string
      */
     protected function getTempFilePath()
     {

src/http/data/decoder/QueryStringDecoder.php

@@ -25,7 +25,7 @@ class QueryStringDecoder
      * Provide a parameter collection to append to it; otherwise all decoded
      * parameters will be added to a new collection
      *
-     * @param string $contentType
+     * @param int $contentLength
      * @param \sndsgd\http\data\Collection|null $values
      */
     public function __construct(
@@ -46,21 +46,21 @@ public function __construct(
     }
 
     /**
-     * Decode a urlencoded parameter pair
+     * Decode a urlencoded parameter key value pair
      *
-     * @param string $pair
+     * @param string $keyValuePair
      * @return array<string> The decoded key and value
      */
-    public function decodePair(string $pair): array
+    public function decodePair(string $keyValuePair): array
     {
         # more than a handful of clients like to use '+' characters
         # when encoding data that is (almost) compliant with rfc 3986
         # this is a hack that allows for it
-        if (strpos($pair, "+") !== false) {
-            $pair = str_replace("+", " ", $pair);
+        if (strpos($keyValuePair, "+") !== false) {
+            $keyValuePair = str_replace("+", " ", $keyValuePair);
         }
 
-        $parts = explode("=", $pair, 2);
+        $parts = explode("=", $keyValuePair, 2);
         $key = rawurldecode($parts[0]);
 
         # interpret a key with an empty value as `null`
@@ -76,8 +76,8 @@ public function decodePair(string $pair): array
      */
     public function decode($query): array
     {
-        foreach (explode("&", $query) as $pair) {
-            list($key, $value) = $this->decodePair($pair);
+        foreach (explode("&", $query) as $keyValuePair) {
+            list($key, $value) = $this->decodePair($keyValuePair);
             $this->values->addValue($key, $value);
         }
         return $this->values->getValues();

src/http/request/BodyDecoder.php

@@ -119,8 +119,7 @@ protected function parsePost()
                         ]);
                         \sndsgd\Arr::addValue($ret, $name, $file);    
                     }
-                }
-                else {
+                } else {
                     $file = $this->createUploadedFile($info);
                     \sndsgd\Arr::addValue($ret, $name, $file);
                 }