Documentation

TwitterCC extends OAuth2Provider
in package

Application

implements ClientCredentials uses ClientCredentialsTrait

Twitter OAuth2 (client credentials)

Interfaces

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

Constants

IDENTIFIER = 'TWITTERCC'
AUTH_ERRMSG = 'TwitterCC only supports Client Credentials Grant,' . 'use the Twitter OAuth1 class for authentication instead.'

Properties

$accessTokenURL : string: The access token exchange URL
$apiDocs : string|null
$apiURL : string
$applicationURL : string|null
$authorizationURL : string: The authorization URL
$clientCredentialsTokenURL : string|null: An optional client credentials token endpoint in case the provider supports ClientCredentials.
$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
$parAuthorizationURL : string: An optional PAR (Pushed Authorization Request) endpoint URL
$refreshTokenURL : string|null: An optional refresh token endpoint in case the provider supports TokenRefresh.
$requestFactory : RequestFactoryInterface: A PSR-17 request factory
$revokeURL : string: An optional URL for application side token revocation
$storage : OAuthStorageInterface: A storage instance
$streamFactory : StreamFactoryInterface: A PSR-17 stream factory
$uriFactory : UriFactoryInterface: A PSR-17 URI factory
$userRevokeURL : string|null

Methods

__construct() : mixed: OAuthProvider constructor.
checkState() : void: implements CSRFToken::checkState()
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)
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.
getClientCredentialsToken() : AccessToken: implements ClientCredentials::getClientCredentialsToken()
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
refreshAccessToken() : AccessToken: implements TokenRefresh::refreshAccessToken()
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
setState() : array<string, string>: implements CSRFToken::setState()
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
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, string>: prepares the request body parameters for the access token request
getAuthorizationURLRequestParams() : array<string, string>: prepares the query parameters for the auth URL
getClientCredentialsTokenRequestBodyParams() : array<string, string>: prepares the request body parameters for the client credentials token request
getMeResponseData() : array<int|string, mixed>: fetches the provider's "me" endpoint and returns the JSON data as an array
getRefreshAccessTokenRequestBodyParams() : array<string, string|null>: prepares the request body parameters for the token refresh
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
getTokenResponseData() : array<string, string|mixed>: extracts the data from the access token response and returns an array with the key->value pairs contained
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: 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
sendMeRequest() : ResponseInterface: prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
setRequestBody() : RequestInterface: Prepares the request body and sets it in the given RequestInterface, along with a Content-Length header

IDENTIFIER


    public
        mixed
    IDENTIFIER
    = 'TWITTERCC'

AUTH_ERRMSG


    protected
        mixed
    AUTH_ERRMSG
    = 'TwitterCC only supports Client Credentials Grant,' . 'use the Twitter OAuth1 class for authentication instead.'

$accessTokenURL

The access token exchange URL


    protected
        string
    $accessTokenURL
     = ''

$apiDocs


    protected
        string|null
    $apiDocs
     = 'https://developer.twitter.com/en/docs/basics/authentication/overview/application-only'

$apiURL


    protected
        string
    $apiURL
     = 'https://api.twitter.com'

$applicationURL


    protected
        string|null
    $applicationURL
     = 'https://developer.twitter.com/apps'

$authorizationURL

The authorization URL


    protected
        string
    $authorizationURL
     = ''

$clientCredentialsTokenURL

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


    protected
        string|null
    $clientCredentialsTokenURL
     = 'https://api.twitter.com/oauth2/token'

If the provider supports client credentials and $clientCredentialsTokenURL is null, $accessTokenURL will be used instead.

$http

The PSR-18 HTTP client


    protected
        ClientInterface
    $http

$logger

A PSR-3 logger


    protected
        LoggerInterface
    $logger

$name

The name of the provider/class


    protected
        string
    $name
     = ''

$options

The options instance


    protected
        OAuthOptions|SettingsContainerInterface
    $options

$parAuthorizationURL

An optional PAR (Pushed Authorization Request) endpoint URL


    protected
        string
    $parAuthorizationURL
     = ''

$refreshTokenURL

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


    protected
        string|null
    $refreshTokenURL
     = null

