CHANGELOG.md

Changelog

2.6.1 (2018-11-07)

• Corrected the authorization URL (891cd0f)

2.6.0 (2018-09-19)

• Added new methods for handling following of playlists, no longer requiring $userId (6f1bb6b):
  • SpotifyWebAPI::followPlaylistForCurrentUser()
  • SpotifyWebAPI::unfollowPlaylistForCurrentUser()
  • SpotifyWebAPI::usersFollowPlaylist
• Deprecated the following methods (6f1bb6b):
  • SpotifyWebAPI::followPlaylist()
  • SpotifyWebAPI::unfollowPlaylist()
  • SpotifyWebAPI::userFollowPlaylist

2.5.1 (2018-07-18)

• Corrected the URI in SpotifyWebAPI::createUserPlaylist(). (d8a59eb)

2.5.0 (2018-07-03)

• Because of recent changes in the handling of playlist related calls, the following methods are deprecated (a05db96):
  • SpotifyWebAPI::addUserPlaylistTracks()
  • SpotifyWebAPI::createUserPlaylist()
  • SpotifyWebAPI::deleteUserPlaylistTracks()
  • SpotifyWebAPI::getUserPlaylist()
  • SpotifyWebAPI::getUserPlaylistTracks()
  • SpotifyWebAPI::reorderUserPlaylistTracks()
  • SpotifyWebAPI::replaceUserPlaylistTracks()
  • SpotifyWebAPI::updateUserPlaylist()
  • SpotifyWebAPI::updateUserPlaylistImage()
• The following methods should be used instead, accepting the same arguments except for $userId (a05db96):
  • SpotifyWebAPI::addPlaylistTracks()
  • SpotifyWebAPI::createPlaylist()
  • SpotifyWebAPI::deletePlaylistTracks()
  • SpotifyWebAPI::getPlaylist()
  • SpotifyWebAPI::getPlaylistTracks()
  • SpotifyWebAPI::reorderPlaylistTracks()
  • SpotifyWebAPI::replacePlaylistTracks()
  • SpotifyWebAPI::updatePlaylist()
  • SpotifyWebAPI::updatePlaylistImage()

2.4.0 (2018-06-06)

• Authentication errors will now throw an SpotifyWebAPIAuthException instead of the regular SpotifyWebAPIException. (4b068d0)

2.3.0 (2018-06-05)

• Restored support for PHP 5.6. It's used by too many at this point and nothing PHP 7 specific is really used. (ff3de71)
• Added a Session::setRefreshToken() method (c30ebfe)

2.2.1 (2018-05-05)

• When running behind a proxy, the first set of proxy response headers are now stripped. (a9dfa55)

2.2.0 (2018-03-01)

• Added positions support to SpotifyWebAPI::deleteUserPlaylistTracks(). (4dfa494)
• Updated CA bundle. (cd63d1a)

2.1.1 (2018-02-02)

• Fixed an issue where a new refresh token wouldn't be properly updated in the Session class when a new one was returned from Spotify. (2bf18e0)

2.1.0 (2017-12-06)

• Added the Session::getScope() method to check which scopes that are granted by the current user. (f741511)
• CI tests are now run on PHP 7.2. (3649e78)
• Improved authorization docs. (14bb6e6)

2.0.1 (2017-09-25)

• Updated CA bundle. (d846e8c)

2.0.0 (2017-08-15)

• Breaking The following, deprecated, methods have been removed (fdaa1bd):
  • Request::getReturnAssoc() (use Request::getReturnType() instead)
  • Request::setReturnAssoc() (use Request::setReturnType(Request::RETURN_ASSOC) instead)
  • SpotifyWebAPI::getReturnAssoc() (use SpotifyWebAPI::getReturnType() instead)
  • SpotifyWebAPI::setReturnAssoc() (use SpotifyWebAPI::setReturnType(SpotifyWebAPI::RETURN_ASSOC) instead)
• Breaking The $type parameter in SpotifyWebAPI::idToUri() and SpotifyWebAPI::uriToId() no longer has a default value. (fdcba71)
• Breaking Dropped support for PHP versions less than 7. (71de436)
• Breaking Tests are no longer run on HHVM, support for it was never documented anyway. (7b9ff5d)
• Removed unused $scope parameter in Session::requestCredentialsToken(). (582f983)
• Updated PHPUnit to 6.x. (49829ac)
• Updated CA bundle. (ac09f96)

