Skip to content

Commit fe99ba5

Browse files
frankmayerjsteemann
frankmayer
authored and
jsteemann
committed
Recreated Docs
1 parent c22fa48 commit fe99ba5

File tree

51 files changed

+7301
-7018
lines changed

Some content is hidden

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

51 files changed

+7301
-7018
lines changed

‎docs/class-triagens.ArangoDb.AdminHandler.html

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,7 @@ <h1>Class AdminHandler</h1>
140140
<div class="description">
141141
<p>Provides access to ArangoDB's administration interface</p>
142142

143-
<p>The admin handler utilizes ArangoDB's Admin API.<br>
144-
<br></p>
143+
<p>The admin handler utilizes ArangoDB's Admin API.</p>
145144
</div>
146145

147146
<dl class="tree well">
@@ -174,7 +173,7 @@ <h1>Class AdminHandler</h1>
174173

175174
<b>Since:</b>
176175
1.2<br>
177-
<b>Located at</b> <a href="source-class-triagens.ArangoDb.AdminHandler.html#16-222" title="Go to source code">AdminHandler.php</a>
176+
<b>Located at</b> <a href="source-class-triagens.ArangoDb.AdminHandler.html#16-221" title="Go to source code">AdminHandler.php</a>
178177
<br>
179178
</div>
180179

@@ -194,7 +193,7 @@ <h1>Class AdminHandler</h1>
194193

195194
<td class="name"><div>
196195
<a class="anchor" href="#_getServerVersion">#</a>
197-
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#33-61" title="Go to source code">getServerVersion</a>( <span>boolean <var>$details</var> = <span class="php-keyword1">false</span></span> )</code>
196+
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#32-60" title="Go to source code">getServerVersion</a>( <span>boolean <var>$details</var> = <span class="php-keyword1">false</span></span> )</code>
198197

199198
<div class="description short">
200199
<p>Get the server version</p>
@@ -246,7 +245,7 @@ <h4>Since</h4>
246245

247246
<td class="name"><div>
248247
<a class="anchor" href="#_getServerRole">#</a>
249-
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#63-80" title="Go to source code">getServerRole</a>( )</code>
248+
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#62-79" title="Go to source code">getServerRole</a>( )</code>
250249

251250
<div class="description short">
252251
<p>Get the server role</p>
@@ -291,7 +290,7 @@ <h4>Since</h4>
291290

292291
<td class="name"><div>
293292
<a class="anchor" href="#_getServerTime">#</a>
294-
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#83-99" title="Go to source code">getServerTime</a>( )</code>
293+
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#82-98" title="Go to source code">getServerTime</a>( )</code>
295294

296295
<div class="description short">
297296
<p>Get the server time</p>
@@ -336,7 +335,7 @@ <h4>Since</h4>
336335

337336
<td class="name"><div>
338337
<a class="anchor" href="#_getServerLog">#</a>
339-
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#102-137" title="Go to source code">getServerLog</a>( <span>array <var>$options</var> = []</span> )</code>
338+
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#101-136" title="Go to source code">getServerLog</a>( <span>array <var>$options</var> = []</span> )</code>
340339

341340
<div class="description short">
342341
<p>Get the server log</p>
@@ -405,7 +404,7 @@ <h4>Since</h4>
405404

406405
<td class="name"><div>
407406
<a class="anchor" href="#_reloadServerRouting">#</a>
408-
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#140-156" title="Go to source code">reloadServerRouting</a>( )</code>
407+
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#139-155" title="Go to source code">reloadServerRouting</a>( )</code>
409408

410409
<div class="description short">
411410
<p>Reload the server's routing information
@@ -450,7 +449,7 @@ <h4>Since</h4>
450449

451450
<td class="name"><div>
452451
<a class="anchor" href="#_getServerStatistics">#</a>
453-
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#159-187" title="Go to source code">getServerStatistics</a>( )</code>
452+
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#158-186" title="Go to source code">getServerStatistics</a>( )</code>
454453

455454
<div class="description short">
456455
<p>Get the server statistics
@@ -495,7 +494,7 @@ <h4>See</h4>
495494
</div>
496495
<h4>Link</h4>
497496
<div class="list">
498-
<a href="http://www.arangodb.com/manuals/1.3.devel/HttpSystem.html#HttpSystemAdminStatistics">This will throw if the statistics cannot be retrieved</a><br>
497+
<a href="https://docs.arangodb.com/HTTP/AdministrationAndMonitoring/index.html">This will throw if the statistics cannot be retrieved</a><br>
499498
</div>
500499

501500

@@ -513,7 +512,7 @@ <h4>Link</h4>
513512

514513
<td class="name"><div>
515514
<a class="anchor" href="#_getServerStatisticsDescription">#</a>
516-
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#190-221" title="Go to source code">getServerStatisticsDescription</a>( <span>array <var>$options</var> = []</span> )</code>
515+
<code><a href="source-class-triagens.ArangoDb.AdminHandler.html#189-220" title="Go to source code">getServerStatisticsDescription</a>( <span>array <var>$options</var> = []</span> )</code>
517516

518517
<div class="description short">
519518
<p>Returns a description of the statistics returned by getServerStatistics().
@@ -564,7 +563,7 @@ <h4>See</h4>
564563
</div>
565564
<h4>Link</h4>
566565
<div class="list">
567-
<a href="http://www.arangodb.com/manuals/1.3.devel/HttpSystem.html#HttpSystemAdminStatistics">This will throw if the statistics-description cannot be retrieved</a><br>
566+
<a href="https://docs.arangodb.com/HTTP/AdministrationAndMonitoring/index.html">This will throw if the statistics-description cannot be retrieved</a><br>
568567
</div>
569568

