1. class
  2. Bmatovu
  3. \
  4. OAuthNegotiator
  5. \
  6. OAuth2Middleware

OAuth2Middleware

class OAuth2Middleware (View source)

Class OAuth2Middleware.

Properties

protected GrantTypeInterface $grantType Primary grant type.
protected GrantTypeInterface $refreshTokenGrantType Refresh token (secondary) grant type.
protected TokenRepositoryInterface $tokenRepository Token repository.
protected TokenInterface $token Token model.

Methods

GrantTypeInterface
getGrantType()

Get main grant type.

setGrantType(GrantTypeInterface $grantType)

Set main grant type.

GrantTypeInterface
getRefreshTokenGrantType()

Get refresh token grant type.

setRefreshTokenGrantType(GrantTypeInterface $refreshTokenGrantType)

Set refresh token grant type.

setToken(TokenInterface $token)

Set token.

TokenInterface|null
getToken()

Get a valid access token.

setTokenRepository(TokenRepositoryInterface $tokenRepository)

Set token repository.

TokenRepositoryInterface
getTokenRepository()

Get token repository.

__construct(GrantTypeInterface $grantType, GrantTypeInterface $refreshTokenGrantType = null, TokenRepositoryInterface $tokenRepository = null)

Constructor.

Closure
__invoke(callable $handler)

Guzzle middleware invocation.

RequestInterface
signRequest(RequestInterface $request, TokenInterface $token)

Add auth headers.

TokenInterface
requestNewToken()

Acquire a new access token from the oauth2 server.

Details

at line 51
GrantTypeInterface getGrantType()

Get main grant type.

Return Value

GrantTypeInterface

at line 61
setGrantType(GrantTypeInterface $grantType)

Set main grant type.

Parameters

GrantTypeInterface $grantType

at line 71
GrantTypeInterface getRefreshTokenGrantType()

Get refresh token grant type.

Return Value

GrantTypeInterface

at line 81
setRefreshTokenGrantType(GrantTypeInterface $refreshTokenGrantType)

Set refresh token grant type.

Parameters

GrantTypeInterface $refreshTokenGrantType

at line 91
setToken(TokenInterface $token)

Set token.

Parameters

TokenInterface $token

at line 103
TokenInterface|null getToken()

Get a valid access token.

Return Value

TokenInterface|null

Exceptions

TokenRequestException

at line 125
setTokenRepository(TokenRepositoryInterface $tokenRepository)

Set token repository.

Parameters

TokenRepositoryInterface $tokenRepository

at line 135
TokenRepositoryInterface getTokenRepository()

Get token repository.

Return Value

TokenRepositoryInterface

at line 147
__construct(GrantTypeInterface $grantType, GrantTypeInterface $refreshTokenGrantType = null, TokenRepositoryInterface $tokenRepository = null)

Constructor.

Parameters

GrantTypeInterface $grantType
GrantTypeInterface $refreshTokenGrantType
TokenRepositoryInterface $tokenRepository

at line 161
Closure __invoke(callable $handler)

Guzzle middleware invocation.

Parameters

callable $handler

Return Value

Closure

at line 243
protected RequestInterface signRequest(RequestInterface $request, TokenInterface $token)

Add auth headers.

Parameters

RequestInterface $request
TokenInterface $token

Return Value

RequestInterface

at line 259
protected TokenInterface requestNewToken()

Acquire a new access token from the oauth2 server.

Return Value

TokenInterface

Exceptions

TokenRequestException