1.12.0 (2017-07-26)

• Added the SpotifyWebAPI::updateUserPlaylistImage() method. (14a9631)

1.11.1 (2017-06-12)

• Fixed an issue where some URI IDs wouldn't be properly cast to an array. (713e8e7)

1.11.0 (2017-06-09)

• All methods accepting Album, Artist, Playlist, Track, or User IDs can now also accept Spotify URIs. (1a47fa1, e71daeb, 63dde40, 4bf29b1)
• Corrected SpotifyWebAPI::getMySavedTracks example. (0eedf1c)
• Updated PHP_CodeSniffer to 3.x. (60adb2c)
• Travis builds now uses Trusty as the distribution. (011524b)

1.10.1 (2017-04-29)

• Updated CA bundle. (ff8d87e)
• Corrected the name of some Markdown example files. (d6425f6)
• Corrected SpotifyWebAPI::play() example. (ce2c08c)
• Corrected inline method docs. (d725d16)
• Removed stray SpotifyWebApi object in examples. (7ef922b)

1.10.0 (2017-04-12)

• Added Spotify Connect endpoints:
  • SpotifyWebAPI::changeMyDevice() (21dd887)
  • SpotifyWebAPI::changeVolume() (e9cdd79)
  • SpotifyWebAPI::getMyCurrentPlaybackInfo() (61f4cbd)
  • SpotifyWebAPI::getMyCurrentTrack() (0f30a6b)
  • SpotifyWebAPI::getMyDevices() (8b33f9d)
  • SpotifyWebAPI::next() (9950c51)
  • SpotifyWebAPI::pause() (b724c4a)
  • SpotifyWebAPI::play() (825a632)
  • SpotifyWebAPI::previous() (90a97e1)
  • SpotifyWebAPI::repeat() (1feebfe)
  • SpotifyWebAPI::seek() (0641a07)
  • SpotifyWebAPI::shuffle() (d43268c)
• Complete documentation revamp. (82d9fab)
• Made sure empty objects are correctly serialized to JSON objects instead of JSON arrays. (b17682e)

1.9.0 (2017-03-24)

• Added the SpotifyWebAPI::getMyRecentTracks() method. (4df889f)

1.8.0 (2017-03-05)

• Added the SpotifyWebAPI::getMyRecentTracks() method. (fd8ea0d)

1.7.0 (2017-02-25)

• The following methods can now also accept Spotify URIs:
  • SpotifyWebAPI::addMyAlbums() (eecaea4)
  • SpotifyWebAPI::addMyTracks() (1b63d90)
  • SpotifyWebAPI::deleteMyAlbums() (eecaea4)
  • SpotifyWebAPI::deleteMyTracks() (eecaea4)
  • SpotifyWebAPI::myAlbumsContains() (beb48e2)
  • SpotifyWebAPI::myTracksContains() (edd72d7)
• PHPUnit 5 is now used whenever possible. (9892fe4)

1.6.1 (2017-01-28)

• Bump for bad 1.6.0.

1.6.0 (2017-01-28)

• Deprecated the following methods and replaced them with (6aac5c6):
  • Request::getReturnAssoc() -> Request::getReturnType()
  • Request::setReturnAssoc() -> Request::setReturnType(Request::RETURN_ASSOC)
  • SpotifyWebAPI::getReturnAssoc() -> SpotifyWebAPI::getReturnType()
  • SpotifyWebAPI::setReturnAssoc() -> SpotifyWebAPI::setReturnType(SpotifyWebAPI::RETURN_ASSOC)
• Added the following constants for use with setReturnType() (6aac5c6):
  • Request::RETURN_ASSOC
  • Request::RETURN_OBJECT
  • SpotifyWebAPI::RETURN_ASSOC
  • SpotifyWebAPI::RETURN_OBJECT
• Added docs on how to change the return type. (10b47b5)

1.5.0 (2016-12-11)

