arangodb · jsteemann · Oct 29, 2012 · Oct 23, 2012 · Oct 23, 2012 · Oct 23, 2012
diff --git a/CHANGELOG b/CHANGELOG
@@ -0,0 +1,37 @@
+v1.0.0 (XXXX-XX-XX)
+-------------------
+
+* issue #18: Implemented revision check with policy = "error" 
+  for update/replace and delete/remove methods.
+
+* issue #17: Implemented basic edges support
+
+* issue #14: Refactored function names to better match the server api.
+  This results in sevaral methods being deprecated:
+
+DocumentHandler:
+  update(), updateById() => These are replaced by replace() and replaceById(). They will have their behavior changed in api version 1.1 in favor for the update method that has been added in ArangoDb 1.1
+
+  delete(), deleteById() => These are replaced by remove() and removeById(). They will be removed in api version 2.0.
+
+  add() => This is being replaced by the new save() method. add() will be removed in api version 2.0.
+
+  getByExample() => This is being replaced by CollectionHandler::byExample(). byExample() will be removed in api version 2.0.
+
+  getAllIds() => This is being replaced by CollectionHandler::getAllIds(). getAllIds() will be removed in api version 2.0.
+
+CollectionHandler:
+
+  add() => This is being replaced by the new create() method. add() will be removed in api version 2.0.
+
+  delete() => This is being replaced by the new drop() method. delete() will be removed in api version 2.0.
+
+  getCount() => This is being replaced by the new count() method. getCount() will be removed in api version 2.0.
+
+  getFigures() => This is being replaced by the new figures() method. getFigures() will be removed in api version 2.0.
+
+
+
+* issue #11: Written initial unit tests for api.
+* issue #10: Implemented api version info constant and a getVersion() method to go with it.
+
diff --git a/docs/classes.svg b/docs/classes.svg
diff --git a/docs/classes/triagens.ArangoDb.Autoloader.html b/docs/classes/triagens.ArangoDb.Autoloader.html
@@ -169,7 +169,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.0a10</a> and<br>
-            generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
+            generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
 </div>
 </body>
 </html>
diff --git a/docs/classes/triagens.ArangoDb.BindVars.html b/docs/classes/triagens.ArangoDb.BindVars.html
@@ -177,7 +177,7 @@ <h2>Current bind values</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.0a10</a> and<br>
-            generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
+            generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
 </div>
 </body>
 </html>
diff --git a/docs/classes/triagens.ArangoDb.ClientException.html b/docs/classes/triagens.ArangoDb.ClientException.html
@@ -271,7 +271,7 @@ <h2>getTraceAsString()
 <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.0a10</a> and<br>
-            generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
+            generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
 </div>
 </body>
 </html>
diff --git a/docs/classes/triagens.ArangoDb.Collection.html b/docs/classes/triagens.ArangoDb.Collection.html
@@ -67,7 +67,6 @@
 Returns the collection as JSON-encoded string</span><pre>__toString()</pre></a></li>
 <li class="method public "><a href="#method_createFromArray" title="createFromArray :: Factory method to construct a new collection"><span class="description">Factory method to construct a new collection</span><pre>createFromArray()</pre></a></li>
 <li class="method public "><a href="#method_getAll" title="getAll :: Get all collection attributes"><span class="description">Get all collection attributes</span><pre>getAll()</pre></a></li>
-<li class="method public "><a href="#method_getDefaultType" title="getDefaultType :: Get the default collection type"><span class="description">Get the default collection type</span><pre>getDefaultType()</pre></a></li>
 <li class="method public "><a href="#method_getId" title="getId :: Get the collection id (if already known)
 Collection ids are generated on the server only."><span class="description">Get the collection id (if already known)
 Collection ids are generated on the server only.</span><pre>getId()</pre></a></li>
@@ -105,8 +104,6 @@
 <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>
 <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>
 <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>
-<li class="constant  "><a href="#constant_TYPE_DOCUMENT" title="TYPE_DOCUMENT :: document collection type"><span class="description">document collection type</span><pre>TYPE_DOCUMENT</pre></a></li>
-<li class="constant  "><a href="#constant_TYPE_EDGE" title="TYPE_EDGE :: edge collection type"><span class="description">edge collection type</span><pre>TYPE_EDGE</pre></a></li>
 </ul>
 </li>
 </ul>
@@ -192,17 +189,6 @@ <h3>Returns</h3>
 <code>array</code>- array of all collection attributes</div>
 </div></div>
 </div>
-<a id="method_getDefaultType"></a><div class="element clickable method public method_getDefaultType" data-toggle="collapse" data-target=".method_getDefaultType .collapse">
-<h2>Get the default collection type</h2>
-<pre>getDefaultType() : string</pre>
-<div class="labels"><span class="label">Static</span></div>
-<div class="row collapse"><div class="detail-description">
-<div class="long_description"></div>
-<h3>Returns</h3>
-<div class="subelement response">
-<code>string</code>- name</div>
-</div></div>
-</div>
 <a id="method_getId"></a><div class="element clickable method public method_getId" data-toggle="collapse" data-target=".method_getId .collapse">
 <h2>Get the collection id (if already known)
 Collection ids are generated on the server only.</h2>
@@ -434,26 +420,14 @@ <h2>properties option</h2>
 <div class="labels"></div>
 <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
 </div>
