Merge pull request #5 from Martin1982/filter-search

Allow searching through specific object types
PouleR · Dec 8, 2022 · 690b6cd · 690b6cd
2 parents 1fd5d6b + 18fab14
commit 690b6cd
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/src/DeezerAPI.php b/src/DeezerAPI.php
@@ -229,12 +229,13 @@ public function addPlaylistToFavorites($playlistId)
      * @param string      $query
      * @param bool        $strict
      * @param string|null $order
+     * @param string|null $type
      *
      * @return array|object
      *
      * @throws DeezerAPIException
      */
-    public function search(string $query, bool $strict = false, string $order = null): object|array
+    public function search(string $query, bool $strict = false, string $order = null, ?string $type = null): object|array
     {
         if (empty($query)) {
             throw new DeezerAPIException('A query parameter is mandatory');
@@ -250,6 +251,11 @@ public function search(string $query, bool $strict = false, string $order = null
             $apiQuery['order'] = $order;
         }
 
-        return $this->client->apiRequest('GET', 'search', [], null, $apiQuery);
+        $endpoint = 'search';
+        if (null !== $type) {
+            $endpoint.= '/'.urlencode($type);
+        }
+
+        return $this->client->apiRequest('GET', $endpoint, [], null, $apiQuery);
     }
 }
diff --git a/tests/DeezerAPITest.php b/tests/DeezerAPITest.php
@@ -307,4 +307,16 @@ public function testSearch(): void
             ->willReturn([]);
         $this->deezerApi->search('bohemian', true, 'RANKING');
     }
+
+    /**
+     * @throws DeezerAPIException
+     */
+    public function testSearchArtist(): void
+    {
+        $this->client->expects(static::once())
+            ->method('apiRequest')
+            ->with('GET', 'search/artist', [], null, ['q' => 'bohemian', 'strict' => 'on', 'order' => 'RANKING'])
+            ->willReturn([]);
+        $this->deezerApi->search('bohemian', true, 'RANKING', 'artist');
+    }
 }