Skip to content

Commit 93f1b51

Browse files
frankmayerfrankmayer
committed
Merge pull request arangodb#129 from frankmayer/devel
changed PhpDocs @Package content to triagens\ArangoDb, closes issue arangodb#123
2 parents 96c712f + 5b98fec commit 93f1b51

File tree

105 files changed

+2865
-2222
lines changed

Some content is hidden

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

105 files changed

+2865
-2222
lines changed

‎README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
##### Table of Contents
1313

1414
- [Description](#description)
15+
- [Requirements](#requirements)
1516
- [Installing the PHP client](#installing)
1617
- [Using packagist/composer](#using_packagist)
1718
- [Cloning the git repository](#cloning_git)
@@ -25,7 +26,7 @@
2526
- [Deleting a document](#deleting_document)
2627
- [Dropping a collection](#dropping_collection)
2728
- [Putting it all together](#alltogether)
28-
- [Requirements](#requirements)
29+
2930
- [More information](#more_info)
3031

3132
<br>
@@ -54,6 +55,19 @@ The client library provides document and collection classes you can use to work
5455

5556
<br>
5657

58+
59+
60+
<a name="requirements"/a>
61+
# Requirements
62+
63+
* ArangoDB database server version 1.3 (detailed info [here](https://github.com/triAGENS/ArangoDB-PHP/wiki/Important-versioning-information-on-ArangoDB-PHP#arangodb-php-client-to-arangodb-server-interoperability-matrix))
64+
65+
* PHP version 5.3 or higher (Travis-tested with 5.4 and 5.5)
66+
67+
<br>
68+
69+
70+
5771
<a name="installing"/a>
5872
## Installing the PHP client
5973

@@ -559,14 +573,6 @@ Here's the full code that combines all the pieces outlined above:
559573
<br>
560574

561575

562-
<a name="requirements"/a>
563-
# Requirements
564-
565-
* ArangoDB database server version 1.2 (detailed info [here](https://github.com/triAGENS/ArangoDB-PHP/wiki/Important-versioning-information-on-ArangoDB-PHP#arangodb-php-client-to-arangodb-server-interoperability-matrix))
566-
567-
* PHP version 5.3 or higher (Travis-tested with 5.4 and 5.5)
568-
569-
570576

571577
<a name="more_info"/a>
572578
# More information

‎docs/classes/triagens.ArangoDb.AdminHandler.html

Lines changed: 9 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
<li><a>Namespaces</a></li>
2323
<li><a href="../namespaces/triagens.html"><i class="icon-th"></i> triagens</a></li>
2424
<li><a>Packages</a></li>
25-
<li><a href="../packages/ArangoDbPhpClient.html"><i class="icon-folder-open"></i> ArangoDbPhpClient</a></li>
2625
<li><a href="../packages/triagens.html"><i class="icon-folder-open"></i> triagens</a></li>
2726
</ul>
2827
</li>
@@ -68,7 +67,6 @@
6867
Returns the statistics information."><span class="description">Get the server statistics
6968
Returns the statistics information.</span><pre>getServerStatistics()</pre></a></li>
7069
<li class="method public "><a href="#method_getServerStatisticsDescription" title="getServerStatisticsDescription :: Returns a description of the statistics returned by getServerStatistics()."><span class="description">Returns a description of the statistics returned by getServerStatistics().</span><pre>getServerStatisticsDescription()</pre></a></li>
71-
<li class="method public "><a href="#method_getServerStatus" title="getServerStatus :: Get the server status"><span class="description">Get the server status</span><pre>getServerStatus()</pre></a></li>
7270
<li class="method public "><a href="#method_getServerTime" title="getServerTime :: Get the server time"><span class="description">Get the server time</span><pre>getServerTime()</pre></a></li>
7371
<li class="method public "><a href="#method_getServerVersion" title="getServerVersion :: Get the server version"><span class="description">Get the server version</span><pre>getServerVersion()</pre></a></li>
7472
<li class="method public "><a href="#method_reloadServerRouting" title="reloadServerRouting :: Reload the server's routing information
@@ -123,7 +121,7 @@
123121
<table class="table table-bordered">
124122
<tr>
125123
<th>package</th>
126-
<td><a href="../packages/ArangoDbPhpClient.html">ArangoDbPhpClient</a></td>
124+
<td><a href="../packages/triagens.ArangoDb.html">triagens\ArangoDb</a></td>
127125
</tr>
128126
<tr>
129127
<th>since</th>
@@ -134,7 +132,7 @@ <h3>
134132
<i class="icon-custom icon-method"></i> Methods</h3>
135133
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
136134
<h2>Construct a new handler</h2>
137-
<pre>__construct(\triagens\ArangoDb\Connection $connection) : void</pre>
135+
<pre>__construct(\triagens\ArangoDb\Connection $connection) : <a href="../classes/triagens.ArangoDb.Handler.html">\triagens\ArangoDb\Handler</a></pre>
138136
<div class="labels"><span class="label">Inherited</span></div>
139137
<div class="row collapse"><div class="detail-description">
140138
<div class="long_description"></div>
@@ -149,6 +147,8 @@ <h4>$connection</h4>
149147
<li>connection to be used</li>
150148
</ul>
151149
</div>
150+
<h3>Returns</h3>
151+
<div class="subelement response"><code><a href="../classes/triagens.ArangoDb.Handler.html">\triagens\ArangoDb\Handler</a></code></div>
152152
</div></div>
153153
</div>
154154
<a id="method_flushServerModuleCache"></a><div class="element clickable method public method_flushServerModuleCache" data-toggle="collapse" data-target=".method_flushServerModuleCache .collapse">
@@ -187,11 +187,11 @@ <h3>Parameters</h3>
187187
<div class="subelement argument">
188188
<h4>$options</h4>
189189
<code>array</code><ul>
190-
<li>an array of options that define the resultset:</li>
190+
<li>an array of options that define the result-set:</li>
191191
</ul>
192192

193193
<p>Options are :<br>
194-
<li>'upto' - returns all log entries upto a log-level. Note that log-level must be one of:</li>
194+
<li>'upto' - returns all log entries up to a log-level. Note that log-level must be one of:</li>
195195
<p>
196196
<li>fatal / 0</li>
197197
<li>error / 1</li>
@@ -298,33 +298,6 @@ <h3>Returns</h3>
298298
<div class="subelement response"><code>array</code></div>
299299
</div></div>
300300
</div>
301-
<a id="method_getServerStatus"></a><div class="element clickable method public method_getServerStatus" data-toggle="collapse" data-target=".method_getServerStatus .collapse">
302-
<h2>Get the server status</h2>
303-
<pre>getServerStatus() : array</pre>
304-
<div class="labels"></div>
305-
<div class="row collapse"><div class="detail-description">
306-
<div class="long_description"><p>This will throw if the status cannot be retrieved</p></div>
307-
<table class="table table-bordered"><tr>
308-
<th>since</th>
309-
<td>1.2</td>
310-
</tr></table>
311-
<h3>Exceptions</h3>
312-
<table class="table table-bordered"><tr>
313-
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
314-
<td></td>
315-
</tr></table>
316-
<h3>Returns</h3>
317-
<div class="subelement response">
318-
<code>array</code>- The call returns an array with the attributes described here: http://www.arangodb.org/manuals/1.2.beta3/HttpSystem.html#HttpSystemStatus
319-
['system']['userTime']
320-
['system']['systemTime']
321-
['system']['numberOfThreads']
322-
['system']['residentSize']
323-
['system']['virtualSize']
324-
['system']['minorPageFaults']
325-
['system']['majorPageFaults']</div>
326-
</div></div>
327-
</div>
328301
<a id="method_getServerTime"></a><div class="element clickable method public method_getServerTime" data-toggle="collapse" data-target=".method_getServerTime .collapse">
329302
<h2>Get the server time</h2>
330303
<pre>getServerTime() : double</pre>
@@ -431,7 +404,7 @@ <h3>Returns</h3>
431404
</div>
432405
<a id="method_getCursorOptions"></a><div class="element clickable method protected method_getCursorOptions" data-toggle="collapse" data-target=".method_getCursorOptions .collapse">
433406
<h2>Return an array of cursor options</h2>
434-
<pre>getCursorOptions(bool $options) : array</pre>
407+
<pre>getCursorOptions(mixed $options) : array</pre>
435408
<div class="labels"><span class="label">Inherited</span></div>
436409
<div class="row collapse"><div class="detail-description">
437410
<div class="long_description"></div>
@@ -442,7 +415,7 @@ <h2>Return an array of cursor options</h2>
442415
<h3>Parameters</h3>
443416
<div class="subelement argument">
444417
<h4>$options</h4>
445-
<code>bool</code><ul>
418+
<code>mixed</code><ul>
446419
<li>$options might be a boolean sanitize value, or an array of options, with or without a '_sanitize' key.</li>
447420
</ul>
448421
</div>
@@ -614,7 +587,7 @@ <h2>details for server version</h2>
614587
<div class="row"><footer class="span12">
615588
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>
616589
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
617-
generated on 2013-05-04T16:18:33+03:00.<br></footer></div>
590+
generated on 2013-05-11T17:21:44+03:00.<br></footer></div>
618591
</div>
619592
</body>
620593
</html>

‎docs/classes/triagens.ArangoDb.AqlUserFunction.html

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
<li><a>Namespaces</a></li>
2323
<li><a href="../namespaces/triagens.html"><i class="icon-th"></i> triagens</a></li>
2424
<li><a>Packages</a></li>
25-
<li><a href="../packages/ArangoDbPhpClient.html"><i class="icon-folder-open"></i> ArangoDbPhpClient</a></li>
2625
<li><a href="../packages/triagens.html"><i class="icon-folder-open"></i> triagens</a></li>
2726
</ul>
2827
</li>
@@ -81,12 +80,16 @@
8180
<li class="nav-header">
8281
<i class="icon-custom icon-property"></i> Properties
8382
<ul>
83+
<li class="property public "><a href="#property_" title=" :: _action"><span class="description"></span><pre></pre></a></li>
8484
<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>
8585
<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>
8686
</ul>
8787
</li>
8888
<li class="nav-header protected">» Protected
89-
<ul><li class="property protected "><a href="#property_attributes" title="$attributes :: The transaction's attributes."><span class="description"></span><pre>$attributes</pre></a></li></ul>
89+
<ul>
90+
<li class="property protected "><a href="#property__action" title="$_action :: The transaction's action."><span class="description"></span><pre>$_action</pre></a></li>
91+
<li class="property protected "><a href="#property_attributes" title="$attributes :: The transaction's attributes."><span class="description"></span><pre>$attributes</pre></a></li>
92+
</ul>
9093
</li>
9194
<li class="nav-header private">» Private
9295
<ul><li class="property private "><a href="#property__connection" title="$_connection :: The connection object"><span class="description"></span><pre>$_connection</pre></a></li></ul>
@@ -411,6 +414,24 @@ <h3>Returns</h3>
411414
</div>
412415
<h3>
413416
<i class="icon-custom icon-property"></i> Properties</h3>
417+
<a id="property_"> </a><div class="element clickable property public property_" data-toggle="collapse" data-target=".property_ .collapse">
418+
<h2></h2>
419+
<pre> : mixed</pre>
420+
<div class="labels"></div>
421+
<div class="row collapse"><div class="detail-description">
422+
<div class="long_description"></div>
423+
<table class="table table-bordered">
424+
<tr>
425+
<th>magic</th>
426+
<td></td>
427+
</tr>
428+
<tr>
429+
<th>property</th>
430+
<td>_action</td>
431+
</tr>
432+
</table>
433+
</div></div>
434+
</div>
414435
<a id="property_code"> </a><div class="element clickable property public property_code" data-toggle="collapse" data-target=".property_code .collapse">
415436
<h2></h2>
416437
<pre>$code : string</pre>
@@ -447,6 +468,12 @@ <h2></h2>
447468
</table>
448469
</div></div>
449470
</div>
471+
<a id="property__action"> </a><div class="element clickable property protected property__action" data-toggle="collapse" data-target=".property__action .collapse">
472+
<h2></h2>
473+
<pre>$_action : string</pre>
474+
<div class="labels"></div>
475+
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
476+
</div>
450477
<a id="property_attributes"> </a><div class="element clickable property protected property_attributes" data-toggle="collapse" data-target=".property_attributes .collapse">
451478
<h2></h2>
452479
<pre>$attributes : array</pre>
@@ -480,7 +507,7 @@ <h2>Collections index</h2>
480507
<div class="row"><footer class="span12">
481508
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>
482509
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
483-
generated on 2013-05-04T16:18:33+03:00.<br></footer></div>
510+
generated on 2013-05-11T17:21:43+03:00.<br></footer></div>
484511
</div>
485512
</body>
486513
</html>

‎docs/classes/triagens.ArangoDb.Autoloader.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
<li><a>Namespaces</a></li>
2323
<li><a href="../namespaces/triagens.html"><i class="icon-th"></i> triagens</a></li>
2424
<li><a>Packages</a></li>
25-
<li><a href="../packages/ArangoDbPhpClient.html"><i class="icon-folder-open"></i> ArangoDbPhpClient</a></li>
2625
<li><a href="../packages/triagens.html"><i class="icon-folder-open"></i> triagens</a></li>
2726
</ul>
2827
</li>
@@ -100,7 +99,7 @@
10099
process classes from its own namespace and ignore all others.</p></div>
101100
<table class="table table-bordered"><tr>
102101
<th>package</th>
103-
<td><a href="../packages/ArangoDbPhpClient.html">ArangoDbPhpClient</a></td>
102+
<td><a href="../packages/triagens.ArangoDb.html">triagens\ArangoDb</a></td>
104103
</tr></table>
105104
<h3>
106105
<i class="icon-custom icon-method"></i> Methods</h3>
@@ -171,7 +170,7 @@ <h2>Class file extension</h2>
171170
<div class="row"><footer class="span12">
172171
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>
173172
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
174-
generated on 2013-05-04T16:18:33+03:00.<br></footer></div>
173+
generated on 2013-05-11T17:21:43+03:00.<br></footer></div>
175174
</div>
176175
</body>
177176
</html>

0 commit comments

Comments
 (0)