Documentation

LastFM extends OAuthProvider

in package

• Application

implements UserInfo

Last.fm

Tags

link

https://www.last.fm/api/authentication

Table of Contents

Interfaces

UserInfo

Indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.

Constants

IDENTIFIER  = 'LASTFM'

PERIOD_12MONTH  = '12month'

PERIOD_1MONTH  = '1month'

PERIOD_3MONTH  = '3month'

PERIOD_6MONTH  = '6month'

PERIOD_7DAY  = '7day'

PERIOD_OVERALL  = 'overall'

PERIODS  = [self::PERIOD_OVERALL, self::PERIOD_7DAY, self::PERIOD_1MONTH, self::PERIOD_3MONTH, self::PERIOD_6MONTH, self::PERIOD_12MONTH]

Properties

$accessTokenURL  : string

The access token exchange URL

$apiDocs  : string|null

An optional link to the provider's API docs

$apiURL  : string

The API base URL

$applicationURL  : string|null

An optional URL to the provider's credential registration/application page

$authorizationURL  : string

The authorization URL

$http  : ClientInterface

The PSR-18 HTTP client

$logger  : LoggerInterface

A PSR-3 logger

$name  : string

The name of the provider/class

$options  : OAuthOptions|SettingsContainerInterface

The options instance

$requestFactory  : RequestFactoryInterface

A PSR-17 request factory

$revokeURL  : string

An optional URL for application side token revocation

$scrobbles  : array<int, array<string, scalar>>

$storage  : OAuthStorageInterface

A storage instance

$streamFactory  : StreamFactoryInterface

A PSR-17 stream factory

$uriFactory  : UriFactoryInterface

A PSR-17 URI factory

$userRevokeURL  : string|null

An optional link to the page where a user can revoke access tokens

Methods

__construct()  : mixed

OAuthProvider constructor.

addScrobble()  : static

Adds a track to scrobble

clearScrobbles()  : static

getAccessToken()  : AccessToken

Obtains an authentication token

getAccessTokenFromStorage()  : AccessToken

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

getApiDocURL()  : string|null

Returns the link to the provider's API docs, or null if the value is not set

getApplicationURL()  : string|null

Returns the link to the provider's credential registration/application page, or null if the value is not set

getAuthorizationURL()  : UriInterface

Prepares the URL with optional $params which redirects to the provider's authorization prompt and returns a PSR-7 UriInterface with all necessary parameters set.

getName()  : string

Returns the name of the provider/class

getRequestAuthorization()  : RequestInterface

Authorizes the $request with the credentials from the given $token and returns a PSR-7 RequestInterface with all necessary headers and/or parameters set

getStorage()  : OAuthStorageInterface

Returns the current OAuthStorageInterface

getUserRevokeURL()  : string|null

Returns the link to the page where a user can revoke access tokens, or null if the value is not set

InvalidateAccessToken()  : bool

implements TokenInvalidate

me()  : AuthenticatedUser

Returns information about the currently authenticated user (usually a /me or /user endpoint).

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

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

Scrobbles an array of one or more tracks

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)

addBasicAuthHeader()  : RequestInterface

Adds an "Authorization: Basic <base64(key:secret)>" header to the given request

addSignature()  : array<string, string>

returns the signature for the set of parameters

cleanBodyParams()  : array<string, string>

Cleans an array of body parameters

cleanQueryParams()  : array<string, string>

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->name

getAccessTokenRequestBodyParams()  : array<string, scalar|bool|null>

prepares the request body parameters for the access token request

getAuthorization()  : array<string, scalar|bool|null>

adds the authorization parameters to the request parameters

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

fetches the provider's "me" endpoint and returns the JSON data as an array

getRequestHeaders()  : array<string, string>

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

handleMeResponseError()  : void

handles errors for the `me()` endpoints - one horrible block of code to catch them all

nonce()  : string

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

parseTokenResponse()  : AccessToken

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

sendAccessTokenRequest()  : ResponseInterface

sends a request to the access token endpoint $url with the given $params as URL query

sendMeRequest()  : ResponseInterface

prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface

sendScrobbles()  : array<string|int, mixed>|null

setRequestBody()  : RequestInterface

Prepares the request body and sets it in the given RequestInterface, along with a Content-Length header