If the provider supports token refresh and $refreshTokenURL is null, $accessTokenURL will be used instead.

$requestFactory

A PSR-17 request factory


    protected
        RequestFactoryInterface
    $requestFactory

$revokeURL

An optional URL for application side token revocation


    protected
        string
    $revokeURL
     = ''

$storage

A storage instance


    protected
        OAuthStorageInterface
    $storage

$streamFactory

A PSR-17 stream factory


    protected
        StreamFactoryInterface
    $streamFactory

$uriFactory

A PSR-17 URI factory


    protected
        UriFactoryInterface
    $uriFactory

$userRevokeURL


    protected
        string|null
    $userRevokeURL
     = 'https://twitter.com/settings/applications'

__construct()

OAuthProvider constructor.


    public
        final            __construct(OAuthOptions|SettingsContainerInterface $options, ClientInterface $http, RequestFactoryInterface $requestFactory, StreamFactoryInterface $streamFactory, UriFactoryInterface $uriFactory[, OAuthStorageInterface $storage = new MemoryStorage() ][, LoggerInterface $logger = new NullLogger() ]) : mixed

Parameters

$options : OAuthOptions|SettingsContainerInterface
$http : ClientInterface
$requestFactory : RequestFactoryInterface
$streamFactory : StreamFactoryInterface
$uriFactory : UriFactoryInterface
$storage : OAuthStorageInterface = new MemoryStorage()
$logger : LoggerInterface = new NullLogger()

checkState()

implements CSRFToken::checkState()


    public
        final            checkState([string|null $state = null ]) : void

Parameters

$state : string|null = null

getAccessToken()

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


    public
                    getAccessToken(string $code[, string|null $state = null ]) : AccessToken

Parameters

$code : string
$state : string|null = null

Return values

AccessToken

getAccessTokenFromStorage()

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


    public
        final            getAccessTokenFromStorage() : AccessToken

Return values

AccessToken

getApiDocURL()

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


    public
        final            getApiDocURL() : string|null

Return values

string|null

getApplicationURL()

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


    public
        final            getApplicationURL() : string|null

Return values

string|null

getAuthorizationURL()

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.


    public
                    getAuthorizationURL([array<string|int, mixed>|null $params = null ][, array<string|int, mixed>|null $scopes = null ]) : UriInterface

Parameters

$params : array<string|int, mixed>|null = null
$scopes : array<string|int, mixed>|null = null

Return values

UriInterface

getClientCredentialsToken()

implements ClientCredentials::getClientCredentialsToken()


    public
                    getClientCredentialsToken([array<string|int, string>|null $scopes = null ]) : AccessToken

Parameters

$scopes : array<string|int, string>|null = null

Return values

AccessToken

getName()

Returns the name of the provider/class


    public
        final            getName() : string

Return values

string

getRequestAuthorization()

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


    public
                    getRequestAuthorization(RequestInterface $request[, AccessToken|null $token = null ]) : RequestInterface

Parameters

$request : RequestInterface
$token : AccessToken|null = null

Return values

RequestInterface

getStorage()

Returns the current OAuthStorageInterface


    public
        final            getStorage() : OAuthStorageInterface

Return values

OAuthStorageInterface

getUserRevokeURL()

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


    public
        final            getUserRevokeURL() : string|null

Return values

string|null

InvalidateAccessToken()

implements TokenInvalidate


    public
                    InvalidateAccessToken([AccessToken|null $token = null ]) : bool

Parameters

$token : AccessToken|null = null

Return values

bool

refreshAccessToken()

implements TokenRefresh::refreshAccessToken()


    public
                    refreshAccessToken([AccessToken|null $token = null ]) : AccessToken

Parameters

$token : AccessToken|null = null

Return values

AccessToken

request()

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


    public
                    request(string $path[, array<string|int, mixed>|null $params = null ][, string|null $method = null ][, StreamInterface|array<string|int, mixed>|string|null $body = null ][, array<string|int, mixed>|null $headers = null ][, string|null $protocolVersion = null ]) : ResponseInterface

Parameters

