OAuthOptions
extends SettingsContainerAbstract
in package
uses
OAuthOptionsTrait
This class holds all settings related to the OAuth provider
Table of Contents
Properties
- $callbackURL : string
- The (main) callback URL associated with your application
- $fileStoragePath : string
- The file storage root path (requires permissions 0777)
- $key : string
- The application key (or client-id) given by your provider
- $pkceVerifierLength : int
- The length of the PKCE challenge verifier (43-128 characters)
- $secret : string
- The application secret given by your provider
- $sessionStart : bool
- Whether to start the session when session storage is used
- $sessionStop : bool
- Whether to end the session when session storage is used
- $sessionStorageVar : string
- The session key for the storage array
- $storageEncryptionKey : string
- The encryption key (hexadecimal) to use
- $tokenAutoRefresh : bool
- Whether to automatically refresh access tokens (OAuth2)
- $useStorageEncryption : bool
- Whether to use encryption for the file storage
Methods
- set_fileStoragePath() : void
- sets and verifies the file storage path
- set_pkceVerifierLength() : void
- clamps the PKCE verifier length between 43 and 128
- set_storageEncryptionKey() : void
- sets an encryption key
Properties
$callbackURL
The (main) callback URL associated with your application
protected
string
$callbackURL
= ''
$fileStoragePath
The file storage root path (requires permissions 0777)
protected
string
$fileStoragePath
= ''
Tags
$key
The application key (or client-id) given by your provider
protected
string
$key
= ''
$pkceVerifierLength
The length of the PKCE challenge verifier (43-128 characters)
protected
int
$pkceVerifierLength
= 128
Tags
$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
$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
$sessionStorageVar
The session key for the storage array
protected
string
$sessionStorageVar
= 'chillerlan-oauth-storage'
Tags
$storageEncryptionKey
The encryption key (hexadecimal) to use
protected
string
$storageEncryptionKey
= ''
Tags
$tokenAutoRefresh
Whether to automatically refresh access tokens (OAuth2)
protected
bool
$tokenAutoRefresh
= true
Tags
$useStorageEncryption
Whether to use encryption for the file storage
protected
bool
$useStorageEncryption
= false
Tags
Methods
set_fileStoragePath()
sets and verifies the file storage path
protected
set_fileStoragePath(string $fileStoragePath) : void
Parameters
- $fileStoragePath : string
set_pkceVerifierLength()
clamps the PKCE verifier length between 43 and 128
protected
set_pkceVerifierLength(int $pkceVerifierLength) : void
Parameters
- $pkceVerifierLength : int
set_storageEncryptionKey()
sets an encryption key
protected
set_storageEncryptionKey(string $storageEncryptionKey) : void
Parameters
- $storageEncryptionKey : string