Skip to content

Commit

Permalink
Deploying to gh-pages from @ 068058c 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@codemasher
codemasher committed May 18, 2024
1 parent e74e89e commit 71bafd5
Show file tree
Hide file tree
Showing 416 changed files with 61,138 additions and 15,917 deletions.
441 changes: 61 additions & 380 deletions classes/chillerlan-OAuth-Core-AccessToken.html
View file

Large diffs are not rendered by default.

375 changes: 66 additions & 309 deletions classes/chillerlan-OAuth-Core-AuthenticatedUser.html
View file

Large diffs are not rendered by default.

28 changes: 26 additions & 2 deletions classes/chillerlan-OAuth-Core-CSRFStateMismatchException.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,14 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Doc
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -social">
<a href="https://github.com/chillerlan/php-oauth/discussions">
<span>
<i class="fas fa-envelope-open-text"></i>

</span>
</a>
</li>
</ul>
</nav>
</header>
Expand Down Expand Up @@ -141,13 +149,29 @@ <h2 class="phpdocumentor-content__title">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/CSRFStateMismatchException.php"><a href="files/src-core-csrfstatemismatchexception.html"><abbr title="src/Core/CSRFStateMismatchException.php">CSRFStateMismatchException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">19</span>
<span class="phpdocumentor-element-found-in__line">21</span>

</aside>


<p class="phpdocumentor-summary">Thrown on mismatching CSRF (&quot;state&quot;) token</p>



<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/chillerlan-OAuth-Core-CSRFStateMismatchException.html#tags" class="headerlink"><i class="fas fa-link"></i></a>

</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-OAuth-Core-CSRFToken.html"><abbr title="\chillerlan\OAuth\Core\CSRFToken">CSRFToken</abbr></a></span>


</dd>
</dl>



Expand Down
181 changes: 172 additions & 9 deletions classes/chillerlan-OAuth-Core-CSRFToken.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,14 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Doc
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -social">
<a href="https://github.com/chillerlan/php-oauth/discussions">
<span>
<i class="fas fa-envelope-open-text"></i>

</span>
</a>
</li>
</ul>
</nav>
</header>
Expand Down Expand Up @@ -144,20 +152,18 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.1">https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.1</a></span>


<a class="phpdocumentor-tag-link" href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.1"> https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.1 </a>

</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="https://datatracker.ietf.org/doc/html/rfc6749#section-10.12">https://datatracker.ietf.org/doc/html/rfc6749#section-10.12</a></span>


<a class="phpdocumentor-tag-link" href="https://datatracker.ietf.org/doc/html/rfc6749#section-10.12"> https://datatracker.ietf.org/doc/html/rfc6749#section-10.12 </a>

</dd>
</dl>

Expand All @@ -178,13 +184,163 @@ <h3 id="toc">



<h4 id="toc-methods">
Methods
<a href="classes/chillerlan-OAuth-Core-CSRFToken.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>

</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/chillerlan-OAuth-Core-CSRFToken.html#method_checkState">checkState()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Checks whether the CSRF state was set and verifies against the last known state.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/chillerlan-OAuth-Core-CSRFToken.html#method_setState">setState()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Sets the CSRF state parameter in a given array of query parameters and stores that value
in the local storage for later verification. Returns the updated array of parameters.</dd>

</dl>







<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/chillerlan-OAuth-Core-CSRFToken.html#methods" class="headerlink"><i class="fas fa-link"></i></a>

</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_checkState">
checkState()
<a href="classes/chillerlan-OAuth-Core-CSRFToken.html#method_checkState" class="headerlink"><i class="fas fa-link"></i></a>

</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/CSRFToken.php"><a href="files/src-core-csrftoken.html"><abbr title="src/Core/CSRFToken.php">CSRFToken.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>

</aside>

<p class="phpdocumentor-summary">Checks whether the CSRF state was set and verifies against the last known state.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">checkState</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$state</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">void</span></code>

<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Throws a ProviderException if the given state is empty, unknown or doesn't match the known state.</p>
</section>

<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$state</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">

</dd>
</dl>


<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/chillerlan-OAuth-Core-CSRFToken.html#method_checkState#tags" class="headerlink"><i class="fas fa-link"></i></a>

</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-OAuth-Providers-ProviderException.html"><abbr title="\chillerlan\OAuth\Providers\ProviderException">ProviderException</abbr></a></span>


</dd>
</dl>


</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setState">
setState()
<a href="classes/chillerlan-OAuth-Core-CSRFToken.html#method_setState" class="headerlink"><i class="fas fa-link"></i></a>

</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/CSRFToken.php"><a href="files/src-core-csrftoken.html"><abbr title="src/Core/CSRFToken.php">CSRFToken.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>

</aside>

<p class="phpdocumentor-summary">Sets the CSRF state parameter in a given array of query parameters and stores that value
in the local storage for later verification. Returns the updated array of parameters.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setState</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>

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

<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">

</dd>
</dl>


<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/chillerlan-OAuth-Core-CSRFToken.html#method_setState#tags" class="headerlink"><i class="fas fa-link"></i></a>

</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-OAuth-Providers-ProviderException.html"><abbr title="\chillerlan\OAuth\Providers\ProviderException">ProviderException</abbr></a></span>


</dd>
</dl>

<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
</section>

</article>
</section>

<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
Expand Down Expand Up @@ -292,6 +448,13 @@ <h3 id="toc">
<li><a href="classes/chillerlan-OAuth-Core-CSRFToken.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/chillerlan-OAuth-Core-CSRFToken.html#method_checkState">checkState()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-CSRFToken.html#method_setState">setState()</a></li>
</ul>
</li>

</ul>
</section>
Expand Down
21 changes: 14 additions & 7 deletions classes/chillerlan-OAuth-Core-ClientCredentials.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,14 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Doc
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -social">
<a href="https://github.com/chillerlan/php-oauth/discussions">
<span>
<i class="fas fa-envelope-open-text"></i>

</span>
</a>
</li>
</ul>
</nav>
</header>
Expand Down Expand Up @@ -144,12 +152,11 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.4">https://datatracker.ietf.org/doc/html/rfc6749#section-4.4</a></span>


<a class="phpdocumentor-tag-link" href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.4"> https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 </a>

</dd>
</dl>

Expand Down Expand Up @@ -210,15 +217,15 @@ <h4 class="phpdocumentor-element__name" id="method_getClientCredentialsToken">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/ClientCredentials.php"><a href="files/src-core-clientcredentials.html"><abbr title="src/Core/ClientCredentials.php">ClientCredentials.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
<span class="phpdocumentor-element-found-in__line">26</span>

</aside>

<p class="phpdocumentor-summary">Obtains an OAuth2 client credentials token and returns an AccessToken</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getClientCredentialsToken</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$scopes</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>
<span class="phpdocumentor-signature__name">getClientCredentialsToken</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$scopes</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 @@ -227,7 +234,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$scopes</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|null</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;|null</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">

Expand Down
Loading

0 comments on commit 71bafd5

Please sign in to comment.