diff --git a/Readme.md b/Readme.md deleted file mode 100644 index 8095954f..00000000 --- a/Readme.md +++ /dev/null @@ -1,13 +0,0 @@ -# Auto generated API documentation - -The API documentation can be auto generated with [phpDocumentor](https://www.phpdoc.org/). -There is an [online version available](https://chillerlan.github.io/php-oauth-core/) via the [gh-pages branch](https://github.com/chillerlan/php-oauth-core/tree/gh-pages) that is [automatically deployed](https://github.com/chillerlan/php-oauth-core/deployments) on each push to main. - -Locally created docs will appear in this directory. If you'd like to create local docs, please follow these steps: - -- [download phpDocumentor](https://github.com/phpDocumentor/phpDocumentor/releases) v3+ as .phar archive -- run it in the repository root directory: - - on Windows `c:\path\to\php.exe c:\path\to\phpDocumentor.phar --config=phpdoc.xml` - - on Linux just `php /path/to/phpDocumentor.phar --config=phpdoc.xml` -- open [index.html](./index.html) in a browser -- profit! diff --git a/classes/chillerlan-OAuth-Core-AccessToken.html b/classes/chillerlan-OAuth-Core-AccessToken.html index 22e7094e..82632c36 100644 --- a/classes/chillerlan-OAuth-Core-AccessToken.html +++ b/classes/chillerlan-OAuth-Core-AccessToken.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

isExpired() +

@@ -955,15 +1002,17 @@

public isExpired() : bool +
+
+
Return values
- bool - — - - + bool +
+
Return values

setExpiry() +

@@ -986,25 +1036,27 @@

public - setExpiry([int $expires = null ]) : AccessToken + setExpiry([int|null $expires = null ]) : AccessToken +
+

Parameters
$expires - : int + : int|null = null
-
- +
Tags - + +
@@ -1016,13 +1068,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

set_expires() +

@@ -1045,95 +1098,180 @@

protected - set_expires([int $expires = null ]) : void + set_expires([int|null $expires = null ]) : void +
+

Parameters
$expires - : int + : int|null = null
-
- +
-
Return values
- void - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -1144,7 +1282,6 @@

Search results

- diff --git a/classes/chillerlan-OAuth-Core-CSRFToken.html b/classes/chillerlan-OAuth-Core-CSRFToken.html index 7442c8e0..c042da6d 100644 --- a/classes/chillerlan-OAuth-Core-CSRFToken.html +++ b/classes/chillerlan-OAuth-Core-CSRFToken.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

getStorage() +

@@ -435,15 +475,17 @@

public getStorage() : OAuthStorageInterface +
+
+
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

me() +

@@ -468,6 +511,8 @@

public me() : ResponseInterface +
+

Throws a ProviderException if no such information is available or if the method cannot be implemented.

@@ -475,7 +520,8 @@

Tags - + +
@@ -486,13 +532,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

request() +

@@ -516,8 +563,10 @@

public - request(string $path[, array<string|int, mixed> $params = null ][, string $method = null ][, StreamInterface|array<string|int, mixed>|string $body = null ][, array<string|int, mixed> $headers = null ]) : ResponseInterface + request(string $path[, array<string|int, mixed>|null $params = null ][, string|null $method = null ][, StreamInterface|array<string|int, mixed>|string|null $body = null ][, array<string|int, mixed>|null $headers = null ]) : ResponseInterface +
+

Parameters
@@ -526,47 +575,43 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$method - : string + : string|null = null
-
- +
$body - : StreamInterface|array<string|int, mixed>|string + : StreamInterface|array<string|int, mixed>|string|null = null
-
- +
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
Tags - + +
@@ -577,13 +622,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

setLogger() +

@@ -608,6 +654,8 @@

public setLogger(LoggerInterface $logger) : static +
+

Parameters
@@ -616,18 +664,17 @@
Parameters
: LoggerInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

setRequestFactory() +

@@ -652,6 +700,8 @@

public setRequestFactory(RequestFactoryInterface $requestFactory) : static +
+

Parameters
@@ -660,18 +710,17 @@
Parameters
: RequestFactoryInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

setStorage() +

@@ -696,6 +746,8 @@

public setStorage(OAuthStorageInterface $storage) : static +
+

Parameters
@@ -704,18 +756,17 @@
Parameters
: OAuthStorageInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

setStreamFactory() +

@@ -740,6 +792,8 @@

public setStreamFactory(StreamFactoryInterface $streamFactory) : static +
+

Parameters
@@ -748,18 +802,17 @@
Parameters
: StreamFactoryInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

setUriFactory() +

@@ -784,6 +838,8 @@

public setUriFactory(UriFactoryInterface $uriFactory) : static +
+

Parameters
@@ -792,18 +848,17 @@
Parameters
: UriFactoryInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

@@ -828,6 +884,8 @@

public storeAccessToken(AccessToken $token) : static +
+

Parameters
@@ -836,85 +894,151 @@
Parameters
: AccessToken
-
- +
+
Return values
- static - — - - -
+ static - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -925,7 +1049,6 @@

Search results

- diff --git a/classes/chillerlan-OAuth-Core-OAuth1Provider.html b/classes/chillerlan-OAuth-Core-OAuth1Provider.html index 899af215..6a158438 100644 --- a/classes/chillerlan-OAuth-Core-OAuth1Provider.html +++ b/classes/chillerlan-OAuth-Core-OAuth1Provider.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

__get() +

@@ -1241,6 +1296,8 @@

public __get(string $name) : mixed|null +
+

Parameters
@@ -1249,18 +1306,17 @@
Parameters
: string
-
- +
+
Return values
- mixed|null - — - - + mixed|null +
+
Return values

getAccessToken() +

@@ -1285,6 +1342,8 @@

public getAccessToken(string $token, string $verifier) : AccessToken +
+

Parameters
@@ -1293,23 +1352,22 @@
Parameters
: string
-
- +
$verifier : string
-
- +
Tags - + +
@@ -1319,13 +1377,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getAuthURL() +

public - getAuthURL([array<string|int, mixed> $params = null ]) : UriInterface + getAuthURL([array<string|int, mixed>|null $params = null ]) : UriInterface +
+
Parameters
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
Tags - + +
@@ -1375,13 +1436,13 @@
-
+ +
Return values
- UriInterface - — - - + UriInterface +
+
Return values

getRequestAuthorization() +

@@ -1405,6 +1467,8 @@

public getRequestAuthorization(RequestInterface $request, AccessToken $token) : RequestInterface +
+

Parameters
@@ -1413,23 +1477,22 @@
Parameters
: RequestInterface
-
- +
$token : AccessToken
-
- +
Tags - + +
@@ -1439,13 +1502,13 @@
-
+ +
Return values
- RequestInterface - — - - + RequestInterface +
+
Return values

getRequestToken() +

@@ -1470,12 +1534,15 @@

public getRequestToken() : AccessToken +
+

Tags - + +
@@ -1485,13 +1552,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getStorage() +

@@ -1516,12 +1584,15 @@

public getStorage() : OAuthStorageInterface +
+

Tags - + +
@@ -1538,13 +1609,13 @@
-
+ +
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

invalidateAccessToken() +

public - invalidateAccessToken([AccessToken $token = null ]) : bool + invalidateAccessToken([AccessToken|null $token = null ]) : bool +
+
Parameters
$token - : AccessToken + : AccessToken|null = null
-
- +
Tags - + +
@@ -1611,13 +1685,13 @@
-
+ +
Return values
- bool - — - - + bool +
+
Return values

me() +

@@ -1642,12 +1717,15 @@

public me() : ResponseInterface +
+

Tags - + +
@@ -1664,13 +1742,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

request() +

@@ -1694,8 +1773,10 @@

public - request(string $path[, array<string|int, mixed> $params = null ][, string $method = null ][, StreamInterface|array<string|int, mixed>|string $body = null ][, array<string|int, mixed> $headers = null ][, string $protocolVersion = null ]) : ResponseInterface + request(string $path[, array<string|int, mixed>|null $params = null ][, string|null $method = null ][, StreamInterface|array<string|int, mixed>|string|null $body = null ][, array<string|int, mixed>|null $headers = null ][, string|null $protocolVersion = null ]) : ResponseInterface +
+

Parameters
@@ -1704,55 +1785,50 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$method - : string + : string|null = null
-
- +
$body - : StreamInterface|array<string|int, mixed>|string + : StreamInterface|array<string|int, mixed>|string|null = null
-
- +
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$protocolVersion - : string + : string|null = null
-
- +
Tags - + +
@@ -1762,13 +1838,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

sendRequest() +

@@ -1792,6 +1869,8 @@

public sendRequest(RequestInterface $request) : ResponseInterface +
+

Parameters
@@ -1800,15 +1879,15 @@
Parameters
: RequestInterface
-
- +
Tags - + +
@@ -1818,13 +1897,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

setLogger() +

@@ -1849,6 +1929,8 @@

public setLogger(LoggerInterface $logger) : static +
+

Parameters
@@ -1857,15 +1939,15 @@
Parameters
: LoggerInterface
-
- +
Tags - + +
@@ -1882,13 +1964,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setRequestFactory() +

@@ -1913,6 +1996,8 @@

public setRequestFactory(RequestFactoryInterface $requestFactory) : static +
+

Parameters
@@ -1921,15 +2006,15 @@
Parameters
: RequestFactoryInterface
-
- +
Tags - + +
@@ -1946,13 +2031,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStorage() +

@@ -1977,6 +2063,8 @@

public setStorage(OAuthStorageInterface $storage) : static +
+

Parameters
@@ -1985,15 +2073,15 @@
Parameters
: OAuthStorageInterface
-
- +
Tags - + +
@@ -2010,13 +2098,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStreamFactory() +

@@ -2041,6 +2130,8 @@

public setStreamFactory(StreamFactoryInterface $streamFactory) : static +
+

Parameters
@@ -2049,15 +2140,15 @@
Parameters
: StreamFactoryInterface
-
- +
Tags - + +
@@ -2074,13 +2165,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setUriFactory() +

@@ -2105,6 +2197,8 @@

public setUriFactory(UriFactoryInterface $uriFactory) : static +
+

Parameters
@@ -2113,15 +2207,15 @@
Parameters
: UriFactoryInterface
-
- +
Tags - + +
@@ -2138,13 +2232,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

@@ -2169,6 +2264,8 @@

public storeAccessToken(AccessToken $token) : static +
+

Parameters
@@ -2177,15 +2274,15 @@
Parameters
: AccessToken
-
- +
Tags - + +
@@ -2202,13 +2299,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

cleanBodyParams() +

@@ -2231,28 +2329,29 @@

protected - cleanBodyParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanBodyParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

cleanQueryParams() +

@@ -2275,28 +2375,29 @@

protected - cleanQueryParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanQueryParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

createAccessToken() +

@@ -2321,15 +2423,17 @@

protected createAccessToken() : AccessToken +
+
+
Return values
- AccessToken - — - - + AccessToken +
+

Return values

getRequestBody() +

@@ -2354,6 +2459,8 @@

protected getRequestBody(StreamInterface|array<string|int, mixed>|string $body, RequestInterface $request) : StreamInterface +
+

Parameters
@@ -2362,23 +2469,22 @@
Parameters
: StreamInterface|array<string|int, mixed>|string
-
- +
$request : RequestInterface
-
- +
Tags - + +
@@ -2389,13 +2495,13 @@
-
+ +
Return values
- StreamInterface - — - - + StreamInterface +
+
Return values

getRequestHeaders() +

@@ -2418,28 +2525,29 @@

protected - getRequestHeaders([array<string|int, mixed> $headers = null ]) : array<string|int, mixed> + getRequestHeaders([array<string|int, mixed>|null $headers = null ]) : array<string|int, mixed> +
+

Parameters
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

getRequestTarget() +

@@ -2465,6 +2574,8 @@

protected getRequestTarget(string $uri) : string +
+

Throws if the given path is invalid or if the host of a given URL does not match $apiURL.

@@ -2475,15 +2586,15 @@

Parameters
: string
-
- +
Tags - + +
@@ -2502,13 +2613,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

getRequestURL() +

@@ -2531,8 +2643,10 @@

protected - getRequestURL(string $path[, array<string|int, mixed> $params = null ]) : string + getRequestURL(string $path[, array<string|int, mixed>|null $params = null ]) : string +
+

Parameters
@@ -2541,26 +2655,24 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- string - — - - + string +
+
Return values

getSignature() +

@@ -2583,8 +2696,10 @@

protected - getSignature(string $url, array<string|int, mixed> $params, string $method[, string $accessTokenSecret = null ]) : string + getSignature(string $url, array<string|int, mixed> $params, string $method[, string|null $accessTokenSecret = null ]) : string +
+

Parameters
@@ -2593,39 +2708,36 @@
Parameters
: string
-
- +
$params : array<string|int, mixed>
-
- +
$method : string
-
- +
$accessTokenSecret - : string + : string|null = null
-
- +
Tags - + +
@@ -2643,13 +2755,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

nonce() +

@@ -2674,15 +2787,17 @@

protected nonce() : string +
+
+
Return values
- string - — - - + string +
+

Return values

parseTokenResponse() +

@@ -2705,8 +2821,10 @@

protected - parseTokenResponse(ResponseInterface $response[, bool $checkCallbackConfirmed = null ]) : AccessToken + parseTokenResponse(ResponseInterface $response, bool $checkCallbackConfirmed) : AccessToken +
+

Parameters
@@ -2715,23 +2833,22 @@
Parameters
: ResponseInterface
-
- +
$checkCallbackConfirmed : bool - = null
+
-
- +
Tags - + +
@@ -2749,80 +2866,193 @@
-
+ +
Return values
- AccessToken - — - - -
+ AccessToken - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -2833,7 +3063,6 @@

Search results

- diff --git a/classes/chillerlan-OAuth-Core-OAuth2Interface.html b/classes/chillerlan-OAuth-Core-OAuth2Interface.html index ee5aecfc..8b014dc3 100644 --- a/classes/chillerlan-OAuth-Core-OAuth2Interface.html +++ b/classes/chillerlan-OAuth-Core-OAuth2Interface.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

getAuthURL() +

@@ -395,6 +433,8 @@

public getAuthURL([array<string|int, mixed>|null $params = null ][, array<string|int, string>|null $scopes = null ]) : UriInterface +
+

Parameters
@@ -416,11 +456,11 @@
Parameters
+
Return values
- UriInterface - — - - + UriInterface +
+
Return values

getStorage() +

@@ -445,15 +486,17 @@

public getStorage() : OAuthStorageInterface +
+
+
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+

Return values

me() +

@@ -478,6 +522,8 @@

public me() : ResponseInterface +
+

Throws a ProviderException if no such information is available or if the method cannot be implemented.

@@ -485,7 +531,8 @@

Tags - + +
@@ -496,13 +543,13 @@
-
+
+
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

request() +

@@ -526,8 +574,10 @@

public - request(string $path[, array<string|int, mixed> $params = null ][, string $method = null ][, StreamInterface|array<string|int, mixed>|string $body = null ][, array<string|int, mixed> $headers = null ]) : ResponseInterface + request(string $path[, array<string|int, mixed>|null $params = null ][, string|null $method = null ][, StreamInterface|array<string|int, mixed>|string|null $body = null ][, array<string|int, mixed>|null $headers = null ]) : ResponseInterface +
+

Parameters
@@ -536,47 +586,43 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$method - : string + : string|null = null
-
- +
$body - : StreamInterface|array<string|int, mixed>|string + : StreamInterface|array<string|int, mixed>|string|null = null
-
- +
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
Tags - + +
@@ -587,13 +633,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

setLogger() +

@@ -618,6 +665,8 @@

public setLogger(LoggerInterface $logger) : static +
+

Parameters
@@ -626,18 +675,17 @@
Parameters
: LoggerInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

setRequestFactory() +

@@ -662,6 +711,8 @@

public setRequestFactory(RequestFactoryInterface $requestFactory) : static +
+

Parameters
@@ -670,18 +721,17 @@
Parameters
: RequestFactoryInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

setStorage() +

@@ -706,6 +757,8 @@

public setStorage(OAuthStorageInterface $storage) : static +
+

Parameters
@@ -714,18 +767,17 @@
Parameters
: OAuthStorageInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

setStreamFactory() +

@@ -750,6 +803,8 @@

public setStreamFactory(StreamFactoryInterface $streamFactory) : static +
+

Parameters
@@ -758,18 +813,17 @@
Parameters
: StreamFactoryInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

setUriFactory() +

@@ -794,6 +849,8 @@

public setUriFactory(UriFactoryInterface $uriFactory) : static +
+

Parameters
@@ -802,18 +859,17 @@
Parameters
: UriFactoryInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

@@ -838,6 +895,8 @@

public storeAccessToken(AccessToken $token) : static +
+

Parameters
@@ -846,85 +905,157 @@
Parameters
: AccessToken
-
- +
+
Return values
- static - — - - -
+ static - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -935,7 +1066,6 @@

Search results

- diff --git a/classes/chillerlan-OAuth-Core-OAuth2Provider.html b/classes/chillerlan-OAuth-Core-OAuth2Provider.html index 1827eeef..c10c99b8 100644 --- a/classes/chillerlan-OAuth-Core-OAuth2Provider.html +++ b/classes/chillerlan-OAuth-Core-OAuth2Provider.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

__get() +

@@ -1506,6 +1561,8 @@

public __get(string $name) : mixed|null +
+

Parameters
@@ -1514,18 +1571,17 @@
Parameters
: string
-
- +
+
Return values
- mixed|null - — - - + mixed|null +
+
Return values

getAccessToken() +

@@ -1549,8 +1606,10 @@