$path : string
$params : array<string|int, mixed>|null = null
$method : string|null = null
$body : StreamInterface|array<string|int, mixed>|string|null = null
$headers : array<string|int, mixed>|null = null
$protocolVersion : string|null = null

Return values

ResponseInterface

sendRequest()


    public
        final            sendRequest(RequestInterface $request) : ResponseInterface

Parameters

$request : RequestInterface

Return values

ResponseInterface

setLogger()

Sets an optional PSR-3 LoggerInterface


    public
        final            setLogger(LoggerInterface $logger) : static

Parameters

$logger : LoggerInterface

Return values

static

setRequestFactory()

Sets an optional PSR-17 RequestFactoryInterface


    public
        final            setRequestFactory(RequestFactoryInterface $requestFactory) : static

Parameters

$requestFactory : RequestFactoryInterface

Return values

static

setState()

implements CSRFToken::setState()


    public
        final            setState(array<string, string> $params) : array<string, string>

Parameters

$params : array<string, string>

Return values

array<string, string>

setStorage()

Sets an optional OAuthStorageInterface


    public
        final            setStorage(OAuthStorageInterface $storage) : static

Parameters

$storage : OAuthStorageInterface

Return values

static

setStreamFactory()

Sets an optional PSR-17 StreamFactoryInterface


    public
        final            setStreamFactory(StreamFactoryInterface $streamFactory) : static

Parameters

$streamFactory : StreamFactoryInterface

Return values

static

setUriFactory()

Sets an optional PSR-17 UriFactoryInterface


    public
        final            setUriFactory(UriFactoryInterface $uriFactory) : static

Parameters

$uriFactory : UriFactoryInterface

Return values

static

storeAccessToken()

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


    public
        final            storeAccessToken(AccessToken $token) : static

Parameters

$token : AccessToken

Return values

static

addBasicAuthHeader()

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


    protected
                    addBasicAuthHeader(RequestInterface $request) : RequestInterface

Parameters

$request : RequestInterface

Return values

RequestInterface

cleanBodyParams()

Cleans an array of body parameters


    protected
                    cleanBodyParams(array<string, scalar|bool|null> $params) : array<string, string>

Parameters

$params : array<string, scalar|bool|null>

Return values

array<string, string>

cleanQueryParams()

Cleans an array of query parameters


    protected
                    cleanQueryParams(array<string, scalar|bool|null> $params) : array<string, string>

Parameters

$params : array<string, scalar|bool|null>

Return values

array<string, string>

construct()

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


    protected
                    construct() : void

createAccessToken()

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


    protected
        final            createAccessToken() : AccessToken

Return values

AccessToken

getAccessTokenRequestBodyParams()

prepares the request body parameters for the access token request


    protected
                    getAccessTokenRequestBodyParams(string $code) : array<string, string>

Parameters

$code : string

Return values

array<string, string>

getAuthorizationURLRequestParams()

prepares the query parameters for the auth URL


    protected
                    getAuthorizationURLRequestParams(array<string, scalar> $params, array<string|int, string> $scopes) : array<string, string>

Parameters

$params : array<string, scalar>
$scopes : array<string|int, string>

Return values

array<string, string>

getClientCredentialsTokenRequestBodyParams()

prepares the request body parameters for the client credentials token request


    protected
                    getClientCredentialsTokenRequestBodyParams(array<string|int, string>|null $scopes) : array<string, string>

Parameters

$scopes : array<string|int, string>|null

Return values

array<string, string>

getMeResponseData()

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


    protected
        final            getMeResponseData(string $endpoint[, array<string, scalar|bool|null>|null $params = null ]) : array<int|string, mixed>

Parameters

$endpoint : string
$params : array<string, scalar|bool|null>|null = null

Return values

array<int|string, mixed>

getRefreshAccessTokenRequestBodyParams()

prepares the request body parameters for the token refresh


    protected
                    getRefreshAccessTokenRequestBodyParams(string $refreshToken) : array<string, string|null>

Parameters

$refreshToken : string

Return values

array<string, string|null>

getRequestHeaders()

