public
- getAuthURL([array<string|int, mixed>|null $params = null ]) : UriInterface
+ getAuthURL([array<string|int, mixed>|null $params = null ][, array<string|int, mixed>|null $scopes = null ]) : UriInterface
Obtains an OAuth1 request token and returns an AccessToken object for use in the authentication request.
- -
- public
- getRequestToken() : AccessToken
-
- Implements an abstract OAuth1 provider with all methods required by the OAuth1Interface.
+Implements an abstract OAuth1 (1.0a) provider with all methods required by the OAuth1Interface.
+ -@see https://datatracker.ietf.org/doc/html/rfc5849
-
public
- __get(string $name) : string|null
+ final __get(string $name) : string|null
public
- getAuthURL([array<string|int, mixed>|null $params = null ]) : UriInterface
+ getAuthURL([array<string|int, mixed>|null $params = null ][, array<string|int, mixed>|null $scopes = null ]) : UriInterface
public
- getRequestAuthorization(RequestInterface $request, AccessToken $token) : RequestInterface
+ getRequestAuthorization(RequestInterface $request[, AccessToken|null $token = null ]) : RequestInterface
Obtains an OAuth1 request token and returns an AccessToken object for use in the authentication request.
- -
- public
- getRequestToken() : AccessToken
-
-
public
- getStorage() : OAuthStorageInterface
+ final getStorage() : OAuthStorageInterface
public
- sendRequest(RequestInterface $request) : ResponseInterface
+ final sendRequest(RequestInterface $request) : ResponseInterface
public
- setLogger(LoggerInterface $logger) : static
+ final setLogger(LoggerInterface $logger) : static
public
- setRequestFactory(RequestFactoryInterface $requestFactory) : static
+ final setRequestFactory(RequestFactoryInterface $requestFactory) : static
public
- setStorage(OAuthStorageInterface $storage) : static
+ final setStorage(OAuthStorageInterface $storage) : static
public
- setStreamFactory(StreamFactoryInterface $streamFactory) : static
+ final setStreamFactory(StreamFactoryInterface $streamFactory) : static
public
- setUriFactory(UriFactoryInterface $uriFactory) : static
+ final setUriFactory(UriFactoryInterface $uriFactory) : static
Throws if the given path is invalid or if the host of a given URL does not match $apiURL.
+Throws if the host of a given URL does not match the host of $apiURL.
prepares the parameters for the request token request header
+ +
+ protected
+ getRequestTokenRequestParams() : array<string|int, mixed>
+
+
protected
- nonce() : string
+ nonce([int $bytes = 32 ]) : string
protected
- parseTokenResponse(ResponseInterface $response, bool $checkCallback) : AccessToken
+ parseTokenResponse(ResponseInterface $response[, bool $confirmCallback = false ]) : AccessToken
Note: "oauth_callback_confirmed" is only sent in request token response
+
protected
- sendAccessTokenRequest(AccessToken $token, string $verifier) : ResponseInterface
+ sendAccessTokenRequest(string $verifier) : ResponseInterface
Sends a request to the request token endpoint with the given params
+Sends a request to the request token endpoint
protected
- sendRequestTokenRequest(array<string|int, mixed> $requestTokenRequestParams) : ResponseInterface
+ sendRequestTokenRequest(string $url) : ResponseInterface
Prepares the URL with optional $params and $scopes which redirects to the provider's authorization prompt +
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
@@ -769,13 +769,21 @@ Parameters
Tags
-
+
public
- __get(string $name) : string|null
+ final __get(string $name) : string|null
Prepares the URL with optional $params and $scopes which redirects to the provider's authorization prompt -and returns a PSR-7 UriInterface with all necessary parameters set
- +
public
getAuthURL([array<string|int, mixed>|null $params = null ][, array<string|int, string>|null $scopes = null ]) : UriInterface
@@ -1529,7 +1589,7 @@
public
- getRequestAuthorization(RequestInterface $request, AccessToken $token) : RequestInterface
+ getRequestAuthorization(RequestInterface $request[, AccessToken|null $token = null ]) : RequestInterface
public
- getStorage() : OAuthStorageInterface
+ final getStorage() : OAuthStorageInterface
public
- sendRequest(RequestInterface $request) : ResponseInterface
+ final sendRequest(RequestInterface $request) : ResponseInterface
public
- setLogger(LoggerInterface $logger) : static
+ final setLogger(LoggerInterface $logger) : static
public
- setRequestFactory(RequestFactoryInterface $requestFactory) : static
+ final setRequestFactory(RequestFactoryInterface $requestFactory) : static
public
- setStorage(OAuthStorageInterface $storage) : static
+ final setStorage(OAuthStorageInterface $storage) : static
public
- setStreamFactory(StreamFactoryInterface $streamFactory) : static
+ final setStreamFactory(StreamFactoryInterface $streamFactory) : static
public
- setUriFactory(UriFactoryInterface $uriFactory) : static
+ final setUriFactory(UriFactoryInterface $uriFactory) : static
prepares the request body parameters for the access token request
+ +
+ protected
+ getAccessTokenRequestBodyParams(string $code) : array<string|int, mixed>
+
+ prepares the query parameters for the auth URL
+ +
+ protected
+ getAuthURLRequestParams(array<string|int, mixed> $params, array<string|int, mixed> $scopes) : array<string|int, mixed>
+
+ prepares the request body parameters for the client credentials token request
+ +
+ protected
+ getClientCredentialsTokenRequestBodyParams(array<string|int, string>|null $scopes) : array<string|int, mixed>
+
+ prepares the request body parameters for the token refresh
+ +
+ protected
+ getRefreshAccessTokenRequestBodyParams(string $refreshToken) : array<string|int, mixed>
+
+ Throws if the given path is invalid or if the host of a given URL does not match $apiURL.
+Throws if the host of a given URL does not match the host of $apiURL.
extracts the data from the access token response and returns an array with the key->value pairs contained
+ +
+ protected
+ getTokenResponseData(ResponseInterface $response) : array<string|int, 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:
+returns a 32 byte random string (in hexadecimal representation) for use as a nonce
+ +
+ protected
+ nonce([int $bytes = 32 ]) : string
+
+ sends a request to the access/refresh token endpoint $url with the given $body as form data
+ +
+ protected
+ sendAccessTokenRequest(string $url, array<string|int, mixed> $body) : ResponseInterface
+
+ sends a request to the client credentials endpoint, using basic authentication
+ +
+ protected
+ sendClientCredentialsTokenRequest(string $url, array<string|int, mixed> $body) : ResponseInterface
+
+
public
- getAuthURL([array<string|int, mixed>|null $params = null ]) : UriInterface
+ getAuthURL([array<string|int, mixed>|null $params = null ][, array<string|int, mixed>|null $scopes = null ]) : UriInterface
public
- __get(string $name) : string|null
+ final __get(string $name) : string|null
public
- getStorage() : OAuthStorageInterface
+ final getStorage() : OAuthStorageInterface
public
- sendRequest(RequestInterface $request) : ResponseInterface
+ final sendRequest(RequestInterface $request) : ResponseInterface
public
- setLogger(LoggerInterface $logger) : static
+ final setLogger(LoggerInterface $logger) : static
public
- setRequestFactory(RequestFactoryInterface $requestFactory) : static
+ final setRequestFactory(RequestFactoryInterface $requestFactory) : static
public
- setStorage(OAuthStorageInterface $storage) : static
+ final setStorage(OAuthStorageInterface $storage) : static
public
- setStreamFactory(StreamFactoryInterface $streamFactory) : static
+ final setStreamFactory(StreamFactoryInterface $streamFactory) : static
public
- setUriFactory(UriFactoryInterface $uriFactory) : static
+ final setUriFactory(UriFactoryInterface $uriFactory) : static
Throws if the given path is invalid or if the host of a given URL does not match $apiURL.
+Throws if the host of a given URL does not match the host of $apiURL.
returns a 32 byte random string (in hexadecimal representation) for use as a nonce
+ +
+ protected
+ nonce([int $bytes = 32 ]) : string
+
+