public - getAccessToken(string $code[, string $state = null ]) : AccessToken + getAccessToken(string $code[, string|null $state = null ]) : AccessToken +
+

Parameters
@@ -1559,23 +1618,22 @@
Parameters
: string
-
- +
$state - : string + : string|null = null
-
- +
Tags - + +
@@ -1585,13 +1643,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getAuthURL() +

@@ -1615,21 +1674,23 @@

public - getAuthURL([array<string|int, mixed> $params = null ][, array<string|int, mixed> $scopes = null ]) : UriInterface + getAuthURL([array<string|int, mixed>|null $params = null ][, array<string|int, mixed>|null $scopes = null ]) : UriInterface +
+

Parameters
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
$scopes - : array<string|int, mixed> + : array<string|int, mixed>|null = null
@@ -1639,7 +1700,8 @@
Parameters
Tags - + +
@@ -1649,13 +1711,13 @@
-
+ +
Return values
- UriInterface - — - - + UriInterface +
+
Return values

getClientCredentialsToken() +

public - getClientCredentialsToken([array<string|int, mixed> $scopes = null ]) : AccessToken + getClientCredentialsToken([array<string|int, mixed>|null $scopes = null ]) : AccessToken +
+
Parameters
$scopes - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
Tags - + +
@@ -1715,13 +1780,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getRequestAuthorization() +

@@ -1745,6 +1811,8 @@

public getRequestAuthorization(RequestInterface $request, AccessToken $token) : RequestInterface +
+

Parameters
@@ -1753,23 +1821,22 @@
Parameters
: RequestInterface
-
- +
$token : AccessToken
-
- +
Tags - + +
@@ -1779,13 +1846,13 @@
-
+ +
Return values
- RequestInterface - — - - + RequestInterface +
+
Return values

getStorage() +

@@ -1810,12 +1878,15 @@

public getStorage() : OAuthStorageInterface +
+

Tags - + +
@@ -1832,13 +1903,13 @@
-
+ +
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

invalidateAccessToken() +

public - invalidateAccessToken([AccessToken $token = null ]) : bool + invalidateAccessToken([AccessToken|null $token = null ]) : bool +
+
Parameters
$token - : AccessToken + : AccessToken|null = null
-
- +
Tags - + +
@@ -1905,13 +1979,13 @@
-
+ +
Return values
- bool - — - - + bool +
+
Return values

me() +

@@ -1936,12 +2011,15 @@

public me() : ResponseInterface +
+

Tags - + +
@@ -1958,13 +2036,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

refreshAccessToken() +

public - refreshAccessToken([AccessToken $token = null ]) : AccessToken + refreshAccessToken([AccessToken|null $token = null ]) : AccessToken +
+
Parameters
$token - : AccessToken + : AccessToken|null = null
-
- +
Tags - + +
@@ -2024,13 +2105,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

request() +

@@ -2054,8 +2136,10 @@

public - request(string $path[, array<string|int, mixed> $params = null ][, string $method = null ][, StreamInterface|array<string|int, mixed>|string $body = null ][, array<string|int, mixed> $headers = null ][, string $protocolVersion = null ]) : ResponseInterface + request(string $path[, array<string|int, mixed>|null $params = null ][, string|null $method = null ][, StreamInterface|array<string|int, mixed>|string|null $body = null ][, array<string|int, mixed>|null $headers = null ][, string|null $protocolVersion = null ]) : ResponseInterface +
+

Parameters
@@ -2064,55 +2148,50 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$method - : string + : string|null = null
-
- +
$body - : StreamInterface|array<string|int, mixed>|string + : StreamInterface|array<string|int, mixed>|string|null = null
-
- +
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$protocolVersion - : string + : string|null = null
-
- +
Tags - + +
@@ -2122,13 +2201,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

sendRequest() +

@@ -2152,6 +2232,8 @@

public sendRequest(RequestInterface $request) : ResponseInterface +
+

Parameters
@@ -2160,15 +2242,15 @@
Parameters
: RequestInterface
-
- +
Tags - + +
@@ -2178,13 +2260,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

setLogger() +

@@ -2209,6 +2292,8 @@

public setLogger(LoggerInterface $logger) : static +
+

Parameters
@@ -2217,15 +2302,15 @@
Parameters
: LoggerInterface
-
- +
Tags - + +
@@ -2242,13 +2327,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setRequestFactory() +

@@ -2273,6 +2359,8 @@

public setRequestFactory(RequestFactoryInterface $requestFactory) : static +
+

Parameters
@@ -2281,15 +2369,15 @@
Parameters
: RequestFactoryInterface
-
- +
Tags - + +
@@ -2306,13 +2394,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStorage() +

@@ -2337,6 +2426,8 @@

public setStorage(OAuthStorageInterface $storage) : static +
+

Parameters
@@ -2345,15 +2436,15 @@
Parameters
: OAuthStorageInterface
-
- +
Tags - + +
@@ -2370,13 +2461,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStreamFactory() +

@@ -2401,6 +2493,8 @@

public setStreamFactory(StreamFactoryInterface $streamFactory) : static +
+

Parameters
@@ -2409,15 +2503,15 @@
Parameters
: StreamFactoryInterface
-
- +
Tags - + +
@@ -2434,13 +2528,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setUriFactory() +

@@ -2465,6 +2560,8 @@

public setUriFactory(UriFactoryInterface $uriFactory) : static +
+

Parameters
@@ -2473,15 +2570,15 @@
Parameters
: UriFactoryInterface
-
- +
Tags - + +
@@ -2498,13 +2595,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

@@ -2529,6 +2627,8 @@

public storeAccessToken(AccessToken $token) : static +
+

Parameters
@@ -2537,15 +2637,15 @@
Parameters
: AccessToken
-
- +
Tags - + +
@@ -2562,13 +2662,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

cleanBodyParams() +

@@ -2591,28 +2692,29 @@

protected - cleanBodyParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanBodyParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

cleanQueryParams() +

@@ -2635,28 +2738,29 @@

protected - cleanQueryParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanQueryParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

createAccessToken() +

@@ -2681,15 +2786,17 @@

protected createAccessToken() : AccessToken +
+
+
Return values
- AccessToken - — - - + AccessToken +
+

Return values

getRequestBody() +

@@ -2714,6 +2822,8 @@

protected getRequestBody(StreamInterface|array<string|int, mixed>|string $body, RequestInterface $request) : StreamInterface +
+

Parameters
@@ -2722,23 +2832,22 @@
Parameters
: StreamInterface|array<string|int, mixed>|string
-
- +
$request : RequestInterface
-
- +
Tags - + +
@@ -2749,13 +2858,13 @@
-
+ +
Return values
- StreamInterface - — - - + StreamInterface +
+
Return values

getRequestHeaders() +

@@ -2778,28 +2888,29 @@

protected - getRequestHeaders([array<string|int, mixed> $headers = null ]) : array<string|int, mixed> + getRequestHeaders([array<string|int, mixed>|null $headers = null ]) : array<string|int, mixed> +
+

Parameters
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

getRequestTarget() +

@@ -2825,6 +2937,8 @@

protected getRequestTarget(string $uri) : string +
+

Throws if the given path is invalid or if the host of a given URL does not match $apiURL.

@@ -2835,15 +2949,15 @@

Parameters
: string
-
- +
Tags - + +
@@ -2862,13 +2976,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

getRequestURL() +

@@ -2891,8 +3006,10 @@

protected - getRequestURL(string $path[, array<string|int, mixed> $params = null ]) : string + getRequestURL(string $path[, array<string|int, mixed>|null $params = null ]) : string +
+

Parameters
@@ -2901,26 +3018,24 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- string - — - - + string +
+
Return values

parseTokenResponse() +

@@ -2945,6 +3061,8 @@

protected parseTokenResponse(ResponseInterface $response) : AccessToken +
+

Parameters
@@ -2953,15 +3071,15 @@
Parameters
: ResponseInterface
-
- +
Tags - + +
@@ -2987,80 +3105,198 @@
-
+ +
Return values
- AccessToken - — - - -
+ AccessToken - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -3071,7 +3307,6 @@

Search results

- diff --git a/classes/chillerlan-OAuth-Core-OAuthInterface.html b/classes/chillerlan-OAuth-Core-OAuthInterface.html index 1d8c0ede..585ebc61 100644 --- a/classes/chillerlan-OAuth-Core-OAuthInterface.html +++ b/classes/chillerlan-OAuth-Core-OAuthInterface.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

getStorage() +

@@ -286,15 +320,17 @@

public getStorage() : OAuthStorageInterface +
+
+
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

me() +

@@ -319,6 +356,8 @@

public me() : ResponseInterface +
+

Throws a ProviderException if no such information is available or if the method cannot be implemented.

@@ -326,7 +365,8 @@

Tags - + +
@@ -337,13 +377,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

request() +

@@ -367,8 +408,10 @@

public - request(string $path[, array<string|int, mixed> $params = null ][, string $method = null ][, StreamInterface|array<string|int, mixed>|string $body = null ][, array<string|int, mixed> $headers = null ]) : ResponseInterface + request(string $path[, array<string|int, mixed>|null $params = null ][, string|null $method = null ][, StreamInterface|array<string|int, mixed>|string|null $body = null ][, array<string|int, mixed>|null $headers = null ]) : ResponseInterface +
+

Parameters
@@ -377,47 +420,43 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$method - : string + : string|null = null
-
- +
$body - : StreamInterface|array<string|int, mixed>|string + : StreamInterface|array<string|int, mixed>|string|null = null
-
- +
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
Tags - + +
@@ -428,13 +467,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

setLogger() +

@@ -459,6 +499,8 @@

public setLogger(LoggerInterface $logger) : static +
+

Parameters
@@ -467,18 +509,17 @@
Parameters
: LoggerInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

setRequestFactory() +

@@ -503,6 +545,8 @@

public setRequestFactory(RequestFactoryInterface $requestFactory) : static +
+

Parameters
@@ -511,18 +555,17 @@
Parameters
: RequestFactoryInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

setStorage() +

@@ -547,6 +591,8 @@

public setStorage(OAuthStorageInterface $storage) : static +
+

Parameters
@@ -555,18 +601,17 @@
Parameters
: OAuthStorageInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

setStreamFactory() +

@@ -591,6 +637,8 @@

public setStreamFactory(StreamFactoryInterface $streamFactory) : static +
+

Parameters
@@ -599,18 +647,17 @@
Parameters
: StreamFactoryInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

setUriFactory() +

@@ -635,6 +683,8 @@

public setUriFactory(UriFactoryInterface $uriFactory) : static +
+

Parameters
@@ -643,18 +693,17 @@
Parameters
: UriFactoryInterface
-
- +
+
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

@@ -679,6 +729,8 @@

public storeAccessToken(AccessToken $token) : static +
+

Parameters
@@ -687,85 +739,149 @@
Parameters
: AccessToken
-
- +
+
Return values
- static - — - - -
+ static - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -776,7 +892,6 @@

Search results

- diff --git a/classes/chillerlan-OAuth-Core-OAuthProvider.html b/classes/chillerlan-OAuth-Core-OAuthProvider.html index d562c34b..82698c4d 100644 --- a/classes/chillerlan-OAuth-Core-OAuthProvider.html +++ b/classes/chillerlan-OAuth-Core-OAuthProvider.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

__get() +

@@ -1150,6 +1207,8 @@

public __get(string $name) : mixed|null +
+

Parameters
@@ -1158,18 +1217,17 @@
Parameters
: string
-
- +
+
Return values
- mixed|null - — - - + mixed|null +
+
Return values

getStorage() +

@@ -1194,12 +1253,15 @@

public getStorage() : OAuthStorageInterface +
+

Tags - + +
@@ -1216,13 +1278,13 @@
-
+ +
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

invalidateAccessToken() +

public - invalidateAccessToken([AccessToken $token = null ]) : bool + invalidateAccessToken([AccessToken|null $token = null ]) : bool +
+
Parameters
$token - : AccessToken + : AccessToken|null = null
-
- +
Tags - + +
@@ -1289,13 +1354,13 @@
-
+ +
Return values
- bool - — - - + bool +
+
Return values

me() +

@@ -1320,12 +1386,15 @@

public me() : ResponseInterface +
+

Tags - + +
@@ -1342,13 +1411,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

request() +

@@ -1372,8 +1442,10 @@

public - request(string $path[, array<string|int, mixed> $params = null ][, string $method = null ][, StreamInterface|array<string|int, mixed>|string $body = null ][, array<string|int, mixed> $headers = null ][, string $protocolVersion = null ]) : ResponseInterface + request(string $path[, array<string|int, mixed>|null $params = null ][, string|null $method = null ][, StreamInterface|array<string|int, mixed>|string|null $body = null ][, array<string|int, mixed>|null $headers = null ][, string|null $protocolVersion = null ]) : ResponseInterface +
+

Parameters
@@ -1382,55 +1454,50 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$method - : string + : string|null = null
-
- +
$body - : StreamInterface|array<string|int, mixed>|string + : StreamInterface|array<string|int, mixed>|string|null = null
-
- +
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$protocolVersion - : string + : string|null = null
-
- +
Tags - + +
@@ -1440,13 +1507,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

sendRequest() +

@@ -1470,6 +1538,8 @@

public sendRequest(RequestInterface $request) : ResponseInterface +
+

Parameters
@@ -1478,15 +1548,15 @@
Parameters
: RequestInterface
-
- +
Tags - + +
@@ -1496,13 +1566,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

setLogger() +

@@ -1527,6 +1598,8 @@

public setLogger(LoggerInterface $logger) : static +
+

Parameters
@@ -1535,15 +1608,15 @@
Parameters
: LoggerInterface
-
- +
Tags - + +
@@ -1560,13 +1633,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setRequestFactory() +

@@ -1591,6 +1665,8 @@

public setRequestFactory(RequestFactoryInterface $requestFactory) : static +
+

Parameters
@@ -1599,15 +1675,15 @@
Parameters
: RequestFactoryInterface
-
- +
Tags - + +
@@ -1624,13 +1700,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStorage() +

@@ -1655,6 +1732,8 @@

public setStorage(OAuthStorageInterface $storage) : static +
+

Parameters
@@ -1663,15 +1742,15 @@
Parameters
: OAuthStorageInterface
-
- +
Tags - + +
@@ -1688,13 +1767,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStreamFactory() +

@@ -1719,6 +1799,8 @@

public setStreamFactory(StreamFactoryInterface $streamFactory) : static +
+

Parameters
@@ -1727,15 +1809,15 @@
Parameters
: StreamFactoryInterface
-
- +
Tags - + +
@@ -1752,13 +1834,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setUriFactory() +

@@ -1783,6 +1866,8 @@

public setUriFactory(UriFactoryInterface $uriFactory) : static +
+

Parameters
@@ -1791,15 +1876,15 @@
Parameters
: UriFactoryInterface
-
- +
Tags - + +
@@ -1816,13 +1901,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

@@ -1847,6 +1933,8 @@

public storeAccessToken(AccessToken $token) : static +
+

Parameters
@@ -1855,15 +1943,15 @@
Parameters
: AccessToken
-
- +
Tags - + +
@@ -1880,13 +1968,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

cleanBodyParams() +

@@ -1909,28 +1998,29 @@

protected - cleanBodyParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanBodyParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

cleanQueryParams() +

@@ -1953,28 +2044,29 @@

protected - cleanQueryParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanQueryParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

createAccessToken() +

@@ -1999,15 +2092,17 @@

protected createAccessToken() : AccessToken +
+
+
Return values
- AccessToken - — - - + AccessToken +
+

Return values

getRequestBody() +

@@ -2032,6 +2128,8 @@

protected getRequestBody(StreamInterface|array<string|int, mixed>|string $body, RequestInterface $request) : StreamInterface +
+

Parameters
@@ -2040,23 +2138,22 @@
Parameters
: StreamInterface|array<string|int, mixed>|string
-
- +
$request : RequestInterface
-
- +
Tags - + +
@@ -2067,13 +2164,13 @@
-
+ +
Return values
- StreamInterface - — - - + StreamInterface +
+
Return values

getRequestHeaders() +

@@ -2096,28 +2194,29 @@

protected - getRequestHeaders([array<string|int, mixed> $headers = null ]) : array<string|int, mixed> + getRequestHeaders([array<string|int, mixed>|null $headers = null ]) : array<string|int, mixed> +
+

Parameters
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

getRequestTarget() +

@@ -2143,6 +2243,8 @@

protected getRequestTarget(string $uri) : string +
+

Throws if the given path is invalid or if the host of a given URL does not match $apiURL.

@@ -2153,15 +2255,15 @@

Parameters
: string
-
- +
Tags - + +
@@ -2180,13 +2282,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

getRequestURL() +

@@ -2209,8 +2312,10 @@

protected - getRequestURL(string $path[, array<string|int, mixed> $params = null ]) : string + getRequestURL(string $path[, array<string|int, mixed>|null $params = null ]) : string +
+

Parameters
@@ -2219,93 +2324,196 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- string - — - - -
+ string - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -2316,7 +2524,6 @@

Search results

- diff --git a/classes/chillerlan-OAuth-Core-ProviderException.html b/classes/chillerlan-OAuth-Core-ProviderException.html index 15f72d54..f5dc89c5 100644 --- a/classes/chillerlan-OAuth-Core-ProviderException.html +++ b/classes/chillerlan-OAuth-Core-ProviderException.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

getCSRFState() +

public - getCSRFState([string $service = null ]) : string + getCSRFState([string|null $service = null ]) : string +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -845,13 +941,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

getServiceName() +

@@ -874,25 +971,27 @@

public - getServiceName([string $service = null ]) : string + getServiceName([string|null $service = null ]) : string +
+

Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -902,13 +1001,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

