Skip to content

Commit 5a3de81

Browse files
maxkernbachmaxkernbach
committed
generate 3.5 documentation
1 parent eee9a83 commit 5a3de81

File tree

66 files changed

+26352
-18777
lines changed

Some content is hidden

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

66 files changed

+26352
-18777
lines changed

‎docs/Drivers/PHP/Tutorial/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ object(ArangoDBClient\Document)##6 (4) {
277277
*/
278278
```
279279

280-
Whenever the document id is yet unknown, but you want to fetch a document from the server by any of its other properties, you can use the CollectionHandler->byExample() method. It allows you to provide an example of the document that you are looking for. The example should either be a Document object with the relevant properties set, or, a PHP array with the propeties that you are looking for:
280+
Whenever the document id is yet unknown, but you want to fetch a document from the server by any of its other properties, you can use the CollectionHandler->byExample() method. It allows you to provide an example of the document that you are looking for. The example should either be a Document object with the relevant properties set, or, a PHP array with the properties that you are looking for:
281281

282282
```php
283283
// get a document list back from the server, using a document example
@@ -287,7 +287,7 @@ Whenever the document id is yet unknown, but you want to fetch a document from t
287287
```
288288

289289
This will return all documents from the specified collection (here: "users") with the properties provided in the example (here: that have an attribute "name" with a value of "John"). The result is a cursor which can be iterated sequentially or completely. We have chosen to get the complete result set above by calling the cursor's getAll() method.
290-
Note that CollectionHandler->byExample() might return multiple documents if the example is ambigious.
290+
Note that CollectionHandler->byExample() might return multiple documents if the example is ambiguous.
291291

292292
## Updating a document
293293

‎docs/classes.svg

Lines changed: 400 additions & 352 deletions
Loading

‎docs/classes/ArangoDBClient.AdminHandler.html

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@
3131
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
3232
Reports <b class="caret"></b></a><ul class="dropdown-menu">
3333
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
34-
<span class="label label-info">22</span></a></li>
34+
<span class="label label-info">25</span></a></li>
3535
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
3636
<ul></ul></a></li>
3737
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
38-
<span class="label label-info">2</span></a></li>
38+
<span class="label label-info">15</span></a></li>
3939
</ul>
4040
</li>
4141
</ul></div>
@@ -82,6 +82,7 @@
8282
</li>
8383
<li class="nav-header protected">» Protected
8484
<ul>
85+
<li class="method protected inherited"><a href="#method_addTransactionHeader" title="addTransactionHeader() :: Add a transaction header to the array of headers in case this is a transactional operation"><span class="description">Add a transaction header to the array of headers in case this is a transactional operation</span><pre>addTransactionHeader()</pre></a></li>
8586
<li class="method protected inherited"><a href="#method_getConnection" title="getConnection() :: Return the connection object"><span class="description">Return the connection object</span><pre>getConnection()</pre></a></li>
8687
<li class="method protected inherited"><a href="#method_getConnectionOption" title="getConnectionOption() :: Return a connection option
8788
This is a convenience function that calls json_encode_wrapper on the connection"><span class="description">Return a connection option
@@ -406,6 +407,25 @@ <h3>Returns</h3>
406407
<div class="subelement response"><code>\ArangoDBClient\DocumentClassable</code></div>
407408
</div></div>
408409
</div>
410+
<a id="method_addTransactionHeader"></a><div class="element clickable method protected method_addTransactionHeader inherited" data-toggle="collapse" data-target=".method_addTransactionHeader .collapse" title="protected">
411+
<h2>Add a transaction header to the array of headers in case this is a transactional operation</h2>
412+
<pre>addTransactionHeader(array $headers, mixed $collection) </pre>
413+
<div class="labels"><span class="label">Inherited</span></div>
414+
<div class="row collapse"><div class="detail-description">
415+
<div class="long_description"></div>
416+
<h3>Parameters</h3>
417+
<div class="subelement argument">
418+
<h4>$headers</h4>
419+
<code>array</code><ul>
420+
<li>already existing headers</li>
421+
</ul></div>
422+
<div class="subelement argument">
423+
<h4>$collection</h4>
424+
<code>mixed</code><ul>
425+
<li>any type of collection (can be StreamingTransactionCollection or other)</li>
426+
</ul></div>
427+
</div></div>
428+
</div>
409429
<a id="method_getConnection"></a><div class="element clickable method protected method_getConnection inherited" data-toggle="collapse" data-target=".method_getConnection .collapse" title="protected">
410430
<h2>Return the connection object</h2>
411431
<pre>getConnection() : \ArangoDBClient\Connection</pre>
@@ -564,7 +584,7 @@ <h2>details for server version</h2>
564584
<div class="row"><footer class="span12">
565585
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>
566586
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
567-
generated on 2019-01-22T11:16:23+01:00.<br></footer></div>
587+
generated on 2019-08-19T13:30:49+02:00.<br></footer></div>
568588
</div>
569589
</body>
570590
</html>

‎docs/classes/ArangoDBClient.AqlUserFunction.html

Lines changed: 5 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@
3131
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
3232
Reports <b class="caret"></b></a><ul class="dropdown-menu">
3333
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
34-
<span class="label label-info">22</span></a></li>
34+
<span class="label label-info">25</span></a></li>
3535
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
3636
<ul></ul></a></li>
3737
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
38-
<span class="label label-info">2</span></a></li>
38+
<span class="label label-info">15</span></a></li>
3939
</ul>
4040
</li>
4141
</ul></div>
@@ -65,7 +65,6 @@
6565
<li class="method public "><a href="#method___get" title="__get() :: Get an attribute, magic method"><span class="description">Get an attribute, magic method</span><pre>__get()</pre></a></li>
6666
<li class="method public "><a href="#method___isset" title="__isset() :: Is triggered by calling isset() or empty() on inaccessible properties."><span class="description">Is triggered by calling isset() or empty() on inaccessible properties.</span><pre>__isset()</pre></a></li>
6767
<li class="method public "><a href="#method___set" title="__set() :: Set an attribute, magic method"><span class="description">Set an attribute, magic method</span><pre>__set()</pre></a></li>
68-
<li class="method public "><a href="#method___toString" title="__toString() :: Returns the action string"><span class="description">Returns the action string</span><pre>__toString()</pre></a></li>
6968
<li class="method public "><a href="#method_buildAttributesFromArray" title="buildAttributesFromArray() :: Build the object's attributes from a given array"><span class="description">Build the object's attributes from a given array</span><pre>buildAttributesFromArray()</pre></a></li>
7069
<li class="method public "><a href="#method_get" title="get() :: Get an attribute"><span class="description">Get an attribute</span><pre>get()</pre></a></li>
7170
<li class="method public "><a href="#method_getCode" title="getCode() :: Get user function code"><span class="description">Get user function code</span><pre>getCode()</pre></a></li>
@@ -84,16 +83,12 @@
8483
<li class="nav-header">
8584
<i title="Properties" class="icon-custom icon-property"></i> Properties
8685
<ul>
87-
<li class="property public "><a href="#property_" title="() :: _action"><span class="description"></span><pre></pre></a></li>
8886
<li class="property public "><a href="#property_code" title="$code() :: - The code of the user function"><span class="description"></span><pre>$code</pre></a></li>
8987
<li class="property public "><a href="#property_name" title="$name() :: - The name of the user function"><span class="description"></span><pre>$name</pre></a></li>
9088
</ul>
9189
</li>
9290
<li class="nav-header protected">» Protected
93-
<ul>
94-
<li class="property protected "><a href="#property__action" title="$_action() :: The transaction's action."><span class="description"></span><pre>$_action</pre></a></li>
95-
<li class="property protected "><a href="#property_attributes" title="$attributes() :: The transaction's attributes."><span class="description"></span><pre>$attributes</pre></a></li>
96-
</ul>
91+
<ul><li class="property protected "><a href="#property_attributes" title="$attributes() :: The function's attributes."><span class="description"></span><pre>$attributes</pre></a></li></ul>
9792
</li>
9893
<li class="nav-header private">» Private
9994
<ul><li class="property private "><a href="#property__connection" title="$_connection() :: The connection object"><span class="description"></span><pre>$_connection</pre></a></li></ul>
@@ -255,21 +250,6 @@ <h3>Exceptions</h3>
255250
</tr></table>
256251
</div></div>
257252
</div>
258-
<a id="method___toString"></a><div class="element clickable method public method___toString " data-toggle="collapse" data-target=".method___toString .collapse" title="public">
259-
<h2>Returns the action string</h2>
260-
<pre>__toString() : string</pre>
261-
<div class="labels"></div>
262-
<div class="row collapse"><div class="detail-description">
263-
<div class="long_description"></div>
264-
<table class="table table-bordered"><tr>
265-
<th>magic</th>
266-
<td></td>
267-
</tr></table>
268-
<h3>Returns</h3>
269-
<div class="subelement response">
270-
<code>string</code>- the current action string</div>
271-
</div></div>
272-
</div>
273253
<a id="method_buildAttributesFromArray"></a><div class="element clickable method public method_buildAttributesFromArray " data-toggle="collapse" data-target=".method_buildAttributesFromArray .collapse" title="public">
274254
<h2>Build the object's attributes from a given array</h2>
275255
<pre>buildAttributesFromArray($options) </pre>
@@ -472,28 +452,6 @@ <h3>Returns</h3>
472452
</div>
473453
<h3>
474454
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
475-
<a id="property_"> </a><div class="element clickable property public property_" data-toggle="collapse" data-target=".property_ .collapse" title="public">
476-
<h2>_action</h2>
477-
<pre> : string</pre>
478-
<div class="row collapse"><div class="detail-description">
479-
<h3>Default</h3>
480-
<div class="subelement argument"></div>
481-
</div></div>
482-
<div class="labels"></div>
483-
<div class="row collapse"><div class="detail-description">
484-
<div class="long_description"></div>
485-
<table class="table table-bordered">
486-
<tr>
487-
<th>magic</th>
488-
<td></td>
489-
</tr>
490-
<tr>
491-
<th>property</th>
492-
<td>_action</td>
493-
</tr>
494-
</table>
495-
</div></div>
496-
</div>
497455
<a id="property_code"> </a><div class="element clickable property public property_code" data-toggle="collapse" data-target=".property_code .collapse" title="public">
498456
<h2>- The code of the user function</h2>
499457
<pre>$code : string</pre>
@@ -538,18 +496,8 @@ <h3>Default</h3>
538496
</table>
539497
</div></div>
540498
</div>
541-
<a id="property__action"> </a><div class="element clickable property protected property__action" data-toggle="collapse" data-target=".property__action .collapse" title="protected">
542-
<h2>The transaction's action.</h2>
543-
<pre>$_action : string</pre>
544-
<div class="row collapse"><div class="detail-description">
545-
<h3>Default</h3>
546-
<div class="subelement argument"><code>''</code></div>
547-
</div></div>
548-
<div class="labels"></div>
549-
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
550-
</div>
551499
<a id="property_attributes"> </a><div class="element clickable property protected property_attributes" data-toggle="collapse" data-target=".property_attributes .collapse" title="protected">
552-
<h2>The transaction's attributes.</h2>
500+
<h2>The function's attributes.</h2>
553501
<pre>$attributes : array</pre>
554502
<div class="row collapse"><div class="detail-description">
555503
<h3>Default</h3>
@@ -589,7 +537,7 @@ <h2>Collections index</h2>
589537
<div class="row"><footer class="span12">
590538
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>
591539
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
592-
generated on 2019-01-22T11:16:22+01:00.<br></footer></div>
540+
generated on 2019-08-19T13:30:48+02:00.<br></footer></div>
593541
</div>
594542
</body>
595543
</html>

‎docs/classes/ArangoDBClient.Autoloader.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@
3131
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
3232
Reports <b class="caret"></b></a><ul class="dropdown-menu">
3333
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
34-
<span class="label label-info">22</span></a></li>
34+
<span class="label label-info">25</span></a></li>
3535
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
3636
<ul></ul></a></li>
3737
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
38-
<span class="label label-info">2</span></a></li>
38+
<span class="label label-info">15</span></a></li>
3939
</ul>
4040
</li>
4141
</ul></div>
@@ -178,7 +178,7 @@ <h2>Class file extension</h2>
178178
<div class="row"><footer class="span12">
179179
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>
180180
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
181-
generated on 2019-01-22T11:16:23+01:00.<br></footer></div>
181+
generated on 2019-08-19T13:30:48+02:00.<br></footer></div>
182182
</div>
183183
</body>
184184
</html>

‎docs/classes/ArangoDBClient.Batch.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@
3131
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
3232
Reports <b class="caret"></b></a><ul class="dropdown-menu">
3333
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
34-
<span class="label label-info">22</span></a></li>
34+
<span class="label label-info">25</span></a></li>
3535
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
3636
<ul></ul></a></li>
3737
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
38-
<span class="label label-info">2</span></a></li>
38+
<span class="label label-info">15</span></a></li>
3939
</ul>
4040
</li>
4141
</ul></div>
@@ -658,7 +658,7 @@ <h3>Default</h3>
658658
<div class="row"><footer class="span12">
659659
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>
660660
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
661-
generated on 2019-01-22T11:16:23+01:00.<br></footer></div>
661+
generated on 2019-08-19T13:30:48+02:00.<br></footer></div>
662662
</div>
663663
</body>
664664
</html>

‎docs/classes/ArangoDBClient.BatchPart.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@
3131
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
3232
Reports <b class="caret"></b></a><ul class="dropdown-menu">
3333
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
34-
<span class="label label-info">22</span></a></li>
34+
<span class="label label-info">25</span></a></li>
3535
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
3636
<ul></ul></a></li>
3737
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
38-
<span class="label label-info">2</span></a></li>
38+
<span class="label label-info">15</span></a></li>
3939
</ul>
4040
</li>
4141
</ul></div>
@@ -424,7 +424,7 @@ <h3>Default</h3>
424424
<div class="row"><footer class="span12">
425425
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>
426426
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
427-
generated on 2019-01-22T11:16:22+01:00.<br></footer></div>
427+
generated on 2019-08-19T13:30:48+02:00.<br></footer></div>
428428
</div>
429429
</body>
430430
</html>

‎docs/classes/ArangoDBClient.BindVars.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@
3131
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
3232
Reports <b class="caret"></b></a><ul class="dropdown-menu">
3333
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
34-
<span class="label label-info">22</span></a></li>
34+
<span class="label label-info">25</span></a></li>
3535
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
3636
<ul></ul></a></li>
3737
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
38-
<span class="label label-info">2</span></a></li>
38+
<span class="label label-info">15</span></a></li>
3939
</ul>
4040
</li>
4141
</ul></div>
@@ -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.9.0</a> and<br>
191-
generated on 2019-01-22T11:16:23+01:00.<br></footer></div>
191+
generated on 2019-08-19T13:30:49+02:00.<br></footer></div>
192192
</div>
193193
</body>
194194
</html>

‎docs/classes/ArangoDBClient.ClientException.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@
3131
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
3232
Reports <b class="caret"></b></a><ul class="dropdown-menu">
3333
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
34-
<span class="label label-info">22</span></a></li>
34+
<span class="label label-info">25</span></a></li>
3535
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
3636
<ul></ul></a></li>
3737
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
38-
<span class="label label-info">2</span></a></li>
38+
<span class="label label-info">15</span></a></li>
3939
</ul>
4040
</li>
4141
</ul></div>
@@ -179,7 +179,7 @@ <h3>Default</h3>
179179
<div class="row"><footer class="span12">
180180
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>
181181
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
182-
generated on 2019-01-22T11:16:23+01:00.<br></footer></div>
182+
generated on 2019-08-19T13:30:49+02:00.<br></footer></div>
183183
</div>
184184
</body>
185185
</html>

0 commit comments

Comments
 (0)