diff --git a/classes/chillerlan-OAuth-Core-AccessToken.html b/classes/chillerlan-OAuth-Core-AccessToken.html index 82632c36..1ddbd5d2 100644 --- a/classes/chillerlan-OAuth-Core-AccessToken.html +++ b/classes/chillerlan-OAuth-Core-AccessToken.html @@ -143,16 +143,39 @@

Access token implementation for any OAuth version.

-

// Oauth1

-
+

+ Tags + + +
+
+
+ see +
+
+ https://datatracker.ietf.org/doc/html/rfc5849#section-2.3 + + +
+
+ see +
+
+ https://datatracker.ietf.org/doc/html/rfc6749#section-1.4 + +

// Oauth1

+
+ +
+
@@ -186,7 +209,7 @@

 = -9001 -
Denotes an unknown end of lifetime.
+
Denotes an unknown end of lifetime, such a token should be considered as expired.
EXPIRY_MAX @@ -207,13 +230,13 @@

$accessToken -  : string +  : string|null
$accessTokenSecret -  : string +  : string|null
@@ -237,7 +260,7 @@

$refreshToken -  : string +  : string|null
@@ -303,13 +326,6 @@

-
- __construct() - -  : mixed -
-
AccessToken constructor.
-
isExpired() @@ -353,7 +369,7 @@

@@ -382,11 +398,11 @@

-

Denotes an unknown end of lifetime.

+

Denotes an unknown end of lifetime, such a token should be considered as expired.

public @@ -411,7 +427,7 @@

@@ -463,7 +479,7 @@

public - string + string|null $accessToken @@ -496,7 +512,7 @@

public - string + string|null $accessTokenSecret @@ -630,11 +646,13 @@

public - string + string|null $refreshToken - +

// common

+
+ @@ -667,9 +685,7 @@

$scopes -

// Oauth1/2

-
- + @@ -691,7 +707,7 @@

@@ -725,7 +741,7 @@

@@ -759,7 +775,7 @@

@@ -809,7 +825,7 @@

@@ -843,7 +859,7 @@

@@ -877,7 +893,7 @@

@@ -911,7 +927,7 @@

@@ -941,48 +957,6 @@

-method -public " -> -

- __construct() - - -

- - -

AccessToken constructor.

- - - public - __construct([iterable<string|int, mixed>|null $properties = null ]) : mixed - -
-
- -

Parameters
-
-
- $properties - : iterable<string|int, mixed>|null - = null
-
- -
-
- - - - - -
-
- Tags - - -
-
-
- phan-suppress -
-
- -

PhanPossiblyNullTypeMismatchProperty

-
- -
-
Return values
@@ -1090,7 +1048,7 @@

@@ -1260,7 +1218,6 @@

