Skip to content

Commit ed2be2f

Browse files
jsteemannjsteemann
committed
Merge pull request arangodb#17 from frankmayer/Branch_1.0.0beta1
Implemented basic edges support
2 parents d568abd + af5398b commit ed2be2f

Some content is hidden

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

45 files changed

+1592
-344
lines changed

‎docs/classes.svg

Lines changed: 128 additions & 104 deletions
Loading

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ <h2>Class file extension</h2>
169169
<div class="row"><footer class="span12">
170170
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>
171171
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
172-
generated on 2012-10-14T17:33:26+03:00.<br></footer></div>
172+
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
173173
</div>
174174
</body>
175175
</html>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ <h2>Current bind values</h2>
177177
<div class="row"><footer class="span12">
178178
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>
179179
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
180-
generated on 2012-10-14T17:33:26+03:00.<br></footer></div>
180+
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
181181
</div>
182182
</body>
183183
</html>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ <h2>getTraceAsString()
271271
<div class="row"><footer class="span12">
272272
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>
273273
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
274-
generated on 2012-10-14T17:33:26+03:00.<br></footer></div>
274+
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
275275
</div>
276276
</body>
277277
</html>

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

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,14 @@
7171
Collection ids are generated on the server only."><span class="description">Get the collection id (if already known)
7272
Collection ids are generated on the server only.</span><pre>getId()</pre></a></li>
7373
<li class="method public "><a href="#method_getName" title="getName :: Get the collection name (if already known)"><span class="description">Get the collection name (if already known)</span><pre>getName()</pre></a></li>
74+
<li class="method public "><a href="#method_getType" title="getType :: Get the collection type (if already known)"><span class="description">Get the collection type (if already known)</span><pre>getType()</pre></a></li>
7475
<li class="method public "><a href="#method_getWaitForSync" title="getWaitForSync :: Get the waitForSync value (if already known)"><span class="description">Get the waitForSync value (if already known)</span><pre>getWaitForSync()</pre></a></li>
7576
<li class="method public "><a href="#method_set" title="set :: Set a collection attribute"><span class="description">Set a collection attribute</span><pre>set()</pre></a></li>
7677
<li class="method public "><a href="#method_setId" title="setId :: Set the collection id
7778
This will throw if the id of an existing collection gets updated to some other id"><span class="description">Set the collection id
7879
This will throw if the id of an existing collection gets updated to some other id</span><pre>setId()</pre></a></li>
7980
<li class="method public "><a href="#method_setName" title="setName :: Set the collection name"><span class="description">Set the collection name</span><pre>setName()</pre></a></li>
81+
<li class="method public "><a href="#method_setType" title="setType :: Set the collection type."><span class="description">Set the collection type.</span><pre>setType()</pre></a></li>
8082
<li class="method public "><a href="#method_setWaitForSync" title="setWaitForSync :: Set the waitForSync value"><span class="description">Set the waitForSync value</span><pre>setWaitForSync()</pre></a></li>
8183
<li class="method public "><a href="#method_toJson" title="toJson :: Returns the collection as JSON-encoded string"><span class="description">Returns the collection as JSON-encoded string</span><pre>toJson()</pre></a></li>
8284
<li class="method public "><a href="#method_toSerialized" title="toSerialized :: Returns the collection as a serialized string"><span class="description">Returns the collection as a serialized string</span><pre>toSerialized()</pre></a></li>
@@ -90,6 +92,7 @@
9092
<ul>
9193
<li class="property private "><a href="#property__id" title="$_id :: The collection id (might be NULL for new collections)"><span class="description">The collection id (might be NULL for new collections)</span><pre>$_id</pre></a></li>
9294
<li class="property private "><a href="#property__name" title="$_name :: The collection name (might be NULL for new collections)"><span class="description">The collection name (might be NULL for new collections)</span><pre>$_name</pre></a></li>
95+
<li class="property private "><a href="#property__type" title="$_type :: The collection type (might be NULL for new collections)"><span class="description">The collection type (might be NULL for new collections)</span><pre>$_type</pre></a></li>
9396
<li class="property private "><a href="#property__waitForSync" title="$_waitForSync :: The collection waitForSync value (might be NULL for new collections)"><span class="description">The collection waitForSync value (might be NULL for new collections)</span><pre>$_waitForSync</pre></a></li>
9497
</ul>
9598
</li>
@@ -98,6 +101,7 @@
98101
<ul>
99102
<li class="constant "><a href="#constant_ENTRY_ID" title="ENTRY_ID :: Collection id index"><span class="description">Collection id index</span><pre>ENTRY_ID</pre></a></li>
100103
<li class="constant "><a href="#constant_ENTRY_NAME" title="ENTRY_NAME :: Collection name index"><span class="description">Collection name index</span><pre>ENTRY_NAME</pre></a></li>
104+
<li class="constant "><a href="#constant_ENTRY_TYPE" title="ENTRY_TYPE :: Collection type index"><span class="description">Collection type index</span><pre>ENTRY_TYPE</pre></a></li>
101105
<li class="constant "><a href="#constant_ENTRY_WAIT_SYNC" title="ENTRY_WAIT_SYNC :: Collection 'waitForSync' index"><span class="description">Collection 'waitForSync' index</span><pre>ENTRY_WAIT_SYNC</pre></a></li>
102106
<li class="constant "><a href="#constant_OPTION_PROPERTIES" title="OPTION_PROPERTIES :: properties option"><span class="description">properties option</span><pre>OPTION_PROPERTIES</pre></a></li>
103107
</ul>
@@ -209,6 +213,17 @@ <h3>Returns</h3>
209213
<code>string</code>- name</div>
210214
</div></div>
211215
</div>
216+
<a id="method_getType"></a><div class="element clickable method public method_getType" data-toggle="collapse" data-target=".method_getType .collapse">
217+
<h2>Get the collection type (if already known)</h2>
218+
<pre>getType() : string</pre>
219+
<div class="labels"></div>
220+
<div class="row collapse"><div class="detail-description">
221+
<div class="long_description"></div>
222+
<h3>Returns</h3>
223+
<div class="subelement response">
224+
<code>string</code>- name</div>
225+
</div></div>
226+
</div>
212227
<a id="method_getWaitForSync"></a><div class="element clickable method public method_getWaitForSync" data-toggle="collapse" data-target=".method_getWaitForSync .collapse">
213228
<h2>Get the waitForSync value (if already known)</h2>
214229
<pre>getWaitForSync() : bool</pre>
@@ -289,6 +304,27 @@ <h3>Exceptions</h3>
289304
</tr></table>
290305
</div></div>
291306
</div>
307+
<a id="method_setType"></a><div class="element clickable method public method_setType" data-toggle="collapse" data-target=".method_setType .collapse">
308+
<h2>Set the collection type.</h2>
309+
<pre>setType(int $type) : void</pre>
310+
<div class="labels"></div>
311+
<div class="row collapse"><div class="detail-description">
312+
<div class="long_description"><p>This is useful before a collection is create() 'ed in order to set a different type than the normal one.
313+
For example this must be set to 3 in order to create an edge-collection.</p></div>
314+
<h3>Parameters</h3>
315+
<div class="subelement argument">
316+
<h4>$type</h4>
317+
<code>int</code><ul>
318+
<li>type = 2 -> normal collection, type = 3 -> edge-collection</li>
319+
</ul>
320+
</div>
321+
<h3>Exceptions</h3>
322+
<table class="table table-bordered"><tr>
323+
<th><code><a href="../classes/triagens.ArangoDb.ClientException.html">\triagens\ArangoDb\ClientException</a></code></th>
324+
<td></td>
325+
</tr></table>
326+
</div></div>
327+
</div>
292328
<a id="method_setWaitForSync"></a><div class="element clickable method public method_setWaitForSync" data-toggle="collapse" data-target=".method_setWaitForSync .collapse">
293329
<h2>Set the waitForSync value</h2>
294330
<pre>setWaitForSync(bool $value) : void</pre>
@@ -340,6 +376,12 @@ <h2>The collection name (might be NULL for new collections)</h2>
340376
<div class="labels"></div>
341377
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
342378
</div>
379+
<a id="property__type"> </a><div class="element clickable property private property__type" data-toggle="collapse" data-target=".property__type .collapse">
380+
<h2>The collection type (might be NULL for new collections)</h2>
381+
<pre>$_type : int</pre>
382+
<div class="labels"></div>
383+
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
384+
</div>
343385
<a id="property__waitForSync"> </a><div class="element clickable property private property__waitForSync" data-toggle="collapse" data-target=".property__waitForSync .collapse">
344386
<h2>The collection waitForSync value (might be NULL for new collections)</h2>
345387
<pre>$_waitForSync : bool</pre>
@@ -360,6 +402,12 @@ <h2>Collection name index</h2>
360402
<div class="labels"></div>
361403
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
362404
</div>
405+
<a id="constant_ENTRY_TYPE"> </a><div class="element clickable constant constant_ENTRY_TYPE" data-toggle="collapse" data-target=".constant_ENTRY_TYPE .collapse">
406+
<h2>Collection type index</h2>
407+
<pre>ENTRY_TYPE </pre>
408+
<div class="labels"></div>
409+
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
410+
</div>
363411
<a id="constant_ENTRY_WAIT_SYNC"> </a><div class="element clickable constant constant_ENTRY_WAIT_SYNC" data-toggle="collapse" data-target=".constant_ENTRY_WAIT_SYNC .collapse">
364412
<h2>Collection 'waitForSync' index</h2>
365413
<pre>ENTRY_WAIT_SYNC </pre>
@@ -379,7 +427,7 @@ <h2>properties option</h2>
379427
<div class="row"><footer class="span12">
380428
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>
381429
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
382-
generated on 2012-10-14T17:33:26+03:00.<br></footer></div>
430+
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
383431
</div>
384432
</body>
385433
</html>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,7 @@ <h2>truncate option</h2>
618618
<div class="row"><footer class="span12">
619619
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>
620620
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
621-
generated on 2012-10-14T17:33:26+03:00.<br></footer></div>
621+
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
622622
</div>
623623
</body>
624624
</html>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ <h2>getTraceAsString()
271271
<div class="row"><footer class="span12">
272272
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>
273273
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
274-
generated on 2012-10-14T17:33:26+03:00.<br></footer></div>
274+
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
275275
</div>
276276
</body>
277277
</html>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ <h2>Flag if keep-alive connections are used</h2>
405405
<div class="row"><footer class="span12">
406406
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>
407407
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
408-
generated on 2012-10-14T17:33:26+03:00.<br></footer></div>
408+
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
409409
</div>
410410
</body>
411411
</html>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ <h2>Wait for sync index constant</h2>
409409
<div class="row"><footer class="span12">
410410
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>
411411
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
412-
generated on 2012-10-14T17:33:26+03:00.<br></footer></div>
412+
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
413413
</div>
414414
</body>
415415
</html>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ <h2>sanitize option entry</h2>
413413
<div class="row"><footer class="span12">
414414
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>
415415
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
416-
generated on 2012-10-14T17:33:26+03:00.<br></footer></div>
416+
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
417417
</div>
418418
</body>
419419
</html>

0 commit comments

Comments
 (0)