Add null return type to SpotifyWebAPI::getMyCurrentTrack() and Spotif…

…yWebAPI::getMyCurrentPlaybackInfo() Closes #269
jwilsson · Dec 14, 2023 · 776d063 · 776d063
1 parent c115c3c
commit 776d063
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 4 deletions.
diff --git a/src/SpotifyWebAPI.php b/src/SpotifyWebAPI.php
@@ -1133,9 +1133,10 @@ public function getMultipleAudioFeatures(string|array $trackIds): array|object
      * - string market Optional. ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.
      * - string|array additional_types Optional. Types of media to return info about.
      *
-     * @return array|object The user's currently playing track. Type is controlled by the `return_assoc` option.
+     * @return array|object|null The user's currently playing track or null if nothing's currently playing.
+     * Type is controlled by the `return_assoc` option.
      */
-    public function getMyCurrentTrack(array|object $options = []): array|object
+    public function getMyCurrentTrack(array|object $options = []): array|object|null
     {
         $uri = '/v1/me/player/currently-playing';
         $options = (array) $options;
@@ -1172,9 +1173,10 @@ public function getMyDevices(): array|object
      * - string market Optional. ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.
      * - string|array additional_types Optional. Types of media to return info about.
      *
-     * @return array|object The user's playback information. Type is controlled by the `return_assoc` option.
+     * @return array|object|null The user's playback information or null if nothing's currently playing.
+     * Type is controlled by the `return_assoc` option.
      */
-    public function getMyCurrentPlaybackInfo(array|object $options = []): array|object
+    public function getMyCurrentPlaybackInfo(array|object $options = []): array|object|null
     {
         $uri = '/v1/me/player';
         $options = (array) $options;

diff --git a/tests/SpotifyWebAPITest.php b/tests/SpotifyWebAPITest.php
@@ -1266,6 +1266,22 @@ public function testGetMyCurrentTrack()
         $this->assertObjectHasProperty('item', $response);
     }
 
+    public function testGetMyCurrentTrackEmptyResponse()
+    {
+        $return = ['body' => null];
+        $api = $this->setupApi(
+            'GET',
+            '/v1/me/player/currently-playing',
+            [],
+            [],
+            $return
+        );
+
+        $response = $api->getMyCurrentTrack([]);
+
+        $this->assertNull($response);
+    }
+
     public function testGetMyDevices()
     {
         $return = ['body' => get_fixture('user-devices')];
@@ -1308,6 +1324,22 @@ public function testGetMyCurrentPlaybackInfo()
         $this->assertObjectHasProperty('item', $response);
     }
 
+    public function testGetMyCurrentPlaybackInfoEmptyResponse()
+    {
+        $return = ['body' => null];
+        $api = $this->setupApi(
+            'GET',
+            '/v1/me/player',
+            [],
+            [],
+            $return
+        );
+
+        $response = $api->getMyCurrentPlaybackInfo([]);
+
+        $this->assertNull($response);
+    }
+
     public function testGetMyPlaylists()
     {
         $options = ['limit' => 10];