Overview

Namespaces

  • Authoritarian
    • Exception
      • Flow
    • Flow
  • PHP

Classes

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

Class AbstractFlow

Authorization Flow interface to generate Access Token Requests

Direct known subclasses

Authoritarian\Flow\AuthorizationCodeFlow, Authoritarian\Flow\ClientCredentialsFlow, Authoritarian\Flow\ResourceOwnerPasswordFlow
Abstract
Namespace: Authoritarian\Flow
Located at Authoritarian/Flow/AbstractFlow.php
Methods summary
public
# setHttpClient( Guzzle\Http\ClientInterface $client )

Parameters

$client
Guzzle\Http\ClientInterface
$client
public
# setTokenUrl( string $token_url )

Parameters

$token_url
string
$token_url The URL to request the Access Token
public
# setClientCredential( string $client_id, string $client_secret )

Parameters

$client_id
string
$client_id The app's client id
$client_secret
string
$client_secret The app's client secret
public
# setScope( string $scope )

Parameters

$scope
string
$scope The scope the app is requiring access
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\MissingTokenUrlException
When the OAuth token URL wasn't set
Authoritarian\Exception\Flow\MissingClientCredentialException
When the app's client credentials wasn't set
protected
# removeNullItems( array $parameters )
Properties summary
protected mixed $client
#
protected mixed $tokenUrl
#
protected mixed $clientId
#
protected mixed $clientSecret
#
protected mixed $scope
#
API documentation generated by ApiGen 2.8.0