570569

@@ -601,7 +600,7 @@ <h4>Link</h4>
601600
<td class="attributes"><code>string</code></td>
602601
<td class="name">
603602
<code>
604-
<a href="source-class-triagens.ArangoDb.AdminHandler.html#28-31" title="Go to source code"><b>OPTION_DETAILS</b></a>
603+
<a href="source-class-triagens.ArangoDb.AdminHandler.html#27-30" title="Go to source code"><b>OPTION_DETAILS</b></a>
605604
</code>
606605

607606
<div class="description short">

‎docs/class-triagens.ArangoDb.AqlUserFunction.html

Lines changed: 47 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ <h1>Class AqlUserFunction</h1>
142142

143143
<p>AqlUserFunction object<br>
144144
An AqlUserFunction is an object that is used to manage AQL User Functions.<br>
145-
It registers, unregisters and lists user functions on the server<br>
145+
It registers, un-registers and lists user functions on the server<br>
146146
<br>
147147
The object encapsulates:<br>
148148
<br></p>
@@ -186,7 +186,7 @@ <h1>Class AqlUserFunction</h1>
186186

187187
<b>Since:</b>
188188
1.3<br>
189-
<b>Located at</b> <a href="source-class-triagens.ArangoDb.AqlUserFunction.html#12-378" title="Go to source code">AqlUserFunction.php</a>
189+
<b>Located at</b> <a href="source-class-triagens.ArangoDb.AqlUserFunction.html#12-394" title="Go to source code">AqlUserFunction.php</a>
190190
<br>
191191
</div>
192192

@@ -307,11 +307,11 @@ <h4>Throws</h4>
307307
<code><a href="source-class-triagens.ArangoDb.AqlUserFunction.html#147-176" title="Go to source code">unregister</a>( <span>string <var>$name</var> = <span class="php-keyword1">null</span></span>, <span>boolean <var>$namespace</var> = <span class="php-keyword1">false</span></span> )</code>
308308

309309
<div class="description short">
310-
<p>Unregister the user function</p>
310+
<p>Un-register the user function</p>
311311
</div>
312312

313313
<div class="description detailed hidden">
314-
<p>Unregister the user function</p>
314+
<p>Un-register the user function</p>
315315

316316
<p>If no parameter ($name) is passed, it will use the property of the object.</p>
317317

@@ -704,6 +704,46 @@ <h4>Returns</h4>
704704

705705

706706

707+
</div>
708+
</div></td>
709+
</tr>
710+
<tr data-order="__isset" id="___isset">
711+
712+
<td class="attributes"><code>
713+
public
714+
boolean
715+
716+
</code>
717+
</td>
718+
719+
<td class="name"><div>
720+
<a class="anchor" href="#___isset">#</a>
721+
<code><a href="source-class-triagens.ArangoDb.AqlUserFunction.html#332-346" title="Go to source code">__isset</a>( <span>string <var>$key</var></span> )</code>
722+
723+
<div class="description short">
724+
<p>Is triggered by calling isset() or empty() on inaccessible properties.</p>
725+
</div>
726+
727+
<div class="description detailed hidden">
728+
<p>Is triggered by calling isset() or empty() on inaccessible properties.</p>
729+
730+
731+
<h4>Parameters</h4>
732+
<div class="list"><dl>
733+
<dt><var>$key</var></dt>
734+
<dd><ul>
735+
<li>name of attribute</li>
736+
</ul></dd>
737+
</dl></div>
738+
739+
<h4>Returns</h4>
740+
<div class="list">
741+
boolean<br>returns true or false (set or not set)
742+
</div>
743+
744+
745+
746+
707747
</div>
708748
</div></td>
709749
</tr>
@@ -718,7 +758,7 @@ <h4>Returns</h4>
718758

719759
<td class="name"><div>
720760
<a class="anchor" href="#___get">#</a>
721-
<code><a href="source-class-triagens.ArangoDb.AqlUserFunction.html#332-346" title="Go to source code">__get</a>( <span>string <var>$key</var></span> )</code>
761+
<code><a href="source-class-triagens.ArangoDb.AqlUserFunction.html#348-362" title="Go to source code">__get</a>( <span>string <var>$key</var></span> )</code>
722762

723763
<div class="description short">
724764
<p>Get an attribute, magic method</p>
@@ -765,7 +805,7 @@ <h4>Magic</h4>
765805

766806
<td class="name"><div>
767807
<a class="anchor" href="#___toString">#</a>
768-
<code><a href="source-class-triagens.ArangoDb.AqlUserFunction.html#349-359" title="Go to source code">__toString</a>( )</code>
808+
<code><a href="source-class-triagens.ArangoDb.AqlUserFunction.html#365-375" title="Go to source code">__toString</a>( )</code>
769809

770810
<div class="description short">
771811
<p>Returns the action string</p>
@@ -803,7 +843,7 @@ <h4>Magic</h4>
803843

804844
<td class="name"><div>
805845
<a class="anchor" href="#_buildAttributesFromArray">#</a>
806-
<code><a href="source-class-triagens.ArangoDb.AqlUserFunction.html#361-377" title="Go to source code">buildAttributesFromArray</a>( <span> <var>$options</var></span> )</code>
846+
<code><a href="source-class-triagens.ArangoDb.AqlUserFunction.html#377-393" title="Go to source code">buildAttributesFromArray</a>( <span> <var>$options</var></span> )</code>
807847

808848
<div class="description short">
809849
<p>Build the object's attributes from a given array</p>

0 commit comments

Comments
 (0)