Skip to content

Commit 502dab6

Browse files
seth-mgseth-mg
committed
publish php apidocs 1.26.0
1 parent 54f3442 commit 502dab6

File tree

90 files changed

+23958
-752
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+23958
-752
lines changed

‎classes/rosette-api-Address.html‎

Lines changed: 1519 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/rosette-api-AddressSimilarityParameters.html‎

Lines changed: 717 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/rosette-api-Api.html‎

Lines changed: 3361 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/rosette-api-CustomException.html‎

Lines changed: 439 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/rosette-api-DocumentParameters.html‎

Lines changed: 1125 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/rosette-api-FieldedAddress.html‎

Lines changed: 1506 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/rosette-api-IAddress.html‎

Lines changed: 272 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,272 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Documentation</title>
6+
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
8+
<base href="../">
9+
<link rel="icon" href="images/favicon.ico"/>
10+
<link rel="stylesheet" href="css/normalize.css">
11+
<link rel="stylesheet" href="css/base.css">
12+
<link rel="preconnect" href="https://fonts.gstatic.com">
13+
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
14+
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
15+
<link rel="stylesheet" href="css/template.css">
16+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
17+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/themes/prism-okaidia.css">
18+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-numbers/prism-line-numbers.css">
19+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-highlight/prism-line-highlight.css">
20+
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
21+
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
22+
<script src="js/search.js"></script>
23+
<script defer src="js/searchIndex.js"></script>
24+
</head>
25+
<body id="top">
26+
<header class="phpdocumentor-header phpdocumentor-section">
27+
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
28+
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
29+
<label class="phpdocumentor-header__menu-icon" for="menu-button">
30+
<i class="fas fa-bars"></i>
31+
</label>
32+
<section data-search-form class="phpdocumentor-search">
33+
<label>
34+
<span class="visually-hidden">Search for</span>
35+
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
36+
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
37+
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
38+
</svg>
39+
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
40+
</label>
41+
</section>
42+
43+
<nav class="phpdocumentor-topnav">
44+
<ul class="phpdocumentor-topnav__menu">
45+
</ul>
46+
</nav>
47+
</header>
48+
49+
<main class="phpdocumentor">
50+
<div class="phpdocumentor-section">
51+
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
52+
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
53+
Menu
54+
</label>
55+
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
56+
<section class="phpdocumentor-sidebar__category">
57+
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
58+
<h4 class="phpdocumentor-sidebar__root-namespace">
59+
<a href="namespaces/rosette.html" class="">rosette</a>
60+
</h4>
61+
<ul class="phpdocumentor-list">
62+
<li>
63+
<a href="namespaces/rosette-api.html" class="">api</a>
64+
65+
</li>
66+
</ul>
67+
68+
</section>
69+
<section class="phpdocumentor-sidebar__category">
70+
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
71+
<h4 class="phpdocumentor-sidebar__root-namespace">
72+
<a href="packages/Application.html" class="">Application</a>
73+
</h4>
74+
75+
</section>
76+
77+
<section class="phpdocumentor-sidebar__category">
78+
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
79+
<h3 class="phpdocumentor-sidebar__root-package"><a href="graphs/classes.html">Class Diagram</a></h3>
80+
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
81+
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
82+
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
83+
</section>
84+
85+
<section class="phpdocumentor-sidebar__category">
86+
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
87+
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
88+
</section>
89+
</aside>
90+
91+
<div class="phpdocumentor-column -eight phpdocumentor-content">
92+
<ul class="phpdocumentor-breadcrumbs">
93+
<li class="phpdocumentor-breadcrumb"><a href="namespaces/rosette.html">rosette</a></li>
94+
<li class="phpdocumentor-breadcrumb"><a href="namespaces/rosette-api.html">api</a></li>
95+
</ul>
96+
97+
<article class="phpdocumentor-element -interface">
98+
<h2 class="phpdocumentor-content__title">
99+
IAddress
100+
<div class="phpdocumentor-element__package">
101+
in
102+
<ul class="phpdocumentor-breadcrumbs">
103+
<li><a href="packages/Application.html">Application</a></li>
104+
</ul>
105+
</div>
106+
</h2>
107+
108+
<aside class="phpdocumentor-element-found-in">
109+
<abbr class="phpdocumentor-element-found-in__file" title="source/rosette/api/IAddress.php"><a href="files/source-rosette-api-iaddress.html"><abbr title="source/rosette/api/IAddress.php">IAddress.php</abbr></a></abbr>
110+
:
111+
<span class="phpdocumentor-element-found-in__line">21</span>
112+
113+
</aside>
114+
115+
<p class="phpdocumentor-summary">Interface implemented by all Addresses</p>
116+
117+
118+
119+
120+
121+
122+
123+
124+
125+
<h3 id="toc">
126+
Table of Contents
127+
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
128+
</h3>
129+
130+
<dl class="phpdocumentor-table-of-contents">
131+
<dt class="phpdocumentor-table-of-contents__entry -method -public">
132+
<a href="classes/rosette-api-IAddress.html#method_fielded">fielded()</a>
133+
<span>
134+
&nbsp;: bool </span>
135+
</dt>
136+
<dd>Returns whether or not this address is fielded.</dd>
137+
138+
</dl>
139+
140+
141+
142+
143+
144+
<section class="phpdocumentor-methods">
145+
<h3 class="phpdocumentor-elements__header" id="methods">
146+
Methods
147+
<a href="classes/rosette-api-IAddress.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
148+
</h3>
149+
<article
150+
class="phpdocumentor-element
151+
-method
152+
-public
153+
"
154+
>
155+
<h4 class="phpdocumentor-element__name" id="method_fielded">
156+
fielded()
157+
<a href="classes/rosette-api-IAddress.html#method_fielded" class="headerlink"><i class="fas fa-link"></i></a>
158+
</h4>
159+
<aside class="phpdocumentor-element-found-in">
160+
<abbr class="phpdocumentor-element-found-in__file" title="source/rosette/api/IAddress.php"><a href="files/source-rosette-api-iaddress.html"><abbr title="source/rosette/api/IAddress.php">IAddress.php</abbr></a></abbr>
161+
:
162+
<span class="phpdocumentor-element-found-in__line">29</span>
163+
164+
</aside>
165+
166+
<p class="phpdocumentor-summary">Returns whether or not this address is fielded.</p>
167+
168+
<code class="phpdocumentor-code phpdocumentor-signature ">
169+
<span class="phpdocumentor-signature__visibility">public</span>
170+
<span class="phpdocumentor-signature__name">fielded</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
171+
172+
173+
174+
175+
176+
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
177+
<span class="phpdocumentor-signature__response_type">bool</span>
178+
&mdash;
179+
180+
181+
</article>
182+
</section>
183+
184+
185+
<script type="text/javascript">
186+
function loadExternalCodeSnippets(line) {
187+
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
188+
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
189+
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
190+
var language = 'php';
191+
192+
var code = document.createElement('code');
193+
code.className = 'language-' + language;
194+
195+
pre.textContent = '';
196+
197+
pre.setAttribute('data-line', line)
198+
code.textContent = 'Loading…';
199+
200+
pre.appendChild(code);
201+
202+
var xhr = new XMLHttpRequest();
203+
204+
xhr.open('GET', src, true);
205+
206+
xhr.onreadystatechange = function () {
207+
if (xhr.readyState == 4) {
208+
209+
if (xhr.status < 400 && xhr.responseText) {
210+
code.textContent = xhr.responseText;
211+
212+
Prism.highlightElement(code);
213+
}
214+
else if (xhr.status >= 400) {
215+
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
216+
}
217+
else {
218+
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
219+
}
220+
}
221+
};
222+
223+
xhr.send(null);
224+
});
225+
}
226+
227+
var modals = document.querySelectorAll("[data-modal]");
228+
229+
modals.forEach(function (trigger) {
230+
trigger.addEventListener("click", function (event) {
231+
//event.preventDefault();
232+
const modal = document.getElementById(trigger.dataset.modal);
233+
modal.classList.add("phpdocumentor-modal__open");
234+
loadExternalCodeSnippets(trigger.dataset.line)
235+
const exits = modal.querySelectorAll("[data-exit-button]");
236+
exits.forEach(function (exit) {
237+
exit.addEventListener("click", function (event) {
238+
event.preventDefault();
239+
modal.classList.remove("phpdocumentor-modal__open");
240+
});
241+
});
242+
});
243+
});
244+
</script>
245+
246+
</article>
247+
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
248+
<section class="phpdocumentor-search-results__dialog">
249+
<header class="phpdocumentor-search-results__header">
250+
<h2 class="phpdocumentor-search-results__title">Search results</h2>
251+
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
252+
</header>
253+
<section class="phpdocumentor-search-results__body">
254+
<ul class="phpdocumentor-search-results__entries"></ul>
255+
</section>
256+
</section>
257+
</section>
258+
</div>
259+
</div>
260+
<a href="classes/rosette-api-IAddress.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
261+
262+
</main>
263+
264+
<script>
265+
cssVars({});
266+
</script>
267+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/prism.min.js"></script>
268+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/plugins/autoloader/prism-autoloader.min.js"></script>
269+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-numbers/prism-line-numbers.min.js"></script>
270+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-highlight/prism-line-highlight.min.js"></script>
271+
</body>
272+
</html>

0 commit comments

Comments
 (0)