Documentation

Spotify extends OAuth2Provider

in package

• Application

implements ClientCredentials, CSRFToken, TokenRefresh

Spotify OAuth2

Tags

see

https://developer.spotify.com/documentation/web-api

see

https://developer.spotify.com/documentation/web-api/tutorials/code-flow

see

https://developer.spotify.com/documentation/web-api/tutorials/client-credentials-flow

Table of Contents

Interfaces

ClientCredentials

Indicates whether the provider is capable of the OAuth2 client credentials authentication flow.

CSRFToken

Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")

TokenRefresh

Indicates whether the provider is capable of the OAuth2 token refresh.

Constants

DEFAULT_SCOPES  = [self::SCOPE_PLAYLIST_READ_COLLABORATIVE, self::SCOPE_PLAYLIST_MODIFY_PUBLIC, self::SCOPE_USER_FOLLOW_MODIFY, self::SCOPE_USER_FOLLOW_READ, self::SCOPE_USER_LIBRARY_READ, self::SCOPE_USER_LIBRARY_MODIFY, self::SCOPE_USER_TOP_READ, self::SCOPE_USER_READ_EMAIL, self::SCOPE_STREAMING, self::SCOPE_USER_READ_PLAYBACK_STATE, self::SCOPE_USER_MODIFY_PLAYBACK_STATE, self::SCOPE_USER_READ_CURRENTLY_PLAYING, self::SCOPE_USER_READ_RECENTLY_PLAYED]

SCOPE_PLAYLIST_MODIFY_PRIVATE  = 'playlist-modify-private'

SCOPE_PLAYLIST_MODIFY_PUBLIC  = 'playlist-modify-public'

SCOPE_PLAYLIST_READ_COLLABORATIVE  = 'playlist-read-collaborative'

SCOPE_PLAYLIST_READ_PRIVATE  = 'playlist-read-private'

SCOPE_STREAMING  = 'streaming'

SCOPE_UGC_IMAGE_UPLOAD  = 'ugc-image-upload'

SCOPE_USER_CREATE_PARTNER  = 'user-create-partner'

SCOPE_USER_FOLLOW_MODIFY  = 'user-follow-modify'

SCOPE_USER_FOLLOW_READ  = 'user-follow-read'

SCOPE_USER_LIBRARY_MODIFY  = 'user-library-modify'

SCOPE_USER_LIBRARY_READ  = 'user-library-read'

SCOPE_USER_MANAGE_ENTITLEMENTS  = 'user-manage-entitlements'

SCOPE_USER_MANAGE_PARTNER  = 'user-manage-partner'

SCOPE_USER_MODIFY_PLAYBACK_STATE  = 'user-modify-playback-state'

SCOPE_USER_READ_CURRENTLY_PLAYING  = 'user-read-currently-playing'

SCOPE_USER_READ_EMAIL  = 'user-read-email'

SCOPE_USER_READ_PLAYBACK_POSITION  = 'user-read-playback-position'

SCOPE_USER_READ_PLAYBACK_STATE  = 'user-read-playback-state'

SCOPE_USER_READ_PRIVATE  = 'user-read-private'

SCOPE_USER_READ_RECENTLY_PLAYED  = 'user-read-recently-played'

SCOPE_USER_SOA_LINK  = 'user-soa-link'

SCOPE_USER_SOA_UNLINK  = 'user-soa-unlink'

SCOPE_USER_TOP_READ  = 'user-top-read'

MAGIC_PROPERTIES  = ['apiDocs', 'apiURL', 'applicationURL', 'serviceName', 'userRevokeURL']

Properties

$accessTokenURL  : string

$apiDocs  : string|null

$apiURL  : string

$applicationURL  : string|null

$authURL  : string

$clientCredentialsTokenURL  : string|null

An optional client credentials token endpoint in case the provider supports ClientCredentials.

$http  : ClientInterface

$logger  : LoggerInterface

$options  : OAuthOptions|SettingsContainerInterface

$refreshTokenURL  : string

An optional refresh token endpoint in case the provider supports TokenRefresh.

$requestFactory  : RequestFactoryInterface

$revokeURL  : string

an optional URL for application side token revocation

$serviceName  : string

the name of the provider/class (magic)

$storage  : OAuthStorageInterface

$streamFactory  : StreamFactoryInterface

$uriFactory  : UriFactoryInterface

$userRevokeURL  : string|null

Methods

__construct()  : mixed

OAuthProvider constructor.

__get()  : string|null

Magic getter for the properties specified in self::ALLOWED_PROPERTIES

getAccessToken()  : AccessToken

Obtains an OAuth2 access token with the given $code, verifies the $state if the provider implements the CSRFToken interface, and returns an AccessToken object

getAccessTokenFromStorage()  : AccessToken

Gets an access token from the current OAuthStorageInterface (shorthand/convenience)

getAuthURL()  : UriInterface

getClientCredentialsToken()  : AccessToken

getRequestAuthorization()  : RequestInterface

getStorage()  : OAuthStorageInterface

Returns the current OAuthStorageInterface

InvalidateAccessToken()  : bool

me()  : ResponseInterface

refreshAccessToken()  : AccessToken

request()  : ResponseInterface

Prepares an API request to $path with the given parameters, gets authorization, fires the request and returns a PSR-7 ResponseInterface with the corresponding API response

sendRequest()  : ResponseInterface

setLogger()  : static

Sets an optional PSR-3 LoggerInterface

setRequestFactory()  : static

Sets an optional PSR-17 RequestFactoryInterface

setStorage()  : static

Sets an optional OAuthStorageInterface

setStreamFactory()  : static

Sets an optional PSR-17 StreamFactoryInterface

setUriFactory()  : static

Sets an optional PSR-17 UriFactoryInterface

storeAccessToken()  : static

Sets an access token in the current OAuthStorageInterface (shorthand/convenience)

cleanBodyParams()  : array<string|int, mixed>

Cleans an array of body parameters

cleanQueryParams()  : array<string|int, mixed>

Cleans an array of query parameters

construct()  : void

A replacement constructor that you can call in extended classes, so that you don't have to implement the monstrous original `__construct()`

createAccessToken()  : AccessToken

Creates an access token with the provider set to $this->serviceName

getAccessTokenRequestBodyParams()  : array<string|int, mixed>

prepares the request body parameters for the access token request

getAuthURLRequestParams()  : array<string|int, mixed>

prepares the query parameters for the auth URL

getClientCredentialsTokenRequestBodyParams()  : array<string|int, mixed>

prepares the request body parameters for the client credentials token request

getRefreshAccessTokenRequestBodyParams()  : array<string|int, mixed>

prepares the request body parameters for the token refresh

getRequestBody()  : StreamInterface

Prepares the request body

getRequestHeaders()  : array<string|int, mixed>

Prepare request headers

getRequestTarget()  : string

Determine the request target from the given URI (path segment or URL) with respect to $apiURL, anything except host and path will be ignored, scheme will always be set to "https".

getRequestURL()  : string

Prepares the request URL

getTokenResponseData()  : array<string|int, mixed>

extracts the data from the access token response and returns an array with the key->value pairs contained

nonce()  : string

returns a 32 byte random string (in hexadecimal representation) for use as a nonce

parseTokenResponse()  : AccessToken

Parses the response from a request to the token endpoint

sendAccessTokenRequest()  : ResponseInterface

sends a request to the access/refresh token endpoint $url with the given $body as form data

sendClientCredentialsTokenRequest()  : ResponseInterface

sends a request to the client credentials endpoint, using basic authentication