diogo/indieauth
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Regenerated docs

Browse Source
This commit is contained in:
Barnaby Walters 2021-06-13 15:35:36 +02:00
parent 2255202803
commit 36d56807fe
5 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/classes/Taproot-IndieAuth-Callback-SingleUserPasswordAuthenticationCallback.html
View File

@ -439,13 +439,13 @@ $server = new IndieAuth\Server([
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/SingleUserPasswordAuthenticationCallback.php"><a href="files/src-callback-singleuserpasswordauthenticationcallback.html"><abbr title="src/Callback/SingleUserPasswordAuthenticationCallback.php">SingleUserPasswordAuthenticationCallback.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__invoke</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$request</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">$formAction</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">$normalizedMeUrl</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">__invoke</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$request</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">$formAction</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">$normalizedMeUrl</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">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
@ -467,7 +467,7 @@ $server = new IndieAuth\Server([
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$normalizedMeUrl</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
</dt>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>

42
docs/classes/Taproot-IndieAuth-Server.html
View File

@ -89,7 +89,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">78</span>
<span class="phpdocumentor-element-found-in__line">79</span>
</aside>
<p class="phpdocumentor-summary">IndieAuth Server</p>
@ -345,7 +345,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">95</span>
<span class="phpdocumentor-element-found-in__line">96</span>
</aside>
<p class="phpdocumentor-summary">The form data key used for identifying a request as an authorization (consent screen) form submissions.</p>
@ -372,7 +372,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">100</span>
<span class="phpdocumentor-element-found-in__line">101</span>
</aside>
<p class="phpdocumentor-summary">The form data value used for identifying a request as an authorization (consent screen) form submissions.</p>
@ -399,7 +399,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>
<span class="phpdocumentor-element-found-in__line">91</span>
</aside>
<p class="phpdocumentor-summary">The key used to store the CSRF token everywhere it’s used: Request parameters, Request body, and Cookies.</p>
@ -426,7 +426,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">80</span>
<span class="phpdocumentor-element-found-in__line">81</span>
</aside>
@ -451,7 +451,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">79</span>
<span class="phpdocumentor-element-found-in__line">80</span>
</aside>
@ -476,7 +476,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">85</span>
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">The query string parameter key used for storing the hash used for validating authorization request parameters.</p>
@ -518,7 +518,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">104</span>
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
@ -548,7 +548,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">106</span>
<span class="phpdocumentor-element-found-in__line">107</span>
</aside>
@ -578,7 +578,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">116</span>
<span class="phpdocumentor-element-found-in__line">117</span>
</aside>
@ -608,7 +608,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">112</span>
<span class="phpdocumentor-element-found-in__line">113</span>
</aside>
@ -638,7 +638,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
@ -668,7 +668,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">110</span>
<span class="phpdocumentor-element-found-in__line">111</span>
</aside>
@ -698,7 +698,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">108</span>
<span class="phpdocumentor-element-found-in__line">109</span>
</aside>
@ -728,7 +728,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">118</span>
<span class="phpdocumentor-element-found-in__line">119</span>
</aside>
@ -758,7 +758,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">102</span>
<span class="phpdocumentor-element-found-in__line">103</span>
</aside>
@ -792,7 +792,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">187</span>
<span class="phpdocumentor-element-found-in__line">188</span>
</aside>
<p class="phpdocumentor-summary">Constructor</p>
@ -909,7 +909,7 @@ as the logger for any objects passed in config which implement <code class="pret
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">279</span>
<span class="phpdocumentor-element-found-in__line">283</span>
</aside>
@ -941,7 +941,7 @@ as the logger for any objects passed in config which implement <code class="pret
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">318</span>
<span class="phpdocumentor-element-found-in__line">322</span>
</aside>
<p class="phpdocumentor-summary">Handle Authorization Endpoint Request</p>
@ -1016,7 +1016,7 @@ error behaviour, one way to do so is to subclass <code class="prettyprint">Serve
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">676</span>
<span class="phpdocumentor-element-found-in__line">680</span>
</aside>
<p class="phpdocumentor-summary">Handle Token Endpoint Request</p>
@ -1072,7 +1072,7 @@ error behaviour, one way to do so is to subclass <code class="prettyprint">Serve
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">771</span>
<span class="phpdocumentor-element-found-in__line">775</span>
</aside>
<p class="phpdocumentor-summary">Handle Exception</p>

4
docs/classes/Taproot-IndieAuth-Storage-FilesystemJsonStorage.html
View File

@ -201,7 +201,7 @@ will likely be superceded by the SQLite version.</p>
<span>
&nbsp;: string|null </span>
</dt>
<dd>Create Auth Code</dd>
<dd>Create Authorization Code</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Taproot-IndieAuth-Storage-FilesystemJsonStorage.html#method_delete">delete()</a>
@ -623,7 +623,7 @@ will likely be superceded by the SQLite version.</p>
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
<p class="phpdocumentor-summary">Create Auth Code</p>
<p class="phpdocumentor-summary">Create Authorization Code</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>

4
docs/classes/Taproot-IndieAuth-Storage-TokenStorageInterface.html
View File

@ -135,7 +135,7 @@ reason, is indicated by returning either <code class="prettyprint">null</code> o
<span>
&nbsp;: string|null </span>
</dt>
<dd>Create Auth Code</dd>
<dd>Create Authorization Code</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Taproot-IndieAuth-Storage-TokenStorageInterface.html#method_exchangeAuthCodeForAccessToken">exchangeAuthCodeForAccessToken()</a>
@ -185,7 +185,7 @@ reason, is indicated by returning either <code class="prettyprint">null</code> o
<span class="phpdocumentor-element-found-in__line">78</span>
</aside>
<p class="phpdocumentor-summary">Create Auth Code</p>
<p class="phpdocumentor-summary">Create Authorization Code</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>

4
docs/js/searchIndex.js
View File

@ -553,7 +553,7 @@ Search.appendIndex(
}, {
"fqsen": "\\Taproot\\IndieAuth\\Storage\\FilesystemJsonStorage\u003A\u003AcreateAuthCode\u0028\u0029",
"name": "createAuthCode",
"summary": "Create\u0020Auth\u0020Code",
"summary": "Create\u0020Authorization\u0020Code",
"url": "classes/Taproot-IndieAuth-Storage-FilesystemJsonStorage.html#method_createAuthCode"
}, {
"fqsen": "\\Taproot\\IndieAuth\\Storage\\FilesystemJsonStorage\u003A\u003AexchangeAuthCodeForAccessToken\u0028\u0029",
@ -658,7 +658,7 @@ Search.appendIndex(
}, {
"fqsen": "\\Taproot\\IndieAuth\\Storage\\TokenStorageInterface\u003A\u003AcreateAuthCode\u0028\u0029",
"name": "createAuthCode",
"summary": "Create\u0020Auth\u0020Code",
"summary": "Create\u0020Authorization\u0020Code",
"url": "classes/Taproot-IndieAuth-Storage-TokenStorageInterface.html#method_createAuthCode"
}, {
"fqsen": "\\Taproot\\IndieAuth\\Storage\\TokenStorageInterface\u003A\u003AexchangeAuthCodeForAccessToken\u0028\u0029",