Skip to content

Commit 4fefecb

Browse files
mmanesmmanes
committed
📝 Updating docs
1 parent e9d7afd commit 4fefecb

11 files changed

Lines changed: 393 additions & 124 deletions

‎docs/classes/FusionAuth-ClientResponse.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -622,12 +622,12 @@ <h4 class="phpdocumentor-element__name" id="method_wasSuccessful">
622622
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
623623
<li>
624624
<ul class="phpdocumentor-list -clean">
625-
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_errorResponse">$errorResponse</li>
626-
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_exception">$exception</li>
627-
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_method">$method</li>
628-
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_request">$request</li>
629-
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_status">$status</li>
630-
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_successResponse">$successResponse</li>
625+
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_errorResponse">$errorResponse</a></li>
626+
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_exception">$exception</a></li>
627+
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_method">$method</a></li>
628+
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_request">$request</a></li>
629+
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_status">$status</a></li>
630+
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_successResponse">$successResponse</a></li>
631631
</ul>
632632
</li>
633633

‎docs/classes/FusionAuth-FormDataBodyHandler.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,8 +584,8 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
584584
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
585585
<li>
586586
<ul class="phpdocumentor-list -clean">
587-
<li class=""><a href="classes/FusionAuth-FormDataBodyHandler.html#property_body">$body</li>
588-
<li class=""><a href="classes/FusionAuth-FormDataBodyHandler.html#property_bodyObject">$bodyObject</li>
587+
<li class=""><a href="classes/FusionAuth-FormDataBodyHandler.html#property_body">$body</a></li>
588+
<li class=""><a href="classes/FusionAuth-FormDataBodyHandler.html#property_bodyObject">$bodyObject</a></li>
589589
</ul>
590590
</li>
591591

‎docs/classes/FusionAuth-FusionAuthClient.html‎

Lines changed: 326 additions & 92 deletions
Large diffs are not rendered by default.

‎docs/classes/FusionAuth-JSONBodyHandler.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,8 +584,8 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
584584
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
585585
<li>
586586
<ul class="phpdocumentor-list -clean">
587-
<li class=""><a href="classes/FusionAuth-JSONBodyHandler.html#property_body">$body</li>
588-
<li class=""><a href="classes/FusionAuth-JSONBodyHandler.html#property_bodyObject">$bodyObject</li>
587+
<li class=""><a href="classes/FusionAuth-JSONBodyHandler.html#property_body">$body</a></li>
588+
<li class=""><a href="classes/FusionAuth-JSONBodyHandler.html#property_bodyObject">$bodyObject</a></li>
589589
</ul>
590590
</li>
591591

‎docs/classes/FusionAuth-RESTClient.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1835,18 +1835,18 @@ <h4 class="phpdocumentor-element__name" id="method_resetAuthorizationHeaders">
18351835
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
18361836
<li>
18371837
<ul class="phpdocumentor-list -clean">
1838-
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_bodyHandler">$bodyHandler</li>
1839-
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_certificate">$certificate</li>
1840-
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_connectTimeout">$connectTimeout</li>
1841-
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_errorResponseHandler">$errorResponseHandler</li>
1842-
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_headers">$headers</li>
1843-
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_key">$key</li>
1844-
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_method">$method</li>
1845-
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_parameters">$parameters</li>
1846-
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_proxy">$proxy</li>
1847-
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_readTimeout">$readTimeout</li>
1848-
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_successResponseHandler">$successResponseHandler</li>
1849-
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_url">$url</li>
1838+
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_bodyHandler">$bodyHandler</a></li>
1839+
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_certificate">$certificate</a></li>
1840+
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_connectTimeout">$connectTimeout</a></li>
1841+
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_errorResponseHandler">$errorResponseHandler</a></li>
1842+
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_headers">$headers</a></li>
1843+
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_key">$key</a></li>
1844+
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_method">$method</a></li>
1845+
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_parameters">$parameters</a></li>
1846+
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_proxy">$proxy</a></li>
1847+
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_readTimeout">$readTimeout</a></li>
1848+
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_successResponseHandler">$successResponseHandler</a></li>
1849+
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_url">$url</a></li>
18501850
</ul>
18511851
</li>
18521852

