Skip to content

Commit

Permalink
Deploying to gh-pages from @ 8b67cd7 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@codemasher
codemasher committed Apr 17, 2024
1 parent da5ee1b commit 1fec3c9
Show file tree
Hide file tree
Showing 4 changed files with 559 additions and 30 deletions.
160 changes: 153 additions & 7 deletions classes/chillerlan-OAuth-Providers-Steam.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,14 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
<span class="phpdocumentor-tag-link"><a href="https://partner.steamgames.com/doc/webapi_overview">https://partner.steamgames.com/doc/webapi_overview</a></span>


</dd>
<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="https://partner.steamgames.com/doc/features/auth">https://partner.steamgames.com/doc/features/auth</a></span>


</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
Expand Down Expand Up @@ -358,6 +366,7 @@ <h4 id="toc-methods">
<span>
&nbsp;: <a href="classes/chillerlan-OAuth-Core-AccessToken.html"><abbr title="\chillerlan\OAuth\Core\AccessToken">AccessToken</abbr></a> </span>
</dt>
<dd>Obtains an &quot;authentication token&quot; (the steamID64)</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_getAccessTokenFromStorage">getAccessTokenFromStorage()</a>
Expand Down Expand Up @@ -491,6 +500,13 @@ <h4 id="toc-methods">
</dt>
<dd>Creates an access token with the provider set to $this-&gt;name</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/chillerlan-OAuth-Providers-Steam.html#method_getAccessTokenRequestBodyParams">getAccessTokenRequestBodyParams()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>prepares the request body parameters for the access token request</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_getMeResponseData">getMeResponseData()</a>
<span>
Expand Down Expand Up @@ -540,6 +556,13 @@ <h4 id="toc-methods">
&nbsp;: <a href="classes/chillerlan-OAuth-Core-AccessToken.html"><abbr title="\chillerlan\OAuth\Core\AccessToken">AccessToken</abbr></a> </span>
</dt>

<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/chillerlan-OAuth-Providers-Steam.html#method_sendAccessTokenRequest">sendAccessTokenRequest()</a>
<span>
&nbsp;: <abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr> </span>
</dt>
<dd>sends a request to the access token endpoint $url with the given $params as URL query</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_sendMeRequest">sendMeRequest()</a>
<span>
Expand Down Expand Up @@ -1305,18 +1328,19 @@ <h4 class="phpdocumentor-element__name" id="method_getAccessToken">

</aside>


<p class="phpdocumentor-summary">Obtains an &quot;authentication token&quot; (the steamID64)</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getAccessToken</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">$received</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">getAccessToken</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">$urlQuery</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>

<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">$received</span>
<span class="phpdocumentor-signature__argument__name">$urlQuery</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
Expand Down Expand Up @@ -1470,7 +1494,7 @@ <h4 class="phpdocumentor-element__name" id="method_getRequestAuthorization">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Providers/Steam.php"><a href="files/src-providers-steam.html"><abbr title="src/Providers/Steam.php">Steam.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">119</span>
<span class="phpdocumentor-element-found-in__line">133</span>

</aside>

Expand Down Expand Up @@ -1501,6 +1525,20 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
</dl>


<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/chillerlan-OAuth-Providers-Steam.html#method_getRequestAuthorization#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">inheritDoc</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">


</dd>
</dl>

<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
Expand Down Expand Up @@ -1655,7 +1693,7 @@ <h4 class="phpdocumentor-element__name" id="method_me">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Providers/Steam.php"><a href="files/src-providers-steam.html"><abbr title="src/Providers/Steam.php">Steam.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">129</span>
<span class="phpdocumentor-element-found-in__line">143</span>

</aside>

Expand Down Expand Up @@ -2491,6 +2529,52 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-OAuth-Core-AccessToken.html"><abbr title="\chillerlan\OAuth\Core\AccessToken">AccessToken</abbr></a></span>
</section>

</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_getAccessTokenRequestBodyParams">
getAccessTokenRequestBodyParams()
<a href="classes/chillerlan-OAuth-Providers-Steam.html#method_getAccessTokenRequestBodyParams" 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/Providers/Steam.php"><a href="files/src-providers-steam.html"><abbr title="src/Providers/Steam.php">Steam.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>

</aside>

<p class="phpdocumentor-summary">prepares the request body parameters for the access token request</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getAccessTokenRequestBodyParams</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">$received</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">$received</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">

</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>
<article
class="phpdocumentor-element
Expand Down Expand Up @@ -2897,14 +2981,14 @@ <h4 class="phpdocumentor-element__name" id="method_parseTokenResponse">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Providers/Steam.php"><a href="files/src-providers-steam.html"><abbr title="src/Providers/Steam.php">Steam.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">96</span>
<span class="phpdocumentor-element-found-in__line">103</span>

</aside>


<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>)</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 class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$claimed_id</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 @@ -2917,6 +3001,13 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
</dt>
<dd class="phpdocumentor-argument-list__definition">

</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$claimed_id</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">

</dd>
</dl>

Expand All @@ -2942,6 +3033,59 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-OAuth-Core-AccessToken.html"><abbr title="\chillerlan\OAuth\Core\AccessToken">AccessToken</abbr></a></span>
</section>

</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_sendAccessTokenRequest">
sendAccessTokenRequest()
<a href="classes/chillerlan-OAuth-Providers-Steam.html#method_sendAccessTokenRequest" 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/Providers/Steam.php"><a href="files/src-providers-steam.html"><abbr title="src/Providers/Steam.php">Steam.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>

</aside>

<p class="phpdocumentor-summary">sends a request to the access token endpoint $url with the given $params as URL query</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">sendAccessTokenRequest</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$url</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$body</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr></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">$url</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">

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

</dd>
</dl>



<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr></span>
</section>

</article>
<article
class="phpdocumentor-element
Expand Down Expand Up @@ -3228,13 +3372,15 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
<li><a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_cleanQueryParams">cleanQueryParams()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_construct">construct()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_createAccessToken">createAccessToken()</a></li>
<li><a href="classes/chillerlan-OAuth-Providers-Steam.html#method_getAccessTokenRequestBodyParams">getAccessTokenRequestBodyParams()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_getMeResponseData">getMeResponseData()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_getRequestHeaders">getRequestHeaders()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_getRequestTarget">getRequestTarget()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_getRequestURL">getRequestURL()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_handleMeResponseError">handleMeResponseError()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_nonce">nonce()</a></li>
<li><a href="classes/chillerlan-OAuth-Providers-Steam.html#method_parseTokenResponse">parseTokenResponse()</a></li>
<li><a href="classes/chillerlan-OAuth-Providers-Steam.html#method_sendAccessTokenRequest">sendAccessTokenRequest()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_sendMeRequest">sendMeRequest()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthProvider.html#method_setRequestBody">setRequestBody()</a></li>
</ul>
Expand Down
Loading

0 comments on commit 1fec3c9

Please sign in to comment.