-<a id="constant_TYPE_DOCUMENT"> </a><div class="element clickable constant  constant_TYPE_DOCUMENT" data-toggle="collapse" data-target=".constant_TYPE_DOCUMENT .collapse">
-<h2>document collection type</h2>
-<pre>TYPE_DOCUMENT </pre>
-<div class="labels"></div>
-<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
-</div>
-<a id="constant_TYPE_EDGE"> </a><div class="element clickable constant  constant_TYPE_EDGE" data-toggle="collapse" data-target=".constant_TYPE_EDGE .collapse">
-<h2>edge collection type</h2>
-<pre>TYPE_EDGE </pre>
-<div class="labels"></div>
-<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
-</div>
 </div>
 </div>
 </div>
 </div>
 <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.0a10</a> and<br>
-            generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
+            generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
 </div>
 </body>
 </html>
diff --git a/docs/classes/triagens.ArangoDb.CollectionHandler.html b/docs/classes/triagens.ArangoDb.CollectionHandler.html
@@ -618,7 +618,7 @@ <h2>truncate option</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.0a10</a> and<br>
-            generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
+            generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
 </div>
 </body>
 </html>
diff --git a/docs/classes/triagens.ArangoDb.ConnectException.html b/docs/classes/triagens.ArangoDb.ConnectException.html
@@ -271,7 +271,7 @@ <h2>getTraceAsString()
 <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.0a10</a> and<br>
-            generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
+            generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
 </div>
 </body>
 </html>
diff --git a/docs/classes/triagens.ArangoDb.Connection.html b/docs/classes/triagens.ArangoDb.Connection.html
@@ -405,7 +405,7 @@ <h2>Flag if keep-alive connections are used</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.0a10</a> and<br>
-            generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
+            generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
 </div>
 </body>
 </html>
diff --git a/docs/classes/triagens.ArangoDb.ConnectionOptions.html b/docs/classes/triagens.ArangoDb.ConnectionOptions.html
@@ -97,6 +97,7 @@
 <li class="constant  "><a href="#constant_OPTION_HOST" title="OPTION_HOST :: Host name string index constant (deprecated, use endpoint instead)"><span class="description">Host name string index constant (deprecated, use endpoint instead)</span><pre>OPTION_HOST</pre></a></li>
 <li class="constant  "><a href="#constant_OPTION_PORT" title="OPTION_PORT :: Port number index constant (deprecated, use endpoint instead)"><span class="description">Port number index constant (deprecated, use endpoint instead)</span><pre>OPTION_PORT</pre></a></li>
 <li class="constant  "><a href="#constant_OPTION_RECONNECT" title="OPTION_RECONNECT :: Reconnect flag"><span class="description">Reconnect flag</span><pre>OPTION_RECONNECT</pre></a></li>
+<li class="constant  "><a href="#constant_OPTION_REVISION" title="OPTION_REVISION :: Update revision constant"><span class="description">Update revision constant</span><pre>OPTION_REVISION</pre></a></li>
 <li class="constant  "><a href="#constant_OPTION_TIMEOUT" title="OPTION_TIMEOUT :: Timeout value index constant"><span class="description">Timeout value index constant</span><pre>OPTION_TIMEOUT</pre></a></li>
 <li class="constant  "><a href="#constant_OPTION_TRACE" title="OPTION_TRACE :: Trace function index constant"><span class="description">Trace function index constant</span><pre>OPTION_TRACE</pre></a></li>
 <li class="constant  "><a href="#constant_OPTION_UPDATE_POLICY" title="OPTION_UPDATE_POLICY :: Update policy index constant"><span class="description">Update policy index constant</span><pre>OPTION_UPDATE_POLICY</pre></a></li>
@@ -378,6 +379,12 @@ <h2>Reconnect flag</h2>
 <div class="labels"></div>
 <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
 </div>
+<a id="constant_OPTION_REVISION"> </a><div class="element clickable constant  constant_OPTION_REVISION" data-toggle="collapse" data-target=".constant_OPTION_REVISION .collapse">
+<h2>Update revision constant</h2>
+<pre>OPTION_REVISION </pre>
+<div class="labels"></div>
+<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
+</div>
 <a id="constant_OPTION_TIMEOUT"> </a><div class="element clickable constant  constant_OPTION_TIMEOUT" data-toggle="collapse" data-target=".constant_OPTION_TIMEOUT .collapse">
 <h2>Timeout value index constant</h2>
 <pre>OPTION_TIMEOUT </pre>
@@ -409,7 +416,7 @@ <h2>Wait for sync index constant</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.0a10</a> and<br>
-            generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
+            generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
 </div>
 </body>
 </html>
diff --git a/docs/classes/triagens.ArangoDb.Cursor.html b/docs/classes/triagens.ArangoDb.Cursor.html
@@ -413,7 +413,7 @@ <h2>sanitize option entry</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.0a10</a> and<br>
-            generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
+            generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
 </div>
 </body>
 </html>
diff --git a/docs/classes/triagens.ArangoDb.DefaultValues.html b/docs/classes/triagens.ArangoDb.DefaultValues.html
@@ -132,7 +132,7 @@ <h2>Default value for waitForSync (fsync all data to disk on document updates/in
 <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.0a10</a> and<br>
-            generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
+            generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
 </div>
 </body>
 </html>