Skip to content
This repository has been archived by the owner on Mar 23, 2024. It is now read-only.

Commit

Permalink
Deploying to gh-pages from @ 3b2327a 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@codemasher
codemasher committed Mar 5, 2024
1 parent 4367970 commit 8859a17
Show file tree
Hide file tree
Showing 281 changed files with 384,965 additions and 771 deletions.
69 changes: 60 additions & 9 deletions classes/chillerlan-OAuth-Core-OAuth1Interface.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,13 @@ <h4 id="toc-methods">
<dd>Prepares an API request to $path with the given parameters, gets authorization, fires the request
and returns a PSR-7 ResponseInterface with the corresponding API response</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/chillerlan-OAuth-Core-OAuthInterface.html#method_retrieveAccessToken">retrieveAccessToken()</a>
<span>
&nbsp;: <a href="classes/chillerlan-OAuth-Core-AccessToken.html"><abbr title="\chillerlan\OAuth\Core\AccessToken">AccessToken</abbr></a> </span>
</dt>
<dd>Gets an access token from the current OAuthStorageInterface (shorthand/convenience)</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/chillerlan-OAuth-Core-OAuthInterface.html#method_setLogger">setLogger()</a>
<span>
Expand Down Expand Up @@ -482,7 +489,7 @@ <h4 class="phpdocumentor-element__name" id="method_getStorage">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuthInterface.php"><a href="files/src-core-oauthinterface.html"><abbr title="src/Core/OAuthInterface.php">OAuthInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
<span class="phpdocumentor-element-found-in__line">73</span>

</aside>

Expand Down Expand Up @@ -518,7 +525,7 @@ <h4 class="phpdocumentor-element__name" id="method_me">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuthInterface.php"><a href="files/src-core-oauthinterface.html"><abbr title="src/Core/OAuthInterface.php">OAuthInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
<span class="phpdocumentor-element-found-in__line">111</span>

</aside>

Expand Down Expand Up @@ -580,7 +587,7 @@ <h4 class="phpdocumentor-element__name" id="method_request">

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">request</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$method</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\StreamInterface">StreamInterface</abbr>|array&lt;string|int, mixed&gt;|string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$body</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$headers</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"><abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr></span></code>
<span class="phpdocumentor-signature__name">request</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$method</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\StreamInterface">StreamInterface</abbr>|array&lt;string|int, mixed&gt;|string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$body</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$headers</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$protocolVersion</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"><abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr></span></code>

<div class="phpdocumentor-label-line">
</div>
Expand Down Expand Up @@ -621,6 +628,13 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">

</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$protocolVersion</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>

Expand All @@ -646,6 +660,42 @@ <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
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_retrieveAccessToken">
retrieveAccessToken()
<a href="classes/chillerlan-OAuth-Core-OAuthInterface.html#method_retrieveAccessToken" 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/OAuthInterface.php"><a href="files/src-core-oauthinterface.html"><abbr title="src/Core/OAuthInterface.php">OAuthInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">83</span>

</aside>

<p class="phpdocumentor-summary">Gets an access token from the current OAuthStorageInterface (shorthand/convenience)</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">retrieveAccessToken</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>




<section>
<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
Expand All @@ -661,7 +711,7 @@ <h4 class="phpdocumentor-element__name" id="method_setLogger">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuthInterface.php"><a href="files/src-core-oauthinterface.html"><abbr title="src/Core/OAuthInterface.php">OAuthInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">82</span>
<span class="phpdocumentor-element-found-in__line">88</span>

</aside>

Expand Down Expand Up @@ -707,7 +757,7 @@ <h4 class="phpdocumentor-element__name" id="method_setRequestFactory">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuthInterface.php"><a href="files/src-core-oauthinterface.html"><abbr title="src/Core/OAuthInterface.php">OAuthInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
<span class="phpdocumentor-element-found-in__line">93</span>

</aside>

Expand Down Expand Up @@ -753,7 +803,7 @@ <h4 class="phpdocumentor-element__name" id="method_setStorage">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuthInterface.php"><a href="files/src-core-oauthinterface.html"><abbr title="src/Core/OAuthInterface.php">OAuthInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
<span class="phpdocumentor-element-found-in__line">68</span>

</aside>

Expand Down Expand Up @@ -799,7 +849,7 @@ <h4 class="phpdocumentor-element__name" id="method_setStreamFactory">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuthInterface.php"><a href="files/src-core-oauthinterface.html"><abbr title="src/Core/OAuthInterface.php">OAuthInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">92</span>
<span class="phpdocumentor-element-found-in__line">98</span>

</aside>

Expand Down Expand Up @@ -845,7 +895,7 @@ <h4 class="phpdocumentor-element__name" id="method_setUriFactory">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuthInterface.php"><a href="files/src-core-oauthinterface.html"><abbr title="src/Core/OAuthInterface.php">OAuthInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">97</span>
<span class="phpdocumentor-element-found-in__line">103</span>

</aside>

Expand Down Expand Up @@ -891,7 +941,7 @@ <h4 class="phpdocumentor-element__name" id="method_storeAccessToken">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/OAuthInterface.php"><a href="files/src-core-oauthinterface.html"><abbr title="src/Core/OAuthInterface.php">OAuthInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">77</span>
<span class="phpdocumentor-element-found-in__line">78</span>

</aside>

Expand Down Expand Up @@ -1041,6 +1091,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
<li><a href="classes/chillerlan-OAuth-Core-OAuthInterface.html#method_getStorage">getStorage()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthInterface.html#method_me">me()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthInterface.html#method_request">request()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthInterface.html#method_retrieveAccessToken">retrieveAccessToken()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthInterface.html#method_setLogger">setLogger()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthInterface.html#method_setRequestFactory">setRequestFactory()</a></li>
<li><a href="classes/chillerlan-OAuth-Core-OAuthInterface.html#method_setStorage">setStorage()</a></li>
Expand Down
Loading

0 comments on commit 8859a17

Please sign in to comment.