Documentation

OAuthOptionsTrait

The settings for the OAuth provider

$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)

The callback URL associated with your application


    protected
        string
    $callbackURL
     = ''

The application key (or id) given by your provider


    protected
        string
    $key
     = ''

The application secret given by your provider


    protected
        string
    $secret
     = ''

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

The session array key for <state> storage (OAuth2)


    protected
        string
    $sessionStateVar
     = 'chillerlan-oauth-state'

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

The session array key for token storage


    protected
        string
    $sessionTokenVar
     = 'chillerlan-oauth-token'

Whether to automatically refresh access tokens (OAuth2)


    protected
        bool
    $tokenAutoRefresh
     = true