• Added a Request::getLastResponse() method. (21b72b0)
• Added a SpotifyWebAPI::getRequest method. (bab8924)
• The $tracks option for SpotifyWebAPI::deleteUserPlaylistTracks() now also supports objects. (ce230e7)
• Response compression will now be automatically negotiated by the client and server. (3f4a643)
• Made sure SpotifyWebAPI::getAlbums() can handle objects for the $options argument properly. (42cf5d0)
• Replaced for-loops with array_map(). (cfc32b7)
• CI tests are run on PHP 7.1. (74cb084)
• Added documentation on error handling. (57ba164)
• Fixed a typo in the SpotifyWebAPI::reorderUserPlaylistTracks() docs. (b25dec4)
• Fixed a typo in the SpotifyWebAPI::getLastResponse() docs. (bdd3ecc)

1.4.2 (2016-10-27)

• Array indexes in SpotifyWebAPI::idToUri() are now always reset to prevent undefined offset errors. (ae8bd96)

1.4.1 (2016-10-25)

• All requests will now be compressed using gzip. (5eeabde)

1.4.0 (2016-10-06)

• Marked SpotifyWebAPI class properties as protected instead of private to allow extending. (f52468a)
• Marked Session class properties as protected instead of private to allow extending. (13e6d53)
• Marked Request class properties as protected instead of private to allow extending. (be2b3f6)
• Moved docs from the gh-pages branch into master. (7f638a1)

1.3.4 (2016-09-23)

• Fixed a typo in the Request::parseBody() method added in 1.3.3. (13d3b94)

1.3.3 (2016-09-06)

• Moved the Request body parsing to its own method. (ef60829)
• All arrays are now using the short array syntax. (Full diff)
• Travis tests are now running on PHP nightlies as well. (0cb8420)
• Updated the inline Request docs for consistency. (cf09e09)

1.3.2 (2016-05-30)

• Improved the handling of seed_* parameters in SpotifyWebAPI::getRecommendations(). (e6603dc)
• Specified better Composer PHP version ranges so we don't break when a new major PHP versions is released. (8dd7749)
• Fixed some minor code style issues in the tests. (de5f7a8)

1.3.1 (2016-04-03)

• Fixed an issue where empty error responses weren't correctly handled. (5f87cc5)
• Fixed an issue where auth call exceptions would sometimes use the wrong message value. (1b7951c)

1.3.0 (2016-03-29)

• The following methods have been added:
  • SpotifyWebAPI::getGenreSeeds() (88b750d)
  • SpotifyWebAPI::getRecommendations() (28b7897)
  • SpotifyWebAPI::getMyTop() (edcafff)
  • SpotifyWebAPI::getAudioFeatures() (0759b29)
• Minor inline docs updates (745f117, 35e9f57, 50f040c)

1.2.0 (2015-12-01)

• The following methods have been added:
  • SpotifyWebAPI::getMyPlaylists() (ea8f0a2)
• Updated CA bundle. (e6161fd)

1.1.0 (2015-11-24)

• The following methods have been added:
  • SpotifyWebAPI::addMyAlbums() (0027122)
  • SpotifyWebAPI::deleteMyAlbums() (1d52172)
  • SpotifyWebAPI::getMySavedAlbums() (1bea486)
  • SpotifyWebAPI::myAlbumsContains() (6f4ecfc)

1.0.0 (2015-10-13)

• This release contains breaking changes, read through this list before updating.
• The following, deprecated, methods have been removed:
  • Session::refreshToken() (4d46e8c)
  • Session::requestToken() (4d46e8c)
  • SpotifyWebAPI::deletePlaylistTracks() (4d46e8c)
  • SpotifyWebAPI::reorderPlaylistTracks() (4d46e8c)
  • SpotifyWebAPI::replacePlaylistTracks() (4d46e8c)
• Added docs for the market parameter to the following methods:
  • SpotifyWebAPI::getAlbums() (b83a131)
  • SpotifyWebAPI::getAlbumTracks() (c0a24d5)
  • SpotifyWebAPI::getMySavedTracks() (06ef152)
  • SpotifyWebAPI::getTrack() (b48c2ff)
  • SpotifyWebAPI::getTracks() (ad7430a)
  • SpotifyWebAPI::getUserPlaylist() (a32ee7c)
  • SpotifyWebAPI::getUserPlaylistTracks() (0c104e8)