hasAccessToken() +

public - hasAccessToken([string $service = null ]) : bool + hasAccessToken([string|null $service = null ]) : bool +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -958,13 +1060,13 @@
-
+ +
Return values
- bool - — - - + bool +
+
Return values

hasCSRFState() +

public - hasCSRFState([string $service = null ]) : bool + hasCSRFState([string|null $service = null ]) : bool +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -1014,13 +1119,80 @@
-
+ +
Return values
- bool - — - + bool +
+ +
+
+

+ setLogger() + + +

+ + +

Sets a logger. (LoggerAwareInterface is stupid)

+ + + public + setLogger(LoggerInterface $logger) : static + +
+
+ +
Parameters
+
+
+ $logger + : LoggerInterface +
+
+ +
+
+ +
+ Tags + + +
+
+
+ inheritDoc +
+
+ + +
+
+ codeCoverageIgnore +
+
+ + +
+
+ +
+
Return values
+ static +
+
Return values

setServiceName() +

@@ -1045,6 +1218,8 @@

public setServiceName(string $service) : static +
+

Parameters
@@ -1053,15 +1228,15 @@
Parameters
: string
-
- +
Tags - + +
@@ -1071,13 +1246,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

public - storeAccessToken(AccessToken $token[, string $service = null ]) : static + storeAccessToken(AccessToken $token[, string|null $service = null ]) : static +
+
Parameters
@@ -1109,23 +1287,22 @@
Parameters
: AccessToken
-
- +
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -1135,13 +1312,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeCSRFState() +

public - storeCSRFState(string $state[, string $service = null ]) : static + storeCSRFState(string $state[, string|null $service = null ]) : static +
+
Parameters
@@ -1173,23 +1353,22 @@
Parameters
: string
-
- +
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -1199,13 +1378,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

toStorage() +

@@ -1231,6 +1411,8 @@

public toStorage(AccessToken $token) : string +
+

Parameters
@@ -1239,15 +1421,15 @@
Parameters
: AccessToken
-
- +
Tags - + +
@@ -1257,80 +1439,162 @@
-
+ +
Return values
- string - — - - -
+ string - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -1341,7 +1605,6 @@

Search results

- diff --git a/classes/chillerlan-OAuth-Storage-OAuthStorageAbstract.html b/classes/chillerlan-OAuth-Storage-OAuthStorageAbstract.html index 5a948d53..48d3f90b 100644 --- a/classes/chillerlan-OAuth-Storage-OAuthStorageAbstract.html +++ b/classes/chillerlan-OAuth-Storage-OAuthStorageAbstract.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

fromStorage() +

@@ -368,6 +446,8 @@

public fromStorage(mixed $data) : AccessToken +
+

Parameters
@@ -376,15 +456,15 @@
Parameters
: mixed
-
- +
Tags - + +
@@ -394,13 +474,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getServiceName() +

@@ -423,25 +504,27 @@

public - getServiceName([string $service = null ]) : string + getServiceName([string|null $service = null ]) : string +
+

Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -451,13 +534,80 @@
-
+ +
Return values
- string - — - + string +
+ +
+
+

+ setLogger() + + +

+ + +

Sets a logger. (LoggerAwareInterface is stupid)

+ + + public + setLogger(LoggerInterface $logger) : static + +
+
+ +
Parameters
+
+
+ $logger + : LoggerInterface +
+
+ +
+
+ +
+ Tags + + +
+
+
+ inheritDoc +
+
+ + +
+
+ codeCoverageIgnore +
+
+ + +
+
+ +
+
Return values
+ static +
+
Return values

setServiceName() +

@@ -482,6 +633,8 @@

public setServiceName(string $service) : static +
+

Parameters
@@ -490,15 +643,15 @@
Parameters
: string
-
- +
Tags - + +
@@ -508,13 +661,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

toStorage() +

@@ -540,6 +694,8 @@

public toStorage(AccessToken $token) : string +
+

Parameters
@@ -548,15 +704,15 @@
Parameters
: AccessToken
-
- +
Tags - + +
@@ -566,80 +722,150 @@
-
+ +
Return values
- string - — - - -
+ string - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -650,7 +876,6 @@

Search results

- diff --git a/classes/chillerlan-OAuth-Storage-OAuthStorageException.html b/classes/chillerlan-OAuth-Storage-OAuthStorageException.html index a5a89bec..6ea3a584 100644 --- a/classes/chillerlan-OAuth-Storage-OAuthStorageException.html +++ b/classes/chillerlan-OAuth-Storage-OAuthStorageException.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

fromStorage() +

@@ -480,6 +530,8 @@

public fromStorage(mixed $data) : AccessToken +
+

Parameters
@@ -488,15 +540,15 @@
Parameters
: mixed
-
- +
Tags - + +
@@ -507,13 +559,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getAccessToken() +

@@ -536,25 +589,27 @@

public - getAccessToken([string $service = null ]) : AccessToken + getAccessToken([string|null $service = null ]) : AccessToken +
+

Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -565,13 +620,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getCSRFState() +

@@ -594,25 +650,27 @@

public - getCSRFState([string $service = null ]) : string + getCSRFState([string|null $service = null ]) : string +
+

Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -623,13 +681,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

getServiceName() +

@@ -652,25 +711,27 @@

public - getServiceName([string $service = null ]) : string + getServiceName([string|null $service = null ]) : string +
+

Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -681,13 +742,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

hasAccessToken() +

@@ -710,28 +772,29 @@

public - hasAccessToken([string $service = null ]) : bool + hasAccessToken([string|null $service = null ]) : bool +
+

Parameters
$service - : string + : string|null = null
-
- +
+
Return values
- bool - — - - + bool +
+
Return values

hasCSRFState() +

@@ -754,28 +818,75 @@

public - hasCSRFState([string $service = null ]) : bool + hasCSRFState([string|null $service = null ]) : bool +
+

Parameters
$service - : string + : string|null = null
-
- +
+
Return values
- bool - — - + bool +
+ +
+
+

+ setLogger() + + +

+ + +

Sets a logger. (LoggerAwareInterface is stupid)

+ + + public + setLogger(LoggerInterface $logger) : static + +
+
+ +
Parameters
+
+
+ $logger + : LoggerInterface +
+
+ +
+
+ + +
+
Return values
+ static +
+
Return values

setServiceName() +

@@ -800,6 +912,8 @@

public setServiceName(string $service) : static +
+

Parameters
@@ -808,15 +922,15 @@
Parameters
: string
-
- +
Tags - + +
@@ -827,13 +941,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

@@ -856,8 +971,10 @@

public - storeAccessToken(AccessToken $token[, string $service = null ]) : static + storeAccessToken(AccessToken $token[, string|null $service = null ]) : static +
+

Parameters
@@ -866,23 +983,22 @@
Parameters
: AccessToken
-
- +
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -893,13 +1009,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeCSRFState() +

@@ -922,8 +1039,10 @@

public - storeCSRFState(string $state[, string $service = null ]) : static + storeCSRFState(string $state[, string|null $service = null ]) : static +
+

Parameters
@@ -932,23 +1051,22 @@
Parameters
: string
-
- +
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -959,13 +1077,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

toStorage() +

@@ -991,6 +1110,8 @@

public toStorage(AccessToken $token) : mixed +
+

Parameters
@@ -999,15 +1120,15 @@
Parameters
: AccessToken
-
- +
Tags - + +
@@ -1018,80 +1139,146 @@
-
+ -
Return values
- mixed - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -1102,7 +1289,6 @@

Search results

- diff --git a/classes/chillerlan-OAuth-Storage-SessionStorage.html b/classes/chillerlan-OAuth-Storage-SessionStorage.html index b2bde4f4..9db63edb 100644 --- a/classes/chillerlan-OAuth-Storage-SessionStorage.html +++ b/classes/chillerlan-OAuth-Storage-SessionStorage.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

__destruct() +

@@ -503,12 +585,15 @@

public __destruct() : mixed +
+

Tags - + +
@@ -518,12 +603,8 @@
-
+ -
Return values
- mixed - — -
Return values

clearAccessToken() +

public - clearAccessToken([string $service = null ]) : static + clearAccessToken([string|null $service = null ]) : static +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -574,13 +658,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

clearAllAccessTokens() +

@@ -604,12 +689,15 @@

public clearAllAccessTokens() : static +
+

Tags - + +
@@ -619,13 +707,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

clearAllCSRFStates() +

@@ -649,12 +738,15 @@

public clearAllCSRFStates() : static +
+

Tags - + +
@@ -664,13 +756,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

clearCSRFState() +

public - clearCSRFState([string $service = null ]) : static + clearCSRFState([string|null $service = null ]) : static +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -720,13 +815,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

fromStorage() +

@@ -752,6 +848,8 @@

public fromStorage(mixed $data) : AccessToken +
+

Parameters
@@ -760,15 +858,15 @@
Parameters
: mixed
-
- +
Tags - + +
@@ -778,13 +876,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getAccessToken() +

public - getAccessToken([string $service = null ]) : AccessToken + getAccessToken([string|null $service = null ]) : AccessToken +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -834,13 +935,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getCSRFState() +

public - getCSRFState([string $service = null ]) : string + getCSRFState([string|null $service = null ]) : string +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -890,13 +994,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

getServiceName() +

@@ -919,25 +1024,27 @@

public - getServiceName([string $service = null ]) : string + getServiceName([string|null $service = null ]) : string +
+

Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -947,13 +1054,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

hasAccessToken() +

public - hasAccessToken([string $service = null ]) : bool + hasAccessToken([string|null $service = null ]) : bool +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -1003,13 +1113,13 @@
-
+ +
Return values
- bool - — - - + bool +
+
Return values

hasCSRFState() +

public - hasCSRFState([string $service = null ]) : bool + hasCSRFState([string|null $service = null ]) : bool +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -1059,13 +1172,80 @@
-
+ +
Return values
- bool - — - + bool +
+ +
+
+

+ setLogger() + + +

+ + +

Sets a logger. (LoggerAwareInterface is stupid)

+ + + public + setLogger(LoggerInterface $logger) : static + +
+
+
Parameters
+
+
+ $logger + : LoggerInterface +
+
+ +
+
+ + +
+ Tags + + +
+
+
+ inheritDoc +
+
+ + +
+
+ codeCoverageIgnore +
+
+ + +
+
+ +
+
Return values
+ static +
+
Return values

setServiceName() +

@@ -1090,6 +1271,8 @@

public setServiceName(string $service) : static +
+

Parameters
@@ -1098,15 +1281,15 @@
Parameters
: string
-
- +
Tags - + +
@@ -1116,13 +1299,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

public - storeAccessToken(AccessToken $token[, string $service = null ]) : static + storeAccessToken(AccessToken $token[, string|null $service = null ]) : static +
+
Parameters
@@ -1154,23 +1340,22 @@
Parameters
: AccessToken
-
- +
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -1180,13 +1365,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeCSRFState() +

public - storeCSRFState(string $state[, string $service = null ]) : static + storeCSRFState(string $state[, string|null $service = null ]) : static +
+
Parameters
@@ -1218,23 +1406,22 @@
Parameters
: string
-
- +
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -1244,13 +1431,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

toStorage() +

@@ -1276,6 +1464,8 @@

public toStorage(AccessToken $token) : string +
+

Parameters
@@ -1284,15 +1474,15 @@
Parameters
: AccessToken
-
- +
Tags - + +
@@ -1302,80 +1492,163 @@
-
+ +
Return values
- string - — - - -
+ string - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -1386,7 +1659,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Core-AccessTokenTest.html b/classes/chillerlan-OAuthTest-Core-AccessTokenTest.html index 1243005d..4a67fca6 100644 --- a/classes/chillerlan-OAuthTest-Core-AccessTokenTest.html +++ b/classes/chillerlan-OAuthTest-Core-AccessTokenTest.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

isExpiredDataProvider() +

@@ -310,16 +349,17 @@

public static isExpiredDataProvider() : array<string|int, mixed> -
- +
+
+ +
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

testDefaultsGetSet() +

@@ -343,8 +384,9 @@

public testDefaultsGetSet(string $property, mixed $value, mixed $data) : void -
- +
+
+

Parameters
@@ -352,33 +394,26 @@
Parameters
: string
-
- +
$value : mixed
-
- +
$data : mixed
-
- +
-
Return values
- void - — -
Return values

testIsExpired() +

@@ -403,8 +439,9 @@

public testIsExpired(int $expires, bool $isExpired) : void -
- +
+
+

Parameters
@@ -412,25 +449,19 @@
Parameters
: int
-
- +
$isExpired : bool
-
- +
-
Return values
- void - — -
Return values

testIsExpiredVariable() +

@@ -455,15 +487,12 @@

public testIsExpiredVariable() : void -
- +
+
+ -

Return values
- void - — -
Return values

testSetExpiry() +

@@ -488,8 +518,9 @@

public testSetExpiry(int|null $expires, int $expected) : void -
- +
+
+

Parameters
@@ -497,25 +528,19 @@
Parameters
: int|null
-
- +
$expected : int
-
- +
-
Return values
- void - — -
Return values

tokenDataProvider() +

@@ -540,16 +566,17 @@

public static tokenDataProvider() : array<string|int, mixed> -
- +
+
+ +
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+

Return values

setUp() +

@@ -573,83 +601,150 @@

protected setUp() : void -
- +
+
+ -

Return values
- void - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -660,7 +755,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-OAuthTestMemoryStorage.html b/classes/chillerlan-OAuthTest-OAuthTestMemoryStorage.html index 19cfcb4f..82194610 100644 --- a/classes/chillerlan-OAuthTest-OAuthTestMemoryStorage.html +++ b/classes/chillerlan-OAuthTest-OAuthTestMemoryStorage.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

clearAccessToken() +

public - clearAccessToken([string $service = null ]) : static + clearAccessToken([string|null $service = null ]) : static +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -569,13 +643,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

clearAllAccessTokens() +

@@ -599,12 +674,15 @@

public clearAllAccessTokens() : static +
+

Tags - + +
@@ -614,13 +692,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

clearAllCSRFStates() +

@@ -644,12 +723,15 @@

public clearAllCSRFStates() : static +
+

Tags - + +
@@ -659,13 +741,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

clearCSRFState() +

public - clearCSRFState([string $service = null ]) : static + clearCSRFState([string|null $service = null ]) : static +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -715,13 +800,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

fromStorage() +

@@ -747,6 +833,8 @@

public fromStorage(mixed $data) : AccessToken +
+

Parameters
@@ -755,15 +843,15 @@
Parameters
: mixed
-
- +
Tags - + +
@@ -773,13 +861,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getAccessToken() +

@@ -803,6 +892,8 @@

public getAccessToken([string $service = null ]) : AccessToken +
+

Parameters
@@ -811,15 +902,15 @@
Parameters
: string = null
-
- +
Tags - + +
@@ -829,13 +920,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getCSRFState() +

public - getCSRFState([string $service = null ]) : string + getCSRFState([string|null $service = null ]) : string +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -885,13 +979,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

getServiceName() +

@@ -914,25 +1009,27 @@

public - getServiceName([string $service = null ]) : string + getServiceName([string|null $service = null ]) : string +
+

Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -942,13 +1039,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

hasAccessToken() +

public - hasAccessToken([string $service = null ]) : bool + hasAccessToken([string|null $service = null ]) : bool +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -998,13 +1098,13 @@
-
+ +
Return values
- bool - — - - + bool +
+
Return values

hasCSRFState() +

public - hasCSRFState([string $service = null ]) : bool + hasCSRFState([string|null $service = null ]) : bool +
+
Parameters
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -1054,13 +1157,80 @@
-
+ +
Return values
- bool - — - + bool +
+ +
+
+

+ setLogger() + + +

+ + +

Sets a logger. (LoggerAwareInterface is stupid)

+ + + public + setLogger(LoggerInterface $logger) : static + +
+
+
Parameters
+
+
+ $logger + : LoggerInterface +
+
+ +
+
+ + +
+ Tags + + +
+
+
+ inheritDoc +
+
+ + +
+
+ codeCoverageIgnore +
+
+ + +
+
+ +
+
Return values
+ static +
+
Return values

setServiceName() +

@@ -1085,6 +1256,8 @@

public setServiceName(string $service) : static +
+

Parameters
@@ -1093,15 +1266,15 @@
Parameters
: string
-
- +
Tags - + +
@@ -1111,13 +1284,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

@@ -1141,6 +1315,8 @@

public storeAccessToken(AccessToken $token[, string $service = null ]) : static +
+

Parameters
@@ -1149,23 +1325,22 @@
Parameters
: AccessToken
-
- +
$service : string = null
-
- +
Tags - + +
@@ -1175,13 +1350,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeCSRFState() +

public - storeCSRFState(string $state[, string $service = null ]) : static + storeCSRFState(string $state[, string|null $service = null ]) : static +
+
Parameters
@@ -1213,23 +1391,22 @@
Parameters
: string
-
- +
$service - : string + : string|null = null
-
- +
Tags - + +
@@ -1239,13 +1416,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

toStorage() +

@@ -1271,6 +1449,8 @@

public toStorage(AccessToken $token) : string +
+

Parameters
@@ -1279,15 +1459,15 @@
Parameters
: AccessToken
-
- +
Tags - + +
@@ -1297,80 +1477,163 @@
-
+ +
Return values
- string - — - - -
+ string - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -1381,7 +1644,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Providers-OAuth1-DummyOAuth1Provider.html b/classes/chillerlan-OAuthTest-Providers-OAuth1-DummyOAuth1Provider.html index c5eb0b85..9e4533cf 100644 --- a/classes/chillerlan-OAuthTest-Providers-OAuth1-DummyOAuth1Provider.html +++ b/classes/chillerlan-OAuthTest-Providers-OAuth1-DummyOAuth1Provider.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

