Skip to content

Docs: generate 3.5 documentation #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 19, 2019
Merged

Docs: generate 3.5 documentation #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/Drivers/PHP/Tutorial/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ object(ArangoDBClient\Document)##6 (4) {
*/
```

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:
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:

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

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.
Note that CollectionHandler->byExample() might return multiple documents if the example is ambigious.
Note that CollectionHandler->byExample() might return multiple documents if the example is ambiguous.

## Updating a document

Expand Down
752 changes: 400 additions & 352 deletions docs/classes.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 23 additions & 3 deletions docs/classes/ArangoDBClient.AdminHandler.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">22</span></a></li>
<span class="label label-info">25</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">2</span></a></li>
<span class="label label-info">15</span></a></li>
</ul>
</li>
</ul></div>
Expand Down Expand Up @@ -82,6 +82,7 @@
</li>
<li class="nav-header protected">» Protected
<ul>
<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>
<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>
<li class="method protected inherited"><a href="#method_getConnectionOption" title="getConnectionOption() :: Return a connection option
This is a convenience function that calls json_encode_wrapper on the connection"><span class="description">Return a connection option
Expand Down Expand Up @@ -406,6 +407,25 @@ <h3>Returns</h3>
<div class="subelement response"><code>\ArangoDBClient\DocumentClassable</code></div>
</div></div>
</div>
<a id="method_addTransactionHeader"></a><div class="element clickable method protected method_addTransactionHeader inherited" data-toggle="collapse" data-target=".method_addTransactionHeader .collapse" title="protected">
<h2>Add a transaction header to the array of headers in case this is a transactional operation</h2>
<pre>addTransactionHeader(array $headers, mixed $collection) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$headers</h4>
<code>array</code><ul>
<li>already existing headers</li>
</ul></div>
<div class="subelement argument">
<h4>$collection</h4>
<code>mixed</code><ul>
<li>any type of collection (can be StreamingTransactionCollection or other)</li>
</ul></div>
</div></div>
</div>
<a id="method_getConnection"></a><div class="element clickable method protected method_getConnection inherited" data-toggle="collapse" data-target=".method_getConnection .collapse" title="protected">
<h2>Return the connection object</h2>
<pre>getConnection() : \ArangoDBClient\Connection</pre>
Expand Down Expand Up @@ -564,7 +584,7 @@ <h2>details for server version</h2>
<div class="row"><footer class="span12">
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>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
generated on 2019-01-22T11:16:23+01:00.<br></footer></div>
generated on 2019-08-19T13:30:49+02:00.<br></footer></div>
</div>
</body>
</html>
62 changes: 5 additions & 57 deletions docs/classes/ArangoDBClient.AqlUserFunction.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">22</span></a></li>
<span class="label label-info">25</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">2</span></a></li>
<span class="label label-info">15</span></a></li>
</ul>
</li>
</ul></div>
Expand Down Expand Up @@ -65,7 +65,6 @@
<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>
<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>
<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>
<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>
<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>
<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>
<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>
Expand All @@ -84,16 +83,12 @@
<li class="nav-header">
<i title="Properties" class="icon-custom icon-property"></i> Properties
<ul>
<li class="property public "><a href="#property_" title="() :: _action"><span class="description"></span><pre></pre></a></li>
<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>
<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>
</ul>
</li>
<li class="nav-header protected">» Protected
<ul>
<li class="property protected "><a href="#property__action" title="$_action() :: The transaction's action."><span class="description"></span><pre>$_action</pre></a></li>
<li class="property protected "><a href="#property_attributes" title="$attributes() :: The transaction's attributes."><span class="description"></span><pre>$attributes</pre></a></li>
</ul>
<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>
</li>
<li class="nav-header private">» Private
<ul><li class="property private "><a href="#property__connection" title="$_connection() :: The connection object"><span class="description"></span><pre>$_connection</pre></a></li></ul>
Expand Down Expand Up @@ -255,21 +250,6 @@ <h3>Exceptions</h3>
</tr></table>
</div></div>
</div>
<a id="method___toString"></a><div class="element clickable method public method___toString " data-toggle="collapse" data-target=".method___toString .collapse" title="public">
<h2>Returns the action string</h2>
<pre>__toString() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>magic</th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>- the current action string</div>
</div></div>
</div>
<a id="method_buildAttributesFromArray"></a><div class="element clickable method public method_buildAttributesFromArray " data-toggle="collapse" data-target=".method_buildAttributesFromArray .collapse" title="public">
<h2>Build the object's attributes from a given array</h2>
<pre>buildAttributesFromArray($options) </pre>
Expand Down Expand Up @@ -472,28 +452,6 @@ <h3>Returns</h3>
</div>
<h3>
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_"> </a><div class="element clickable property public property_" data-toggle="collapse" data-target=".property_ .collapse" title="public">
<h2>_action</h2>
<pre> : string</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered">
<tr>
<th>magic</th>
<td></td>
</tr>
<tr>
<th>property</th>
<td>_action</td>
</tr>
</table>
</div></div>
</div>
<a id="property_code"> </a><div class="element clickable property public property_code" data-toggle="collapse" data-target=".property_code .collapse" title="public">
<h2>- The code of the user function</h2>
<pre>$code : string</pre>
Expand Down Expand Up @@ -538,18 +496,8 @@ <h3>Default</h3>
</table>
</div></div>
</div>
<a id="property__action"> </a><div class="element clickable property protected property__action" data-toggle="collapse" data-target=".property__action .collapse" title="protected">
<h2>The transaction's action.</h2>
<pre>$_action : string</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>''</code></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_attributes"> </a><div class="element clickable property protected property_attributes" data-toggle="collapse" data-target=".property_attributes .collapse" title="protected">
<h2>The transaction's attributes.</h2>
<h2>The function's attributes.</h2>
<pre>$attributes : array</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
Expand Down Expand Up @@ -589,7 +537,7 @@ <h2>Collections index</h2>
<div class="row"><footer class="span12">
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>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
generated on 2019-01-22T11:16:22+01:00.<br></footer></div>
generated on 2019-08-19T13:30:48+02:00.<br></footer></div>
</div>
</body>
</html>
6 changes: 3 additions & 3 deletions docs/classes/ArangoDBClient.Autoloader.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">22</span></a></li>
<span class="label label-info">25</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">2</span></a></li>
<span class="label label-info">15</span></a></li>
</ul>
</li>
</ul></div>
Expand Down Expand Up @@ -178,7 +178,7 @@ <h2>Class file extension</h2>
<div class="row"><footer class="span12">
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>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
generated on 2019-01-22T11:16:23+01:00.<br></footer></div>
generated on 2019-08-19T13:30:48+02:00.<br></footer></div>
</div>
</body>
</html>
6 changes: 3 additions & 3 deletions docs/classes/ArangoDBClient.Batch.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">22</span></a></li>
<span class="label label-info">25</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">2</span></a></li>
<span class="label label-info">15</span></a></li>
</ul>
</li>
</ul></div>
Expand Down Expand Up @@ -658,7 +658,7 @@ <h3>Default</h3>
<div class="row"><footer class="span12">
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>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
generated on 2019-01-22T11:16:23+01:00.<br></footer></div>
generated on 2019-08-19T13:30:48+02:00.<br></footer></div>
</div>
</body>
</html>
6 changes: 3 additions & 3 deletions docs/classes/ArangoDBClient.BatchPart.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">22</span></a></li>
<span class="label label-info">25</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">2</span></a></li>
<span class="label label-info">15</span></a></li>
</ul>
</li>
</ul></div>
Expand Down Expand Up @@ -424,7 +424,7 @@ <h3>Default</h3>
<div class="row"><footer class="span12">
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>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
generated on 2019-01-22T11:16:22+01:00.<br></footer></div>
generated on 2019-08-19T13:30:48+02:00.<br></footer></div>
</div>
</body>
</html>
6 changes: 3 additions & 3 deletions docs/classes/ArangoDBClient.BindVars.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">22</span></a></li>
<span class="label label-info">25</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">2</span></a></li>
<span class="label label-info">15</span></a></li>
</ul>
</li>
</ul></div>
Expand Down Expand Up @@ -188,7 +188,7 @@ <h3>Default</h3>
<div class="row"><footer class="span12">
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>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
generated on 2019-01-22T11:16:23+01:00.<br></footer></div>
generated on 2019-08-19T13:30:49+02:00.<br></footer></div>
</div>
</body>
</html>
6 changes: 3 additions & 3 deletions docs/classes/ArangoDBClient.ClientException.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">22</span></a></li>
<span class="label label-info">25</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">2</span></a></li>
<span class="label label-info">15</span></a></li>
</ul>
</li>
</ul></div>
Expand Down Expand Up @@ -179,7 +179,7 @@ <h3>Default</h3>
<div class="row"><footer class="span12">
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>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.9.0</a> and<br>
generated on 2019-01-22T11:16:23+01:00.<br></footer></div>
generated on 2019-08-19T13:30:49+02:00.<br></footer></div>
</div>
</body>
</html>
Loading