Overview

Namespaces

  • Authoritarian
    • Exception
      • Flow
    • Flow
  • PHP

Classes

  • AbstractFlow
  • AuthorizationCodeFlow
  • ClientCredentialsFlow
  • ResourceOwnerPasswordFlow
  • Overview
  • Namespace
  • Class
  • Tree

Class AuthorizationCodeFlow

Implementation of Authorization Code Flow

Authoritarian\Flow\AbstractFlow
Extended by Authoritarian\Flow\AuthorizationCodeFlow
Namespace: Authoritarian\Flow
Located at Authoritarian/Flow/AuthorizationCodeFlow.php
Methods summary
public
# __construct( string $authorization_url = null )

Parameters

$authorization_url
string
$authorization_url OAuth 2's Authorization endpoint url
public
# setAuthorizationUrl( string $authorization_url )

Parameters

$authorization_url
string
$authorization_url OAuth 2's Authorization endpoint url
public
# setCode( string $code )

Parameters

$code
string
$code The authorization code retrieved in the callback page
public
# setRedirectUri( string $uri )

Parameters

$uri
string
$uri the callback URI to retrieve the authorization code
public
# setState( string $state )

Parameters

$state
string
$state The app's state to be resumed at the callback
public string
# getAuthUrl( )

Get the URL to user's authentication and authorization

Get the URL to user's authentication and authorization

Returns

string
public Guzzle\Http\Message\RequestInterface
# getRequest( )

Get the request to the Access Token

Get the request to the Access Token

Returns

Guzzle\Http\Message\RequestInterface

Throws

Authoritarian\Exception\Flow\MissingAuthorizationCodeException
When the authorization code wasn't set

Overrides

Authoritarian\Flow\AbstractFlow::getRequest()
Methods inherited from Authoritarian\Flow\AbstractFlow
removeNullItems(), setClientCredential(), setHttpClient(), setScope(), setTokenUrl()
Constants summary
string GRANT_TYPE 'authorization_code'
#
string RESPONSE_TYPE 'code'
#
Properties summary
protected mixed $authorizationUrl
#
protected mixed $code
#
protected mixed $redirectUri
#
protected mixed $state
#
protected mixed $parameters
#
Properties inherited from Authoritarian\Flow\AbstractFlow
$client, $clientId, $clientSecret, $scope, $tokenUrl
API documentation generated by ApiGen 2.8.0