Skip to content

Commit

Permalink
Deploying to gh-pages from @ bac3df2 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@codemasher
codemasher committed May 19, 2024
1 parent 6155174 commit ee42433
Show file tree
Hide file tree
Showing 169 changed files with 1,905 additions and 2,129 deletions.
28 changes: 19 additions & 9 deletions classes/chillerlan-OAuth-Core-AccessToken.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -212,14 +212,14 @@ <h4 id="toc-constants">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/chillerlan-OAuth-Core-AccessToken.html#constant_EXPIRY_UNKNOWN">EXPIRY_UNKNOWN</a>
<span>
&nbsp;= -9001 </span>
&nbsp;= -0xdead </span>
</dt>
<dd>Denotes an unknown end of lifetime, such a token should be considered as expired.</dd>

<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/chillerlan-OAuth-Core-AccessToken.html#constant_NEVER_EXPIRES">NEVER_EXPIRES</a>
<span>
&nbsp;= -9002 </span>
&nbsp;= -0xcafe </span>
</dt>
<dd>Denotes a token which never expires</dd>

Expand Down Expand Up @@ -366,7 +366,7 @@ <h4 class="phpdocumentor-element__name" id="constant_EXPIRY_UNKNOWN">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">EXPIRY_UNKNOWN</span>
= <span class="phpdocumentor-signature__default-value">-9001</span>
= <span class="phpdocumentor-signature__default-value">-0xdead</span>
</code>


Expand Down Expand Up @@ -396,7 +396,7 @@ <h4 class="phpdocumentor-element__name" id="constant_NEVER_EXPIRES">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">NEVER_EXPIRES</span>
= <span class="phpdocumentor-signature__default-value">-9002</span>
= <span class="phpdocumentor-signature__default-value">-0xcafe</span>
</code>


Expand Down Expand Up @@ -683,9 +683,9 @@ <h4 class="phpdocumentor-element__name" id="method_isExpired">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/AccessToken.php"><a href="files/src-core-accesstoken.html"><abbr title="src/Core/AccessToken.php">AccessToken.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">112</span>
<span class="phpdocumentor-element-found-in__line">121</span>

<a href="classes/chillerlan-OAuth-Core-AccessToken.html#source-view.112" class="phpdocumentor-element-found-in__source" data-line="112" data-modal="source-view" data-src="files/src/Core/AccessToken.php.txt"></a>
<a href="classes/chillerlan-OAuth-Core-AccessToken.html#source-view.121" class="phpdocumentor-element-found-in__source" data-line="121" data-modal="source-view" data-src="files/src/Core/AccessToken.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Checks whether this token is expired</p>
Expand Down Expand Up @@ -720,9 +720,9 @@ <h4 class="phpdocumentor-element__name" id="method_set_expires">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/AccessToken.php"><a href="files/src-core-accesstoken.html"><abbr title="src/Core/AccessToken.php">AccessToken.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">89</span>
<span class="phpdocumentor-element-found-in__line">93</span>

<a href="classes/chillerlan-OAuth-Core-AccessToken.html#source-view.89" class="phpdocumentor-element-found-in__source" data-line="89" data-modal="source-view" data-src="files/src/Core/AccessToken.php.txt"></a>
<a href="classes/chillerlan-OAuth-Core-AccessToken.html#source-view.93" class="phpdocumentor-element-found-in__source" data-line="93" data-modal="source-view" data-src="files/src/Core/AccessToken.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Sets the expiration for this token, clamps the expiry to EXPIRY_MAX</p>
Expand All @@ -733,7 +733,17 @@ <h4 class="phpdocumentor-element__name" id="method_set_expires">

<div class="phpdocumentor-label-line">
</div>

<section class="phpdocumentor-description"><ul>
<li>
<code class="prettyprint">0</code> sets the expiry to <code class="prettyprint">NEVER_EXPIRES</code>
</li>
<li>
<code class="prettyprint">null</code>, negative integer values or timestamps from <code class="prettyprint">DateTime</code> and <code class="prettyprint">DateInterval</code>
that are in the past set the expiry to <code class="prettyprint">EXPIRY_UNKNOWN</code>
</li>
</ul>
</section>

<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
Expand Down
22 changes: 11 additions & 11 deletions classes/chillerlan-OAuth-Core-OAuth1Provider.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1288,9 +1288,9 @@ <h4 class="phpdocumentor-element__name" id="method_getAccessToken">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuth1Provider.php"><a href="files/src-core-oauth1provider.html"><abbr title="src/Core/OAuth1Provider.php">OAuth1Provider.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">188</span>
<span class="phpdocumentor-element-found-in__line">191</span>

