OAuthOptions
extends SettingsContainerAbstract
in package
Uses
OAuthOptionsTrait
This class holds all settings related to the OAuth provider as well as the default HTTP client.
Table of Contents
Properties
- $callbackURL : string
- The callback URL associated with your application
- $key : string
- The application key (or id) given by your provider
- $secret : string
- The application secret given by your provider
- $sessionStart : bool
- Whether to start the session when session storage is used
- $sessionStateVar : string
- The session array key for <state> storage (OAuth2)
- $sessionStop : bool
- Whether to end the session when session storage is used
- $sessionTokenVar : string
- The session array key for token storage
- $tokenAutoRefresh : bool
- Whether to automatically refresh access tokens (OAuth2)
Properties
$callbackURL
The callback URL associated with your application
protected
string
$callbackURL
= ''
$key
The application key (or id) given by your provider
protected
string
$key
= ''
$secret
The application secret given by your provider
protected
string
$secret
= ''
$sessionStart
Whether to start the session when session storage is used
protected
bool
$sessionStart
= true
Note: this will only start a session if there is no active session present
Tags
$sessionStateVar
The session array key for <state> storage (OAuth2)
protected
string
$sessionStateVar
= 'chillerlan-oauth-state'
Tags
$sessionStop
Whether to end the session when session storage is used
protected
bool
$sessionStop
= false
Note: this is set to false by default to not interfere with other session managers
Tags
$sessionTokenVar
The session array key for token storage
protected
string
$sessionTokenVar
= 'chillerlan-oauth-token'
Tags
$tokenAutoRefresh
Whether to automatically refresh access tokens (OAuth2)
protected
bool
$tokenAutoRefresh
= true