Prepare request headers


    protected
        final            getRequestHeaders([array<string, string>|null $headers = null ]) : array<string, string>

Parameters

$headers : array<string, string>|null = null

Return values

array<string, string>

getRequestTarget()

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".


    protected
                    getRequestTarget(string $uri) : string

Throws if the host of a given URL does not match the host of $apiURL.

Parameters

$uri : string

Return values

string

getRequestURL()

Prepares the request URL


    protected
        final            getRequestURL(string $path[, array<string, scalar|bool|null>|null $params = null ]) : string

Parameters

$path : string
$params : array<string, scalar|bool|null>|null = null

Return values

string

getTokenResponseData()

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


    protected
                    getTokenResponseData(ResponseInterface $response) : array<string, string|mixed>

we don't bother checking the content type here as it's sometimes vendor specific, not set or plain wrong: the spec mandates a JSON body which is what almost all providers send - weird exceptions:

mixcloud sends JSON with a "text/javascript" header
deezer sends form-data with a "text/html" header (???)
silly amazon sends gzip compressed data... (handled by decodeJSON)

Parameters

$response : ResponseInterface

Return values

array<string, string|mixed>

handleMeResponseError()

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


    protected
        final            handleMeResponseError(ResponseInterface $response) : void

we could simply throw a ProviderException and be done with it, but we're nice and try to provide a message too

Parameters

$response : ResponseInterface

nonce()

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


    protected
                    nonce([int $bytes = 32 ]) : string

Parameters

$bytes : int = 32

Return values

string

parseTokenResponse()

Parses the response from a request to the token endpoint


    protected
                    parseTokenResponse(ResponseInterface $response) : AccessToken

Parameters

$response : ResponseInterface

Return values

AccessToken

sendAccessTokenRequest()

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


    protected
                    sendAccessTokenRequest(string $url, array<string, scalar|bool|null> $body) : ResponseInterface

Parameters

$url : string
$body : array<string, scalar|bool|null>

Return values

ResponseInterface

sendClientCredentialsTokenRequest()

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


    protected
                    sendClientCredentialsTokenRequest(string $url, array<string, scalar> $body) : ResponseInterface

Parameters

$url : string
$body : array<string, scalar>

Return values

ResponseInterface

sendMeRequest()

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


    protected
                    sendMeRequest(string $endpoint[, array<string, scalar|bool|null>|null $params = null ]) : ResponseInterface

Parameters

$endpoint : string
$params : array<string, scalar|bool|null>|null = null

Return values

ResponseInterface

setRequestBody()

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


    protected
        final            setRequestBody(StreamInterface|array<string, scalar|bool|null>|string $body, RequestInterface $request) : RequestInterface

Parameters

$body : StreamInterface|array<string, scalar|bool|null>|string
$request : RequestInterface

Return values

RequestInterface

TwitterCC extends OAuth2Provider in package Application implements ClientCredentials uses ClientCredentialsTrait

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

IDENTIFIER

AUTH_ERRMSG

Properties

$accessTokenURL

$apiDocs

$apiURL

$applicationURL

$authorizationURL

$clientCredentialsTokenURL

$http

$logger

$name

$options

$parAuthorizationURL

Tags

$refreshTokenURL

Tags

$requestFactory

$revokeURL

Tags

$storage

$streamFactory

$uriFactory

$userRevokeURL

Methods

__construct()

Parameters

checkState()

Parameters

Tags

getAccessToken()

Parameters

Tags

Return values

getAccessTokenFromStorage()

Tags

Return values

getApiDocURL()

Tags

Return values

getApplicationURL()

Tags

Return values

getAuthorizationURL()

Parameters

Tags

Return values

getClientCredentialsToken()

Parameters

Tags

Return values

getName()

Tags

Return values

getRequestAuthorization()

Parameters

Return values

getStorage()

Tags

Return values

getUserRevokeURL()

Tags

Return values

InvalidateAccessToken()

Parameters

Tags

Return values

refreshAccessToken()

Parameters

Tags

Return values

request()

TwitterCC extends OAuth2Provider
in package

Application

implements ClientCredentials uses ClientCredentialsTrait