<a href="classes/chillerlan-OAuth-Core-OAuth1Provider.html#source-view.188" class="phpdocumentor-element-found-in__source" data-line="188" data-modal="source-view" data-src="files/src/Core/OAuth1Provider.php.txt"></a>
<a href="classes/chillerlan-OAuth-Core-OAuth1Provider.html#source-view.191" class="phpdocumentor-element-found-in__source" data-line="191" data-modal="source-view" data-src="files/src/Core/OAuth1Provider.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Obtains an OAuth1 access token with the given $token and $verifier and returns an AccessToken object.</p>
Expand Down Expand Up @@ -1663,9 +1663,9 @@ <h4 class="phpdocumentor-element__name" id="method_getRequestAuthorization">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuth1Provider.php"><a href="files/src-core-oauth1provider.html"><abbr title="src/Core/OAuth1Provider.php">OAuth1Provider.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">222</span>
<span class="phpdocumentor-element-found-in__line">225</span>

<a href="classes/chillerlan-OAuth-Core-OAuth1Provider.html#source-view.222" class="phpdocumentor-element-found-in__source" data-line="222" data-modal="source-view" data-src="files/src/Core/OAuth1Provider.php.txt"></a>
<a href="classes/chillerlan-OAuth-Core-OAuth1Provider.html#source-view.225" class="phpdocumentor-element-found-in__source" data-line="225" data-modal="source-view" data-src="files/src/Core/OAuth1Provider.php.txt"></a>
</aside>


Expand Down Expand Up @@ -3064,9 +3064,9 @@ <h4 class="phpdocumentor-element__name" id="method_getSignature">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuth1Provider.php"><a href="files/src-core-oauth1provider.html"><abbr title="src/Core/OAuth1Provider.php">OAuth1Provider.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">152</span>
<span class="phpdocumentor-element-found-in__line">155</span>

<a href="classes/chillerlan-OAuth-Core-OAuth1Provider.html#source-view.152" class="phpdocumentor-element-found-in__source" data-line="152" data-modal="source-view" data-src="files/src/Core/OAuth1Provider.php.txt"></a>
<a href="classes/chillerlan-OAuth-Core-OAuth1Provider.html#source-view.155" class="phpdocumentor-element-found-in__source" data-line="155" data-modal="source-view" data-src="files/src/Core/OAuth1Provider.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Generates a request signature</p>
Expand Down Expand Up @@ -3307,7 +3307,7 @@ <h4 class="phpdocumentor-element__name" id="method_parseTokenResponse">

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">parseTokenResponse</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$response</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$checkCallbackConfirmed</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-OAuth-Core-AccessToken.html"><abbr title="\chillerlan\OAuth\Core\AccessToken">AccessToken</abbr></a></span></code>
<span class="phpdocumentor-signature__name">parseTokenResponse</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$response</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$checkCallbackConfirmed</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-OAuth-Core-AccessToken.html"><abbr title="\chillerlan\OAuth\Core\AccessToken">AccessToken</abbr></a></span></code>

<div class="phpdocumentor-label-line">
</div>
Expand All @@ -3325,8 +3325,8 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$checkCallbackConfirmed</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
: <span class="phpdocumentor-signature__argument__return-type">bool|null</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">

</dd>
Expand Down Expand Up @@ -3399,9 +3399,9 @@ <h4 class="phpdocumentor-element__name" id="method_sendAccessTokenRequest">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuth1Provider.php"><a href="files/src-core-oauth1provider.html"><abbr title="src/Core/OAuth1Provider.php">OAuth1Provider.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">205</span>
<span class="phpdocumentor-element-found-in__line">208</span>

<a href="classes/chillerlan-OAuth-Core-OAuth1Provider.html#source-view.205" class="phpdocumentor-element-found-in__source" data-line="205" data-modal="source-view" data-src="files/src/Core/OAuth1Provider.php.txt"></a>
<a href="classes/chillerlan-OAuth-Core-OAuth1Provider.html#source-view.208" class="phpdocumentor-element-found-in__source" data-line="208" data-modal="source-view" data-src="files/src/Core/OAuth1Provider.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Sends the access token request</p>
Expand Down
34 changes: 26 additions & 8 deletions classes/chillerlan-OAuth-Core-OAuth2Provider.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1614,9 +1614,9 @@ <h4 class="phpdocumentor-element__name" id="method_generateChallenge">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuth2Provider.php"><a href="files/src-core-oauth2provider.html"><abbr title="src/Core/OAuth2Provider.php">OAuth2Provider.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">614</span>
<span class="phpdocumentor-element-found-in__line">617</span>

