PHP Класс SpotifyWebAPI\Session

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$accessToken
$clientId
$clientSecret
$expirationTime
$redirectUri
$refreshToken
$request

Открытые методы

Метод Описание
__construct ( string $clientId, string $clientSecret, string $redirectUri = '', Request $request = null ) Constructor Set up client credentials.
getAccessToken ( ) : string Get the access token.
getAuthorizeUrl ( array | object $options = [] ) : string Get the authorization URL.
getClientId ( ) : string Get the client ID.
getClientSecret ( ) : string Get the client secret.
getRedirectUri ( ) : string Get the client's redirect URI.
getRefreshToken ( ) : string Get the refresh token.
getTokenExpiration ( ) : integer Get the access token expiration time.
refreshAccessToken ( string $refreshToken ) : boolean Refresh an access token.
requestAccessToken ( string $authorizationCode ) : boolean Request an access token given an authorization code.
requestCredentialsToken ( array $scope = [] ) : boolean Request an access token using the Client Credentials Flow.
setClientId ( string $clientId ) : void Set the client ID.
setClientSecret ( string $clientSecret ) : void Set the client secret.
setRedirectUri ( string $redirectUri ) : void Set the client's redirect URI.

Описание методов

__construct() публичный Метод

Constructor Set up client credentials.
public __construct ( string $clientId, string $clientSecret, string $redirectUri = '', Request $request = null )
$clientId string The client ID.
$clientSecret string The client secret.
$redirectUri string Optional. The redirect URI.
$request Request Optional. The Request object to use.

getAccessToken() публичный Метод

Get the access token.
public getAccessToken ( ) : string
Результат string The access token.

getAuthorizeUrl() публичный Метод

Get the authorization URL.
public getAuthorizeUrl ( array | object $options = [] ) : string
$options array | object Optional. Options for the authorization URL. - array scope Optional. Scope(s) to request from the user. - boolean show_dialog Optional. Whether or not to force the user to always approve the app. Default is false. - string state Optional. A CSRF token.
Результат string The authorization URL.

getClientId() публичный Метод

Get the client ID.
public getClientId ( ) : string
Результат string The client ID.

getClientSecret() публичный Метод

Get the client secret.
public getClientSecret ( ) : string
Результат string The client secret.

getRedirectUri() публичный Метод

Get the client's redirect URI.
public getRedirectUri ( ) : string
Результат string The redirect URI.

getRefreshToken() публичный Метод

Get the refresh token.
public getRefreshToken ( ) : string
Результат string The refresh token.

getTokenExpiration() публичный Метод

Get the access token expiration time.
public getTokenExpiration ( ) : integer
Результат integer A Unix timestamp indicating the token expiration time.

refreshAccessToken() публичный Метод

Refresh an access token.
public refreshAccessToken ( string $refreshToken ) : boolean
$refreshToken string The refresh token to use.
Результат boolean Whether the access token was successfully refreshed.

requestAccessToken() публичный Метод

Request an access token given an authorization code.
public requestAccessToken ( string $authorizationCode ) : boolean
$authorizationCode string The authorization code from Spotify.
Результат boolean True when the access token was successfully granted, false otherwise.

requestCredentialsToken() публичный Метод

Request an access token using the Client Credentials Flow.
public requestCredentialsToken ( array $scope = [] ) : boolean
$scope array Optional. Scope(s) to request from the user.
Результат boolean True when an access token was successfully granted, false otherwise.

setClientId() публичный Метод

Set the client ID.
public setClientId ( string $clientId ) : void
$clientId string The client ID.
Результат void

setClientSecret() публичный Метод

Set the client secret.
public setClientSecret ( string $clientSecret ) : void
$clientSecret string The client secret.
Результат void

setRedirectUri() публичный Метод

Set the client's redirect URI.
public setRedirectUri ( string $redirectUri ) : void
$redirectUri string The redirect URI.
Результат void

Описание свойств

$accessToken защищенное свойство

protected $accessToken

$clientId защищенное свойство

protected $clientId

$clientSecret защищенное свойство

protected $clientSecret

$expirationTime защищенное свойство

protected $expirationTime

$redirectUri защищенное свойство

protected $redirectUri

$refreshToken защищенное свойство

protected $refreshToken

$request защищенное свойство

protected $request