__get() +

@@ -1228,6 +1269,8 @@

public __get(string $name) : mixed|null +
+

Parameters
@@ -1236,18 +1279,17 @@
Parameters
: string
-
- +
+
Return values
- mixed|null - — - - + mixed|null +
+
Return values

getAccessToken() +

@@ -1272,6 +1315,8 @@

public getAccessToken(string $token, string $verifier) : AccessToken +
+

Parameters
@@ -1280,23 +1325,22 @@
Parameters
: string
-
- +
$verifier : string
-
- +
Tags - + +
@@ -1306,13 +1350,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getAuthURL() +

public - getAuthURL([array<string|int, mixed> $params = null ]) : UriInterface + getAuthURL([array<string|int, mixed>|null $params = null ]) : UriInterface +
+
Parameters
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
Tags - + +
@@ -1362,13 +1409,13 @@
-
+ +
Return values
- UriInterface - — - - + UriInterface +
+
Return values

getRequestAuthorization() +

@@ -1392,6 +1440,8 @@

public getRequestAuthorization(RequestInterface $request, AccessToken $token) : RequestInterface +
+

Parameters
@@ -1400,23 +1450,22 @@
Parameters
: RequestInterface
-
- +
$token : AccessToken
-
- +
Tags - + +
@@ -1426,13 +1475,13 @@
-
+ +
Return values
- RequestInterface - — - - + RequestInterface +
+
Return values

getRequestToken() +

@@ -1457,12 +1507,15 @@

public getRequestToken() : AccessToken +
+

Tags - + +
@@ -1472,13 +1525,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getStorage() +

@@ -1503,12 +1557,15 @@

public getStorage() : OAuthStorageInterface +
+

Tags - + +
@@ -1525,13 +1582,13 @@
-
+ +
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

invalidateAccessToken() +

@@ -1556,6 +1614,8 @@

public invalidateAccessToken([AccessToken $token = null ]) : bool +
+

Parameters
@@ -1564,15 +1624,15 @@
Parameters
: AccessToken = null
-
- +
Tags - + +
@@ -1582,13 +1642,13 @@
-
+ +
Return values
- bool - — - - + bool +
+
Return values

me() +

@@ -1613,12 +1674,15 @@

public me() : ResponseInterface +
+

Tags - + +
@@ -1635,13 +1699,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

request() +

@@ -1665,8 +1730,10 @@

public - request(string $path[, array<string|int, mixed> $params = null ][, string $method = null ][, StreamInterface|array<string|int, mixed>|string $body = null ][, array<string|int, mixed> $headers = null ][, string $protocolVersion = null ]) : ResponseInterface + request(string $path[, array<string|int, mixed>|null $params = null ][, string|null $method = null ][, StreamInterface|array<string|int, mixed>|string|null $body = null ][, array<string|int, mixed>|null $headers = null ][, string|null $protocolVersion = null ]) : ResponseInterface +
+

Parameters
@@ -1675,55 +1742,50 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$method - : string + : string|null = null
-
- +
$body - : StreamInterface|array<string|int, mixed>|string + : StreamInterface|array<string|int, mixed>|string|null = null
-
- +
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$protocolVersion - : string + : string|null = null
-
- +
Tags - + +
@@ -1733,13 +1795,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

sendRequest() +

@@ -1763,6 +1826,8 @@

public sendRequest(RequestInterface $request) : ResponseInterface +
+

Parameters
@@ -1771,15 +1836,15 @@
Parameters
: RequestInterface
-
- +
Tags - + +
@@ -1789,13 +1854,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

setLogger() +

@@ -1820,6 +1886,8 @@

public setLogger(LoggerInterface $logger) : static +
+

Parameters
@@ -1828,15 +1896,15 @@
Parameters
: LoggerInterface
-
- +
Tags - + +
@@ -1853,13 +1921,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setRequestFactory() +

@@ -1884,6 +1953,8 @@

public setRequestFactory(RequestFactoryInterface $requestFactory) : static +
+

Parameters
@@ -1892,15 +1963,15 @@
Parameters
: RequestFactoryInterface
-
- +
Tags - + +
@@ -1917,13 +1988,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStorage() +

@@ -1948,6 +2020,8 @@

public setStorage(OAuthStorageInterface $storage) : static +
+

Parameters
@@ -1956,15 +2030,15 @@
Parameters
: OAuthStorageInterface
-
- +
Tags - + +
@@ -1981,13 +2055,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStreamFactory() +

@@ -2012,6 +2087,8 @@

public setStreamFactory(StreamFactoryInterface $streamFactory) : static +
+

Parameters
@@ -2020,15 +2097,15 @@
Parameters
: StreamFactoryInterface
-
- +
Tags - + +
@@ -2045,13 +2122,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setUriFactory() +

@@ -2076,6 +2154,8 @@

public setUriFactory(UriFactoryInterface $uriFactory) : static +
+

Parameters
@@ -2084,15 +2164,15 @@
Parameters
: UriFactoryInterface
-
- +
Tags - + +
@@ -2109,13 +2189,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

@@ -2140,6 +2221,8 @@

public storeAccessToken(AccessToken $token) : static +
+

Parameters
@@ -2148,15 +2231,15 @@
Parameters
: AccessToken
-
- +
Tags - + +
@@ -2173,13 +2256,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

cleanBodyParams() +

@@ -2202,28 +2286,29 @@

protected - cleanBodyParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanBodyParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

cleanQueryParams() +

@@ -2246,28 +2332,29 @@

protected - cleanQueryParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanQueryParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

createAccessToken() +

@@ -2292,15 +2380,17 @@

protected createAccessToken() : AccessToken +
+
+
Return values
- AccessToken - — - - + AccessToken +
+

Return values

getRequestBody() +

@@ -2325,6 +2416,8 @@

protected getRequestBody(StreamInterface|array<string|int, mixed>|string $body, RequestInterface $request) : StreamInterface +
+

Parameters
@@ -2333,23 +2426,22 @@
Parameters
: StreamInterface|array<string|int, mixed>|string
-
- +
$request : RequestInterface
-
- +
Tags - + +
@@ -2360,13 +2452,13 @@
-
+ +
Return values
- StreamInterface - — - - + StreamInterface +
+
Return values

getRequestHeaders() +

@@ -2389,28 +2482,29 @@

protected - getRequestHeaders([array<string|int, mixed> $headers = null ]) : array<string|int, mixed> + getRequestHeaders([array<string|int, mixed>|null $headers = null ]) : array<string|int, mixed> +
+

Parameters
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

getRequestTarget() +

@@ -2436,6 +2531,8 @@

protected getRequestTarget(string $uri) : string +
+

Throws if the given path is invalid or if the host of a given URL does not match $apiURL.

@@ -2446,15 +2543,15 @@

Parameters
: string
-
- +
Tags - + +
@@ -2473,13 +2570,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

getRequestURL() +

@@ -2502,8 +2600,10 @@

protected - getRequestURL(string $path[, array<string|int, mixed> $params = null ]) : string + getRequestURL(string $path[, array<string|int, mixed>|null $params = null ]) : string +
+

Parameters
@@ -2512,26 +2612,24 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- string - — - - + string +
+
Return values

getSignature() +

@@ -2554,8 +2653,10 @@

protected - getSignature(string $url, array<string|int, mixed> $params, string $method[, string $accessTokenSecret = null ]) : string + getSignature(string $url, array<string|int, mixed> $params, string $method[, string|null $accessTokenSecret = null ]) : string +
+

Parameters
@@ -2564,39 +2665,36 @@
Parameters
: string
-
- +
$params : array<string|int, mixed>
-
- +
$method : string
-
- +
$accessTokenSecret - : string + : string|null = null
-
- +
Tags - + +
@@ -2614,13 +2712,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

nonce() +

@@ -2645,15 +2744,17 @@

protected nonce() : string +
+
+
Return values
- string - — - - + string +
+

Return values

parseTokenResponse() +

@@ -2676,8 +2778,10 @@

protected - parseTokenResponse(ResponseInterface $response[, bool $checkCallbackConfirmed = null ]) : AccessToken + parseTokenResponse(ResponseInterface $response, bool $checkCallbackConfirmed) : AccessToken +
+

Parameters
@@ -2686,23 +2790,22 @@
Parameters
: ResponseInterface
-
- +
$checkCallbackConfirmed : bool - = null
+
-
- +
Tags - + +
@@ -2720,80 +2823,193 @@
-
+ +
Return values
- AccessToken - — - - -
+ AccessToken - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -2804,7 +3020,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Providers-OAuth1-DummyOAuth1Test.html b/classes/chillerlan-OAuthTest-Providers-OAuth1-DummyOAuth1Test.html index 288c5c2c..9e6d1d8e 100644 --- a/classes/chillerlan-OAuthTest-Providers-OAuth1-DummyOAuth1Test.html +++ b/classes/chillerlan-OAuthTest-Providers-OAuth1-DummyOAuth1Test.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

testGetAccessToken() +

@@ -1042,15 +1036,12 @@

public testGetAccessToken() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetAuthURL() +

@@ -1075,15 +1067,12 @@

public testGetAuthURL() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetRequestAuthorization() +

@@ -1108,15 +1098,12 @@

public testGetRequestAuthorization() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetRequestTarget() +

@@ -1141,8 +1129,9 @@

public testGetRequestTarget(string $path, string $expected) : void -
- +
+
+

Parameters
@@ -1150,25 +1139,19 @@
Parameters
: string
-
- +
$expected : string
-
- +
-
Return values
- void - — -
Return values

testGetSignature() +

@@ -1193,15 +1177,12 @@

public testGetSignature() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetSignatureInvalidURLException() +

@@ -1226,15 +1208,12 @@

public testGetSignatureInvalidURLException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testMagicGet() +

@@ -1259,15 +1239,12 @@

public testMagicGet() : void -
- +
+
+ -

Return values
- void - — -
Return values

testOAuth1Instance() +

@@ -1292,15 +1270,12 @@

public testOAuth1Instance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testOAuthInstance() +

@@ -1325,15 +1301,12 @@

public testOAuthInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseCallbackUnconfirmedException() +

@@ -1358,15 +1332,12 @@

public testParseTokenResponseCallbackUnconfirmedException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseErrorException() +

@@ -1391,15 +1363,12 @@

public testParseTokenResponseErrorException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseNoDataException() +

@@ -1424,15 +1394,12 @@

public testParseTokenResponseNoDataException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseNoTokenException() +

@@ -1457,15 +1425,12 @@

public testParseTokenResponseNoTokenException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testProviderInstance() +

@@ -1490,15 +1456,12 @@

public testProviderInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequest() +

@@ -1523,15 +1487,12 @@

public testRequest() : void -
- +
+
+ -

Return values
- void - — -
Return values

testTokenInvalidate() +

@@ -1556,15 +1518,12 @@

public testTokenInvalidate() : void -
- +
+
+ -

Return values
- void - — -
Return values

initFactories() +

@@ -1589,15 +1549,12 @@

protected initFactories() : void -
- +
+
+ -

Return values
- void - — -
Return values

initHttp() +

@@ -1622,8 +1580,9 @@

protected initHttp(SettingsContainerInterface $options, LoggerInterface $logger, array<string|int, mixed> $responses) : ClientInterface -
- +
+
+

Parameters
@@ -1631,34 +1590,31 @@
Parameters
: SettingsContainerInterface
-
- +
$logger : LoggerInterface
-
- +
$responses : array<string|int, mixed>
-
- +
+
Return values
- ClientInterface - — - - + ClientInterface +
+
Return values

initLogger() +

@@ -1682,8 +1639,9 @@

protected initLogger(bool $is_ci) : LoggerInterface -
- +
+
+

Parameters
@@ -1691,18 +1649,17 @@
Parameters
: bool
-
- +
+
Return values
- LoggerInterface - — - - + LoggerInterface +
+
Return values

initOptions() +

@@ -1726,16 +1684,17 @@

protected initOptions() : SettingsContainerInterface -
- +
+
+ +
Return values
- SettingsContainerInterface - — - - + SettingsContainerInterface +
+

Return values

initProvider() +

@@ -1759,16 +1719,17 @@

protected initProvider() : OAuthInterface|OAuth1Interface|OAuth2Interface -
- +
+
+ +
Return values
- OAuthInterface|OAuth1Interface|OAuth2Interface - — - - + OAuthInterface|OAuth1Interface|OAuth2Interface +
+

Return values

initStorage() +

@@ -1792,8 +1754,9 @@

protected initStorage(SettingsContainerInterface $options) : OAuthStorageInterface -
- +
+
+

Parameters
@@ -1801,18 +1764,17 @@
Parameters
: SettingsContainerInterface
-
- +
+
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

initTestProperties() +

@@ -1836,8 +1799,9 @@

protected initTestProperties(array<string|int, mixed> $properties) : void -
- +
+
+

Parameters
@@ -1845,17 +1809,12 @@
Parameters
: array<string|int, mixed>
-
- +
-
Return values
- void - — -
Return values

setUp() +

@@ -1880,83 +1840,182 @@

protected setUp() : void -
- +
+
+ -

Return values
- void - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -1967,7 +2026,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Providers-OAuth1ProviderTestAbstract.html b/classes/chillerlan-OAuthTest-Providers-OAuth1ProviderTestAbstract.html index 0ed8ecc3..f1aa039f 100644 --- a/classes/chillerlan-OAuthTest-Providers-OAuth1ProviderTestAbstract.html +++ b/classes/chillerlan-OAuthTest-Providers-OAuth1ProviderTestAbstract.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

testGetAccessToken() +

@@ -1001,15 +996,12 @@

public testGetAccessToken() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetAuthURL() +

@@ -1034,15 +1027,12 @@

public testGetAuthURL() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetRequestAuthorization() +

@@ -1067,15 +1058,12 @@

public testGetRequestAuthorization() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetRequestTarget() +

@@ -1100,8 +1089,9 @@

public testGetRequestTarget(string $path, string $expected) : void -
- +
+
+

Parameters
@@ -1109,25 +1099,19 @@
Parameters
: string
-
- +
$expected : string
-
- +
-
Return values
- void - — -
Return values

testGetSignature() +

@@ -1152,15 +1137,12 @@

public testGetSignature() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetSignatureInvalidURLException() +

@@ -1185,15 +1168,12 @@

public testGetSignatureInvalidURLException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testMagicGet() +

@@ -1218,15 +1199,12 @@

public testMagicGet() : void -
- +
+
+ -

Return values
- void - — -
Return values

testOAuth1Instance() +

@@ -1251,15 +1230,12 @@

public testOAuth1Instance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testOAuthInstance() +

@@ -1284,15 +1261,12 @@

public testOAuthInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseCallbackUnconfirmedException() +

@@ -1317,15 +1292,12 @@

public testParseTokenResponseCallbackUnconfirmedException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseErrorException() +

@@ -1350,15 +1323,12 @@

public testParseTokenResponseErrorException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseNoDataException() +

@@ -1383,15 +1354,12 @@

public testParseTokenResponseNoDataException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseNoTokenException() +

@@ -1416,15 +1385,12 @@

public testParseTokenResponseNoTokenException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testProviderInstance() +

@@ -1449,15 +1416,12 @@

public testProviderInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequest() +

@@ -1482,15 +1447,12 @@

public testRequest() : void -
- +
+
+ -

Return values
- void - — -
Return values

testTokenInvalidate() +

@@ -1515,15 +1478,12 @@

public testTokenInvalidate() : void -
- +
+
+ -

Return values
- void - — -
Return values

initFactories() +

@@ -1548,15 +1509,12 @@

protected initFactories() : void -
- +
+
+ -

Return values
- void - — -
Return values

initHttp() +

@@ -1581,8 +1540,9 @@

protected initHttp(SettingsContainerInterface $options, LoggerInterface $logger, array<string|int, mixed> $responses) : ClientInterface -
- +
+
+

Parameters
@@ -1590,34 +1550,31 @@
Parameters
: SettingsContainerInterface
-
- +
$logger : LoggerInterface
-
- +
$responses : array<string|int, mixed>
-
- +
+
Return values
- ClientInterface - — - - + ClientInterface +
+
Return values

initLogger() +

@@ -1641,8 +1599,9 @@

protected initLogger(bool $is_ci) : LoggerInterface -
- +
+
+

Parameters
@@ -1650,18 +1609,17 @@
Parameters
: bool
-
- +
+
Return values
- LoggerInterface - — - - + LoggerInterface +
+
Return values

initOptions() +

@@ -1685,16 +1644,17 @@

protected initOptions() : SettingsContainerInterface -
- +
+
+ +
Return values
- SettingsContainerInterface - — - - + SettingsContainerInterface +
+

Return values

initProvider() +

@@ -1718,16 +1679,17 @@

protected initProvider() : OAuthInterface|OAuth1Interface|OAuth2Interface -
- +
+
+ +
Return values
- OAuthInterface|OAuth1Interface|OAuth2Interface - — - - + OAuthInterface|OAuth1Interface|OAuth2Interface +
+

Return values

initStorage() +

@@ -1751,8 +1714,9 @@

protected initStorage(SettingsContainerInterface $options) : OAuthStorageInterface -
- +
+
+

Parameters
@@ -1760,18 +1724,17 @@
Parameters
: SettingsContainerInterface
-
- +
+
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

initTestProperties() +

@@ -1795,8 +1759,9 @@

protected initTestProperties(array<string|int, mixed> $properties) : void -
- +
+
+

Parameters
@@ -1804,17 +1769,12 @@
Parameters
: array<string|int, mixed>
-
- +
-
Return values
- void - — -
Return values

setUp() +

@@ -1839,83 +1800,181 @@

protected setUp() : void -
- +
+
+ -

