Created Response class to manage the api response array

Author: hmerritt

src/Response.php

@@ -11,4 +11,47 @@
 class Response
 {
 
+    /**
+     * A persistent array to store the response in
+     *
+     * @var array
+     */
+    public $store = [];
+
+    /**
+     * Add (or modify) to the response $store
+     *
+     * @param string $key
+     * @param string $value
+     * @return array $store
+     */
+    public function add(string $key, $value): array
+    {
+        //  Add item to $store
+        $this->store[$key] = $value;
+
+        return $this->store;
+    }
+
+    /**
+     * Get an individual value from the response $store
+     *
+     * @param string $key
+     * @return $store[$key]
+     */
+    public function get(string $key)
+    {
+        return $this->store[$key];
+    }
+
+    /**
+     * Returns the entire $store array
+     *
+     * @return array $store
+     */
+    public function return(): array
+    {
+        return $this->store;
+    }
+
 }

src/imdb.php

@@ -47,7 +47,7 @@ private function populateOptions(array $options = []): array
      * film name is passed instead of film-id
      * @param string $film
      * @param array  $options
-     * @return array $filmData
+     * @return array $response
      */
     public function film(string $film, array $options = []): array
     {
@@ -58,15 +58,19 @@ public function film(string $film, array $options = []): array
         // -> handles what the api returns
         $response = new Response;
 
+        //  Initiate dom object
+        //  -> handles page scraping
         $dom = new Dom;
+
+        //  Load imdb page and parse the dom
         $page = $dom->fetch("https://www.imdb.com/title/tt0816692/", $options);
 
-        return [
-            "id" => "tt0816692",
-            "title" => "Interstellar",
-            "length" => "2h 49min",
-            "year" => "2014"
-        ];
+        $response->add("id", "tt0816692");
+        $response->add("title", "Interstellar");
+        $response->add("length", "2h 49min");
+        $response->add("year", "2014");
+
+        return $response->return();
     }
 
     /**
@@ -80,11 +84,15 @@ public function search(string $search, array $options = []): array
         //  Combine user options with default ones
         $options = $this->populateOptions($options);
 
-        return [
-            "titles" => [],
-            "names" => [],
-            "companies" => []
-        ];
+        //  Initiate response object
+        // -> handles what the api returns
+        $response = new Response;
+
+        $response->add("titles", []);
+        $response->add("names", []);
+        $response->add("companies", []);
+
+        return $response->return();
     }
 
 }