<a href="classes/chillerlan-OAuth-Core-OAuth2Provider.html#source-view.614" class="phpdocumentor-element-found-in__source" data-line="614" data-modal="source-view" data-src="files/src/Core/OAuth2Provider.php.txt"></a>
<a href="classes/chillerlan-OAuth-Core-OAuth2Provider.html#source-view.617" class="phpdocumentor-element-found-in__source" data-line="617" data-modal="source-view" data-src="files/src/Core/OAuth2Provider.php.txt"></a>
</aside>


Expand Down Expand Up @@ -1691,9 +1691,9 @@ <h4 class="phpdocumentor-element__name" id="method_generateVerifier">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuth2Provider.php"><a href="files/src-core-oauth2provider.html"><abbr title="src/Core/OAuth2Provider.php">OAuth2Provider.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">592</span>
<span class="phpdocumentor-element-found-in__line">595</span>

<a href="classes/chillerlan-OAuth-Core-OAuth2Provider.html#source-view.592" class="phpdocumentor-element-found-in__source" data-line="592" data-modal="source-view" data-src="files/src/Core/OAuth2Provider.php.txt"></a>
<a href="classes/chillerlan-OAuth-Core-OAuth2Provider.html#source-view.595" class="phpdocumentor-element-found-in__source" data-line="595" data-modal="source-view" data-src="files/src/Core/OAuth2Provider.php.txt"></a>
</aside>


Expand Down Expand Up @@ -1747,6 +1747,24 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
<section class="phpdocumentor-description"><p>PhanUndeclaredClassMethod, PhanUndeclaredMethod</p>
</section>

</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">noinspection</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">

<section class="phpdocumentor-description"><p>PhpFullyQualifiedNameUsageInspection</p>
</section>

</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">SuppressWarnings</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">

<section class="phpdocumentor-description"><p>(PHPMD.MissingImport)</p>
</section>

</dd>
</dl>

Expand Down Expand Up @@ -2208,9 +2226,9 @@ <h4 class="phpdocumentor-element__name" id="method_getParRequestUri">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuth2Provider.php"><a href="files/src-core-oauth2provider.html"><abbr title="src/Core/OAuth2Provider.php">OAuth2Provider.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">637</span>
<span class="phpdocumentor-element-found-in__line">640</span>

<a href="classes/chillerlan-OAuth-Core-OAuth2Provider.html#source-view.637" class="phpdocumentor-element-found-in__source" data-line="637" data-modal="source-view" data-src="files/src/Core/OAuth2Provider.php.txt"></a>
<a href="classes/chillerlan-OAuth-Core-OAuth2Provider.html#source-view.640" class="phpdocumentor-element-found-in__source" data-line="640" data-modal="source-view" data-src="files/src/Core/OAuth2Provider.php.txt"></a>
</aside>


Expand Down Expand Up @@ -4072,9 +4090,9 @@ <h4 class="phpdocumentor-element__name" id="method_getParAuthorizationURLRequest
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuth2Provider.php"><a href="files/src-core-oauth2provider.html"><abbr title="src/Core/OAuth2Provider.php">OAuth2Provider.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">671</span>
<span class="phpdocumentor-element-found-in__line">674</span>

<a href="classes/chillerlan-OAuth-Core-OAuth2Provider.html#source-view.671" class="phpdocumentor-element-found-in__source" data-line="671" data-modal="source-view" data-src="files/src/Core/OAuth2Provider.php.txt"></a>
<a href="classes/chillerlan-OAuth-Core-OAuth2Provider.html#source-view.674" class="phpdocumentor-element-found-in__source" data-line="674" data-modal="source-view" data-src="files/src/Core/OAuth2Provider.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Parses the response from the PAR request and returns the query parameters for the authorization URL</p>
Expand Down
2 changes: 1 addition & 1 deletion classes/chillerlan-OAuth-OAuthOptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ <h2 class="phpdocumentor-content__title">

</aside>

<p class="phpdocumentor-summary">This class holds all settings related to the OAuth provider as well as the default HTTP client.</p>
<p class="phpdocumentor-summary">This class holds all settings related to the OAuth provider</p>



Expand Down
Loading

0 comments on commit ee42433

Please sign in to comment.