Return values
- void - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -1926,7 +1985,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2BasicProvider.html b/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2BasicProvider.html index 247d9679..5d9d202d 100644 --- a/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2BasicProvider.html +++ b/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2BasicProvider.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

__get() +

@@ -1490,6 +1542,8 @@

public __get(string $name) : mixed|null +
+

Parameters
@@ -1498,18 +1552,17 @@
Parameters
: string
-
- +
+
Return values
- mixed|null - — - - + mixed|null +
+
Return values

getAccessToken() +

@@ -1533,8 +1587,10 @@

public - getAccessToken(string $code[, string $state = null ]) : AccessToken + getAccessToken(string $code[, string|null $state = null ]) : AccessToken +
+

Parameters
@@ -1543,23 +1599,22 @@
Parameters
: string
-
- +
$state - : string + : string|null = null
-
- +
Tags - + +
@@ -1569,13 +1624,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getAuthURL() +

@@ -1599,21 +1655,23 @@

public - getAuthURL([array<string|int, mixed> $params = null ][, array<string|int, mixed> $scopes = null ]) : UriInterface + getAuthURL([array<string|int, mixed>|null $params = null ][, array<string|int, mixed>|null $scopes = null ]) : UriInterface +
+

Parameters
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
$scopes - : array<string|int, mixed> + : array<string|int, mixed>|null = null
@@ -1623,7 +1681,8 @@
Parameters
Tags - + +
@@ -1633,13 +1692,13 @@
-
+ +
Return values
- UriInterface - — - - + UriInterface +
+
Return values

getClientCredentialsToken() +

public - getClientCredentialsToken([array<string|int, mixed> $scopes = null ]) : AccessToken + getClientCredentialsToken([array<string|int, mixed>|null $scopes = null ]) : AccessToken +
+
Parameters
$scopes - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
Tags - + +
@@ -1699,13 +1761,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getRequestAuthorization() +

@@ -1729,6 +1792,8 @@

public getRequestAuthorization(RequestInterface $request, AccessToken $token) : RequestInterface +
+

Parameters
@@ -1737,23 +1802,22 @@
Parameters
: RequestInterface
-
- +
$token : AccessToken
-
- +
Tags - + +
@@ -1763,13 +1827,13 @@
-
+ +
Return values
- RequestInterface - — - - + RequestInterface +
+
Return values

getStorage() +

@@ -1794,12 +1859,15 @@

public getStorage() : OAuthStorageInterface +
+

Tags - + +
@@ -1816,13 +1884,13 @@
-
+ +
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

invalidateAccessToken() +

public - invalidateAccessToken([AccessToken $token = null ]) : bool + invalidateAccessToken([AccessToken|null $token = null ]) : bool +
+
Parameters
$token - : AccessToken + : AccessToken|null = null
-
- +
Tags - + +
@@ -1889,13 +1960,13 @@
-
+ +
Return values
- bool - — - - + bool +
+
Return values

me() +

@@ -1920,12 +1992,15 @@

public me() : ResponseInterface +
+

Tags - + +
@@ -1942,13 +2017,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

refreshAccessToken() +

public - refreshAccessToken([AccessToken $token = null ]) : AccessToken + refreshAccessToken([AccessToken|null $token = null ]) : AccessToken +
+
Parameters
$token - : AccessToken + : AccessToken|null = null
-
- +
Tags - + +
@@ -2008,13 +2086,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

request() +

@@ -2038,8 +2117,10 @@

public - request(string $path[, array<string|int, mixed> $params = null ][, string $method = null ][, StreamInterface|array<string|int, mixed>|string $body = null ][, array<string|int, mixed> $headers = null ][, string $protocolVersion = null ]) : ResponseInterface + request(string $path[, array<string|int, mixed>|null $params = null ][, string|null $method = null ][, StreamInterface|array<string|int, mixed>|string|null $body = null ][, array<string|int, mixed>|null $headers = null ][, string|null $protocolVersion = null ]) : ResponseInterface +
+

Parameters
@@ -2048,55 +2129,50 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$method - : string + : string|null = null
-
- +
$body - : StreamInterface|array<string|int, mixed>|string + : StreamInterface|array<string|int, mixed>|string|null = null
-
- +
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$protocolVersion - : string + : string|null = null
-
- +
Tags - + +
@@ -2106,13 +2182,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

sendRequest() +

@@ -2136,6 +2213,8 @@

public sendRequest(RequestInterface $request) : ResponseInterface +
+

Parameters
@@ -2144,15 +2223,15 @@
Parameters
: RequestInterface
-
- +
Tags - + +
@@ -2162,13 +2241,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

setLogger() +

@@ -2193,6 +2273,8 @@

public setLogger(LoggerInterface $logger) : static +
+

Parameters
@@ -2201,15 +2283,15 @@
Parameters
: LoggerInterface
-
- +
Tags - + +
@@ -2226,13 +2308,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setRequestFactory() +

@@ -2257,6 +2340,8 @@

public setRequestFactory(RequestFactoryInterface $requestFactory) : static +
+

Parameters
@@ -2265,15 +2350,15 @@
Parameters
: RequestFactoryInterface
-
- +
Tags - + +
@@ -2290,13 +2375,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStorage() +

@@ -2321,6 +2407,8 @@

public setStorage(OAuthStorageInterface $storage) : static +
+

Parameters
@@ -2329,15 +2417,15 @@
Parameters
: OAuthStorageInterface
-
- +
Tags - + +
@@ -2354,13 +2442,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStreamFactory() +

@@ -2385,6 +2474,8 @@

public setStreamFactory(StreamFactoryInterface $streamFactory) : static +
+

Parameters
@@ -2393,15 +2484,15 @@
Parameters
: StreamFactoryInterface
-
- +
Tags - + +
@@ -2418,13 +2509,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setUriFactory() +

@@ -2449,6 +2541,8 @@

public setUriFactory(UriFactoryInterface $uriFactory) : static +
+

Parameters
@@ -2457,15 +2551,15 @@
Parameters
: UriFactoryInterface
-
- +
Tags - + +
@@ -2482,13 +2576,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

@@ -2513,6 +2608,8 @@

public storeAccessToken(AccessToken $token) : static +
+

Parameters
@@ -2521,15 +2618,15 @@
Parameters
: AccessToken
-
- +
Tags - + +
@@ -2546,13 +2643,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

cleanBodyParams() +

@@ -2575,28 +2673,29 @@

protected - cleanBodyParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanBodyParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

cleanQueryParams() +

@@ -2619,28 +2719,29 @@

protected - cleanQueryParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanQueryParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

createAccessToken() +

@@ -2665,15 +2767,17 @@

protected createAccessToken() : AccessToken +
+
+
Return values
- AccessToken - — - - + AccessToken +
+

Return values

getRequestBody() +

@@ -2698,6 +2803,8 @@

protected getRequestBody(StreamInterface|array<string|int, mixed>|string $body, RequestInterface $request) : StreamInterface +
+

Parameters
@@ -2706,23 +2813,22 @@
Parameters
: StreamInterface|array<string|int, mixed>|string
-
- +
$request : RequestInterface
-
- +
Tags - + +
@@ -2733,13 +2839,13 @@
-
+ +
Return values
- StreamInterface - — - - + StreamInterface +
+
Return values

getRequestHeaders() +

@@ -2762,28 +2869,29 @@

protected - getRequestHeaders([array<string|int, mixed> $headers = null ]) : array<string|int, mixed> + getRequestHeaders([array<string|int, mixed>|null $headers = null ]) : array<string|int, mixed> +
+

Parameters
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

getRequestTarget() +

@@ -2809,6 +2918,8 @@

protected getRequestTarget(string $uri) : string +
+

Throws if the given path is invalid or if the host of a given URL does not match $apiURL.

@@ -2819,15 +2930,15 @@

Parameters
: string
-
- +
Tags - + +
@@ -2846,13 +2957,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

getRequestURL() +

@@ -2875,8 +2987,10 @@

protected - getRequestURL(string $path[, array<string|int, mixed> $params = null ]) : string + getRequestURL(string $path[, array<string|int, mixed>|null $params = null ]) : string +
+

Parameters
@@ -2885,26 +2999,24 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- string - — - - + string +
+
Return values

parseTokenResponse() +

@@ -2929,6 +3042,8 @@

protected parseTokenResponse(ResponseInterface $response) : AccessToken +
+

Parameters
@@ -2937,15 +3052,15 @@
Parameters
: ResponseInterface
-
- +
Tags - + +
@@ -2971,80 +3086,198 @@
-
+ +
Return values
- AccessToken - — - - -
+ AccessToken - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -3055,7 +3288,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2Provider.html b/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2Provider.html index fe69ef6b..58869fc1 100644 --- a/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2Provider.html +++ b/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2Provider.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

__get() +

@@ -1497,6 +1532,8 @@

public __get(string $name) : mixed|null +
+

Parameters
@@ -1505,18 +1542,17 @@
Parameters
: string
-
- +
+
Return values
- mixed|null - — - - + mixed|null +
+
Return values

getAccessToken() +

@@ -1540,8 +1577,10 @@

public - getAccessToken(string $code[, string $state = null ]) : AccessToken + getAccessToken(string $code[, string|null $state = null ]) : AccessToken +
+

Parameters
@@ -1550,23 +1589,22 @@
Parameters
: string
-
- +
$state - : string + : string|null = null
-
- +
Tags - + +
@@ -1576,13 +1614,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getAuthURL() +

@@ -1606,21 +1645,23 @@

public - getAuthURL([array<string|int, mixed> $params = null ][, array<string|int, mixed> $scopes = null ]) : UriInterface + getAuthURL([array<string|int, mixed>|null $params = null ][, array<string|int, mixed>|null $scopes = null ]) : UriInterface +
+

Parameters
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
$scopes - : array<string|int, mixed> + : array<string|int, mixed>|null = null
@@ -1630,7 +1671,8 @@
Parameters
Tags - + +
@@ -1640,13 +1682,13 @@
-
+ +
Return values
- UriInterface - — - - + UriInterface +
+
Return values

getClientCredentialsToken() +

public - getClientCredentialsToken([array<string|int, mixed> $scopes = null ]) : AccessToken + getClientCredentialsToken([array<string|int, mixed>|null $scopes = null ]) : AccessToken +
+
Parameters
$scopes - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
Tags - + +
@@ -1706,13 +1751,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

getRequestAuthorization() +

@@ -1736,6 +1782,8 @@

public getRequestAuthorization(RequestInterface $request, AccessToken $token) : RequestInterface +
+

Parameters
@@ -1744,23 +1792,22 @@
Parameters
: RequestInterface
-
- +
$token : AccessToken
-
- +
Tags - + +
@@ -1770,13 +1817,13 @@
-
+ +
Return values
- RequestInterface - — - - + RequestInterface +
+
Return values

getStorage() +

@@ -1801,12 +1849,15 @@

public getStorage() : OAuthStorageInterface +
+

Tags - + +
@@ -1823,13 +1874,13 @@
-
+ +
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

invalidateAccessToken() +

@@ -1854,6 +1906,8 @@

public invalidateAccessToken([AccessToken $token = null ]) : bool +
+

Parameters
@@ -1862,15 +1916,15 @@
Parameters
: AccessToken = null
-
- +
Tags - + +
@@ -1880,13 +1934,13 @@
-
+ +
Return values
- bool - — - - + bool +
+
Return values

me() +

@@ -1911,12 +1966,15 @@

public me() : ResponseInterface +
+

Tags - + +
@@ -1933,13 +1991,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

refreshAccessToken() +

public - refreshAccessToken([AccessToken $token = null ]) : AccessToken + refreshAccessToken([AccessToken|null $token = null ]) : AccessToken +
+
Parameters
$token - : AccessToken + : AccessToken|null = null
-
- +
Tags - + +
@@ -1999,13 +2060,13 @@
-
+ +
Return values
- AccessToken - — - - + AccessToken +
+
Return values

request() +

@@ -2029,8 +2091,10 @@

public - request(string $path[, array<string|int, mixed> $params = null ][, string $method = null ][, StreamInterface|array<string|int, mixed>|string $body = null ][, array<string|int, mixed> $headers = null ][, string $protocolVersion = null ]) : ResponseInterface + request(string $path[, array<string|int, mixed>|null $params = null ][, string|null $method = null ][, StreamInterface|array<string|int, mixed>|string|null $body = null ][, array<string|int, mixed>|null $headers = null ][, string|null $protocolVersion = null ]) : ResponseInterface +
+

Parameters
@@ -2039,55 +2103,50 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$method - : string + : string|null = null
-
- +
$body - : StreamInterface|array<string|int, mixed>|string + : StreamInterface|array<string|int, mixed>|string|null = null
-
- +
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$protocolVersion - : string + : string|null = null
-
- +
Tags - + +
@@ -2097,13 +2156,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

sendRequest() +

@@ -2127,6 +2187,8 @@

public sendRequest(RequestInterface $request) : ResponseInterface +
+

Parameters
@@ -2135,15 +2197,15 @@
Parameters
: RequestInterface
-
- +
Tags - + +
@@ -2153,13 +2215,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

setLogger() +

@@ -2184,6 +2247,8 @@

public setLogger(LoggerInterface $logger) : static +
+

Parameters
@@ -2192,15 +2257,15 @@
Parameters
: LoggerInterface
-
- +
Tags - + +
@@ -2217,13 +2282,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setRequestFactory() +

@@ -2248,6 +2314,8 @@

public setRequestFactory(RequestFactoryInterface $requestFactory) : static +
+

Parameters
@@ -2256,15 +2324,15 @@
Parameters
: RequestFactoryInterface
-
- +
Tags - + +
@@ -2281,13 +2349,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStorage() +

@@ -2312,6 +2381,8 @@

public setStorage(OAuthStorageInterface $storage) : static +
+

Parameters
@@ -2320,15 +2391,15 @@
Parameters
: OAuthStorageInterface
-
- +
Tags - + +
@@ -2345,13 +2416,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStreamFactory() +

@@ -2376,6 +2448,8 @@

public setStreamFactory(StreamFactoryInterface $streamFactory) : static +
+

Parameters
@@ -2384,15 +2458,15 @@
Parameters
: StreamFactoryInterface
-
- +
Tags - + +
@@ -2409,13 +2483,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setUriFactory() +

@@ -2440,6 +2515,8 @@

public setUriFactory(UriFactoryInterface $uriFactory) : static +
+

Parameters
@@ -2448,15 +2525,15 @@
Parameters
: UriFactoryInterface
-
- +
Tags - + +
@@ -2473,13 +2550,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

@@ -2504,6 +2582,8 @@

public storeAccessToken(AccessToken $token) : static +
+

Parameters
@@ -2512,15 +2592,15 @@
Parameters
: AccessToken
-
- +
Tags - + +
@@ -2537,13 +2617,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

cleanBodyParams() +

@@ -2566,28 +2647,29 @@

protected - cleanBodyParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanBodyParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

cleanQueryParams() +

@@ -2610,28 +2693,29 @@

protected - cleanQueryParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanQueryParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

createAccessToken() +

@@ -2656,15 +2741,17 @@

protected createAccessToken() : AccessToken +
+
+
Return values
- AccessToken - — - - + AccessToken +
+

Return values

getRequestBody() +

@@ -2689,6 +2777,8 @@

protected getRequestBody(StreamInterface|array<string|int, mixed>|string $body, RequestInterface $request) : StreamInterface +
+

Parameters
@@ -2697,23 +2787,22 @@
Parameters
: StreamInterface|array<string|int, mixed>|string
-
- +
$request : RequestInterface
-
- +
Tags - + +
@@ -2724,13 +2813,13 @@
-
+ +
Return values
- StreamInterface - — - - + StreamInterface +
+
Return values

getRequestHeaders() +

@@ -2753,28 +2843,29 @@

protected - getRequestHeaders([array<string|int, mixed> $headers = null ]) : array<string|int, mixed> + getRequestHeaders([array<string|int, mixed>|null $headers = null ]) : array<string|int, mixed> +
+

Parameters
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

getRequestTarget() +

@@ -2800,6 +2892,8 @@

protected getRequestTarget(string $uri) : string +
+

Throws if the given path is invalid or if the host of a given URL does not match $apiURL.

@@ -2810,15 +2904,15 @@

Parameters
: string
-
- +
Tags - + +
@@ -2837,13 +2931,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

getRequestURL() +

@@ -2866,8 +2961,10 @@

protected - getRequestURL(string $path[, array<string|int, mixed> $params = null ]) : string + getRequestURL(string $path[, array<string|int, mixed>|null $params = null ]) : string +
+

Parameters
@@ -2876,26 +2973,24 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- string - — - - + string +
+
Return values

parseTokenResponse() +

@@ -2920,6 +3016,8 @@

protected parseTokenResponse(ResponseInterface $response) : AccessToken +
+

Parameters
@@ -2928,15 +3026,15 @@
Parameters
: ResponseInterface
-
- +
Tags - + +
@@ -2962,80 +3060,198 @@
-
+ +
Return values
- AccessToken - — - - -
+ AccessToken - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -3046,7 +3262,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2Test.html b/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2Test.html index 74d7813b..ca945bed 100644 --- a/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2Test.html +++ b/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2Test.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

testCheckCSRFState() +

@@ -1077,15 +1066,12 @@

public testCheckCSRFState() : void -
- +
+
+ -

Return values
- void - — -
Return values

testCheckStateInvalidCSRFStateException() +

@@ -1110,15 +1097,12 @@

public testCheckStateInvalidCSRFStateException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testCheckStateInvalidException() +

@@ -1143,15 +1128,12 @@

public testCheckStateInvalidException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetAccessToken() +

@@ -1176,15 +1159,12 @@