‎docs/classes/Tests-FusionAuthClientTest.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -842,9 +842,9 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
842842
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
843843
<li>
844844
<ul class="phpdocumentor-list -clean">
845-
<li class=""><a href="classes/Tests-FusionAuthClientTest.html#property_applicationId">$applicationId</li>
846-
<li class=""><a href="classes/Tests-FusionAuthClientTest.html#property_client">$client</li>
847-
<li class=""><a href="classes/Tests-FusionAuthClientTest.html#property_userId">$userId</li>
845+
<li class=""><a href="classes/Tests-FusionAuthClientTest.html#property_applicationId">$applicationId</a></li>
846+
<li class=""><a href="classes/Tests-FusionAuthClientTest.html#property_client">$client</a></li>
847+
<li class=""><a href="classes/Tests-FusionAuthClientTest.html#property_userId">$userId</a></li>
848848
</ul>
849849
</li>
850850

‎docs/css/template.css‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,3 +280,6 @@
280280
.phpdocumentor-title__link:hover {
281281
transform: none;
282282
}
283+
.phpdocumentor-uml-diagram svg {
284+
cursor: zoom-in;
285+
}

‎docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<title>FusionAuth PHP Client</title>
66

77
<meta name="viewport" content="width=device-width, initial-scale=1.0">
8-
8+
<base href="./">
99
<link rel="icon" href="images/favicon.ico"/>
1010
<link rel="stylesheet" href="css/normalize.css">
1111
<link rel="stylesheet" href="css/base.css">

‎docs/js/searchIndex.js‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1345,6 +1345,16 @@ Search.appendIndex(
13451345
"name": "retrieveWebhook",
13461346
"summary": "Retrieves\u0020the\u0020webhook\u0020for\u0020the\u0020given\u0020Id.\u0020If\u0020you\u0020pass\u0020in\u0020null\u0020for\u0020the\u0020id,\u0020this\u0020will\u0020return\u0020all\u0020the\u0020webhooks.",
13471347
"url": "classes/FusionAuth-FusionAuthClient.html#method_retrieveWebhook"
1348+
}, {
1349+
"fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AretrieveWebhookAttemptLog\u0028\u0029",
1350+
"name": "retrieveWebhookAttemptLog",
1351+
"summary": "Retrieves\u0020a\u0020single\u0020webhook\u0020attempt\u0020log\u0020for\u0020the\u0020given\u0020Id.",
1352+
"url": "classes/FusionAuth-FusionAuthClient.html#method_retrieveWebhookAttemptLog"
1353+
}, {
1354+
"fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AretrieveWebhookEventLog\u0028\u0029",
1355+
"name": "retrieveWebhookEventLog",
1356+
"summary": "Retrieves\u0020a\u0020single\u0020webhook\u0020event\u0020log\u0020for\u0020the\u0020given\u0020Id.",
1357+
"url": "classes/FusionAuth-FusionAuthClient.html#method_retrieveWebhookEventLog"
13481358
}, {
13491359
"fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AretrieveWebhooks\u0028\u0029",
13501360
"name": "retrieveWebhooks",
@@ -1505,6 +1515,11 @@ Search.appendIndex(
15051515
"name": "searchUsersByQueryString",
15061516
"summary": "Retrieves\u0020the\u0020users\u0020for\u0020the\u0020given\u0020search\u0020criteria\u0020and\u0020pagination.",
15071517
"url": "classes/FusionAuth-FusionAuthClient.html#method_searchUsersByQueryString"
1518+
}, {
1519+
"fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AsearchWebhookEventLogs\u0028\u0029",
1520+
"name": "searchWebhookEventLogs",
1521+
"summary": "Searches\u0020the\u0020webhook\u0020event\u0020logs\u0020with\u0020the\u0020specified\u0020criteria\u0020and\u0020pagination.",
1522+
"url": "classes/FusionAuth-FusionAuthClient.html#method_searchWebhookEventLogs"
15081523
}, {
15091524
"fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AsearchWebhooks\u0028\u0029",
15101525
"name": "searchWebhooks",

‎docs/js/template.js‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,20 @@
1515
observer.observe(el);
1616
})
1717
})();
18+
function openSvg(svg) {
19+
// convert to a valid XML source
20+
const as_text = new XMLSerializer().serializeToString(svg);
21+
// store in a Blob
22+
const blob = new Blob([as_text], { type: "image/svg+xml" });
23+
// create an URI pointing to that blob
24+
const url = URL.createObjectURL(blob);
25+
const win = open(url);
26+
// so the Garbage Collector can collect the blob
27+
win.onload = (evt) => URL.revokeObjectURL(url);
28+
};
29+
30+
31+
var svgs = document.querySelectorAll(".phpdocumentor-uml-diagram svg");
32+
for( var i=0,il = svgs.length; i< il; i ++ ) {
33+
svgs[i].onclick = (evt) => openSvg(evt.target);
34+
}

0 commit comments

Comments
 (0)