• Session::setRefreshToken() has been removed, a refresh token is now passed directly to Session::refreshAccessToken() instead. (62e7383)
• Session::getExpires() has been removed and Session::getTokenExpiration() has been added instead, returning the exact token expiration time. (62e7383)
• The minimum required PHP version has been increased to 5.5 and support for PHP 7 has been added. (b68ae3b, 6a8ac8d)
• HTTP response headers returned by Request::send() and SpotifyWebAPI::getLastResponse() are now parsed to an array. (9075bd3)
• In SpotifyWebAPI::deleteUserPlaylistTracks(), position has been renamed to positions (note the extra "s"). This change was made to better align with the official Spotify docs. (09f2636)
• The positions argument to SpotifyWebAPI::deleteUserPlaylistTracks() now also accept ints. (09f2636)
• SpotifyWebAPI::getArtistTopTracks() now accepts an array of options. (79543ac)
• Session::getAuthorizeUrl() no longer sends empty query strings. (c3e83e8)
• Stopped SpotifyWebAPI::deleteUserPlaylistTracks() from sending internal, leftover data. (09f2636)
• Clarified docs for SpotifyWebAPI::followPlaylist() and SpotifyWebAPI::reorderUserPlaylistTracks(). (09f2636)
• Fixed an issue where SpotifyWebAPI::reorderUserPlaylistTracks() couldn't reorder the first track. (748592e)
• Better tests and coverage. (09f2636)

0.10.0 (2015-09-05)

• The following methods have been added:
  • SpotifyWebAPI::getUserFollowedArtists() (b7142fa)

0.9.0 (2015-07-06)

• This release contains breaking changes, read through this list before updating.
• As we're moving closer to 1.0 the work to make the API more consistent and stable is continuing. This time with an effort to make method names and signatures more consistent.
• Thus, the following methods have been renamed and the old names are deprecated:
  • SpotifyWebAPI::deletePlaylistTracks() -> SpotifyWebAPI::deleteUserPlaylistTracks() (8768328)
  • SpotifyWebAPI::reorderPlaylistTracks -> SpotifyWebAPI::reorderUserPlaylistTracks() (2ce8fc5)
  • SpotifyWebAPI::replacePlaylistTracks() -> SpotifyWebAPI::replaceUserPlaylistTracks() (6362510)
• The following method arguments now also accepts strings:
  • fields in SpotifyWebAPI::getUserPlaylistTracks(). (7a3c200)
  • fields in SpotifyWebAPI::getUserPlaylist(). (80cd7d0)
  • album_type in SpotifyWebAPI::getArtistAlbums(). (4af0a53)
  • ids in SpotifyWebAPI::userFollowsPlaylist(). (9cc11bb)
• A new method, SpotifyWebAPI::getLastResponse() has been introduced which allows for retrieval of the latest full response from the Spotify API. (9b54074)
• Lots of internal changes to increase code consistency and ensure full PSR-2 compatibility. (2b8fda3)
• Better handling of errors from cURL. (c7b5529)

0.8.2 (2015-05-02)

• CA Root Certificates are now included with the library, allowing cURL to always find it. (4ebee9b)

0.8.1 (2015-03-29)

• Fixed an issue where SpotifyWebAPI::updateUserPlaylist() would fail without name set. (39232f5)

0.8.0 (2015-03-22)

• This release contains breaking changes, read through this list before updating.
• The following methods have been renamed:
  • Session::refreshToken() -> Session::refreshAccessToken() (7b6f31a)
  • Session::requestToken() -> Session::requestAccessToken() (98c4a2a)
• The following methods have been added:
  • SpotifyWebAPI::currentUserFollows() (6dbab19)
  • SpotifyWebAPI::followArtistsOrUsers() (6dbab19)
  • SpotifyWebAPI::followPlaylist() (12ff351)
  • SpotifyWebAPI::getCategoriesList() (f09b4b8)
  • SpotifyWebAPI::getCategory() (f09b4b8)
  • SpotifyWebAPI::getCategoryPlaylists() (f09b4b8)
  • SpotifyWebAPI::reorderPlaylistTracks() (0744904)
  • SpotifyWebAPI::unfollowArtistsOrUsers() (6dbab19)
  • SpotifyWebAPI::unfollowPlaylist() (12ff351)
  • SpotifyWebAPI::userFollowsPlaylist() (4293919)