public testGetAccessToken() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetAuthURL() +

@@ -1209,15 +1190,12 @@

public testGetAuthURL() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetClientCredentials() +

@@ -1242,15 +1221,12 @@

public testGetClientCredentials() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetRequestAuthorization() +

@@ -1275,15 +1252,12 @@

public testGetRequestAuthorization() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetRequestTarget() +

@@ -1308,8 +1283,9 @@

public testGetRequestTarget(string $path, string $expected) : void -
- +
+
+

Parameters
@@ -1317,25 +1293,19 @@
Parameters
: string
-
- +
$expected : string
-
- +
-
Return values
- void - — -
Return values

testMagicGet() +

@@ -1360,15 +1331,12 @@

public testMagicGet() : void -
- +
+
+ -

Return values
- void - — -
Return values

testOAuth2Instance() +

@@ -1393,15 +1362,12 @@

public testOAuth2Instance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testOAuthInstance() +

@@ -1426,15 +1393,12 @@

public testOAuthInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseErrorException() +

@@ -1459,15 +1424,12 @@

public testParseTokenResponseErrorException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseNoDataException() +

@@ -1492,15 +1455,12 @@

public testParseTokenResponseNoDataException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseNoTokenException() +

@@ -1525,15 +1486,12 @@

public testParseTokenResponseNoTokenException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testProviderInstance() +

@@ -1558,15 +1517,12 @@

public testProviderInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRefreshAccessToken() +

@@ -1591,15 +1548,12 @@

public testRefreshAccessToken() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRefreshAccessTokenNoRefreshTokenAvailable() +

@@ -1624,15 +1579,12 @@

public testRefreshAccessTokenNoRefreshTokenAvailable() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequest() +

@@ -1657,15 +1610,12 @@

public testRequest() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequestInvalidAuthTypeException() +

@@ -1690,15 +1641,12 @@

public testRequestInvalidAuthTypeException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequestWithTokenRefresh() +

@@ -1723,15 +1672,12 @@

public testRequestWithTokenRefresh() : void -
- +
+
+ -

Return values
- void - — -
Return values

testTokenInvalidate() +

@@ -1756,15 +1703,12 @@

public testTokenInvalidate() : void -
- +
+
+ -

Return values
- void - — -
Return values

initFactories() +

@@ -1789,15 +1734,12 @@

protected initFactories() : void -
- +
+
+ -

Return values
- void - — -
Return values

initHttp() +

@@ -1822,8 +1765,9 @@

protected initHttp(SettingsContainerInterface $options, LoggerInterface $logger, array<string|int, mixed> $responses) : ClientInterface -
- +
+
+

Parameters
@@ -1831,34 +1775,31 @@
Parameters
: SettingsContainerInterface
-
- +
$logger : LoggerInterface
-
- +
$responses : array<string|int, mixed>
-
- +
+
Return values
- ClientInterface - — - - + ClientInterface +
+
Return values

initLogger() +

@@ -1882,8 +1824,9 @@

protected initLogger(bool $is_ci) : LoggerInterface -
- +
+
+

Parameters
@@ -1891,18 +1834,17 @@
Parameters
: bool
-
- +
+
Return values
- LoggerInterface - — - - + LoggerInterface +
+
Return values

initOptions() +

@@ -1926,16 +1869,17 @@

protected initOptions() : SettingsContainerInterface -
- +
+
+ +
Return values
- SettingsContainerInterface - — - - + SettingsContainerInterface +
+

Return values

initProvider() +

@@ -1959,16 +1904,17 @@

protected initProvider() : OAuthInterface|OAuth1Interface|OAuth2Interface -
- +
+
+ +
Return values
- OAuthInterface|OAuth1Interface|OAuth2Interface - — - - + OAuthInterface|OAuth1Interface|OAuth2Interface +
+

Return values

initStorage() +

@@ -1992,8 +1939,9 @@

protected initStorage(SettingsContainerInterface $options) : OAuthStorageInterface -
- +
+
+

Parameters
@@ -2001,18 +1949,17 @@
Parameters
: SettingsContainerInterface
-
- +
+
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

initTestProperties() +

@@ -2036,8 +1984,9 @@

protected initTestProperties(array<string|int, mixed> $properties) : void -
- +
+
+

Parameters
@@ -2045,17 +1994,12 @@
Parameters
: array<string|int, mixed>
-
- +
-
Return values
- void - — -
Return values

setUp() +

@@ -2080,83 +2025,187 @@

protected setUp() : void -
- +
+
+ -

Return values
- void - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -2167,7 +2216,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2TestBasic.html b/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2TestBasic.html index 71fa0276..a67ddc3a 100644 --- a/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2TestBasic.html +++ b/classes/chillerlan-OAuthTest-Providers-OAuth2-DummyOAuth2TestBasic.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

testCheckCSRFState() +

@@ -1106,15 +1091,12 @@

public testCheckCSRFState() : void -
- +
+
+ -

Return values
- void - — -
Return values

testCheckStateInvalidCSRFStateException() +

@@ -1139,15 +1122,12 @@

public testCheckStateInvalidCSRFStateException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testCheckStateInvalidException() +

@@ -1172,15 +1153,12 @@

public testCheckStateInvalidException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testCheckStateNotSupportedException() +

@@ -1205,15 +1184,12 @@

public testCheckStateNotSupportedException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetAccessToken() +

@@ -1238,15 +1215,12 @@

public testGetAccessToken() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetAuthURL() +

@@ -1271,15 +1246,12 @@

public testGetAuthURL() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetClientCredentials() +

@@ -1304,15 +1277,12 @@

public testGetClientCredentials() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetClientCredentialsTokenException() +

@@ -1337,15 +1308,12 @@

public testGetClientCredentialsTokenException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetRequestAuthorization() +

@@ -1370,15 +1339,12 @@

public testGetRequestAuthorization() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetRequestTarget() +

@@ -1403,8 +1370,9 @@

public testGetRequestTarget(string $path, string $expected) : void -
- +
+
+

Parameters
@@ -1412,25 +1380,19 @@
Parameters
: string
-
- +
$expected : string
-
- +
-
Return values
- void - — -
Return values

testMagicGet() +

@@ -1455,15 +1418,12 @@

public testMagicGet() : void -
- +
+
+ -

Return values
- void - — -
Return values

testOAuth2Instance() +

@@ -1488,15 +1449,12 @@

public testOAuth2Instance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testOAuthInstance() +

@@ -1521,15 +1480,12 @@

public testOAuthInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseErrorException() +

@@ -1554,15 +1511,12 @@

public testParseTokenResponseErrorException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseNoDataException() +

@@ -1587,15 +1542,12 @@

public testParseTokenResponseNoDataException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseNoTokenException() +

@@ -1620,15 +1573,12 @@

public testParseTokenResponseNoTokenException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testProviderInstance() +

@@ -1653,15 +1604,12 @@

public testProviderInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRefreshAccessToken() +

@@ -1686,15 +1635,12 @@

public testRefreshAccessToken() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRefreshAccessTokenException() +

@@ -1719,15 +1666,12 @@

public testRefreshAccessTokenException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRefreshAccessTokenNoRefreshTokenAvailable() +

@@ -1752,15 +1697,12 @@

public testRefreshAccessTokenNoRefreshTokenAvailable() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequest() +

@@ -1785,15 +1728,12 @@

public testRequest() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequestInvalidAuthTypeException() +

@@ -1818,15 +1759,12 @@

public testRequestInvalidAuthTypeException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequestWithTokenRefresh() +

@@ -1851,15 +1790,12 @@

public testRequestWithTokenRefresh() : void -
- +
+
+ -

Return values
- void - — -
Return values

testSetStateNotSupportedException() +

@@ -1884,15 +1821,12 @@

public testSetStateNotSupportedException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testTokenInvalidate() +

@@ -1917,15 +1852,12 @@

public testTokenInvalidate() : void -
- +
+
+ -

Return values
- void - — -
Return values

initFactories() +

@@ -1950,15 +1883,12 @@

protected initFactories() : void -
- +
+
+ -

Return values
- void - — -
Return values

initHttp() +

@@ -1983,8 +1914,9 @@

protected initHttp(SettingsContainerInterface $options, LoggerInterface $logger, array<string|int, mixed> $responses) : ClientInterface -
- +
+
+

Parameters
@@ -1992,34 +1924,31 @@
Parameters
: SettingsContainerInterface
-
- +
$logger : LoggerInterface
-
- +
$responses : array<string|int, mixed>
-
- +
+
Return values
- ClientInterface - — - - + ClientInterface +
+
Return values

initLogger() +

@@ -2043,8 +1973,9 @@

protected initLogger(bool $is_ci) : LoggerInterface -
- +
+
+

Parameters
@@ -2052,18 +1983,17 @@
Parameters
: bool
-
- +
+
Return values
- LoggerInterface - — - - + LoggerInterface +
+
Return values

initOptions() +

@@ -2087,16 +2018,17 @@

protected initOptions() : SettingsContainerInterface -
- +
+
+ +
Return values
- SettingsContainerInterface - — - - + SettingsContainerInterface +
+

Return values

initProvider() +

@@ -2120,16 +2053,17 @@

protected initProvider() : OAuthInterface|OAuth1Interface|OAuth2Interface -
- +
+
+ +
Return values
- OAuthInterface|OAuth1Interface|OAuth2Interface - — - - + OAuthInterface|OAuth1Interface|OAuth2Interface +
+

Return values

initStorage() +

@@ -2153,8 +2088,9 @@

protected initStorage(SettingsContainerInterface $options) : OAuthStorageInterface -
- +
+
+

Parameters
@@ -2162,18 +2098,17 @@
Parameters
: SettingsContainerInterface
-
- +
+
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

initTestProperties() +

@@ -2197,8 +2133,9 @@

protected initTestProperties(array<string|int, mixed> $properties) : void -
- +
+
+

Parameters
@@ -2206,17 +2143,12 @@
Parameters
: array<string|int, mixed>
-
- +
-
Return values
- void - — -
Return values

setUp() +

@@ -2241,83 +2174,191 @@

protected setUp() : void -
- +
+
+ -

Return values
- void - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -2328,7 +2369,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Providers-OAuth2ProviderTestAbstract.html b/classes/chillerlan-OAuthTest-Providers-OAuth2ProviderTestAbstract.html index 4f8b0730..1dddb4fe 100644 --- a/classes/chillerlan-OAuthTest-Providers-OAuth2ProviderTestAbstract.html +++ b/classes/chillerlan-OAuthTest-Providers-OAuth2ProviderTestAbstract.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

testCheckCSRFState() +

@@ -1036,15 +1026,12 @@

public testCheckCSRFState() : void -
- +
+
+ -

Return values
- void - — -
Return values

testCheckStateInvalidCSRFStateException() +

@@ -1069,15 +1057,12 @@

public testCheckStateInvalidCSRFStateException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testCheckStateInvalidException() +

@@ -1102,15 +1088,12 @@

public testCheckStateInvalidException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetAccessToken() +

@@ -1135,15 +1119,12 @@

public testGetAccessToken() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetAuthURL() +

@@ -1168,15 +1150,12 @@

public testGetAuthURL() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetClientCredentials() +

@@ -1201,15 +1181,12 @@

public testGetClientCredentials() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetRequestAuthorization() +

@@ -1234,15 +1212,12 @@

public testGetRequestAuthorization() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetRequestTarget() +

@@ -1267,8 +1243,9 @@

public testGetRequestTarget(string $path, string $expected) : void -
- +
+
+

Parameters
@@ -1276,25 +1253,19 @@
Parameters
: string
-
- +
$expected : string
-
- +
-
Return values
- void - — -
Return values

testMagicGet() +

@@ -1319,15 +1291,12 @@

public testMagicGet() : void -
- +
+
+ -

Return values
- void - — -
Return values

testOAuth2Instance() +

@@ -1352,15 +1322,12 @@

public testOAuth2Instance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testOAuthInstance() +

@@ -1385,15 +1353,12 @@

public testOAuthInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseErrorException() +

@@ -1418,15 +1384,12 @@

public testParseTokenResponseErrorException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseNoDataException() +

@@ -1451,15 +1415,12 @@

public testParseTokenResponseNoDataException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testParseTokenResponseNoTokenException() +

@@ -1484,15 +1446,12 @@

public testParseTokenResponseNoTokenException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testProviderInstance() +

@@ -1517,15 +1477,12 @@

public testProviderInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRefreshAccessToken() +

@@ -1550,15 +1508,12 @@

public testRefreshAccessToken() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRefreshAccessTokenNoRefreshTokenAvailable() +

@@ -1583,15 +1539,12 @@

public testRefreshAccessTokenNoRefreshTokenAvailable() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequest() +

@@ -1616,15 +1570,12 @@

public testRequest() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequestInvalidAuthTypeException() +

@@ -1649,15 +1601,12 @@

public testRequestInvalidAuthTypeException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequestWithTokenRefresh() +

@@ -1682,15 +1632,12 @@

public testRequestWithTokenRefresh() : void -
- +
+
+ -

Return values
- void - — -
Return values

testTokenInvalidate() +

@@ -1715,15 +1663,12 @@

public testTokenInvalidate() : void -
- +
+
+ -

Return values
- void - — -
Return values

initFactories() +

@@ -1748,15 +1694,12 @@

protected initFactories() : void -
- +
+
+ -

Return values
- void - — -
Return values

initHttp() +

@@ -1781,8 +1725,9 @@

protected initHttp(SettingsContainerInterface $options, LoggerInterface $logger, array<string|int, mixed> $responses) : ClientInterface -
- +
+
+

Parameters
@@ -1790,34 +1735,31 @@
Parameters
: SettingsContainerInterface
-
- +
$logger : LoggerInterface
-
- +
$responses : array<string|int, mixed>
-
- +
+
Return values
- ClientInterface - — - - + ClientInterface +
+
Return values

initLogger() +

@@ -1841,8 +1784,9 @@

protected initLogger(bool $is_ci) : LoggerInterface -
- +
+
+

Parameters
@@ -1850,18 +1794,17 @@
Parameters
: bool
-
- +
+
Return values
- LoggerInterface - — - - + LoggerInterface +
+
Return values

initOptions() +

@@ -1885,16 +1829,17 @@

protected initOptions() : SettingsContainerInterface -
- +
+
+ +
Return values
- SettingsContainerInterface - — - - + SettingsContainerInterface +
+

Return values

initProvider() +

@@ -1918,16 +1864,17 @@

protected initProvider() : OAuthInterface|OAuth1Interface|OAuth2Interface -
- +
+
+ +
Return values
- OAuthInterface|OAuth1Interface|OAuth2Interface - — - - + OAuthInterface|OAuth1Interface|OAuth2Interface +
+

Return values

initStorage() +

@@ -1951,8 +1899,9 @@

protected initStorage(SettingsContainerInterface $options) : OAuthStorageInterface -
- +
+
+

Parameters
@@ -1960,18 +1909,17 @@
Parameters
: SettingsContainerInterface
-
- +
+
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

initTestProperties() +

@@ -1995,8 +1944,9 @@

protected initTestProperties(array<string|int, mixed> $properties) : void -
- +
+
+

Parameters
@@ -2004,17 +1954,12 @@
Parameters
: array<string|int, mixed>
-
- +
-
Return values
- void - — -
Return values

setUp() +

@@ -2039,83 +1985,186 @@

protected setUp() : void -
- +
+
+ -

Return values
- void - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -2126,7 +2175,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Providers-OAuthProviderTestAbstract.html b/classes/chillerlan-OAuthTest-Providers-OAuthProviderTestAbstract.html index 5dec112f..5f08ebed 100644 --- a/classes/chillerlan-OAuthTest-Providers-OAuthProviderTestAbstract.html +++ b/classes/chillerlan-OAuthTest-Providers-OAuthProviderTestAbstract.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

testGetRequestTarget() +

@@ -885,8 +891,9 @@

public testGetRequestTarget(string $path, string $expected) : void -
- +
+
+

Parameters
@@ -894,25 +901,19 @@
Parameters
: string
-
- +
$expected : string
-
- +
-
Return values
- void - — -
Return values

testMagicGet() +

@@ -937,15 +939,12 @@

public testMagicGet() : void -
- +
+
+ -

Return values
- void - — -
Return values

testOAuthInstance() +

@@ -970,15 +970,12 @@

public testOAuthInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testProviderInstance() +

@@ -1003,15 +1001,12 @@

public testProviderInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testTokenInvalidate() +

@@ -1036,15 +1032,12 @@

public testTokenInvalidate() : void -
- +
+
+ -

Return values
- void - — -
Return values

initFactories() +

@@ -1069,15 +1063,12 @@

protected initFactories() : void -
- +
+
+ -

Return values
- void - — -
Return values

initHttp() +

@@ -1102,8 +1094,9 @@

protected initHttp(SettingsContainerInterface $options, LoggerInterface $logger, array<string|int, mixed> $responses) : ClientInterface -
- +
+
+

Parameters
@@ -1111,34 +1104,31 @@
Parameters
: SettingsContainerInterface
-
- +
$logger : LoggerInterface
-
- +
$responses : array<string|int, mixed>
-
- +
+
Return values
- ClientInterface - — - - + ClientInterface +
+
Return values

initLogger() +

@@ -1162,8 +1153,9 @@

protected initLogger(bool $is_ci) : LoggerInterface -
- +
+
+

Parameters
@@ -1171,18 +1163,17 @@
Parameters
: bool
-
- +
+
Return values
- LoggerInterface - — - - + LoggerInterface +
+
Return values

initOptions() +

@@ -1206,16 +1198,17 @@

protected initOptions() : SettingsContainerInterface -
- +
+
+ +
Return values
- SettingsContainerInterface - — - - + SettingsContainerInterface +
+

