Samy\OAuth2 Namespace Reference

Classes
class	ClientRequest
interface	RequestInterface
class	Response
interface	ResponseInterface
class	ServerRequest

Functions
	getGrantType ()
	withGrantType (string $GrantType)
	getClientId ()
	withClientId (string $ClientId)
	getClientSecret ()
	withClientSecret (string $ClientSecret)
	getUsername ()
	withUsername (string $Username)
	getPassword ()
	withPassword (string $Password)
	getScope ()
	withScope (string $Scope)

Variables
trait	RequestTrait
	$client_id = ""
	$client_secret = ""
	$username = ""
	$password = ""
	$scope = ""

Function Documentation

getClientId()

Samy\OAuth2\getClientId

(

)

Retrieve provided client id.

Returns

string

getClientSecret()

Samy\OAuth2\getClientSecret

(

)

Retrieve provided client secret.

Returns

string

getGrantType()

Samy\OAuth2\getGrantType

(

)

Retrieve provided grant type.

Returns

string

getPassword()

Samy\OAuth2\getPassword

(

)

Retrieve provided password.

Returns

string

getScope()

Samy\OAuth2\getScope

(

)

Retrieve provided scope.

Returns

string

getUsername()

Samy\OAuth2\getUsername

(

)

Retrieve provided username.

Returns

string

withClientId()

Samy\OAuth2\withClientId

(

string

$ClientId

)

Return an instance with provided client id.

Parameters

[in]

string

$ClientId

Client id

Returns

static

withClientSecret()

Samy\OAuth2\withClientSecret

(

string

$ClientSecret

)

Return an instance with provided client secret.

Parameters

[in]

string

$ClientSecret

Client secret

Returns

static

withGrantType()

Samy\OAuth2\withGrantType

(

string

$GrantType

)

Retrieve provided grant type.

Parameters

[in]

string

$GrantType

Grant type

Returns

static

withPassword()

Samy\OAuth2\withPassword

(

string

$Password

)

Return an instance with provided password.

Parameters

[in]

string

$Password

Password

Returns

static

withScope()

Samy\OAuth2\withScope

(

string

$Scope

)

Return an instance with provided scope.

Parameters

[in]

string

$Scope

Scope

Returns

static

withUsername()

Samy\OAuth2\withUsername

(

string

$Username

)

Return an instance with provided username.

Parameters

[in]

string

$Username

Username

Returns

static

Variable Documentation

$client_id

Samy::OAuth2\$client_id = ""

protected

describe client id

$client_secret

Samy::OAuth2\$client_secret = ""

protected

describe client secret

$password

Samy::OAuth2\$password = ""

protected

describe password

$scope

Samy::OAuth2\$scope = ""

protected

describe scope

$username

Samy::OAuth2\$username = ""

protected

describe username

RequestTrait

trait Samy::OAuth2\RequestTrait

Initial value:

{
    
    protected $grant_type = ""

Describes OAuth2 Request reuse code.