Parameters
  • Methods
  • -
    the name of the provider (class) (magic)
    +
    the name of the provider/class (magic)
    $storage @@ -334,7 +336,7 @@

    __get() -  : mixed|null +  : string|null
    Magic getter for the properties specified in self::ALLOWED_PROPERTIES
    @@ -533,14 +535,14 @@

    protected - mixed + array<string|int, string> ALLOWED_PROPERTIES = ['apiDocs', 'apiURL', 'applicationURL', 'serviceName', 'userRevokeURL'] @@ -611,7 +613,7 @@

    @@ -679,7 +681,7 @@

    @@ -713,7 +715,7 @@

    @@ -815,7 +817,7 @@

    @@ -848,7 +850,7 @@

    @@ -881,7 +883,7 @@

    @@ -914,7 +916,7 @@

    @@ -1030,11 +1032,11 @@

    -

    the name of the provider (class) (magic)

    +

    the name of the provider/class (magic)

    protected @@ -1064,7 +1066,7 @@

    @@ -1097,7 +1099,7 @@

    @@ -1130,7 +1132,7 @@

    @@ -1163,7 +1165,7 @@

    @@ -1202,7 +1204,7 @@

    @@ -1286,7 +1288,7 @@

    @@ -1294,7 +1296,7 @@

    public - __get(string $name) : mixed|null + __get(string $name) : string|null
    @@ -1314,7 +1316,7 @@

    Parameters
    Return values
    - mixed|null + string|null
    @@ -1332,7 +1334,7 @@

    @@ -1458,7 +1460,7 @@

    @@ -1574,7 +1576,7 @@

    @@ -1631,7 +1633,7 @@

    @@ -1707,7 +1709,7 @@

    @@ -1764,7 +1766,7 @@

    @@ -1860,7 +1862,7 @@

    @@ -1919,7 +1921,7 @@

    @@ -1986,7 +1988,7 @@

    @@ -2053,7 +2055,7 @@

    @@ -2120,7 +2122,7 @@

    @@ -2187,7 +2189,7 @@

    @@ -2254,7 +2256,7 @@

    @@ -2321,7 +2323,7 @@

    @@ -2367,7 +2369,7 @@

    @@ -2413,7 +2415,7 @@

    @@ -2449,7 +2451,7 @@

    @@ -2517,7 +2519,7 @@

    @@ -2563,7 +2565,7 @@

    @@ -2635,7 +2637,7 @@

    @@ -2688,7 +2690,7 @@

    @@ -2741,11 +2743,12 @@

    - link + see
    - https://tools.ietf.org/html/rfc5849#section-3.4 - + https://datatracker.ietf.org/doc/html/rfc5849#section-3.4 + +
    throws @@ -2777,7 +2780,7 @@

    @@ -2792,6 +2795,21 @@

    +

    + Tags + + +
    +
    +
    + see +
    +
    + https://datatracker.ietf.org/doc/html/rfc5849#section-3.3 + + +
    +
    Return values
    @@ -2813,7 +2831,7 @@

    @@ -2852,11 +2870,20 @@

    - link + see
    - https://tools.ietf.org/html/rfc5849#section-2.1 - + https://datatracker.ietf.org/doc/html/rfc5849#section-2.1 + + +
    +
    + see +
    +
    + https://datatracker.ietf.org/doc/html/rfc5849#section-2.3 + +
    throws diff --git a/classes/chillerlan-OAuth-Core-OAuth2Interface.html b/classes/chillerlan-OAuth-Core-OAuth2Interface.html index 8b014dc3..75cc98da 100644 --- a/classes/chillerlan-OAuth-Core-OAuth2Interface.html +++ b/classes/chillerlan-OAuth-Core-OAuth2Interface.html @@ -353,7 +353,7 @@

    @@ -393,6 +393,22 @@

    + see +
    +
    + https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.1 + + +
    +
    + see +
    +
    + https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.3 + + +
    +
    throws
    @@ -422,7 +438,7 @@

    @@ -455,6 +471,21 @@

    Parameters
    +
    + Tags + + +
    +
    +
    + see +
    +
    + https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.1 + + +
    +
    Return values
    @@ -476,7 +507,7 @@

    @@ -512,7 +543,7 @@

    @@ -565,7 +596,7 @@

    @@ -655,7 +686,7 @@

    @@ -701,7 +732,7 @@

    @@ -747,7 +778,7 @@

    @@ -793,7 +824,7 @@

    @@ -839,7 +870,7 @@

    @@ -885,7 +916,7 @@

    diff --git a/classes/chillerlan-OAuth-Core-OAuth2Provider.html b/classes/chillerlan-OAuth-Core-OAuth2Provider.html index c10c99b8..9bcea0f9 100644 --- a/classes/chillerlan-OAuth-Core-OAuth2Provider.html +++ b/classes/chillerlan-OAuth-Core-OAuth2Provider.html @@ -146,7 +146,7 @@

    @@ -156,6 +156,21 @@

    +
    + Tags + + +
    +
    +
    + see +
    +
    + https://datatracker.ietf.org/doc/html/rfc6749 + + +
    +
    @@ -335,7 +350,7 @@

     : string

    -
    the name of the provider (class) (magic)
    +
    the name of the provider/class (magic)
    $storage @@ -380,7 +395,7 @@

    __get() -  : mixed|null +  : string|null
    Magic getter for the properties specified in self::ALLOWED_PROPERTIES
    @@ -573,14 +588,14 @@

    protected - mixed + array<string|int, string> ALLOWED_PROPERTIES = ['apiDocs', 'apiURL', 'applicationURL', 'serviceName', 'userRevokeURL'] @@ -651,7 +666,7 @@

    @@ -719,7 +734,7 @@

    @@ -753,7 +768,7 @@

    @@ -821,7 +836,7 @@

    @@ -857,7 +872,7 @@

    @@ -891,7 +906,7 @@

    @@ -959,7 +974,7 @@

    @@ -995,7 +1010,7 @@

    @@ -1029,7 +1044,7 @@

    @@ -1062,7 +1077,7 @@

    @@ -1095,7 +1110,7 @@

    @@ -1128,7 +1143,7 @@

    @@ -1179,7 +1194,7 @@

    @@ -1261,7 +1276,7 @@

    @@ -1295,11 +1310,11 @@

    -

    the name of the provider (class) (magic)

    +

    the name of the provider/class (magic)

    protected @@ -1329,7 +1344,7 @@

    @@ -1362,7 +1377,7 @@

    @@ -1395,7 +1410,7 @@

    @@ -1428,7 +1443,7 @@

    @@ -1467,7 +1482,7 @@

    @@ -1551,7 +1566,7 @@

    @@ -1559,7 +1574,7 @@

    public - __get(string $name) : mixed|null + __get(string $name) : string|null
    @@ -1579,7 +1594,7 @@

    Parameters
    Return values
    - mixed|null + string|null
    @@ -1597,7 +1612,7 @@

    @@ -1665,7 +1680,7 @@

    @@ -1733,7 +1748,7 @@

    @@ -1802,7 +1817,7 @@

    @@ -1868,7 +1883,7 @@

    @@ -1925,7 +1940,7 @@

    @@ -2001,7 +2016,7 @@

    @@ -2058,7 +2073,7 @@

    @@ -2127,7 +2142,7 @@

    @@ -2223,7 +2238,7 @@

    @@ -2282,7 +2297,7 @@

    @@ -2349,7 +2364,7 @@

    @@ -2416,7 +2431,7 @@

    @@ -2483,7 +2498,7 @@

    @@ -2550,7 +2565,7 @@

    @@ -2617,7 +2632,7 @@

    @@ -2684,7 +2699,7 @@

    @@ -2730,7 +2745,7 @@

    @@ -2776,7 +2791,7 @@

    @@ -2812,7 +2827,7 @@

    @@ -2880,7 +2895,7 @@

    @@ -2926,7 +2941,7 @@

    @@ -2998,7 +3013,7 @@

    @@ -3051,7 +3066,7 @@

    @@ -3083,11 +3098,12 @@

    - link + see
    - https://tools.ietf.org/html/rfc6749#section-4.1.4 - + https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.4 + +
    throws diff --git a/classes/chillerlan-OAuth-Core-OAuthInterface.html b/classes/chillerlan-OAuth-Core-OAuthInterface.html index 585ebc61..6402ae3f 100644 --- a/classes/chillerlan-OAuth-Core-OAuthInterface.html +++ b/classes/chillerlan-OAuth-Core-OAuthInterface.html @@ -263,7 +263,7 @@

    @@ -289,6 +289,21 @@

    Parameters
    +
    + Tags + + +
    +
    +
    + see +
    +
    + https://datatracker.ietf.org/doc/html/rfc5849#section-2.2 + + +
    +
    Return values
    @@ -310,7 +325,7 @@

    @@ -346,7 +361,7 @@

    @@ -399,7 +414,7 @@

    @@ -489,7 +504,7 @@

    @@ -535,7 +550,7 @@

    @@ -581,7 +596,7 @@

    @@ -627,7 +642,7 @@

    @@ -673,7 +688,7 @@

    @@ -719,7 +734,7 @@

    diff --git a/classes/chillerlan-OAuth-Core-OAuthProvider.html b/classes/chillerlan-OAuth-Core-OAuthProvider.html index 82698c4d..72fa844b 100644 --- a/classes/chillerlan-OAuth-Core-OAuthProvider.html +++ b/classes/chillerlan-OAuth-Core-OAuthProvider.html @@ -281,7 +281,7 @@

     : string

    -
    the name of the provider (class) (magic)
    +
    the name of the provider/class (magic)
    $storage @@ -326,7 +326,7 @@

    __get() -  : mixed|null +  : string|null
    Magic getter for the properties specified in self::ALLOWED_PROPERTIES
    @@ -478,14 +478,14 @@

    protected - mixed + array<string|int, string> ALLOWED_PROPERTIES = ['apiDocs', 'apiURL', 'applicationURL', 'serviceName', 'userRevokeURL'] @@ -556,7 +556,7 @@

    @@ -624,7 +624,7 @@

    @@ -658,7 +658,7 @@

    @@ -760,7 +760,7 @@

    @@ -793,7 +793,7 @@

    @@ -826,7 +826,7 @@

    @@ -859,7 +859,7 @@

    @@ -941,11 +941,11 @@

    -

    the name of the provider (class) (magic)

    +

    the name of the provider/class (magic)

    protected @@ -975,7 +975,7 @@

    @@ -1008,7 +1008,7 @@

    @@ -1041,7 +1041,7 @@

    @@ -1074,7 +1074,7 @@

    @@ -1113,7 +1113,7 @@

    @@ -1197,7 +1197,7 @@

    @@ -1205,7 +1205,7 @@

    public - __get(string $name) : mixed|null + __get(string $name) : string|null
    @@ -1225,7 +1225,7 @@

    Parameters
    Return values
    - mixed|null + string|null
    @@ -1243,7 +1243,7 @@

    @@ -1300,7 +1300,7 @@

    @@ -1376,7 +1376,7 @@

    @@ -1433,7 +1433,7 @@

    @@ -1529,7 +1529,7 @@

    @@ -1588,7 +1588,7 @@

    @@ -1655,7 +1655,7 @@

    @@ -1722,7 +1722,7 @@

    @@ -1789,7 +1789,7 @@

    @@ -1856,7 +1856,7 @@

    @@ -1923,7 +1923,7 @@

    @@ -1990,7 +1990,7 @@

    @@ -2036,7 +2036,7 @@

    @@ -2082,7 +2082,7 @@

    @@ -2118,7 +2118,7 @@

    @@ -2186,7 +2186,7 @@

    @@ -2232,7 +2232,7 @@

    @@ -2304,7 +2304,7 @@

    diff --git a/classes/chillerlan-OAuth-Core-TokenRefresh.html b/classes/chillerlan-OAuth-Core-TokenRefresh.html index dee337ba..2ddd31ba 100644 --- a/classes/chillerlan-OAuth-Core-TokenRefresh.html +++ b/classes/chillerlan-OAuth-Core-TokenRefresh.html @@ -144,11 +144,12 @@

    - link + see
    - https://tools.ietf.org/html/rfc6749#section-10.4 - + https://datatracker.ietf.org/doc/html/rfc6749#section-10.4 + +
    diff --git a/classes/chillerlan-OAuth-Storage-MemoryStorage.html b/classes/chillerlan-OAuth-Storage-MemoryStorage.html index b6bf0966..eb73a93e 100644 --- a/classes/chillerlan-OAuth-Storage-MemoryStorage.html +++ b/classes/chillerlan-OAuth-Storage-MemoryStorage.html @@ -141,12 +141,14 @@

    -

    Implements a memory storage adapter. Memory storage is not persistent as tokens are only stored during script runtime.

    +

    Implements a memory storage adapter.

    +

    Note: the memory storage is not persistent, as tokens are only stored during script runtime.

    +
    @@ -446,7 +448,7 @@

    @@ -480,7 +482,7 @@

    @@ -568,7 +570,7 @@

    @@ -627,7 +629,7 @@

    @@ -676,7 +678,7 @@

    @@ -725,7 +727,7 @@

    @@ -845,7 +847,7 @@

    @@ -904,7 +906,7 @@

    @@ -1023,7 +1025,7 @@

    @@ -1082,7 +1084,7 @@

    @@ -1268,7 +1270,7 @@

    @@ -1334,7 +1336,7 @@

    diff --git a/classes/chillerlan-OAuth-Storage-OAuthStorageAbstract.html b/classes/chillerlan-OAuth-Storage-OAuthStorageAbstract.html index 48d3f90b..75d5a33e 100644 --- a/classes/chillerlan-OAuth-Storage-OAuthStorageAbstract.html +++ b/classes/chillerlan-OAuth-Storage-OAuthStorageAbstract.html @@ -168,7 +168,7 @@

    -
    OAuthStorageInterface
    Specifies the methods required for an OAuth storage adapter
    +
    OAuthStorageInterface
    Specifies the methods required for an OAuth token storage adapter
    diff --git a/classes/chillerlan-OAuth-Storage-OAuthStorageInterface.html b/classes/chillerlan-OAuth-Storage-OAuthStorageInterface.html index fa569228..888c12eb 100644 --- a/classes/chillerlan-OAuth-Storage-OAuthStorageInterface.html +++ b/classes/chillerlan-OAuth-Storage-OAuthStorageInterface.html @@ -129,12 +129,16 @@

    -

    Specifies the methods required for an OAuth storage adapter

    +

    Specifies the methods required for an OAuth token storage adapter

    +

    The token storage is intended to be invoked per-user, +for whom it can store tokens for any of the implemented providers.

    +

    The implementer must ensure that the same storage instance is not used for multiple users.

    +
    @@ -295,7 +299,7 @@

    @@ -356,7 +360,7 @@

    @@ -407,7 +411,7 @@

    @@ -458,7 +462,7 @@

    @@ -519,7 +523,7 @@

    @@ -581,7 +585,7 @@

    @@ -642,7 +646,7 @@

    @@ -703,7 +707,7 @@

    @@ -764,7 +768,7 @@

    @@ -810,7 +814,7 @@

    @@ -856,7 +860,7 @@

    @@ -902,7 +906,7 @@

    @@ -963,7 +967,7 @@

    @@ -1031,7 +1035,7 @@

    @@ -1099,7 +1103,7 @@

    diff --git a/classes/chillerlan-OAuth-Storage-SessionStorage.html b/classes/chillerlan-OAuth-Storage-SessionStorage.html index 9db63edb..f908f716 100644 --- a/classes/chillerlan-OAuth-Storage-SessionStorage.html +++ b/classes/chillerlan-OAuth-Storage-SessionStorage.html @@ -141,12 +141,14 @@

    -

    Implements a session storage adapter. Session storage is half persistent as tokens are stored for the duration of the session.

    +

    Implements a session storage adapter.

    +

    Note: the session storage is only half persistent, as tokens are stored for the duration of the session.

    +
    @@ -453,7 +455,7 @@

    @@ -487,7 +489,7 @@

    @@ -526,7 +528,7 @@

    @@ -575,7 +577,7 @@

    @@ -621,7 +623,7 @@

    @@ -680,7 +682,7 @@

    @@ -729,7 +731,7 @@

    @@ -778,7 +780,7 @@

    @@ -898,7 +900,7 @@

    @@ -957,7 +959,7 @@

    @@ -1076,7 +1078,7 @@

    @@ -1135,7 +1137,7 @@

    @@ -1321,7 +1323,7 @@

    @@ -1387,7 +1389,7 @@

    diff --git a/classes/chillerlan-OAuthTest-OAuthTestMemoryStorage.html b/classes/chillerlan-OAuthTest-OAuthTestMemoryStorage.html index 82194610..f2ab61a9 100644 --- a/classes/chillerlan-OAuthTest-OAuthTestMemoryStorage.html +++ b/classes/chillerlan-OAuthTest-OAuthTestMemoryStorage.html @@ -452,7 +452,7 @@

    @@ -519,7 +519,7 @@

    @@ -606,7 +606,7 @@

    @@ -665,7 +665,7 @@

    @@ -714,7 +714,7 @@

    @@ -763,7 +763,7 @@

    @@ -942,7 +942,7 @@

    @@ -1061,7 +1061,7 @@

    @@ -1120,7 +1120,7 @@

    @@ -1372,7 +1372,7 @@

    diff --git a/classes/chillerlan-OAuthTest-Providers-OAuth1-DummyOAuth1Provider.html b/classes/chillerlan-OAuthTest-Providers-OAuth1-DummyOAuth1Provider.html index 9e4533cf..a4586ebf 100644 --- a/classes/chillerlan-OAuthTest-Providers-OAuth1-DummyOAuth1Provider.html +++ b/classes/chillerlan-OAuthTest-Providers-OAuth1-DummyOAuth1Provider.html @@ -284,7 +284,7 @@

     : string

    -
    the name of the provider (class) (magic)
    +
    the name of the provider/class (magic)
    $storage @@ -328,7 +328,7 @@

    __get() -  : mixed|null +  : string|null
    Magic getter for the properties specified in self::ALLOWED_PROPERTIES
    @@ -528,14 +528,14 @@

    protected - mixed + array<string|int, string> ALLOWED_PROPERTIES = ['apiDocs', 'apiURL', 'applicationURL', 'serviceName', 'userRevokeURL'] @@ -605,7 +605,7 @@

    @@ -705,7 +705,7 @@

    @@ -805,7 +805,7 @@

    @@ -838,7 +838,7 @@

    @@ -871,7 +871,7 @@

    @@ -904,7 +904,7 @@

    @@ -1004,11 +1004,11 @@

    -

    the name of the provider (class) (magic)

    +

    the name of the provider/class (magic)

    protected @@ -1038,7 +1038,7 @@

    @@ -1071,7 +1071,7 @@

    @@ -1104,7 +1104,7 @@

    @@ -1175,7 +1175,7 @@

    @@ -1259,7 +1259,7 @@

    @@ -1267,7 +1267,7 @@

    public - __get(string $name) : mixed|null + __get(string $name) : string|null
    @@ -1287,7 +1287,7 @@

    Parameters
    Return values
    - mixed|null + string|null
    @@ -1305,7 +1305,7 @@

    @@ -1431,7 +1431,7 @@

    @@ -1547,7 +1547,7 @@

    @@ -1664,7 +1664,7 @@

    @@ -1721,7 +1721,7 @@

    @@ -1817,7 +1817,7 @@

    @@ -1876,7 +1876,7 @@

    @@ -1943,7 +1943,7 @@

    @@ -2010,7 +2010,7 @@

    @@ -2077,7 +2077,7 @@

    @@ -2144,7 +2144,7 @@

    @@ -2211,7 +2211,7 @@

    @@ -2278,7 +2278,7 @@

    @@ -2324,7 +2324,7 @@

    @@ -2370,7 +2370,7 @@

    @@ -2406,7 +2406,7 @@

    @@ -2474,7 +2474,7 @@

    @@ -2520,7 +2520,7 @@

    @@ -2592,7 +2592,7 @@

    @@ -2645,7 +2645,7 @@

    @@ -2698,11 +2698,12 @@

    - link + see
    - https://tools.ietf.org/html/rfc5849#section-3.4 - + https://datatracker.ietf.org/doc/html/rfc5849#section-3.4 + +
    throws @@ -2734,7 +2735,7 @@

    @@ -2749,6 +2750,21 @@

    +

    + Tags + + +
    +
    +
    + see +
    +
    + https://datatracker.ietf.org/doc/html/rfc5849#section-3.3 + + +
    +
    Return values
    @@ -2770,7 +2786,7 @@

    @@ -2809,11 +2825,20 @@

    - link + see +
    +
    + https://datatracker.ietf.org/doc/html/rfc5849#section-2.1 + + +
    +
    + see
    - https://tools.ietf.org/html/rfc5849#section-2.1 - + https://datatracker.ietf.org/doc/html/rfc5849#section-2.3 + +
    throws diff --git a/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2BasicProvider.html b/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2BasicProvider.html index 5d9d202d..9f15d470 100644 --- a/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2BasicProvider.html +++ b/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2BasicProvider.html @@ -321,7 +321,7 @@

     : string

    -
    the name of the provider (class) (magic)
    +
    the name of the provider/class (magic)
    $storage @@ -365,7 +365,7 @@

    __get() -  : mixed|null +  : string|null
    Magic getter for the properties specified in self::ALLOWED_PROPERTIES
    @@ -558,14 +558,14 @@

    protected - mixed + array<string|int, string> ALLOWED_PROPERTIES = ['apiDocs', 'apiURL', 'applicationURL', 'serviceName', 'userRevokeURL'] @@ -635,7 +635,7 @@

    @@ -736,7 +736,7 @@

    @@ -804,7 +804,7 @@

    @@ -840,7 +840,7 @@

    @@ -874,7 +874,7 @@

    @@ -941,7 +941,7 @@

    @@ -977,7 +977,7 @@

    @@ -1011,7 +1011,7 @@

    @@ -1044,7 +1044,7 @@

    @@ -1077,7 +1077,7 @@

    @@ -1110,7 +1110,7 @@

    @@ -1161,7 +1161,7 @@

    @@ -1243,7 +1243,7 @@

    @@ -1277,11 +1277,11 @@

    -

    the name of the provider (class) (magic)

    +

    the name of the provider/class (magic)

    protected @@ -1311,7 +1311,7 @@

    @@ -1344,7 +1344,7 @@

    @@ -1377,7 +1377,7 @@

    @@ -1448,7 +1448,7 @@

    @@ -1532,7 +1532,7 @@

    @@ -1540,7 +1540,7 @@

    public - __get(string $name) : mixed|null + __get(string $name) : string|null
    @@ -1560,7 +1560,7 @@

    Parameters
    Return values
    - mixed|null + string|null
    @@ -1578,7 +1578,7 @@

    @@ -1646,7 +1646,7 @@

    @@ -1714,7 +1714,7 @@

    @@ -1783,7 +1783,7 @@

    @@ -1849,7 +1849,7 @@

    @@ -1906,7 +1906,7 @@

    @@ -1982,7 +1982,7 @@

    @@ -2039,7 +2039,7 @@

    @@ -2108,7 +2108,7 @@

    @@ -2204,7 +2204,7 @@

    @@ -2263,7 +2263,7 @@

    @@ -2330,7 +2330,7 @@

    @@ -2397,7 +2397,7 @@

    @@ -2464,7 +2464,7 @@

    @@ -2531,7 +2531,7 @@

    @@ -2598,7 +2598,7 @@

    @@ -2665,7 +2665,7 @@

    @@ -2711,7 +2711,7 @@

    @@ -2757,7 +2757,7 @@

    @@ -2793,7 +2793,7 @@

    @@ -2861,7 +2861,7 @@

    @@ -2907,7 +2907,7 @@

    @@ -2979,7 +2979,7 @@

    @@ -3032,7 +3032,7 @@

    @@ -3064,11 +3064,12 @@

    - link + see
    - https://tools.ietf.org/html/rfc6749#section-4.1.4 - + https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.4 + +
    throws diff --git a/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2Provider.html b/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2Provider.html index 58869fc1..b6a66260 100644 --- a/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2Provider.html +++ b/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2Provider.html @@ -328,7 +328,7 @@

     : string

    -
    the name of the provider (class) (magic)
    +
    the name of the provider/class (magic)
    $storage @@ -372,7 +372,7 @@

    __get() -  : mixed|null +  : string|null
    Magic getter for the properties specified in self::ALLOWED_PROPERTIES
    @@ -566,14 +566,14 @@

    protected - mixed + array<string|int, string> ALLOWED_PROPERTIES = ['apiDocs', 'apiURL', 'applicationURL', 'serviceName', 'userRevokeURL'] @@ -643,7 +643,7 @@

    @@ -743,7 +743,7 @@

    @@ -846,7 +846,7 @@

    @@ -880,7 +880,7 @@

    @@ -947,7 +947,7 @@

    @@ -983,7 +983,7 @@

    @@ -1017,7 +1017,7 @@

    @@ -1050,7 +1050,7 @@

    @@ -1083,7 +1083,7 @@

    @@ -1116,7 +1116,7 @@

    @@ -1167,7 +1167,7 @@

    @@ -1233,7 +1233,7 @@

    @@ -1267,11 +1267,11 @@

    -

    the name of the provider (class) (magic)

    +

    the name of the provider/class (magic)

    protected @@ -1301,7 +1301,7 @@

    @@ -1334,7 +1334,7 @@

    @@ -1367,7 +1367,7 @@

    @@ -1438,7 +1438,7 @@

    @@ -1522,7 +1522,7 @@

    @@ -1530,7 +1530,7 @@

    public - __get(string $name) : mixed|null + __get(string $name) : string|null
    @@ -1550,7 +1550,7 @@

    Parameters
    Return values
    - mixed|null + string|null
    @@ -1568,7 +1568,7 @@

    @@ -1636,7 +1636,7 @@

    @@ -1704,7 +1704,7 @@

    @@ -1773,7 +1773,7 @@

    @@ -1839,7 +1839,7 @@

    @@ -1956,7 +1956,7 @@

    @@ -2013,7 +2013,7 @@

    @@ -2082,7 +2082,7 @@

    @@ -2178,7 +2178,7 @@

    @@ -2237,7 +2237,7 @@

    @@ -2304,7 +2304,7 @@

    @@ -2371,7 +2371,7 @@

    @@ -2438,7 +2438,7 @@

    @@ -2505,7 +2505,7 @@

    @@ -2572,7 +2572,7 @@

    @@ -2639,7 +2639,7 @@

    @@ -2685,7 +2685,7 @@

    @@ -2731,7 +2731,7 @@

    @@ -2767,7 +2767,7 @@

    @@ -2835,7 +2835,7 @@

    @@ -2881,7 +2881,7 @@

    @@ -2953,7 +2953,7 @@

    @@ -3006,7 +3006,7 @@

    @@ -3038,11 +3038,12 @@

    - link + see
    - https://tools.ietf.org/html/rfc6749#section-4.1.4 - + https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.4 + +
    throws diff --git a/classes/chillerlan-OAuthTest-Providers-RequestTest-RequestTestProvider.html b/classes/chillerlan-OAuthTest-Providers-RequestTest-RequestTestProvider.html index 9dc472a2..231c4c1c 100644 --- a/classes/chillerlan-OAuthTest-Providers-RequestTest-RequestTestProvider.html +++ b/classes/chillerlan-OAuthTest-Providers-RequestTest-RequestTestProvider.html @@ -275,7 +275,7 @@

     : string

    -
    the name of the provider (class) (magic)
    +
    the name of the provider/class (magic)
    $storage @@ -320,7 +320,7 @@

    __get() -  : mixed|null +  : string|null
    Magic getter for the properties specified in self::ALLOWED_PROPERTIES
    @@ -484,14 +484,14 @@

    protected - mixed + array<string|int, string> ALLOWED_PROPERTIES = ['apiDocs', 'apiURL', 'applicationURL', 'serviceName', 'userRevokeURL'] @@ -562,7 +562,7 @@

    @@ -664,7 +664,7 @@

    @@ -766,7 +766,7 @@

    @@ -799,7 +799,7 @@

    @@ -832,7 +832,7 @@

    @@ -865,7 +865,7 @@

    @@ -947,11 +947,11 @@

    -

    the name of the provider (class) (magic)

    +

    the name of the provider/class (magic)

    protected @@ -981,7 +981,7 @@

    @@ -1014,7 +1014,7 @@

    @@ -1047,7 +1047,7 @@

    @@ -1080,7 +1080,7 @@

    @@ -1119,7 +1119,7 @@

    @@ -1203,7 +1203,7 @@

    @@ -1211,7 +1211,7 @@

    public - __get(string $name) : mixed|null + __get(string $name) : string|null
    @@ -1231,7 +1231,7 @@

    Parameters
    Return values
    - mixed|null + string|null
    @@ -1361,7 +1361,7 @@

    @@ -1418,7 +1418,7 @@

    @@ -1494,7 +1494,7 @@

    @@ -1551,7 +1551,7 @@

    @@ -1647,7 +1647,7 @@

    @@ -1706,7 +1706,7 @@

    @@ -1773,7 +1773,7 @@

    @@ -1840,7 +1840,7 @@

    @@ -1907,7 +1907,7 @@

    @@ -1974,7 +1974,7 @@

    @@ -2041,7 +2041,7 @@

    @@ -2108,7 +2108,7 @@

    @@ -2154,7 +2154,7 @@

    @@ -2200,7 +2200,7 @@

    @@ -2236,7 +2236,7 @@

    @@ -2304,7 +2304,7 @@

    @@ -2350,7 +2350,7 @@

    @@ -2422,7 +2422,7 @@

    diff --git a/files/src-core-oauth1provider.html b/files/src-core-oauth1provider.html index aa4cb7ef..e3bca552 100644 --- a/files/src-core-oauth1provider.html +++ b/files/src-core-oauth1provider.html @@ -126,13 +126,6 @@

    - link -
    -
    - https://tools.ietf.org/html/rfc5849 - -
    -
    created
    diff --git a/files/src-core-oauth2provider.html b/files/src-core-oauth2provider.html index 20e3e481..7bc466cd 100644 --- a/files/src-core-oauth2provider.html +++ b/files/src-core-oauth2provider.html @@ -126,13 +126,6 @@
    - link -
    -
    - https://tools.ietf.org/html/rfc6749 - -
    -
    created
    @@ -167,15 +160,6 @@

    MIT

    -
    -
    - phan-file-suppress -
    -
    - -

    PhanUndeclaredMethod (CSRFToken, ClientCredentials, TokenRefresh)

    -
    -
    diff --git a/files/src-storage-memorystorage.html b/files/src-storage-memorystorage.html index e69d0d54..5185bf1e 100644 --- a/files/src-storage-memorystorage.html +++ b/files/src-storage-memorystorage.html @@ -180,7 +180,7 @@

    -
    MemoryStorage
    Implements a memory storage adapter. Memory storage is not persistent as tokens are only stored during script runtime.
    +
    MemoryStorage
    Implements a memory storage adapter.
    diff --git a/files/src-storage-oauthstorageinterface.html b/files/src-storage-oauthstorageinterface.html index af053425..c341c43e 100644 --- a/files/src-storage-oauthstorageinterface.html +++ b/files/src-storage-oauthstorageinterface.html @@ -179,7 +179,7 @@

    -
    OAuthStorageInterface
    Specifies the methods required for an OAuth storage adapter
    +
    OAuthStorageInterface
    Specifies the methods required for an OAuth token storage adapter
    diff --git a/files/src-storage-sessionstorage.html b/files/src-storage-sessionstorage.html index 55f30654..35231640 100644 --- a/files/src-storage-sessionstorage.html +++ b/files/src-storage-sessionstorage.html @@ -180,7 +180,7 @@

    -
    SessionStorage
    Implements a session storage adapter. Session storage is half persistent as tokens are stored for the duration of the session.
    +
    SessionStorage
    Implements a session storage adapter.
    diff --git a/js/searchIndex.js b/js/searchIndex.js index e341497f..f97c952d 100644 --- a/js/searchIndex.js +++ b/js/searchIndex.js @@ -5,11 +5,6 @@ Search.appendIndex( "name": "AccessToken", "summary": "Access\u0020token\u0020implementation\u0020for\u0020any\u0020OAuth\u0020version.", "url": "classes/chillerlan-OAuth-Core-AccessToken.html" - }, { - "fqsen": "\\chillerlan\\OAuth\\Core\\AccessToken\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "AccessToken\u0020constructor.", - "url": "classes/chillerlan-OAuth-Core-AccessToken.html#method___construct" }, { "fqsen": "\\chillerlan\\OAuth\\Core\\AccessToken\u003A\u003Aset_expires\u0028\u0029", "name": "set_expires", @@ -28,7 +23,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\OAuth\\Core\\AccessToken\u003A\u003AEOL_UNKNOWN", "name": "EOL_UNKNOWN", - "summary": "Denotes\u0020an\u0020unknown\u0020end\u0020of\u0020lifetime.", + "summary": "Denotes\u0020an\u0020unknown\u0020end\u0020of\u0020lifetime,\u0020such\u0020a\u0020token\u0020should\u0020be\u0020considered\u0020as\u0020expired.", "url": "classes/chillerlan-OAuth-Core-AccessToken.html#constant_EOL_UNKNOWN" }, { "fqsen": "\\chillerlan\\OAuth\\Core\\AccessToken\u003A\u003AEOL_NEVER_EXPIRES", @@ -438,7 +433,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\OAuth\\Core\\OAuthProvider\u003A\u003A\u0024serviceName", "name": "serviceName", - "summary": "the\u0020name\u0020of\u0020the\u0020provider\u0020\u0028class\u0029\u0020\u0028magic\u0029", + "summary": "the\u0020name\u0020of\u0020the\u0020provider\/class\u0020\u0028magic\u0029", "url": "classes/chillerlan-OAuth-Core-OAuthProvider.html#property_serviceName" }, { "fqsen": "\\chillerlan\\OAuth\\Core\\OAuthProvider\u003A\u003A\u0024apiURL", @@ -573,7 +568,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\OAuth\\Storage\\MemoryStorage", "name": "MemoryStorage", - "summary": "Implements\u0020a\u0020memory\u0020storage\u0020adapter.\u0020Memory\u0020storage\u0020is\u0020not\u0020persistent\u0020as\u0020tokens\u0020are\u0020only\u0020stored\u0020during\u0020script\u0020runtime.", + "summary": "Implements\u0020a\u0020memory\u0020storage\u0020adapter.", "url": "classes/chillerlan-OAuth-Storage-MemoryStorage.html" }, { "fqsen": "\\chillerlan\\OAuth\\Storage\\MemoryStorage\u003A\u003AstoreAccessToken\u0028\u0029", @@ -693,7 +688,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\OAuth\\Storage\\OAuthStorageInterface", "name": "OAuthStorageInterface", - "summary": "Specifies\u0020the\u0020methods\u0020required\u0020for\u0020an\u0020OAuth\u0020storage\u0020adapter", + "summary": "Specifies\u0020the\u0020methods\u0020required\u0020for\u0020an\u0020OAuth\u0020token\u0020storage\u0020adapter", "url": "classes/chillerlan-OAuth-Storage-OAuthStorageInterface.html" }, { "fqsen": "\\chillerlan\\OAuth\\Storage\\OAuthStorageInterface\u003A\u003AsetLogger\u0028\u0029", @@ -773,7 +768,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\OAuth\\Storage\\SessionStorage", "name": "SessionStorage", - "summary": "Implements\u0020a\u0020session\u0020storage\u0020adapter.\u0020Session\u0020storage\u0020is\u0020half\u0020persistent\u0020as\u0020tokens\u0020are\u0020stored\u0020for\u0020the\u0020duration\u0020of\u0020the\u0020session.", + "summary": "Implements\u0020a\u0020session\u0020storage\u0020adapter.", "url": "classes/chillerlan-OAuth-Storage-SessionStorage.html" }, { "fqsen": "\\chillerlan\\OAuth\\Storage\\SessionStorage\u003A\u003A__construct\u0028\u0029", diff --git a/namespaces/chillerlan-oauth-storage.html b/namespaces/chillerlan-oauth-storage.html index e9243545..fa0d42e7 100644 --- a/namespaces/chillerlan-oauth-storage.html +++ b/namespaces/chillerlan-oauth-storage.html @@ -132,7 +132,7 @@

    -
    OAuthStorageInterface
    Specifies the methods required for an OAuth storage adapter
    +
    OAuthStorageInterface
    Specifies the methods required for an OAuth token storage adapter

    Classes @@ -140,7 +140,7 @@

    -
    MemoryStorage
    Implements a memory storage adapter. Memory storage is not persistent as tokens are only stored during script runtime.
    OAuthStorageAbstract
    Implements an abstract OAuth storage adapter
    OAuthStorageException
    SessionStorage
    Implements a session storage adapter. Session storage is half persistent as tokens are stored for the duration of the session.
    +
    MemoryStorage
    Implements a memory storage adapter.
    OAuthStorageAbstract
    Implements an abstract OAuth storage adapter
    OAuthStorageException
    SessionStorage
    Implements a session storage adapter.
    diff --git a/packages/Application.html b/packages/Application.html index 7f356879..b65ccce3 100644 --- a/packages/Application.html +++ b/packages/Application.html @@ -130,7 +130,7 @@

    -
    ClientCredentials
    Indicates whether the provider is capable of the OAuth2 client credentials authentication flow.
    CSRFToken
    Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")
    OAuth1Interface
    Specifies the basic methods for an OAuth1 provider.
    OAuth2Interface
    Specifies the basic methods for an OAuth2 provider.
    OAuthInterface
    Specifies the basic methods for an OAuth provider.
    TokenInvalidate
    Indicates whether the service is capable of invalidating access tokens
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    OAuthStorageInterface
    Specifies the methods required for an OAuth storage adapter
    +
    ClientCredentials
    Indicates whether the provider is capable of the OAuth2 client credentials authentication flow.
    CSRFToken
    Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")
    OAuth1Interface
    Specifies the basic methods for an OAuth1 provider.
    OAuth2Interface
    Specifies the basic methods for an OAuth2 provider.
    OAuthInterface
    Specifies the basic methods for an OAuth provider.
    TokenInvalidate
    Indicates whether the service is capable of invalidating access tokens
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    OAuthStorageInterface
    Specifies the methods required for an OAuth token storage adapter

    Classes @@ -138,7 +138,7 @@

    -
    AccessToken
    Access token implementation for any OAuth version.
    OAuth1Provider
    Implements an abstract OAuth1 provider with all methods required by the OAuth1Interface.
    OAuth2Provider
    Implements an abstract OAuth2 provider with all methods required by the OAuth2Interface.
    OAuthProvider
    Implements an abstract OAuth provider with all methods required by the OAuthInterface.
    ProviderException
    OAuthException
    OAuthOptions
    This class holds all settings related to the OAuth provider as well as the default HTTP client.
    MemoryStorage
    Implements a memory storage adapter. Memory storage is not persistent as tokens are only stored during script runtime.
    OAuthStorageAbstract
    Implements an abstract OAuth storage adapter
    OAuthStorageException
    SessionStorage
    Implements a session storage adapter. Session storage is half persistent as tokens are stored for the duration of the session.
    AccessTokenTest
    Tests the AccessToken class
    OAuthTestMemoryStorage
    Extends the standard memory storage so that it also saves tokens as JSON in the given path
    DummyOAuth1Provider
    An OAuth1 provider implementation
    DummyOAuth1Test
    OAuth1ProviderTestAbstract
    DummyOAuth2BasicProvider
    A minimal OAuth2 provider implementation
    DummyOAuth2Provider
    An OAuth2 provider implementation that supports token refresh, csrf tokens and client credentials
    DummyOAuth2Test
    DummyOAuth2TestBasic
    Tests a minimal OAuth2 provider implementation (no token refresh, no csrf, no nothing)
    OAuth2ProviderTestAbstract
    OAuthProviderTestAbstract
    ProviderTestHttpClient
    a dummy client that returns a prepared set of responses
    OAuthProviderRequestTest
    RequestTestProvider
    Implements an abstract OAuth provider with all methods required by the OAuthInterface.
    MemoryStorageTest
    SessionStorageTest
    StorageTestAbstract
    +
    AccessToken
    Access token implementation for any OAuth version.
    OAuth1Provider
    Implements an abstract OAuth1 provider with all methods required by the OAuth1Interface.
    OAuth2Provider
    Implements an abstract OAuth2 provider with all methods required by the OAuth2Interface.
    OAuthProvider
    Implements an abstract OAuth provider with all methods required by the OAuthInterface.
    ProviderException
    OAuthException
    OAuthOptions
    This class holds all settings related to the OAuth provider as well as the default HTTP client.
    MemoryStorage
    Implements a memory storage adapter.
    OAuthStorageAbstract
    Implements an abstract OAuth storage adapter
    OAuthStorageException
    SessionStorage
    Implements a session storage adapter.
    AccessTokenTest
    Tests the AccessToken class
    OAuthTestMemoryStorage
    Extends the standard memory storage so that it also saves tokens as JSON in the given path
    DummyOAuth1Provider
    An OAuth1 provider implementation
    DummyOAuth1Test
    OAuth1ProviderTestAbstract
    DummyOAuth2BasicProvider
    A minimal OAuth2 provider implementation
    DummyOAuth2Provider
    An OAuth2 provider implementation that supports token refresh, csrf tokens and client credentials
    DummyOAuth2Test
    DummyOAuth2TestBasic
    Tests a minimal OAuth2 provider implementation (no token refresh, no csrf, no nothing)
    OAuth2ProviderTestAbstract
    OAuthProviderTestAbstract
    ProviderTestHttpClient
    a dummy client that returns a prepared set of responses
    OAuthProviderRequestTest
    RequestTestProvider
    Implements an abstract OAuth provider with all methods required by the OAuthInterface.
    MemoryStorageTest
    SessionStorageTest
    StorageTestAbstract

    Traits