Return values

initProvider() +

@@ -1239,16 +1233,17 @@

protected initProvider() : OAuthInterface|OAuth1Interface|OAuth2Interface -
- +
+
+ +
Return values
- OAuthInterface|OAuth1Interface|OAuth2Interface - — - - + OAuthInterface|OAuth1Interface|OAuth2Interface +
+

Return values

initStorage() +

@@ -1272,8 +1268,9 @@

protected initStorage(SettingsContainerInterface $options) : OAuthStorageInterface -
- +
+
+

Parameters
@@ -1281,18 +1278,17 @@
Parameters
: SettingsContainerInterface
-
- +
+
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

initTestProperties() +

@@ -1316,8 +1313,9 @@

protected initTestProperties(array<string|int, mixed> $properties) : void -
- +
+
+

Parameters
@@ -1325,17 +1323,12 @@
Parameters
: array<string|int, mixed>
-
- +
-
Return values
- void - — -
Return values

setUp() +

@@ -1360,83 +1354,169 @@

protected setUp() : void -
- +
+
+ -

Return values
- void - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -1447,7 +1527,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Providers-ProviderTestHttpClient.html b/classes/chillerlan-OAuthTest-Providers-ProviderTestHttpClient.html index 1422cec1..32c85a1a 100644 --- a/classes/chillerlan-OAuthTest-Providers-ProviderTestHttpClient.html +++ b/classes/chillerlan-OAuthTest-Providers-ProviderTestHttpClient.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

sendRequest() +

@@ -431,6 +466,8 @@

public sendRequest(RequestInterface $request) : ResponseInterface +
+

Parameters
@@ -439,15 +476,15 @@
Parameters
: RequestInterface
-
- +
Tags - + +
@@ -457,80 +494,153 @@
-
+ +
Return values
- ResponseInterface - — - - - + ResponseInterface
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -541,7 +651,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Providers-RequestTest-OAuthProviderRequestTest.html b/classes/chillerlan-OAuthTest-Providers-RequestTest-OAuthProviderRequestTest.html index 4fc6abaf..bd218d53 100644 --- a/classes/chillerlan-OAuthTest-Providers-RequestTest-OAuthProviderRequestTest.html +++ b/classes/chillerlan-OAuthTest-Providers-RequestTest-OAuthProviderRequestTest.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

testGetRequestTarget() +

@@ -907,8 +910,9 @@

public testGetRequestTarget(string $path, string $expected) : void -
- +
+
+

Parameters
@@ -916,25 +920,19 @@
Parameters
: string
-
- +
$expected : string
-
- +
-
Return values
- void - — -
Return values

testMagicGet() +

@@ -959,15 +958,12 @@

public testMagicGet() : void -
- +
+
+ -

Return values
- void - — -
Return values

testOAuthInstance() +

@@ -992,15 +989,12 @@

public testOAuthInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testProviderInstance() +

@@ -1025,15 +1020,12 @@

public testProviderInstance() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequestBody() +

@@ -1058,15 +1051,12 @@

public testRequestBody() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequestHostMismatchException() +

@@ -1091,15 +1082,12 @@

public testRequestHostMismatchException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRequestURI() +

@@ -1124,15 +1113,12 @@

public testRequestURI() : void -
- +
+
+ -

Return values
- void - — -
Return values

testTokenInvalidate() +

@@ -1157,15 +1144,12 @@

public testTokenInvalidate() : void -
- +
+
+ -

Return values
- void - — -
Return values

initFactories() +

@@ -1190,15 +1175,12 @@

protected initFactories() : void -
- +
+
+ -

Return values
- void - — -
Return values

initHttp() +

@@ -1223,8 +1206,9 @@

protected initHttp(SettingsContainerInterface $options, LoggerInterface $logger, array<string|int, mixed> $responses) : ClientInterface -
- +
+
+

Parameters
@@ -1232,34 +1216,31 @@
Parameters
: SettingsContainerInterface
-
- +
$logger : LoggerInterface
-
- +
$responses : array<string|int, mixed>
-
- +
+
Return values
- ClientInterface - — - - + ClientInterface +
+
Return values

initLogger() +

@@ -1283,8 +1265,9 @@

protected initLogger(bool $is_ci) : LoggerInterface -
- +
+
+

Parameters
@@ -1292,18 +1275,17 @@
Parameters
: bool
-
- +
+
Return values
- LoggerInterface - — - - + LoggerInterface +
+
Return values

initOptions() +

@@ -1327,16 +1310,17 @@

protected initOptions() : SettingsContainerInterface -
- +
+
+ +
Return values
- SettingsContainerInterface - — - - + SettingsContainerInterface +
+

Return values

initProvider() +

@@ -1360,16 +1345,17 @@

protected initProvider() : OAuthInterface|OAuth1Interface|OAuth2Interface -
- +
+
+ +
Return values
- OAuthInterface|OAuth1Interface|OAuth2Interface - — - - + OAuthInterface|OAuth1Interface|OAuth2Interface +
+

Return values

initStorage() +

@@ -1393,8 +1380,9 @@

protected initStorage(SettingsContainerInterface $options) : OAuthStorageInterface -
- +
+
+

Parameters
@@ -1402,18 +1390,17 @@
Parameters
: SettingsContainerInterface
-
- +
+
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

initTestProperties() +

@@ -1437,8 +1425,9 @@

protected initTestProperties(array<string|int, mixed> $properties) : void -
- +
+
+

Parameters
@@ -1446,17 +1435,12 @@
Parameters
: array<string|int, mixed>
-
- +
-
Return values
- void - — -
Return values

setUp() +

@@ -1481,83 +1466,172 @@

protected setUp() : void -
- +
+
+ -

Return values
- void - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -1568,7 +1642,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Providers-RequestTest-RequestTestProvider.html b/classes/chillerlan-OAuthTest-Providers-RequestTest-RequestTestProvider.html index 556f06d5..9dc472a2 100644 --- a/classes/chillerlan-OAuthTest-Providers-RequestTest-RequestTestProvider.html +++ b/classes/chillerlan-OAuthTest-Providers-RequestTest-RequestTestProvider.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

__get() +

@@ -1153,6 +1213,8 @@

public __get(string $name) : mixed|null +
+

Parameters
@@ -1161,18 +1223,17 @@
Parameters
: string
-
- +
+
Return values
- mixed|null - — - - + mixed|null +
+
Return values

getAuthURL() +

@@ -1196,6 +1258,8 @@

public getAuthURL([array<string|int, mixed> $params = null ]) : UriInterface +
+

Parameters
@@ -1204,15 +1268,15 @@
Parameters
: array<string|int, mixed> = null
-
- +
Tags - + +
@@ -1223,13 +1287,13 @@
-
+ +
Return values
- UriInterface - — - - + UriInterface +
+
Return values

getRequestAuthorization() +

@@ -1253,8 +1318,9 @@

public getRequestAuthorization(RequestInterface $request, AccessToken $token) : RequestInterface -
- +
+
+

Parameters
@@ -1262,26 +1328,24 @@
Parameters
: RequestInterface
-
- +
$token : AccessToken
-
- +
+
Return values
- RequestInterface - — - - + RequestInterface +
+
Return values

getStorage() +

@@ -1306,12 +1371,15 @@

public getStorage() : OAuthStorageInterface +
+

Tags - + +
@@ -1328,13 +1396,13 @@
-
+ +
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+
Return values

invalidateAccessToken() +

public - invalidateAccessToken([AccessToken $token = null ]) : bool + invalidateAccessToken([AccessToken|null $token = null ]) : bool +
+
Parameters
$token - : AccessToken + : AccessToken|null = null
-
- +
Tags - + +
@@ -1401,13 +1472,13 @@
-
+ +
Return values
- bool - — - - + bool +
+
Return values

me() +

@@ -1432,12 +1504,15 @@

public me() : ResponseInterface +
+

Tags - + +
@@ -1454,13 +1529,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

request() +

@@ -1484,8 +1560,10 @@

public - request(string $path[, array<string|int, mixed> $params = null ][, string $method = null ][, StreamInterface|array<string|int, mixed>|string $body = null ][, array<string|int, mixed> $headers = null ][, string $protocolVersion = null ]) : ResponseInterface + request(string $path[, array<string|int, mixed>|null $params = null ][, string|null $method = null ][, StreamInterface|array<string|int, mixed>|string|null $body = null ][, array<string|int, mixed>|null $headers = null ][, string|null $protocolVersion = null ]) : ResponseInterface +
+

Parameters
@@ -1494,55 +1572,50 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$method - : string + : string|null = null
-
- +
$body - : StreamInterface|array<string|int, mixed>|string + : StreamInterface|array<string|int, mixed>|string|null = null
-
- +
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
$protocolVersion - : string + : string|null = null
-
- +
Tags - + +
@@ -1552,13 +1625,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

sendRequest() +

@@ -1582,6 +1656,8 @@

public sendRequest(RequestInterface $request) : ResponseInterface +
+

Parameters
@@ -1590,15 +1666,15 @@
Parameters
: RequestInterface
-
- +
Tags - + +
@@ -1608,13 +1684,13 @@
-
+ +
Return values
- ResponseInterface - — - - + ResponseInterface +
+
Return values

setLogger() +

@@ -1639,6 +1716,8 @@

public setLogger(LoggerInterface $logger) : static +
+

Parameters
@@ -1647,15 +1726,15 @@
Parameters
: LoggerInterface
-
- +
Tags - + +
@@ -1672,13 +1751,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setRequestFactory() +

@@ -1703,6 +1783,8 @@

public setRequestFactory(RequestFactoryInterface $requestFactory) : static +
+

Parameters
@@ -1711,15 +1793,15 @@
Parameters
: RequestFactoryInterface
-
- +
Tags - + +
@@ -1736,13 +1818,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStorage() +

@@ -1767,6 +1850,8 @@

public setStorage(OAuthStorageInterface $storage) : static +
+

Parameters
@@ -1775,15 +1860,15 @@
Parameters
: OAuthStorageInterface
-
- +
Tags - + +
@@ -1800,13 +1885,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setStreamFactory() +

@@ -1831,6 +1917,8 @@

public setStreamFactory(StreamFactoryInterface $streamFactory) : static +
+

Parameters
@@ -1839,15 +1927,15 @@
Parameters
: StreamFactoryInterface
-
- +
Tags - + +
@@ -1864,13 +1952,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

setUriFactory() +

@@ -1895,6 +1984,8 @@

public setUriFactory(UriFactoryInterface $uriFactory) : static +
+

Parameters
@@ -1903,15 +1994,15 @@
Parameters
: UriFactoryInterface
-
- +
Tags - + +
@@ -1928,13 +2019,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

storeAccessToken() +

@@ -1959,6 +2051,8 @@

public storeAccessToken(AccessToken $token) : static +
+

Parameters
@@ -1967,15 +2061,15 @@
Parameters
: AccessToken
-
- +
Tags - + +
@@ -1992,13 +2086,13 @@
-
+ +
Return values
- static - — - - + static +
+
Return values

cleanBodyParams() +

@@ -2021,28 +2116,29 @@

protected - cleanBodyParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanBodyParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

cleanQueryParams() +

@@ -2065,28 +2162,29 @@

protected - cleanQueryParams(iteratable<string|int, mixed> $params) : array<string|int, mixed> + cleanQueryParams(iterable<string|int, mixed> $params) : array<string|int, mixed> +
+

Parameters
$params - : iteratable<string|int, mixed> + : iterable<string|int, mixed>
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

createAccessToken() +

@@ -2111,15 +2210,17 @@

protected createAccessToken() : AccessToken +
+
+
Return values
- AccessToken - — - - + AccessToken +
+

Return values

getRequestBody() +

@@ -2144,6 +2246,8 @@

protected getRequestBody(StreamInterface|array<string|int, mixed>|string $body, RequestInterface $request) : StreamInterface +
+

Parameters
@@ -2152,23 +2256,22 @@
Parameters
: StreamInterface|array<string|int, mixed>|string
-
- +
$request : RequestInterface
-
- +
Tags - + +
@@ -2179,13 +2282,13 @@
-
+ +
Return values
- StreamInterface - — - - + StreamInterface +
+
Return values

getRequestHeaders() +

@@ -2208,28 +2312,29 @@

protected - getRequestHeaders([array<string|int, mixed> $headers = null ]) : array<string|int, mixed> + getRequestHeaders([array<string|int, mixed>|null $headers = null ]) : array<string|int, mixed> +
+

Parameters
$headers - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- array<string|int, mixed> - — - - + array<string|int, mixed> +
+
Return values

getRequestTarget() +

@@ -2255,6 +2361,8 @@

protected getRequestTarget(string $uri) : string +
+

Throws if the given path is invalid or if the host of a given URL does not match $apiURL.

@@ -2265,15 +2373,15 @@

Parameters
: string
-
- +
Tags - + +
@@ -2292,13 +2400,13 @@
-
+ +
Return values
- string - — - - + string +
+
Return values

getRequestURL() +

@@ -2321,8 +2430,10 @@

protected - getRequestURL(string $path[, array<string|int, mixed> $params = null ]) : string + getRequestURL(string $path[, array<string|int, mixed>|null $params = null ]) : string +
+

Parameters
@@ -2331,93 +2442,198 @@
Parameters
: string
-
- +
$params - : array<string|int, mixed> + : array<string|int, mixed>|null = null
-
- +
+
Return values
- string - — - - -
+ string - - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -2428,7 +2644,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Storage-MemoryStorageTest.html b/classes/chillerlan-OAuthTest-Storage-MemoryStorageTest.html index 87d3e984..c1d687f0 100644 --- a/classes/chillerlan-OAuthTest-Storage-MemoryStorageTest.html +++ b/classes/chillerlan-OAuthTest-Storage-MemoryStorageTest.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

testFromStorageInvalidInputException() +

@@ -427,15 +450,12 @@

public testFromStorageInvalidInputException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetServiceNameEmptyServiceException() +

@@ -460,15 +481,12 @@

public testGetServiceNameEmptyServiceException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetServiceNameInvalidServiceException() +

@@ -493,15 +512,12 @@

public testGetServiceNameInvalidServiceException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRetrieveAccessTokenNotFoundException() +

@@ -526,15 +543,12 @@

public testRetrieveAccessTokenNotFoundException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRetrieveCSRFStateNotFoundException() +

@@ -559,15 +574,12 @@

public testRetrieveCSRFStateNotFoundException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testSetServiceName() +

@@ -592,15 +605,12 @@

public testSetServiceName() : void -
- +
+
+ -

Return values
- void - — -
Return values

testSetServiceNameEmptyException() +

@@ -625,15 +636,12 @@

public testSetServiceNameEmptyException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testStoreWithExistingToken() +

@@ -658,15 +667,12 @@

public testStoreWithExistingToken() : void -
- +
+
+ -

Return values
- void - — -
Return values

testTokenStorage() +

@@ -691,15 +698,12 @@

public testTokenStorage() : void -
- +
+
+ -

Return values
- void - — -
Return values

testToStorage() +

@@ -724,15 +729,12 @@

public testToStorage() : void -
- +
+
+ -

Return values
- void - — -
Return values

initStorage() +

@@ -757,16 +760,17 @@

protected initStorage() : OAuthStorageInterface -
- +
+
+ +
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+

Return values

setUp() +

@@ -790,83 +795,157 @@

protected setUp() : void -
- +
+
+ -

Return values
- void - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -877,7 +956,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Storage-SessionStorageTest.html b/classes/chillerlan-OAuthTest-Storage-SessionStorageTest.html index f5e16945..292c28ad 100644 --- a/classes/chillerlan-OAuthTest-Storage-SessionStorageTest.html +++ b/classes/chillerlan-OAuthTest-Storage-SessionStorageTest.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

testFromStorageInvalidInputException() +

@@ -434,15 +456,12 @@

public testFromStorageInvalidInputException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetServiceNameEmptyServiceException() +

@@ -467,15 +487,12 @@

public testGetServiceNameEmptyServiceException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetServiceNameInvalidServiceException() +

@@ -500,15 +518,12 @@

public testGetServiceNameInvalidServiceException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRetrieveAccessTokenNotFoundException() +

@@ -533,15 +549,12 @@

public testRetrieveAccessTokenNotFoundException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRetrieveCSRFStateNotFoundException() +

@@ -566,15 +580,12 @@

public testRetrieveCSRFStateNotFoundException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testSetServiceName() +

@@ -599,15 +611,12 @@

public testSetServiceName() : void -
- +
+
+ -

Return values
- void - — -
Return values

testSetServiceNameEmptyException() +

@@ -632,15 +642,12 @@

public testSetServiceNameEmptyException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testStoreStateWithNonExistentArray() +

@@ -665,15 +673,12 @@

public testStoreStateWithNonExistentArray() : void -
- +
+
+ -

Return values
- void - — -
Return values

testStoreWithExistingToken() +

@@ -698,15 +704,12 @@

public testStoreWithExistingToken() : void -
- +
+
+ -

Return values
- void - — -
Return values

testTokenStorage() +

@@ -731,15 +735,12 @@

public testTokenStorage() : void -
- +
+
+ -

Return values
- void - — -
Return values

testToStorage() +

@@ -764,15 +766,12 @@

public testToStorage() : void -
- +
+
+ -

Return values
- void - — -
Return values

initStorage() +

@@ -797,16 +797,17 @@

protected initStorage() : OAuthStorageInterface -
- +
+
+ +
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+

Return values

setUp() +

@@ -830,83 +832,158 @@

protected setUp() : void -
- +
+
+ -

Return values
- void - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -917,7 +994,6 @@

Search results

