Skip to content

Commit 54f3442

Browse files
seth-mgseth-mg
committed
publish php apidocs 1.14.3
1 parent e6436c3 commit 54f3442

25 files changed

+1621
-81
lines changed

‎classes.svg‎

Lines changed: 71 additions & 47 deletions
Loading

‎classes/rosette.api.Address.html‎

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

‎classes/rosette.api.AddressSimilarityParameters.html‎

Lines changed: 283 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,283 @@
1+
<!DOCTYPE html><html lang="en">
2+
<head>
3+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4+
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
5+
<meta charset="utf-8">
6+
<title>API Documentation » \rosette\api\AddressSimilarityParameters</title>
7+
<meta name="author" content="Mike van Riel">
8+
<meta name="description" content="">
9+
<link href="../css/template.css" rel="stylesheet" media="all">
10+
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
11+
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
12+
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
13+
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
14+
</head>
15+
<body>
16+
<div class="navbar navbar-fixed-top">
17+
<div class="navbar-inner"><div class="container">
18+
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">API Documentation</a><div class="nav-collapse"><ul class="nav">
19+
<li class="dropdown">
20+
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
21+
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
22+
<li><a>Namespaces</a></li>
23+
<li><a href="../namespaces/rosette.html"><i class="icon-th"></i> rosette</a></li>
24+
<li><a>Packages</a></li>
25+
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
26+
</ul>
27+
</li>
28+
<li class="dropdown" id="charts-menu">
29+
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
30+
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
31+
</li>
32+
<li class="dropdown" id="reports-menu">
33+
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
34+
Reports <b class="caret"></b></a><ul class="dropdown-menu">
35+
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
36+
<span class="label label-info">9</span></a></li>
37+
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
38+
<ul></ul></a></li>
39+
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
40+
<span class="label label-info">0</span></a></li>
41+
</ul>
42+
</li>
43+
</ul></div>
44+
</div></div>
45+
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
46+
</div>
47+
<div id="___" class="container">
48+
<noscript><div class="alert alert-warning">
49+
Javascript is disabled; several features are only available
50+
if Javascript is enabled.
51+
</div></noscript>
52+
<div class="row">
53+
<div class="span4">
54+
<div xmlns:php="http://php.net/xsl" class="btn-toolbar">
55+
<div class="btn-group visibility" data-toggle="buttons-checkbox">
56+
<button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button>
57+
</div>
58+
<div class="btn-group view pull-right" data-toggle="buttons-radio">
59+
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
60+
</div>
61+
</div>
62+
<ul xmlns:php="http://php.net/xsl" class="side-nav nav nav-list">
63+
<li class="nav-header">
64+
<i title="Methods" class="icon-custom icon-method"></i> Methods
65+
<ul>
66+
<li class="method public "><a href="#method___construct" title="__construct() :: constructor."><span class="description">constructor.</span><pre>__construct()</pre></a></li>
67+
<li class="method public inherited"><a href="#method_get" title="get() :: Gets a property value based on the property name."><span class="description">Gets a property value based on the property name.</span><pre>get()</pre></a></li>
68+
<li class="method public inherited"><a href="#method_getMultiPartContent" title="getMultiPartContent() :: Provides default multiPart call for child classes that don't implement it"><span class="description">Provides default multiPart call for child classes that don't implement it</span><pre>getMultiPartContent()</pre></a></li>
69+
<li class="method public inherited"><a href="#method_serialize" title="serialize() :: Serialize into a json string."><span class="description">Serialize into a json string.</span><pre>serialize()</pre></a></li>
70+
<li class="method public inherited"><a href="#method_set" title="set() :: Sets a property based on the name."><span class="description">Sets a property based on the name.</span><pre>set()</pre></a></li>
71+
<li class="method public "><a href="#method_validate" title="validate() :: Validates parameters."><span class="description">Validates parameters.</span><pre>validate()</pre></a></li>
72+
<li class="method public inherited"><a href="#method_validate" title="validate() :: Validates parameters before serializing them."><span class="description">Validates parameters before serializing them.</span><pre>validate()</pre></a></li>
73+
</ul>
74+
</li>
75+
<li class="nav-header protected">» Protected
76+
<ul><li class="method protected inherited"><a href="#method___construct" title="__construct() :: Constructor."><span class="description">Constructor.</span><pre>__construct()</pre></a></li></ul>
77+
</li>
78+
<li class="nav-header private">» Private
79+
<ul><li class="method private inherited"><a href="#method_removeEmptyProperties" title="removeEmptyProperties() :: Recursively removes empty properties to facilitate json encoding."><span class="description">Recursively removes empty properties to facilitate json encoding.</span><pre>removeEmptyProperties()</pre></a></li></ul>
80+
</li>
81+
<li class="nav-header">
82+
<i title="Properties" class="icon-custom icon-property"></i> Properties
83+
<ul>
84+
<li class="property public "><a href="#property_address1" title="$address1() :: "><span class="description">Address1 address 1</span><pre>$address1</pre></a></li>
85+
<li class="property public "><a href="#property_address2" title="$address2() :: "><span class="description">Address2 address 2</span><pre>$address2</pre></a></li>
86+
</ul>
87+
</li>
88+
</ul>
89+
</div>
90+
<div class="span8">
91+
<a xmlns:php="http://php.net/xsl" id="\rosette\api\AddressSimilarityParameters"></a><ul xmlns:php="http://php.net/xsl" class="breadcrumb">
92+
<li>
93+
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
94+
</li>
95+
<li><a href="../namespaces/rosette.html">rosette</a></li>
96+
<li>
97+
<span class="divider">\</span><a href="../namespaces/rosette.api.html">api</a>
98+
</li>
99+
<li class="active">
100+
<span class="divider">\</span><a href="../classes/rosette.api.AddressSimilarityParameters.html">AddressSimilarityParameters</a>
101+
</li>
102+
</ul>
103+
<div xmlns:php="http://php.net/xsl" class="element class">
104+
<p class="short_description">Class AddressSimilarityParameters.</p>
105+
<div class="details">
106+
<div class="long_description"></div>
107+
<table class="table table-bordered">
108+
<tr>
109+
<th>package</th>
110+
<td><a href="../packages/Default.html">Default</a></td>
111+
</tr>
112+
<tr>
113+
<th>inherited_from</th>
114+
<td>\rosette\api\RosetteParamsSetBase</td>
115+
</tr>
116+
</table>
117+
<h3>
118+
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
119+
<a id="method___construct"></a><div class="element clickable method public method___construct " data-toggle="collapse" data-target=".method___construct .collapse" title="public">
120+
<h2>constructor.</h2>
121+
<pre>__construct(\rosette\api\Address $Address1, \rosette\api\Address $Address2) </pre>
122+
<div class="labels"></div>
123+
<div class="row collapse"><div class="detail-description">
124+
<div class="long_description"></div>
125+
<table class="table table-bordered"><tr>
126+
<th>inherited_from</th>
127+
<td>\rosette\api\RosetteParamsSetBase::__construct()</td>
128+
</tr></table>
129+
<h3>Parameters</h3>
130+
<div class="subelement argument">
131+
<h4>$Address1</h4>
132+
<code>\rosette\api\Address</code><ul>
133+
<li>Address1 to be compared</li>
134+
</ul></div>
135+
<div class="subelement argument">
136+
<h4>$Address2</h4>
137+
<code>\rosette\api\Address</code><ul>
138+
<li>Address2 to be compared</li>
139+
</ul></div>
140+
</div></div>
141+
</div>
142+
<a id="method_get"></a><div class="element clickable method public method_get inherited" data-toggle="collapse" data-target=".method_get .collapse" title="public">
143+
<h2>Gets a property value based on the property name.</h2>
144+
<pre>get(string $propertyName) : mixed</pre>
145+
<div class="labels"><span class="label">Inherited</span></div>
146+
<div class="row collapse"><div class="detail-description">
147+
<div class="long_description"></div>
148+
<h3>Parameters</h3>
149+
<div class="subelement argument">
150+
<h4>$propertyName</h4>
151+
<code>string</code><p>the name of the property</p></div>
152+
<h3>Exceptions</h3>
153+
<table class="table table-bordered"><tr>
154+
<th><code>\rosette\api\RosetteException</code></th>
155+
<td>if property name not found</td>
156+
</tr></table>
157+
<h3>Returns</h3>
158+
<div class="subelement response">
159+
<code>mixed</code>property value</div>
160+
</div></div>
161+
</div>
162+
<a id="method_getMultiPartContent"></a><div class="element clickable method public method_getMultiPartContent inherited" data-toggle="collapse" data-target=".method_getMultiPartContent .collapse" title="public">
163+
<h2>Provides default multiPart call for child classes that don't implement it</h2>
164+
<pre>getMultiPartContent() : string</pre>
165+
<div class="labels"><span class="label">Inherited</span></div>
166+
<div class="row collapse"><div class="detail-description">
167+
<div class="long_description"></div>
168+
<h3>Returns</h3>
169+
<div class="subelement response"><code>string</code></div>
170+
</div></div>
171+
</div>
172+
<a id="method_serialize"></a><div class="element clickable method public method_serialize inherited" data-toggle="collapse" data-target=".method_serialize .collapse" title="public">
173+
<h2>Serialize into a json string.</h2>
174+
<pre>serialize($options) : string</pre>
175+
<div class="labels"><span class="label">Inherited</span></div>
176+
<div class="row collapse"><div class="detail-description">
177+
<div class="long_description"></div>
178+
<h3>Parameters</h3>
179+
<div class="subelement argument">
180+
<h4>$options</h4><p>associative array of options</p></div>
181+
<h3>Returns</h3>
182+
<div class="subelement response"><code>string</code></div>
183+
</div></div>
184+
</div>
185+
<a id="method_set"></a><div class="element clickable method public method_set inherited" data-toggle="collapse" data-target=".method_set .collapse" title="public">
186+
<h2>Sets a property based on the name.</h2>
187+
<pre>set(string $propertyName, mixed $value) </pre>
188+
<div class="labels"><span class="label">Inherited</span></div>
189+
<div class="row collapse"><div class="detail-description">
190+
<div class="long_description"></div>
191+
<h3>Parameters</h3>
192+
<div class="subelement argument">
193+
<h4>$propertyName</h4>
194+
<code>string</code><p>the name of the property</p></div>
195+
<div class="subelement argument">
196+
<h4>$value</h4>
197+
<code>mixed</code><p>the value to set</p></div>
198+
</div></div>
199+
</div>
200+
<a id="method_validate"></a><div class="element clickable method public method_validate " data-toggle="collapse" data-target=".method_validate .collapse" title="public">
201+
<h2>Validates parameters.</h2>
202+
<pre>validate() </pre>
203+
<div class="labels"></div>
204+
<div class="row collapse"><div class="detail-description">
205+
<div class="long_description"></div>
206+
<table class="table table-bordered"><tr>
207+
<th>inherited_from</th>
208+
<td>\rosette\api\RosetteParamsSetBase::validate()</td>
209+
</tr></table>
210+
<h3>Exceptions</h3>
211+
<table class="table table-bordered"><tr>
212+
<th><code>\rosette\api\RosetteException</code></th>
213+
<td></td>
214+
</tr></table>
215+
</div></div>
216+
</div>
217+
<a id="method_validate"></a><div class="element clickable method public method_validate inherited" data-toggle="collapse" data-target=".method_validate .collapse" title="public">
218+
<h2>Validates parameters before serializing them.</h2>
219+
<pre>validate() : mixed</pre>
220+
<div class="labels"><span class="label">Inherited</span></div>
221+
<div class="row collapse"><div class="detail-description">
222+
<div class="long_description"></div>
223+
<h3>Exceptions</h3>
224+
<table class="table table-bordered"><tr>
225+
<th><code>\rosette\api\RosetteException</code></th>
226+
<td></td>
227+
</tr></table>
228+
<h3>Returns</h3>
229+
<div class="subelement response"><code>mixed</code></div>
230+
</div></div>
231+
</div>
232+
<a id="method___construct"></a><div class="element clickable method protected method___construct inherited" data-toggle="collapse" data-target=".method___construct .collapse" title="protected">
233+
<h2>Constructor.</h2>
234+
<pre>__construct() </pre>
235+
<div class="labels"><span class="label">Inherited</span></div>
236+
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
237+
</div>
238+
<a id="method_removeEmptyProperties"></a><div class="element clickable method private method_removeEmptyProperties inherited" data-toggle="collapse" data-target=".method_removeEmptyProperties .collapse" title="private">
239+
<h2>Recursively removes empty properties to facilitate json encoding.</h2>
240+
<pre>removeEmptyProperties($obj) : mixed</pre>
241+
<div class="labels"><span class="label">Inherited</span></div>
242+
<div class="row collapse"><div class="detail-description">
243+
<div class="long_description"></div>
244+
<h3>Parameters</h3>
245+
<div class="subelement argument">
246+
<h4>$obj</h4><p>Object to clean</p></div>
247+
<h3>Returns</h3>
248+
<div class="subelement response"><code>mixed</code></div>
249+
</div></div>
250+
</div>
251+
<h3>
252+
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
253+
<a id="property_address1"> </a><div class="element clickable property public property_address1" data-toggle="collapse" data-target=".property_address1 .collapse" title="public">
254+
<h2>Address1 address 1</h2>
255+
<pre>$address1 : \rosette\api\Address</pre>
256+
<div class="row collapse"><div class="detail-description">
257+
<h3>Default</h3>
258+
<div class="subelement argument"></div>
259+
</div></div>
260+
<div class="labels"></div>
261+
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
262+
</div>
263+
<a id="property_address2"> </a><div class="element clickable property public property_address2" data-toggle="collapse" data-target=".property_address2 .collapse" title="public">
264+
<h2>Address2 address 2</h2>
265+
<pre>$address2 : \rosette\api\Address</pre>
266+
<div class="row collapse"><div class="detail-description">
267+
<h3>Default</h3>
268+
<div class="subelement argument"></div>
269+
</div></div>
270+
<div class="labels"></div>
271+
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
272+
</div>
273+
</div>
274+
</div>
275+
</div>
276+
</div>
277+
<div class="row"><footer class="span12">
278+
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
279+
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.8.5</a> and<br>
280+
generated on 2019-10-31T21:34:28Z.<br></footer></div>
281+
</div>
282+
</body>
283+
</html>

