Skip to content
This repository was archived by the owner on Mar 23, 2024. It is now read-only.

Commit 367fc5f

Browse files
committed
:octocat: +descriptions
1 parent dec63da commit 367fc5f

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

src/OAuthOptionsTrait.php

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,36 +15,56 @@
1515
trait OAuthOptionsTrait{
1616

1717
/**
18+
* The application key (or id) given by your provider
19+
*
1820
* @var string
1921
*/
2022
protected $key;
2123

2224
/**
25+
* The application secret given by your provider
26+
*
2327
* @var string
2428
*/
2529
protected $secret;
2630

2731
/**
32+
* The callback URL associated with your application
33+
*
2834
* @var string
2935
*/
3036
protected $callbackURL;
3137

3238
/**
39+
* Whether or not to start the session when session storage is used
40+
*
41+
* @see \chillerlan\OAuth\Storage\SessionStorage
42+
*
3343
* @var bool
3444
*/
3545
protected $sessionStart = true;
3646

3747
/**
48+
* The session array key for token storage
49+
*
50+
* @see \chillerlan\OAuth\Storage\SessionStorage
51+
*
3852
* @var string
3953
*/
4054
protected $sessionTokenVar = 'chillerlan-oauth-token';
4155

4256
/**
57+
* The session array key for <state> storage (OAuth2)
58+
*
59+
* @see \chillerlan\OAuth\Storage\SessionStorage
60+
*
4361
* @var string
4462
*/
4563
protected $sessionStateVar = 'chillerlan-oauth-state';
4664

4765
/**
66+
* Whether or not to automatically refresh access tokens (OAuth2)
67+
*
4868
* @var bool
4969
*/
5070
protected $tokenAutoRefresh = true;

0 commit comments

Comments
 (0)