- diff --git a/classes/chillerlan-OAuthTest-Storage-StorageTestAbstract.html b/classes/chillerlan-OAuthTest-Storage-StorageTestAbstract.html index c356dc0a..69e71192 100644 --- a/classes/chillerlan-OAuthTest-Storage-StorageTestAbstract.html +++ b/classes/chillerlan-OAuthTest-Storage-StorageTestAbstract.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -

testFromStorageInvalidInputException() +

@@ -427,15 +452,12 @@

public testFromStorageInvalidInputException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetServiceNameEmptyServiceException() +

@@ -460,15 +483,12 @@

public testGetServiceNameEmptyServiceException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testGetServiceNameInvalidServiceException() +

@@ -493,15 +514,12 @@

public testGetServiceNameInvalidServiceException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRetrieveAccessTokenNotFoundException() +

@@ -526,15 +545,12 @@

public testRetrieveAccessTokenNotFoundException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testRetrieveCSRFStateNotFoundException() +

@@ -559,15 +576,12 @@

public testRetrieveCSRFStateNotFoundException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testSetServiceName() +

@@ -592,15 +607,12 @@

public testSetServiceName() : void -
- +
+
+ -

Return values
- void - — -
Return values

testSetServiceNameEmptyException() +

@@ -625,15 +638,12 @@

public testSetServiceNameEmptyException() : void -
- +
+
+ -

Return values
- void - — -
Return values

testStoreWithExistingToken() +

@@ -658,15 +669,12 @@

public testStoreWithExistingToken() : void -
- +
+
+ -

Return values
- void - — -
Return values

testTokenStorage() +

@@ -691,15 +700,12 @@

public testTokenStorage() : void -
- +
+
+ -

Return values
- void - — -
Return values

testToStorage() +

@@ -724,15 +731,12 @@

public testToStorage() : void -
- +
+
+ -

Return values
- void - — -
Return values

initStorage() +

@@ -757,16 +762,17 @@

protected abstract initStorage() : OAuthStorageInterface -
- +
+
+ +
Return values
- OAuthStorageInterface - — - - + OAuthStorageInterface +
+

Return values

setUp() +

@@ -790,83 +797,157 @@

protected setUp() : void -
- +
+
+ -

Return values
- void - — -
- - -
+
+
+ +
+ On this page + + +
+ +
+ +

Search results

@@ -877,7 +958,6 @@

Search results

- diff --git a/css/base.css b/css/base.css index b71c759f..55594cfe 100644 --- a/css/base.css +++ b/css/base.css @@ -1,8 +1,9 @@ + :root { /* Typography */ - --font-primary: 'Source Sans Pro', Helvetica, Arial, sans-serif; - --font-secondary: 'Source Sans Pro', Helvetica, Arial, sans-serif; + --font-primary: 'Open Sans', Helvetica, Arial, sans-serif; + --font-secondary: 'Open Sans', Helvetica, Arial, sans-serif; --font-monospace: 'Source Code Pro', monospace; --line-height--primary: 1.6; --letter-spacing--primary: .05rem; @@ -20,15 +21,34 @@ --text-xxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); --text-xxxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --color-hue-red: 4; + --color-hue-pink: 340; + --color-hue-purple: 291; + --color-hue-deep-purple: 262; + --color-hue-indigo: 231; + --color-hue-blue: 207; + --color-hue-light-blue: 199; + --color-hue-cyan: 187; + --color-hue-teal: 174; + --color-hue-green: 122; + --color-hue-phpdocumentor-green: 96; + --color-hue-light-green: 88; + --color-hue-lime: 66; + --color-hue-yellow: 54; + --color-hue-amber: 45; + --color-hue-orange: 36; + --color-hue-deep-orange: 14; + --color-hue-brown: 16; + /* Colors */ - --primary-color-hue: 96; + --primary-color-hue: var(--color-hue-deep-purple, --color-hue-phpdocumentor-green); --primary-color-saturation: 57%; --primary-color: hsl(var(--primary-color-hue), var(--primary-color-saturation), 60%); --primary-color-darken: hsl(var(--primary-color-hue), var(--primary-color-saturation), 40%); - --primary-color-darker: hsl(var(--primary-color-hue), var(--primary-color-saturation), 20%); + --primary-color-darker: hsl(var(--primary-color-hue), var(--primary-color-saturation), 25%); --primary-color-darkest: hsl(var(--primary-color-hue), var(--primary-color-saturation), 10%); - --primary-color-lighten: hsl(var(--primary-color-hue), var(--primary-color-saturation), 80%); - --primary-color-lighter: hsl(var(--primary-color-hue), var(--primary-color-saturation), 99%); + --primary-color-lighten: hsl(var(--primary-color-hue), calc(var(--primary-color-saturation) - 20%), 85%); + --primary-color-lighter: hsl(var(--primary-color-hue), calc(var(--primary-color-saturation) - 45%), 97.5%); --dark-gray: #d1d1d1; --light-gray: #f0f0f0; @@ -44,8 +64,8 @@ --button-text-color: #555; --button-text-color-primary: white; --popover-background-color: rgba(255, 255, 255, 0.75); - --link-color-primary: var(--primary-color-darken); - --link-hover-color-primary: var(--primary-color-darker); + --link-color-primary: var(--primary-color-darker); + --link-hover-color-primary: var(--primary-color-darkest); --form-field-border-color: var(--dark-gray); --form-field-color: #fff; --admonition-success-color: var(--primary-color); @@ -139,7 +159,6 @@ body { margin-bottom: var(--spacing-md); margin-top: var(--spacing-md); } - .phpdocumentor h1 .headerlink, .phpdocumentor h2 .headerlink, .phpdocumentor h3 .headerlink, @@ -147,21 +166,32 @@ body { .phpdocumentor h5 .headerlink, .phpdocumentor h6 .headerlink { - transition: all .3s ease-in-out; - opacity: 0; - text-decoration: none; - color: silver; - font-size: 80%; + display: none; } -.phpdocumentor h1:hover .headerlink, -.phpdocumentor h2:hover .headerlink, -.phpdocumentor h3:hover .headerlink, -.phpdocumentor h4:hover .headerlink, -.phpdocumentor h5:hover .headerlink, -.phpdocumentor h6:hover .headerlink -{ - opacity: 1; +@media (min-width: 550px) { + .phpdocumentor h1 .headerlink, + .phpdocumentor h2 .headerlink, + .phpdocumentor h3 .headerlink, + .phpdocumentor h4 .headerlink, + .phpdocumentor h5 .headerlink, + .phpdocumentor h6 .headerlink { + display: inline; + transition: all .3s ease-in-out; + opacity: 0; + text-decoration: none; + color: silver; + font-size: 80%; + } + + .phpdocumentor h1:hover .headerlink, + .phpdocumentor h2:hover .headerlink, + .phpdocumentor h3:hover .headerlink, + .phpdocumentor h4:hover .headerlink, + .phpdocumentor h5:hover .headerlink, + .phpdocumentor h6:hover .headerlink { + opacity: 1; + } } .phpdocumentor p { margin-top: 0; @@ -191,11 +221,17 @@ body { box-sizing: border-box; margin: 0 auto; max-width: var(--container-width); - padding: 0 var(--spacing-lg); + padding: 0 var(--spacing-sm); position: relative; width: 100%; } +@media (min-width: 550px) { + .phpdocumentor-section { + padding: 0 var(--spacing-lg); + } +} + @media (min-width: 1200px) { .phpdocumentor-section { padding: 0; @@ -426,7 +462,7 @@ textarea { outline: 0; } -.phpdocumentor-label { +label.phpdocumentor-label { display: block; margin-bottom: var(--spacing-xs); } @@ -458,8 +494,15 @@ div.phpdocumentor-list > ul, ol.phpdocumentor-list, ul.phpdocumentor-list { margin-top: 0; - padding-left: 1rem; - margin-bottom: var(--spacing-md); + padding-left: var(--spacing-md); + margin-bottom: var(--spacing-sm); +} + +.phpdocumentor-column ul.-clean, +div.phpdocumentor-list > ul.-clean, +ul.phpdocumentor-list.-clean { + list-style: none; + padding-left: 0; } dl { @@ -473,7 +516,7 @@ ul.phpdocumentor-list ol.phpdocumentor-list, ol.phpdocumentor-list ol.phpdocumentor-list, ol.phpdocumentor-list ul.phpdocumentor-list { font-size: var(--text-sm); - margin: var(--spacing-xs) 0 var(--spacing-xs) calc(var(--spacing-xs) * 2); + margin: 0 0 0 calc(var(--spacing-xs) * 2); } .phpdocumentor-column ul li, @@ -544,6 +587,36 @@ th.phpdocumentor-heading:last-child, td.phpdocumentor-cell:last-child { padding-right: 0; } +.phpdocumentor-label-line { + display: flex; + flex-direction: row; + gap: 1rem +} + +.phpdocumentor-label { + background: #f6f6f6; + border-radius: .25rem; + font-size: 80%; + display: inline-block; + overflow: hidden +} + +/* +It would be better if the phpdocumentor-element class were to become a flex element with a gap, but for #3337 that +is too big a fix and needs to be done in a new design iteration. +*/ +.phpdocumentor-signature + .phpdocumentor-label-line .phpdocumentor-label { + margin-top: var(--spacing-sm); +} + +.phpdocumentor-label span { + display: inline-block; + padding: .125rem .5rem; +} + +.phpdocumentor-label--success span:last-of-type { + background: #abe1ab; +} .phpdocumentor-header { display: flex; @@ -628,7 +701,7 @@ td.phpdocumentor-cell:last-child { @media (min-width: 1000px) { .phpdocumentor-title { - width: 30.6666666667%; + width: 22%; border-right: var(--sidebar-border-color) solid 1px; } @@ -763,6 +836,7 @@ td.phpdocumentor-cell:last-child { .phpdocumentor .phpdocumentor-sidebar__category-header { font-size: var(--text-md); + margin-top: 0; margin-bottom: var(--spacing-xs); color: var(--link-color-primary); font-weight: 600; @@ -933,10 +1007,6 @@ td.phpdocumentor-cell:last-child { margin: 0 0 0 auto; } } -.phpdocumentor-content { - position: relative; -} - .phpdocumentor-search-results { backdrop-filter: blur(5px); background: var(--popover-background-color); @@ -1053,6 +1123,7 @@ td.phpdocumentor-cell:last-child { display: flex; align-items: center; justify-content: center; + z-index: 1; } .phpdocumentor-modal__open { @@ -1090,6 +1161,61 @@ td.phpdocumentor-cell:last-child { font-weight: bold; cursor: pointer; } +.phpdocumentor-on-this-page__sidebar { + display: none; +} + +.phpdocumentor-on-this-page__title { + display: block; + font-weight: bold; + margin-bottom: var(--spacing-sm); + color: var(--link-color-primary); +} + +@media (min-width: 1000px) { + .phpdocumentor-on-this-page__sidebar { + display: block; + position: relative; + } + + .phpdocumentor-on-this-page__content::-webkit-scrollbar, + [scrollbars]::-webkit-scrollbar { + height: 8px; + width: 8px; + } + + .phpdocumentor-on-this-page__content::-webkit-scrollbar-corner, + [scrollbars]::-webkit-scrollbar-corner { + background: 0; + } + + .phpdocumentor-on-this-page__content::-webkit-scrollbar-thumb, + [scrollbars]::-webkit-scrollbar-thumb { + background: rgba(128,134,139,0.26); + border-radius: 8px; + } + + .phpdocumentor-on-this-page__content { + position: sticky; + height: calc(100vh - var(--header-height)); + overflow-y: auto; + border-left: 1px solid var(--sidebar-border-color); + padding-left: var(--spacing-lg); + font-size: 90%; + top: -1px; /* Needed for the javascript to make the .-stuck trick work */ + flex: 0 1 auto; + width: 15vw; + } + + .phpdocumentor-on-this-page__content.-stuck { + height: 100vh; + } + + .phpdocumentor-on-this-page__content li { + word-break: break-all; + line-height: normal; + } +} /* Used for screen readers and such */ .visually-hidden { diff --git a/css/normalize.css b/css/normalize.css index 579152b0..653dc00a 100644 --- a/css/normalize.css +++ b/css/normalize.css @@ -76,7 +76,7 @@ audio:not([controls]) { [hidden], template { - display: none; + display: none !important; } /* Links diff --git a/css/template.css b/css/template.css index f7178281..cafd680d 100644 --- a/css/template.css +++ b/css/template.css @@ -1,3 +1,25 @@ + +.phpdocumentor-content { + position: relative; + display: flex; + gap: var(--spacing-md); +} + +.phpdocumentor-content > section:first-of-type { + width: 75%; + flex: 1 1 auto; +} + +@media (min-width: 1900px) { + .phpdocumentor-content > section:first-of-type { + width: 100%; + flex: 1 1 auto; + } +} + +.phpdocumentor .phpdocumentor-content__title { + margin-top: 0; +} .phpdocumentor-summary { font-style: italic; } @@ -8,8 +30,58 @@ position: relative; } +.phpdocumentor-element .phpdocumentor-element { + border: 1px solid var(--primary-color-lighten); + margin-bottom: var(--spacing-md); + padding: var(--spacing-xs); + border-radius: 5px; +} + +.phpdocumentor-element.-deprecated .phpdocumentor-element__name { + text-decoration: line-through; +} + +@media (min-width: 550px) { + .phpdocumentor-element .phpdocumentor-element { + margin-bottom: var(--spacing-lg); + padding: var(--spacing-md); + } +} + +.phpdocumentor-element__modifier { + font-size: var(--text-xxs); + padding: calc(var(--spacing-base-size) / 4) calc(var(--spacing-base-size) / 2); + color: var(--text-color); + background-color: var(--light-gray); + border-radius: 3px; + text-transform: uppercase; +} + +.phpdocumentor .phpdocumentor-elements__header { + margin-top: var(--spacing-xxl); + margin-bottom: var(--spacing-lg); +} + .phpdocumentor .phpdocumentor-element__name { line-height: 1; + margin-top: 0; + font-weight: 300; + font-size: var(--text-lg); + word-break: break-all; + margin-bottom: var(--spacing-sm); +} + +@media (min-width: 550px) { + .phpdocumentor .phpdocumentor-element__name { + font-size: var(--text-xl); + margin-bottom: var(--spacing-xs); + } +} + +@media (min-width: 1200px) { + .phpdocumentor .phpdocumentor-element__name { + margin-bottom: var(--spacing-md); + } } .phpdocumentor-element__package, @@ -24,38 +96,28 @@ .phpdocumentor-element__package .phpdocumentor-breadcrumbs { display: inline; } - -.phpdocumentor-element:not(:last-child) { - border-bottom: 1px solid var(--primary-color-lighten); - padding-bottom: var(--spacing-lg); +.phpdocumentor .phpdocumentor-signature { + display: block; + font-size: var(--text-sm); + border: 1px solid #f0f0f0; } -.phpdocumentor-element.-deprecated .phpdocumentor-element__name { +.phpdocumentor .phpdocumentor-signature.-deprecated .phpdocumentor-signature__name { text-decoration: line-through; } -.phpdocumentor-element__modifier { - font-size: var(--text-xxs); - padding: calc(var(--spacing-base-size) / 4) calc(var(--spacing-base-size) / 2); - color: var(--text-color); - background-color: var(--light-gray); - border-radius: 3px; - text-transform: uppercase; -} -.phpdocumentor-signature { - display: inline-block; - font-size: var(--text-sm); - margin-bottom: var(--spacing-md); +@media (min-width: 550px) { + .phpdocumentor .phpdocumentor-signature { + margin-left: calc(var(--spacing-xl) * -1); + width: calc(100% + var(--spacing-xl)); + } } -.phpdocumentor-signature.-deprecated .phpdocumentor-signature__name { - text-decoration: line-through; -} .phpdocumentor-table-of-contents { } .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry { - padding-top: var(--spacing-xs); + margin-bottom: var(--spacing-xxs); margin-left: 2rem; display: flex; } @@ -90,7 +152,7 @@ width: 1.25rem; height: 1.25rem; line-height: 1.25rem; - background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; content: ''; position: absolute; left: 0; @@ -104,12 +166,14 @@ .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-method:before { content: 'M'; - background-image: url('data:image/svg+xml;utf8,'); + color: ''; + background-image: url('data:image/svg+xml;utf8,'); } .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-function:before { content: 'M'; - background-image: url('data:image/svg+xml;utf8,'); + color: ' 262'; + background-image: url('data:image/svg+xml;utf8,'); } .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-property:before { @@ -119,7 +183,7 @@ .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-constant:before { content: 'C'; background-color: transparent; - background-image: url('data:image/svg+xml;utf8,'); + background-image: url('data:image/svg+xml;utf8,'); } .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-class:before { @@ -151,11 +215,26 @@ margin-left: 2rem; } .phpdocumentor-element-found-in { - position: absolute; - top: 0; - right: 0; - font-size: var(--text-sm); - color: gray; + display: none; +} + +@media (min-width: 550px) { + .phpdocumentor-element-found-in { + display: block; + font-size: var(--text-sm); + color: gray; + margin-bottom: 1rem; + } +} + +@media (min-width: 1200px) { + .phpdocumentor-element-found-in { + position: absolute; + top: var(--spacing-sm); + right: var(--spacing-sm); + font-size: var(--text-sm); + margin-bottom: 0; + } } .phpdocumentor-element-found-in .phpdocumentor-element-found-in__source { diff --git a/files/src-core-accesstoken.html b/files/src-core-accesstoken.html index d81b2145..54c92517 100644 --- a/files/src-core-accesstoken.html +++ b/files/src-core-accesstoken.html @@ -10,7 +10,7 @@ - + @@ -19,6 +19,7 @@ + @@ -42,7 +43,22 @@

Doc @@ -52,7 +68,7 @@

Doc -