Skip to content

changed PhpDocs @package content to triagens\ArangoDb, closes issue #123 #129

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 3 commits into from
May 13, 2013
Merged

changed PhpDocs @package content to triagens\ArangoDb, closes issue #123 #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c13148
Bumped version and moved requirements up
frankmayer May 11, 2013
f043f84
Renamed @package
frankmayer May 11, 2013
5b98fec
Re-generated docs after renaming of @package
frankmayer May 11, 2013
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
24 changes: 15 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
##### Table of Contents

- [Description](#description)
- [Requirements](#requirements)
- [Installing the PHP client](#installing)
- [Using packagist/composer](#using_packagist)
- [Cloning the git repository](#cloning_git)
Expand All @@ -25,7 +26,7 @@
- [Deleting a document](#deleting_document)
- [Dropping a collection](#dropping_collection)
- [Putting it all together](#alltogether)
- [Requirements](#requirements)

- [More information](#more_info)

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

<br>



<a name="requirements"/a>
# Requirements

* 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))

* PHP version 5.3 or higher (Travis-tested with 5.4 and 5.5)

<br>



<a name="installing"/a>
## Installing the PHP client

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


<a name="requirements"/a>
# Requirements

* 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))

* PHP version 5.3 or higher (Travis-tested with 5.4 and 5.5)



<a name="more_info"/a>
# More information
Expand Down
45 changes: 9 additions & 36 deletions docs/classes/triagens.ArangoDb.AdminHandler.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
<li><a>Namespaces</a></li>
<li><a href="../namespaces/triagens.html"><i class="icon-th"></i> triagens</a></li>
<li><a>Packages</a></li>
<li><a href="../packages/ArangoDbPhpClient.html"><i class="icon-folder-open"></i> ArangoDbPhpClient</a></li>
<li><a href="../packages/triagens.html"><i class="icon-folder-open"></i> triagens</a></li>
</ul>
</li>
Expand Down Expand Up @@ -68,7 +67,6 @@
Returns the statistics information."><span class="description">Get the server statistics
Returns the statistics information.</span><pre>getServerStatistics()</pre></a></li>
<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>
<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>
<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>
<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>
<li class="method public "><a href="#method_reloadServerRouting" title="reloadServerRouting :: Reload the server's routing information
Expand Down Expand Up @@ -123,7 +121,7 @@
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="../packages/ArangoDbPhpClient.html">ArangoDbPhpClient</a></td>
<td><a href="../packages/triagens.ArangoDb.html">triagens\ArangoDb</a></td>
</tr>
<tr>
<th>since</th>
Expand All @@ -134,7 +132,7 @@ <h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Construct a new handler</h2>
<pre>__construct(\triagens\ArangoDb\Connection $connection) : void</pre>
<pre>__construct(\triagens\ArangoDb\Connection $connection) : <a href="../classes/triagens.ArangoDb.Handler.html">\triagens\ArangoDb\Handler</a></pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
Expand All @@ -149,6 +147,8 @@ <h4>$connection</h4>
<li>connection to be used</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/triagens.ArangoDb.Handler.html">\triagens\ArangoDb\Handler</a></code></div>
</div></div>
</div>
<a id="method_flushServerModuleCache"></a><div class="element clickable method public method_flushServerModuleCache" data-toggle="collapse" data-target=".method_flushServerModuleCache .collapse">
Expand Down Expand Up @@ -187,11 +187,11 @@ <h3>Parameters</h3>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><ul>
<li>an array of options that define the resultset:</li>
<li>an array of options that define the result-set:</li>
</ul>

<p>Options are :<br>
<li>'upto' - returns all log entries upto a log-level. Note that log-level must be one of:</li>
<li>'upto' - returns all log entries up to a log-level. Note that log-level must be one of:</li>
<p>
<li>fatal / 0</li>
<li>error / 1</li>
Expand Down Expand Up @@ -298,33 +298,6 @@ <h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a id="method_getServerStatus"></a><div class="element clickable method public method_getServerStatus" data-toggle="collapse" data-target=".method_getServerStatus .collapse">
<h2>Get the server status</h2>
<pre>getServerStatus() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the status cannot be retrieved</p></div>
<table class="table table-bordered"><tr>
<th>since</th>
<td>1.2</td>
</tr></table>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>- The call returns an array with the attributes described here: http://www.arangodb.org/manuals/1.2.beta3/HttpSystem.html#HttpSystemStatus
['system']['userTime']
['system']['systemTime']
['system']['numberOfThreads']
['system']['residentSize']
['system']['virtualSize']
['system']['minorPageFaults']
['system']['majorPageFaults']</div>
</div></div>
</div>
<a id="method_getServerTime"></a><div class="element clickable method public method_getServerTime" data-toggle="collapse" data-target=".method_getServerTime .collapse">
<h2>Get the server time</h2>
<pre>getServerTime() : double</pre>
Expand Down Expand Up @@ -431,7 +404,7 @@ <h3>Returns</h3>
</div>
<a id="method_getCursorOptions"></a><div class="element clickable method protected method_getCursorOptions" data-toggle="collapse" data-target=".method_getCursorOptions .collapse">
<h2>Return an array of cursor options</h2>
<pre>getCursorOptions(bool $options) : array</pre>
<pre>getCursorOptions(mixed $options) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
Expand All @@ -442,7 +415,7 @@ <h2>Return an array of cursor options</h2>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$options</h4>
<code>bool</code><ul>
<code>mixed</code><ul>
<li>$options might be a boolean sanitize value, or an array of options, with or without a '_sanitize' key.</li>
</ul>
</div>
Expand Down Expand Up @@ -614,7 +587,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.0.0a12</a> and<br>
generated on 2013-05-04T16:18:33+03:00.<br></footer></div>
generated on 2013-05-11T17:21:44+03:00.<br></footer></div>
</div>
</body>
</html>
33 changes: 30 additions & 3 deletions docs/classes/triagens.ArangoDb.AqlUserFunction.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
<li><a>Namespaces</a></li>
<li><a href="../namespaces/triagens.html"><i class="icon-th"></i> triagens</a></li>
<li><a>Packages</a></li>
<li><a href="../packages/ArangoDbPhpClient.html"><i class="icon-folder-open"></i> ArangoDbPhpClient</a></li>
<li><a href="../packages/triagens.html"><i class="icon-folder-open"></i> triagens</a></li>
</ul>
</li>
Expand Down Expand Up @@ -81,12 +80,16 @@
<li class="nav-header">
<i 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_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__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>
</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 @@ -411,6 +414,24 @@ <h3>Returns</h3>
</div>
<h3>
<i 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">
<h2></h2>
<pre> : mixed</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>
<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">
<h2></h2>
<pre>$code : string</pre>
Expand Down Expand Up @@ -447,6 +468,12 @@ <h2></h2>
</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">
<h2></h2>
<pre>$_action : string</pre>
<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">
<h2></h2>
<pre>$attributes : array</pre>
Expand Down Expand Up @@ -480,7 +507,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.0.0a12</a> and<br>
generated on 2013-05-04T16:18:33+03:00.<br></footer></div>
generated on 2013-05-11T17:21:43+03:00.<br></footer></div>
</div>
</body>
</html>
5 changes: 2 additions & 3 deletions docs/classes/triagens.ArangoDb.Autoloader.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
<li><a>Namespaces</a></li>
<li><a href="../namespaces/triagens.html"><i class="icon-th"></i> triagens</a></li>
<li><a>Packages</a></li>
<li><a href="../packages/ArangoDbPhpClient.html"><i class="icon-folder-open"></i> ArangoDbPhpClient</a></li>
<li><a href="../packages/triagens.html"><i class="icon-folder-open"></i> triagens</a></li>
</ul>
</li>
Expand Down Expand Up @@ -100,7 +99,7 @@
process classes from its own namespace and ignore all others.</p></div>
<table class="table table-bordered"><tr>
<th>package</th>
<td><a href="../packages/ArangoDbPhpClient.html">ArangoDbPhpClient</a></td>
<td><a href="../packages/triagens.ArangoDb.html">triagens\ArangoDb</a></td>
</tr></table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
Expand Down Expand Up @@ -171,7 +170,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.0.0a12</a> and<br>
generated on 2013-05-04T16:18:33+03:00.<br></footer></div>
generated on 2013-05-11T17:21:43+03:00.<br></footer></div>
</div>
</body>
</html>
Loading