‎classes/rosette.api.Api.html‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@
6464
<i title="Methods" class="icon-custom icon-method"></i> Methods
6565
<ul>
6666
<li class="method public "><a href="#method___construct" title="__construct() :: Create an L{API} object."><span class="description">Create an L{API} object.</span><pre>__construct()</pre></a></li>
67+
<li class="method public "><a href="#method_addressSimilarity" title="addressSimilarity() :: Calls the addressSimilarity endpoint"><span class="description">Calls the addressSimilarity endpoint</span><pre>addressSimilarity()</pre></a></li>
6768
<li class="method public "><a href="#method_categories" title="categories() :: Calls the categories endpoint."><span class="description">Calls the categories endpoint.</span><pre>categories()</pre></a></li>
6869
<li class="method public "><a href="#method_clearCustomHeaders" title="clearCustomHeaders() :: Clears all custom headers"><span class="description">Clears all custom headers</span><pre>clearCustomHeaders()</pre></a></li>
6970
<li class="method public "><a href="#method_clearOptions" title="clearOptions() :: Clears all options"><span class="description">Clears all options</span><pre>clearOptions()</pre></a></li>
@@ -186,6 +187,23 @@ <h4>$service_url</h4>
186187
<code>string</code><p>URL of the Api API</p></div>
187188
</div></div>
188189
</div>
190+
<a id="method_addressSimilarity"></a><div class="element clickable method public method_addressSimilarity " data-toggle="collapse" data-target=".method_addressSimilarity .collapse" title="public">
191+
<h2>Calls the addressSimilarity endpoint</h2>
192+
<pre>addressSimilarity($params) : mixed</pre>
193+
<div class="labels"></div>
194+
<div class="row collapse"><div class="detail-description">
195+
<div class="long_description"></div>
196+
<h3>Parameters</h3>
197+
<div class="subelement argument"><h4>$params</h4></div>
198+
<h3>Exceptions</h3>
199+
<table class="table table-bordered"><tr>
200+
<th><code>\rosette\api\RosetteException</code></th>
201+
<td></td>
202+
</tr></table>
203+
<h3>Returns</h3>
204+
<div class="subelement response"><code>mixed</code></div>
205+
</div></div>
206+
</div>
189207
<a id="method_categories"></a><div class="element clickable method public method_categories " data-toggle="collapse" data-target=".method_categories .collapse" title="public">
190208
<h2>Calls the categories endpoint.</h2>
191209
<pre>categories($params) : mixed</pre>
@@ -814,7 +832,7 @@ <h2>Compatible server version.</h2>
814832
<pre>$binding_version : string</pre>
815833
<div class="row collapse"><div class="detail-description">
816834
<h3>Default</h3>
817-
<div class="subelement argument"><code>'1.12.1'</code></div>
835+
<div class="subelement argument"><code>'1.14.3'</code></div>
818836
</div></div>
819837
<div class="labels"><span class="label">Static</span></div>
820838
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
@@ -916,7 +934,7 @@ <h3>Default</h3>
916934
<div class="row"><footer class="span12">
917935
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
918936
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.8.5</a> and<br>
919-
generated on 2019-02-10T23:51:44Z.<br></footer></div>
937+
generated on 2019-10-31T21:34:28Z.<br></footer></div>
920938
</div>
921939
</body>
922940
</html>

‎classes/rosette.api.CustomException.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ <h3>Default</h3>
188188
<div class="row"><footer class="span12">
189189
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
190190
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.8.5</a> and<br>
191-
generated on 2019-02-10T23:51:44Z.<br></footer></div>
191+
generated on 2019-10-31T21:34:28Z.<br></footer></div>
192192
</div>
193193
</body>
194194
</html>

0 commit comments

Comments
 (0)