• The $redirectUri argument in Session::__construct() is now optional. (8591ea8)

0.7.0 (2014-12-06)

• The following methods to control the return type of all API methods were added:
  • Request::getReturnAssoc() (b95bf3f)
  • Request::setReturnAssoc() (b95bf3f)
  • SpotifyWebAPI::getReturnAssoc() (b95bf3f)
  • SpotifyWebAPI::setReturnAssoc() (b95bf3f)
• Added fields option to SpotifyWebAPI::getUserPlaylist(). (c35e44d)
• All methods now automatically send authorization headers (if a access token is supplied), increasing rate limits. (a5e95a9)
• Lots of inline documentation improvements.

0.6.0 (2014-10-26)

• This release contains breaking changes, read through this list before updating.
• All static methods on Request have been removed. Request now needs to be instantiated before using. (59207ac)
• All methods that accepted the limit option now uses the correct Spotify default value if nothing has been specified. (a291018)
• It's now possible to specify your own Request object in SpotifyWebAPI and Session constructors. (59207ac)
• SpotifyWebAPI::getArtistAlbums() now supports the album_type option. (1bd7014)
• Request::send() will only modify URLs when needed. (0241f3b)

0.5.0 (2014-10-25)

• The following methods have been added:
  • Session::getExpires() (c9c6da6)
  • Session::getRefreshToken() (0d21147)
  • Session::setRefreshToken() (ff83455)
  • SpotifyWebAPI::getFeaturedPlaylists() (c99537a)
  • SpotifyWebAPI::getNewReleases() (7a8533c)
• The following options has been added:
  • offset and limit to SpotifyWebAPI::getUserPlaylists() (3346857)
  • offset and limit to SpotifyWebAPI::getUserPlaylistTracks() (1660600)
  • fields to SpotifyWebAPI::getUserPlaylistTracks() (9a61003)
  • market to SpotifyWebAPI::getArtistAlbums() (98194dd)
  • market to SpotifyWebAPI::search() (8883e79)
• Better handling of HTTP response codes in Request::send(). (351be62)
• Fixed a bug where SpotifyWebAPIException messages weren't correctly set. (c764894)
• Fixed various issues related to user playlists. (9929d45)

0.4.0 (2014-09-01)

• This release contains lots of breaking changes, read through this list before updating.
• All methods which previously required a Spotify URI now just needs an ID. (f1f14bd)
• deletePlaylistTrack() has been renamed to deletePlaylistTracks(). (e54d703)
• When something goes wrong, a SpotifyWebAPIException is thrown. (d98bb8a)
• The SpotifyWebAPI methods are no longer static, you'll need to instantiate the class now. (67c4e8b)

0.3.0 (2014-08-23)

• The following methods have been added:
  • SpotifyWebAPI::getMySavedTracks() (30c865d)
  • SpotifyWebAPI::myTracksContains() (3f99367)
  • SpotifyWebAPI::addMyTracks() (20d80ef)
  • SpotifyWebAPI::deleteMyTracks() (ee17c69)
  • SpotifyWebAPI::updateUserPlaylist() (5d5874d)
  • SpotifyWebAPI::deletePlaylistTrack() (3b17104)
  • SpotifyWebAPI::deletePlaylistTrack() (3b5e23a)
• Added support for the Client Credentials Authorization Flow. (0892e59)
• Added support for more HTTP methods in Request::send(). (d4df8c1)

0.2.0 (2014-07-26)

• The following methods have been added:
  • SpotifyWebAPI::getArtistRelatedArtists() (5a3ea0e)
• Added offset and limit options for SpotifyWebAPI::getAlbumTracks() and SpotifyWebAPI::getArtistAlbums(). (21c98ec, 8b0c417)
• Replaced PSR-0 autoloading with PSR-4 autoloading. (40878a9)
• Changed method signature of Session::getAuthorizeUrl() and added show_dialog option. (8fe7a6e, 57c36af)
• Added missing returns for SpotifyWebAPI::getUserPlaylist() and SpotifyWebAPI::getUserPlaylistTracks(). (b8c87d7)
• Fixed a bug where search terms were double encoded. (9f1eec6)

0.1.0 (2014-06-28)

• Initial release