OAuth2 Response

Implementation OAuth2 Response instance.

$response = new \Samy\OAuth2\Response();

Please see The Authorization Response for more information.


getTokenType

Retrieve provided token type.

$token_type = $response->getTokenType();

withTokenType

Return an instance with provided token type.

$response = $response->withTokenType($token_type);

getAccessToken

Retrieve provided access token.

$access_token = $response->getAccessToken();

withAccessToken

Return an instance with provided access token.

$response = $response->withAccessToken($access_token);

getRefreshToken

Retrieve provided refresh token.

$refresh_token = $response->getRefreshToken();

withRefreshToken

Return an instance with provided refresh token.

$response = $response->withRefreshToken($refresh_token);

getExpiresIn

Retrieve provided token duration.

$expires_in = $response->getExpiresIn();

withExpiresIn

Return an instance with provided token duration.

$response = $response->withExpiresIn($expires_in);

getScope

Retrieve provided scope.

$scope = $response->getScope();

withScope

Return an instance with provided scope.

$response = $response->withScope($scope);

getError

Retrieve provided error parameter.

$error = $response->getError();

withError

Return an instance with provided error parameter.

$response = $response->withError($error);

getErrorDescription

Retrieve provided error description.

$error_description = $response->getErrorDescription();

withErrorDescription

Return an instance with provided error description.

$response = $response->withErrorDescription($error_description);

getErrorUri

Retrieve provided error uri.

$error_uri = $response->getErrorUri();

withErrorUri

Return an instance with provided error uri.

$response = $response->withErrorUri($error_uri);

parse

Return an instance with parsed PSR-7 response interface.

$response = $response->parse($psr7_response_interface);