From 5e2d1af66dd8628f32fd96ebed06f1c6eb4e6513 Mon Sep 17 00:00:00 2001 From: jsteemann Date: Fri, 11 Jan 2019 20:12:47 +0100 Subject: [PATCH 1/7] added some view support --- lib/ArangoDBClient/Document.php | 2 +- lib/ArangoDBClient/Urls.php | 5 + lib/ArangoDBClient/View.php | 127 +++++++++++++++++++++++ lib/ArangoDBClient/ViewHandler.php | 144 ++++++++++++++++++++++++++ tests/DocumentBasicTest.php | 2 +- tests/QueryCacheTest.php | 5 + tests/ViewTest.php | 156 +++++++++++++++++++++++++++++ tests/travis/setup_arangodb.sh | 2 +- 8 files changed, 440 insertions(+), 3 deletions(-) create mode 100644 lib/ArangoDBClient/View.php create mode 100644 lib/ArangoDBClient/ViewHandler.php create mode 100644 tests/ViewTest.php diff --git a/lib/ArangoDBClient/Document.php b/lib/ArangoDBClient/Document.php index c70fbd97..0e7384fd 100644 --- a/lib/ArangoDBClient/Document.php +++ b/lib/ArangoDBClient/Document.php @@ -31,7 +31,7 @@ class Document implements \JsonSerializable /** * The document key (might be NULL for new documents) * - * @var string - document id + * @var string - document key */ protected $_key; diff --git a/lib/ArangoDBClient/Urls.php b/lib/ArangoDBClient/Urls.php index c1d77375..fd639f37 100644 --- a/lib/ArangoDBClient/Urls.php +++ b/lib/ArangoDBClient/Urls.php @@ -37,6 +37,11 @@ abstract class Urls * URL base part for all graph-related REST calls */ const URL_GRAPH = '/_api/gharial'; + + /** + * URL base part for all view-related REST calls + */ + const URL_VIEW = '/_api/view'; /** * URL part vertex-related graph REST calls diff --git a/lib/ArangoDBClient/View.php b/lib/ArangoDBClient/View.php new file mode 100644 index 00000000..159051f3 --- /dev/null +++ b/lib/ArangoDBClient/View.php @@ -0,0 +1,127 @@ + + * + * @package ArangoDBClient + * @since 3.4 + */ +class View +{ + /** + * The view id (might be NULL for new views) + * + * @var string - view id + */ + protected $_id; + + /** + * The view name + * + * @var string - view name + */ + protected $_name; + + /** + * View id index + */ + const ENTRY_ID = 'id'; + + /** + * View name index + */ + const ENTRY_NAME = 'name'; + + /** + * View type index + */ + const ENTRY_TYPE = 'type'; + + /** + * Constructs an empty view + * + * @param array $name - name for view + * @param string $type - view type + * + * @since 3.4 + * + * @throws \ArangoDBClient\ClientException + */ + public function __construct($name, $type) + { + $this->_name = $name; + $this->_type = $type; + } + + /** + * Return the view id + * + * @return string - view id + */ + public function getId() + { + return $this->_id; + } + + /** + * Set the view's id + * + * @param string - view id + * + * @return void + */ + public function setId($id) + { + $this->_id = $id; + } + + /** + * Return the view name + * + * @return string - view name + */ + public function getName() + { + return $this->_name; + } + + /** + * Return the view type + * + * @return string - view type + */ + public function getType() + { + return $this->_type; + } + + /** + * Return the view as an array + * + * @return array - view data as an array + */ + public function getAll() + { + return [ + self::ENTRY_ID => $this->getId(), + self::ENTRY_NAME => $this->getName(), + self::ENTRY_TYPE => $this->getType(), + ]; + } +} + +class_alias(View::class, '\triagens\ArangoDb\View'); diff --git a/lib/ArangoDBClient/ViewHandler.php b/lib/ArangoDBClient/ViewHandler.php new file mode 100644 index 00000000..dea346f8 --- /dev/null +++ b/lib/ArangoDBClient/ViewHandler.php @@ -0,0 +1,144 @@ +
+ * + * @throws Exception + * + * @param View $view - The view object which holds the information of the view to be created + * + * @return array + * @since 3.4 + */ + public function createView(View $view) + { + $params = [ + View::ENTRY_NAME => $view->getName(), + View::ENTRY_TYPE => $view->getType(), + ]; + $url = Urls::URL_VIEW; + $response = $this->getConnection()->post($url, $this->json_encode_wrapper($params)); + $json = $response->getJson(); + $view->setId($json[View::ENTRY_ID]); + + return $view->getAll(); + } + + /** + * Get a view + * + * This will get a view.

+ * + * @param String $view - The name of the view + * + * @return View|false + * @throws \ArangoDBClient\ClientException + * @since 3.4 + */ + public function getView($view) + { + $url = UrlHelper::buildUrl(Urls::URL_VIEW, [$view]); + + $response = $this->getConnection()->get($url); + $data = $response->getJson(); + + $result = new View($data[View::ENTRY_NAME], $data[View::ENTRY_TYPE]); + $result->setId($data[View::ENTRY_ID]); + + return $result; + } + + /** + * Get a view's properties

+ * + * @throws Exception + * + * @param mixed $view - view name as a string or instance of View + * + * @return array - Returns an array of attributes. Will throw if there is an error + * @since 3.4 + */ + public function properties($view) + { + if ($view instanceof View) { + $view = $view->getName(); + } + + $url = UrlHelper::buildUrl(Urls::URL_VIEW, [$view, 'properties']); + + $result = $this->getConnection()->get($url); + + return $result->getJson(); + } + + /** + * Set a view's properties

+ * + * @throws Exception + * + * @param mixed $view - view name as a string or instance of View + * @param array $properties - array with view properties + * + * @return array - Returns an array of attributes. Will throw if there is an error + * @since 3.4 + */ + public function setProperties($view, array $properties) + { + if ($view instanceof View) { + $view = $view->getName(); + } + + $url = UrlHelper::buildUrl(Urls::URL_VIEW, [$view, 'properties']); + $response = $this->getConnection()->put($url, $this->json_encode_wrapper($properties)); + $json = $response->getJson(); + + return $json; + } + + + /** + * Drop a view

+ * + * @throws Exception + * + * @param mixed $view - view name as a string or instance of View + * + * @return bool - always true, will throw if there is an error + * @since 3.4 + */ + public function dropView($view) + { + if ($view instanceof View) { + $view = $view->getName(); + } + + $url = UrlHelper::buildUrl(Urls::URL_VIEW, [$view]); + $this->getConnection()->delete($url); + + return true; + } +} + +class_alias(ViewHandler::class, '\triagens\ArangoDb\ViewHandler'); diff --git a/tests/DocumentBasicTest.php b/tests/DocumentBasicTest.php index deab404a..b921bea5 100644 --- a/tests/DocumentBasicTest.php +++ b/tests/DocumentBasicTest.php @@ -181,7 +181,7 @@ public function testCreateAndDeleteDocumentWithoutCreatedCollection() try { $this->collectionHandler->drop('ArangoDB_PHP_TestSuite_TestCollection_01' . '_' . static::$testsTimestamp); } catch (\Exception $e) { - #don't bother us, if it's already deleted. + // don't bother us, if it's already deleted. } $document->someAttribute = 'someValue'; diff --git a/tests/QueryCacheTest.php b/tests/QueryCacheTest.php index 196f03b9..d8d7fd36 100644 --- a/tests/QueryCacheTest.php +++ b/tests/QueryCacheTest.php @@ -109,6 +109,11 @@ public function testClear() */ public function testGetEntries() { + if (isCluster($this->connection)) { + // don't execute this test in a cluster + $this->markTestSkipped("test is only meaningful in single server"); + return; + } $this->setupCollection(); $this->cacheHandler->enable(); diff --git a/tests/ViewTest.php b/tests/ViewTest.php new file mode 100644 index 00000000..8e84a24c --- /dev/null +++ b/tests/ViewTest.php @@ -0,0 +1,156 @@ +connection = getConnection(); + $this->viewHandler = new ViewHandler($this->connection); + } + + /** + * Test creation of view + */ + public function testCreateViewObject() + { + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + static::assertNull($this->view->getId()); + static::assertEquals('View1' . '_' . static::$testsTimestamp, $this->view->getName()); + static::assertEquals('arangosearch', $this->view->getType()); + } + + /** + * Test creation of view + */ + public function testCreateView() + { + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $result = $this->viewHandler->createView($this->view); + static::assertEquals('View1' . '_' . static::$testsTimestamp, $result['name']); + static::assertEquals('arangosearch', $result['type']); + } + + /** + * Test getting a view + */ + public function testGetView() + { + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $this->viewHandler->createView($this->view); + + $result = $this->viewHandler->getView('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + static::assertEquals('View1' . '_' . static::$testsTimestamp, $result->getName()); + static::assertEquals('arangosearch', $result->getType()); + } + + /** + * Test getting a non-existing view + */ + public function testGetNonExistingView() + { + try { + $this->viewHandler->getView('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + } catch (\Exception $exception) { + } + static::assertEquals(404, $exception->getCode()); + } + + /** + * Test view properties + */ + public function testViewProperties() + { + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $result = $this->viewHandler->createView($this->view); + static::assertEquals('View1' . '_' . static::$testsTimestamp, $result['name']); + static::assertEquals('arangosearch', $result['type']); + + $result = $this->viewHandler->properties($this->view); + static::assertEquals([], $result['links']); + } + + + /** + * Test set view properties + */ + public function testViewSetProperties() + { + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $result = $this->viewHandler->createView($this->view); + static::assertEquals('View1' . '_' . static::$testsTimestamp, $result['name']); + static::assertEquals('arangosearch', $result['type']); + + $properties = [ + 'links' => [ + '_graphs' => [ 'includeAllFields' => true ] + ] + ]; + $result = $this->viewHandler->setProperties($this->view, $properties); + static::assertEquals('arangosearch', $result['type']); + static::assertTrue($result['links']['_graphs']['includeAllFields']); + static::assertEquals([], $result['links']['_graphs']['fields']); + } + + /** + * Test drop view + */ + public function testDropView() + { + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $this->viewHandler->createView($this->view); + $result = $this->viewHandler->dropView('View1' . '_' . static::$testsTimestamp); + static::assertTrue($result); + } + + /** + * Test drop non-existing view + */ + public function testDropNonExistingView() + { + try { + $this->viewHandler->dropView('View1' . '_' . static::$testsTimestamp); + } catch (\Exception $exception) { + } + static::assertEquals(404, $exception->getCode()); + } + + public function tearDown() + { + $this->viewHandler = new ViewHandler($this->connection); + try { + $this->viewHandler->dropView('View1' . '_' . static::$testsTimestamp); + } catch (Exception $e) { + } + try { + $this->viewHandler->dropView('View2' . '_' . static::$testsTimestamp); + } catch (Exception $e) { + } + } +} diff --git a/tests/travis/setup_arangodb.sh b/tests/travis/setup_arangodb.sh index ebd460c4..ecab6f8f 100644 --- a/tests/travis/setup_arangodb.sh +++ b/tests/travis/setup_arangodb.sh @@ -36,7 +36,7 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" cd $DIR docker pull arangodb/arangodb-preview:devel -docker run -d -e ARANGO_ROOT_PASSWORD="test" -p 8529:8529 arangodb/arangodb-preview:devel +docker run -d -e ARANGO_ROOT_PASSWORD="test" -p 8529:8529 arangodb/arangodb:3.4.1 sleep 2 From 25f24f48b8100fa6c5585fd22632b3f27eb70722 Mon Sep 17 00:00:00 2001 From: jsteemann Date: Tue, 22 Jan 2019 10:03:01 +0100 Subject: [PATCH 2/7] add view renaming --- CHANGELOG.md | 7 ++-- lib/ArangoDBClient/ViewHandler.php | 37 ++++++++++++++++--- tests/ViewTest.php | 57 ++++++++++++++++++++++++------ 3 files changed, 84 insertions(+), 17 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 037cf174..7e75ddc2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -41,8 +41,11 @@ In addition, the `save` method of `DocumentHandler` will now understand the `ove option, which will turn an insert into a replace operation in case the insert fails with a unique constraint violation error on the primary key. -The method `insert` was introduced in `DocumentHandler` as an alias for `save` for consistency -with the server-side naming. +The method `insert` was introduced in `DocumentHandler` as an alias for the existing `save` +method to be consistent with the server-side method naming. + +Basic support for arangosearch views was added in 3.4.0, via the `View` and `ViewHandler` +classes. Release notes for the ArangoDB-PHP driver 3.3.x diff --git a/lib/ArangoDBClient/ViewHandler.php b/lib/ArangoDBClient/ViewHandler.php index dea346f8..330573b8 100644 --- a/lib/ArangoDBClient/ViewHandler.php +++ b/lib/ArangoDBClient/ViewHandler.php @@ -20,6 +20,11 @@ */ class ViewHandler extends Handler { + /** + * rename option + */ + const OPTION_RENAME = 'rename'; + /** * Create a view * @@ -32,7 +37,7 @@ class ViewHandler extends Handler * @return array * @since 3.4 */ - public function createView(View $view) + public function create(View $view) { $params = [ View::ENTRY_NAME => $view->getName(), @@ -57,7 +62,7 @@ public function createView(View $view) * @throws \ArangoDBClient\ClientException * @since 3.4 */ - public function getView($view) + public function get($view) { $url = UrlHelper::buildUrl(Urls::URL_VIEW, [$view]); @@ -87,7 +92,6 @@ public function properties($view) } $url = UrlHelper::buildUrl(Urls::URL_VIEW, [$view, 'properties']); - $result = $this->getConnection()->get($url); return $result->getJson(); @@ -128,7 +132,7 @@ public function setProperties($view, array $properties) * @return bool - always true, will throw if there is an error * @since 3.4 */ - public function dropView($view) + public function drop($view) { if ($view instanceof View) { $view = $view->getName(); @@ -139,6 +143,31 @@ public function dropView($view) return true; } + + /** + * Rename a view + * + * @throws Exception + * + * @param mixed $view - view name as a string or instance of View + * @param string $name - new name for collection + * + * @return bool - always true, will throw if there is an error + */ + public function rename($view, $name) + { + if ($view instanceof View) { + $view = $view->getName(); + } + + $params = [View::ENTRY_NAME => $name]; + $this->getConnection()->put( + UrlHelper::buildUrl(Urls::URL_VIEW, [$view, self::OPTION_RENAME]), + $this->json_encode_wrapper($params) + ); + + return true; + } } class_alias(ViewHandler::class, '\triagens\ArangoDb\ViewHandler'); diff --git a/tests/ViewTest.php b/tests/ViewTest.php index 8e84a24c..5e56d0df 100644 --- a/tests/ViewTest.php +++ b/tests/ViewTest.php @@ -52,7 +52,7 @@ public function testCreateViewObject() public function testCreateView() { $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); - $result = $this->viewHandler->createView($this->view); + $result = $this->viewHandler->create($this->view); static::assertEquals('View1' . '_' . static::$testsTimestamp, $result['name']); static::assertEquals('arangosearch', $result['type']); } @@ -63,9 +63,9 @@ public function testCreateView() public function testGetView() { $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); - $this->viewHandler->createView($this->view); + $this->viewHandler->create($this->view); - $result = $this->viewHandler->getView('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $result = $this->viewHandler->get('View1' . '_' . static::$testsTimestamp, 'arangosearch'); static::assertEquals('View1' . '_' . static::$testsTimestamp, $result->getName()); static::assertEquals('arangosearch', $result->getType()); } @@ -76,7 +76,7 @@ public function testGetView() public function testGetNonExistingView() { try { - $this->viewHandler->getView('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $this->viewHandler->get('View1' . '_' . static::$testsTimestamp, 'arangosearch'); } catch (\Exception $exception) { } static::assertEquals(404, $exception->getCode()); @@ -88,7 +88,7 @@ public function testGetNonExistingView() public function testViewProperties() { $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); - $result = $this->viewHandler->createView($this->view); + $result = $this->viewHandler->create($this->view); static::assertEquals('View1' . '_' . static::$testsTimestamp, $result['name']); static::assertEquals('arangosearch', $result['type']); @@ -103,7 +103,7 @@ public function testViewProperties() public function testViewSetProperties() { $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); - $result = $this->viewHandler->createView($this->view); + $result = $this->viewHandler->create($this->view); static::assertEquals('View1' . '_' . static::$testsTimestamp, $result['name']); static::assertEquals('arangosearch', $result['type']); @@ -124,8 +124,8 @@ public function testViewSetProperties() public function testDropView() { $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); - $this->viewHandler->createView($this->view); - $result = $this->viewHandler->dropView('View1' . '_' . static::$testsTimestamp); + $this->viewHandler->create($this->view); + $result = $this->viewHandler->drop('View1' . '_' . static::$testsTimestamp); static::assertTrue($result); } @@ -135,7 +135,42 @@ public function testDropView() public function testDropNonExistingView() { try { - $this->viewHandler->dropView('View1' . '_' . static::$testsTimestamp); + $this->viewHandler->drop('View1' . '_' . static::$testsTimestamp); + } catch (\Exception $exception) { + } + static::assertEquals(404, $exception->getCode()); + } + + /** + * Test rename view + */ + public function testRenameView() + { + if (isCluster($this->connection)) { + // don't execute this test in a cluster + $this->markTestSkipped("test is only meaningful in a single server"); + return; + } + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $this->viewHandler->create($this->view); + $result = $this->viewHandler->rename('View1' . '_' . static::$testsTimestamp, 'View2' . '_' . static::$testsTimestamp); + static::assertTrue($result); + } + + /** + * Test rename a non-existing view + */ + public function testRenameNonExistingView() + { + if (isCluster($this->connection)) { + // don't execute this test in a cluster + $this->markTestSkipped("test is only meaningful in a single server"); + return; + } + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $this->viewHandler->create($this->view); + try { + $this->viewHandler->rename('View2' . '_' . static::$testsTimestamp, 'View1' . '_' . static::$testsTimestamp); } catch (\Exception $exception) { } static::assertEquals(404, $exception->getCode()); @@ -145,11 +180,11 @@ public function tearDown() { $this->viewHandler = new ViewHandler($this->connection); try { - $this->viewHandler->dropView('View1' . '_' . static::$testsTimestamp); + $this->viewHandler->drop('View1' . '_' . static::$testsTimestamp); } catch (Exception $e) { } try { - $this->viewHandler->dropView('View2' . '_' . static::$testsTimestamp); + $this->viewHandler->drop('View2' . '_' . static::$testsTimestamp); } catch (Exception $e) { } } From 57daa334e0352d996fadeea493cf93a7666c41d9 Mon Sep 17 00:00:00 2001 From: jsteemann Date: Tue, 22 Jan 2019 10:03:15 +0100 Subject: [PATCH 3/7] fix test --- tests/StatementTest.php | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/StatementTest.php b/tests/StatementTest.php index ba89df28..58875b35 100644 --- a/tests/StatementTest.php +++ b/tests/StatementTest.php @@ -13,6 +13,7 @@ function filtered(array $values) { unset($values['executionTime']); unset($values['httpRequests']); + unset($values['peakMemoryUsage']); return $values; } From d707b1a3cbb51f5b898dea0603798b215d2650ff Mon Sep 17 00:00:00 2001 From: jsteemann Date: Tue, 22 Jan 2019 10:03:27 +0100 Subject: [PATCH 4/7] include 3.4 test results --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index cd90902e..fbe690d6 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ The official ArangoDB PHP Driver. 3.2: [![Build Status](https://travis-ci.org/arangodb/arangodb-php.png?branch=3.2)](https://travis-ci.org/arangodb/arangodb-php) 3.3: [![Build Status](https://travis-ci.org/arangodb/arangodb-php.png?branch=3.3)](https://travis-ci.org/arangodb/arangodb-php) +3.4: [![Build Status](https://travis-ci.org/arangodb/arangodb-php.png?branch=3.4)](https://travis-ci.org/arangodb/arangodb-php) devel: [![Build Status](https://travis-ci.org/arangodb/arangodb-php.png?branch=devel)](https://travis-ci.org/arangodb/arangodb-php) - [Getting Started](docs/Drivers/PHP/GettingStarted/README.md) From 9a9c602098c79e06e883bf0e556e83ad76f92620 Mon Sep 17 00:00:00 2001 From: maxkernbach Date: Tue, 22 Jan 2019 11:31:38 +0100 Subject: [PATCH 5/7] generate 3.4 documentation --- docs/classes.svg | 571 +- docs/classes/ArangoDBClient.AdminHandler.html | 38 +- .../ArangoDBClient.AqlUserFunction.html | 4 +- docs/classes/ArangoDBClient.Autoloader.html | 4 +- docs/classes/ArangoDBClient.Batch.html | 46 +- docs/classes/ArangoDBClient.BatchPart.html | 46 +- docs/classes/ArangoDBClient.BindVars.html | 4 +- .../ArangoDBClient.ClientException.html | 4 +- docs/classes/ArangoDBClient.Collection.html | 100 +- .../ArangoDBClient.CollectionHandler.html | 83 +- .../ArangoDBClient.ConnectException.html | 4 +- docs/classes/ArangoDBClient.Connection.html | 4 +- .../ArangoDBClient.ConnectionOptions.html | 4 +- docs/classes/ArangoDBClient.Cursor.html | 44 +- docs/classes/ArangoDBClient.Database.html | 4 +- .../classes/ArangoDBClient.DefaultValues.html | 4 +- docs/classes/ArangoDBClient.Document.html | 4 +- .../ArangoDBClient.DocumentClassable.html | 166 + .../ArangoDBClient.DocumentHandler.html | 75 +- docs/classes/ArangoDBClient.Edge.html | 4 +- .../ArangoDBClient.EdgeDefinition.html | 4 +- docs/classes/ArangoDBClient.EdgeHandler.html | 90 +- docs/classes/ArangoDBClient.Endpoint.html | 4 +- docs/classes/ArangoDBClient.Exception.html | 4 +- docs/classes/ArangoDBClient.Export.html | 44 +- docs/classes/ArangoDBClient.ExportCursor.html | 44 +- .../ArangoDBClient.FailoverException.html | 4 +- docs/classes/ArangoDBClient.FoxxHandler.html | 38 +- docs/classes/ArangoDBClient.Graph.html | 4 +- docs/classes/ArangoDBClient.GraphHandler.html | 34 +- docs/classes/ArangoDBClient.Handler.html | 44 +- docs/classes/ArangoDBClient.HttpHelper.html | 4 +- docs/classes/ArangoDBClient.HttpResponse.html | 4 +- .../ArangoDBClient.QueryCacheHandler.html | 55 +- docs/classes/ArangoDBClient.QueryHandler.html | 38 +- .../ArangoDBClient.ServerException.html | 4 +- docs/classes/ArangoDBClient.Statement.html | 4 +- docs/classes/ArangoDBClient.TraceRequest.html | 4 +- .../classes/ArangoDBClient.TraceResponse.html | 4 +- docs/classes/ArangoDBClient.Transaction.html | 4 +- docs/classes/ArangoDBClient.Traversal.html | 4 +- docs/classes/ArangoDBClient.UpdatePolicy.html | 4 +- docs/classes/ArangoDBClient.UrlHelper.html | 4 +- docs/classes/ArangoDBClient.Urls.html | 11 +- docs/classes/ArangoDBClient.User.html | 4 +- docs/classes/ArangoDBClient.UserHandler.html | 38 +- .../ArangoDBClient.ValueValidator.html | 4 +- docs/classes/ArangoDBClient.Vertex.html | 4 +- .../classes/ArangoDBClient.VertexHandler.html | 75 +- docs/classes/ArangoDBClient.View.html | 256 + docs/classes/ArangoDBClient.ViewHandler.html | 500 ++ docs/deprecated.html | 8 +- docs/errors.html | 40 +- docs/graph_class.html | 4 +- docs/index.html | 6 +- docs/markers.html | 4 +- docs/namespaces/ArangoDBClient.html | 30 +- docs/packages/ArangoDBClient.html | 30 +- docs/packages/Default.html | 4 +- docs/packages/global.html | 4 +- docs/structure.xml | 6218 ++++++++++------- 61 files changed, 6039 insertions(+), 2861 deletions(-) create mode 100644 docs/classes/ArangoDBClient.DocumentClassable.html create mode 100644 docs/classes/ArangoDBClient.View.html create mode 100644 docs/classes/ArangoDBClient.ViewHandler.html diff --git a/docs/classes.svg b/docs/classes.svg index fba77b91..414d1431 100644 --- a/docs/classes.svg +++ b/docs/classes.svg @@ -1,390 +1,489 @@ - - - + + G - -cluster_Global - -Global + + +cluster_Global + +Global -cluster_\ArangoDBClient - -ArangoDBClient + +cluster_\ArangoDBClient + +ArangoDBClient -\\ArangoDBClient\\AqlUserFunction - -AqlUserFunction + +\\ArangoDBClient\\AqlUserFunction + +AqlUserFunction + + + +\\ArangoDBClient\\ViewHandler + +ViewHandler + + + +\\ArangoDBClient\\Handler + +«abstract» +Handler + + + +\\ArangoDBClient\\ViewHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\BatchPart - -BatchPart + +\\ArangoDBClient\\BatchPart + +BatchPart - -\\ArangoDBClient\\UserHandler - -UserHandler + + +\\ArangoDBClient\\View + +View - -\\ArangoDBClient\\Handler - -«abstract» -Handler + + +\\ArangoDBClient\\UserHandler + +UserHandler -\\ArangoDBClient\\UserHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\UserHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\Document - -Document + +\\ArangoDBClient\\Document + +Document -\\JsonSerializable - -\JsonSerializable + +\\JsonSerializable + +\JsonSerializable -\\ArangoDBClient\\Document->\\JsonSerializable - - + +\\ArangoDBClient\\Document->\\JsonSerializable + + -\\ArangoDBClient\\ConnectionOptions - -ConnectionOptions + +\\ArangoDBClient\\ConnectionOptions + +ConnectionOptions -\\ArrayAccess - -\ArrayAccess + +\\ArrayAccess + +\ArrayAccess -\\ArangoDBClient\\ConnectionOptions->\\ArrayAccess - - + +\\ArangoDBClient\\ConnectionOptions->\\ArrayAccess + + -\\ArangoDBClient\\Connection - -Connection + +\\ArangoDBClient\\Connection + +Connection -\\ArangoDBClient\\Transaction - -Transaction + +\\ArangoDBClient\\Transaction + +Transaction -\\ArangoDBClient\\ExportCursor - -ExportCursor + +\\ArangoDBClient\\ExportCursor + +ExportCursor -\\ArangoDBClient\\UrlHelper - -«abstract» -UrlHelper + +\\ArangoDBClient\\UrlHelper + +«abstract» +UrlHelper -\\ArangoDBClient\\QueryCacheHandler - -QueryCacheHandler + +\\ArangoDBClient\\QueryCacheHandler + +QueryCacheHandler -\\ArangoDBClient\\QueryCacheHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\QueryCacheHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\DocumentHandler - -DocumentHandler + +\\ArangoDBClient\\DocumentHandler + +DocumentHandler -\\ArangoDBClient\\DocumentHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\DocumentHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\Edge - -Edge + +\\ArangoDBClient\\Edge + +Edge -\\ArangoDBClient\\Edge->\\ArangoDBClient\\Document - - + +\\ArangoDBClient\\Edge->\\ArangoDBClient\\Document + + -\\ArangoDBClient\\Cursor - -Cursor + +\\ArangoDBClient\\Cursor + +Cursor -\\Iterator - -\Iterator + +\\Iterator + +\Iterator -\\ArangoDBClient\\Cursor->\\Iterator - - + +\\ArangoDBClient\\Cursor->\\Iterator + + -\\ArangoDBClient\\Database - -Database + +\\ArangoDBClient\\Database + +Database -\\ArangoDBClient\\FailoverException - -FailoverException + +\\ArangoDBClient\\FailoverException + +FailoverException -\\ArangoDBClient\\Exception - -Exception + +\\ArangoDBClient\\Exception + +Exception -\\ArangoDBClient\\FailoverException->\\ArangoDBClient\\Exception - - + +\\ArangoDBClient\\FailoverException->\\ArangoDBClient\\Exception + + -\\ArangoDBClient\\Batch - -Batch + +\\ArangoDBClient\\Batch + +Batch -\\ArangoDBClient\\TraceRequest - -TraceRequest + +\\ArangoDBClient\\TraceRequest + +TraceRequest -\\ArangoDBClient\\ConnectException - -ConnectException + +\\ArangoDBClient\\ConnectException + +ConnectException -\\ArangoDBClient\\ConnectException->\\ArangoDBClient\\Exception - - + +\\ArangoDBClient\\ConnectException->\\ArangoDBClient\\Exception + + -\\ArangoDBClient\\ValueValidator - -ValueValidator + +\\ArangoDBClient\\ValueValidator + +ValueValidator -\\ArangoDBClient\\Autoloader - -Autoloader + +\\ArangoDBClient\\Autoloader + +Autoloader -\\ArangoDBClient\\ClientException - -ClientException + +\\ArangoDBClient\\ClientException + +ClientException -\\ArangoDBClient\\ClientException->\\ArangoDBClient\\Exception - - + +\\ArangoDBClient\\ClientException->\\ArangoDBClient\\Exception + + -\\ArangoDBClient\\FoxxHandler - -FoxxHandler + +\\ArangoDBClient\\FoxxHandler + +FoxxHandler -\\ArangoDBClient\\FoxxHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\FoxxHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\User - -User + +\\ArangoDBClient\\User + +User -\\ArangoDBClient\\User->\\ArangoDBClient\\Document - - + +\\ArangoDBClient\\User->\\ArangoDBClient\\Document + + -\\ArangoDBClient\\BindVars - -BindVars + +\\ArangoDBClient\\BindVars + +BindVars -\\ArangoDBClient\\CollectionHandler - -CollectionHandler + +\\ArangoDBClient\\CollectionHandler + +CollectionHandler -\\ArangoDBClient\\CollectionHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\CollectionHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\Graph - -Graph + +\\ArangoDBClient\\Graph + +Graph -\\ArangoDBClient\\Graph->\\ArangoDBClient\\Document - - + +\\ArangoDBClient\\Graph->\\ArangoDBClient\\Document + + -\\ArangoDBClient\\EdgeDefinition - -EdgeDefinition + +\\ArangoDBClient\\EdgeDefinition + +EdgeDefinition -\\ArangoDBClient\\Vertex - -Vertex + +\\ArangoDBClient\\Vertex + +Vertex -\\ArangoDBClient\\Vertex->\\ArangoDBClient\\Document - - + +\\ArangoDBClient\\Vertex->\\ArangoDBClient\\Document + + -\\ArangoDBClient\\Collection - -Collection + +\\ArangoDBClient\\Collection + +Collection -\\ArangoDBClient\\HttpResponse - -HttpResponse + +\\ArangoDBClient\\HttpResponse + +HttpResponse -\\ArangoDBClient\\HttpHelper - -HttpHelper + +\\ArangoDBClient\\HttpHelper + +HttpHelper -\\ArangoDBClient\\UpdatePolicy - -UpdatePolicy + +\\ArangoDBClient\\UpdatePolicy + +UpdatePolicy -\\Exception - -\Exception + +\\Exception + +\Exception -\\ArangoDBClient\\Exception->\\Exception - - + +\\ArangoDBClient\\Exception->\\Exception + + -\\ArangoDBClient\\Endpoint - -Endpoint + +\\ArangoDBClient\\Endpoint + +Endpoint -\\ArangoDBClient\\QueryHandler - -QueryHandler + +\\ArangoDBClient\\QueryHandler + +QueryHandler -\\ArangoDBClient\\QueryHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\QueryHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\ServerException - -ServerException + +\\ArangoDBClient\\ServerException + +ServerException -\\ArangoDBClient\\ServerException->\\ArangoDBClient\\Exception - - + +\\ArangoDBClient\\ServerException->\\ArangoDBClient\\Exception + + -\\ArangoDBClient\\Traversal - -Traversal + +\\ArangoDBClient\\Traversal + +Traversal -\\ArangoDBClient\\VertexHandler - -VertexHandler + +\\ArangoDBClient\\VertexHandler + +VertexHandler -\\ArangoDBClient\\VertexHandler->\\ArangoDBClient\\DocumentHandler - - + +\\ArangoDBClient\\VertexHandler->\\ArangoDBClient\\DocumentHandler + + -\\ArangoDBClient\\Statement - -Statement + +\\ArangoDBClient\\Statement + +Statement -\\ArangoDBClient\\Urls - -«abstract» -Urls + +\\ArangoDBClient\\Urls + +«abstract» +Urls -\\ArangoDBClient\\TraceResponse - -TraceResponse + +\\ArangoDBClient\\TraceResponse + +TraceResponse -\\ArangoDBClient\\AdminHandler - -AdminHandler + +\\ArangoDBClient\\AdminHandler + +AdminHandler -\\ArangoDBClient\\AdminHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\AdminHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\EdgeHandler - -EdgeHandler + +\\ArangoDBClient\\EdgeHandler + +EdgeHandler -\\ArangoDBClient\\EdgeHandler->\\ArangoDBClient\\DocumentHandler - - + +\\ArangoDBClient\\EdgeHandler->\\ArangoDBClient\\DocumentHandler + + -\\ArangoDBClient\\Export - -Export + +\\ArangoDBClient\\Export + +Export -\\ArangoDBClient\\GraphHandler - -GraphHandler + +\\ArangoDBClient\\GraphHandler + +GraphHandler -\\ArangoDBClient\\GraphHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\GraphHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\DefaultValues - -«abstract» -DefaultValues + +\\ArangoDBClient\\DefaultValues + +«abstract» +DefaultValues + + + +\\ArangoDBClient\\DocumentClassable + +DocumentClassable diff --git a/docs/classes/ArangoDBClient.AdminHandler.html b/docs/classes/ArangoDBClient.AdminHandler.html index 47c5a0c1..c6a49f30 100644 --- a/docs/classes/ArangoDBClient.AdminHandler.html +++ b/docs/classes/ArangoDBClient.AdminHandler.html @@ -31,7 +31,7 @@ Reports @@ -252,7 +252,7 @@

Default

+ generated on 2019-08-19T13:30:48+02:00.
diff --git a/docs/classes/ArangoDBClient.TraceResponse.html b/docs/classes/ArangoDBClient.TraceResponse.html index 3e7222b3..310027a1 100644 --- a/docs/classes/ArangoDBClient.TraceResponse.html +++ b/docs/classes/ArangoDBClient.TraceResponse.html @@ -31,11 +31,11 @@ Reports @@ -271,7 +271,7 @@

Default

+ generated on 2019-08-19T13:30:48+02:00.
diff --git a/docs/classes/ArangoDBClient.Transaction.html b/docs/classes/ArangoDBClient.Transaction.html index 270cae0e..8f6e4532 100644 --- a/docs/classes/ArangoDBClient.Transaction.html +++ b/docs/classes/ArangoDBClient.Transaction.html @@ -31,11 +31,11 @@ Reports @@ -62,45 +62,60 @@  Methods @@ -137,7 +137,7 @@

last update will win in case of conflicting versions

+ generated on 2019-08-19T13:30:49+02:00.
diff --git a/docs/classes/ArangoDBClient.UrlHelper.html b/docs/classes/ArangoDBClient.UrlHelper.html index 076c7f08..183aad0a 100644 --- a/docs/classes/ArangoDBClient.UrlHelper.html +++ b/docs/classes/ArangoDBClient.UrlHelper.html @@ -31,11 +31,11 @@ Reports @@ -178,7 +178,7 @@

Returns

+ generated on 2019-08-19T13:30:48+02:00.
diff --git a/docs/classes/ArangoDBClient.Urls.html b/docs/classes/ArangoDBClient.Urls.html index 3baa0ebf..df53120e 100644 --- a/docs/classes/ArangoDBClient.Urls.html +++ b/docs/classes/ArangoDBClient.Urls.html @@ -31,11 +31,11 @@ Reports @@ -425,7 +425,7 @@

URL for select-range

+ generated on 2019-08-19T13:30:49+02:00.
diff --git a/docs/classes/ArangoDBClient.User.html b/docs/classes/ArangoDBClient.User.html index 9484c5f1..d72f4f9c 100644 --- a/docs/classes/ArangoDBClient.User.html +++ b/docs/classes/ArangoDBClient.User.html @@ -31,11 +31,11 @@ Reports @@ -136,6 +136,7 @@
  • isNew id index
    ENTRY_ISNEW
  • Document key index
    ENTRY_KEY
  • Revision id index
    ENTRY_REV
  • +
  • regular expression used for key validation
    KEY_REGEX_PART
  • keepNull option index
    OPTION_KEEPNULL
  • policy option index
    OPTION_POLICY
  • waitForSync option index
    OPTION_WAIT_FOR_SYNC
  • @@ -972,6 +973,12 @@

    Revision id index

    + 
    +

    regular expression used for key validation

    +
    KEY_REGEX_PART = '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' 
    +
    +
    +
     

    keepNull option index

    OPTION_KEEPNULL = 'keepNull' 
    @@ -997,7 +1004,7 @@

    waitForSync option index

    + generated on 2019-08-19T13:30:48+02:00.
    diff --git a/docs/classes/ArangoDBClient.UserHandler.html b/docs/classes/ArangoDBClient.UserHandler.html index 405b6226..0cc2d318 100644 --- a/docs/classes/ArangoDBClient.UserHandler.html +++ b/docs/classes/ArangoDBClient.UserHandler.html @@ -31,11 +31,11 @@ Reports @@ -82,6 +82,7 @@ @@ -131,6 +131,7 @@
  • isNew id index
    ENTRY_ISNEW
  • Document key index
    ENTRY_KEY
  • Revision id index
    ENTRY_REV
  • +
  • regular expression used for key validation
    KEY_REGEX_PART
  • keepNull option index
    OPTION_KEEPNULL
  • policy option index
    OPTION_POLICY
  • waitForSync option index
    OPTION_WAIT_FOR_SYNC
  • @@ -879,6 +880,12 @@

    Revision id index

    + 
    +

    regular expression used for key validation

    +
    KEY_REGEX_PART = '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' 
    +
    +
    +
     

    keepNull option index

    OPTION_KEEPNULL = 'keepNull' 
    @@ -904,7 +911,7 @@

    waitForSync option index

    + generated on 2019-08-19T13:30:49+02:00.
    diff --git a/docs/classes/ArangoDBClient.VertexHandler.html b/docs/classes/ArangoDBClient.VertexHandler.html index 724d1195..586474c7 100644 --- a/docs/classes/ArangoDBClient.VertexHandler.html +++ b/docs/classes/ArangoDBClient.VertexHandler.html @@ -31,11 +31,11 @@ Reports @@ -67,12 +67,12 @@
  • Get a single document from a collection
    getById()
  • Gets information about a single documents from a collection
    getHead()
  • Check if a document exists
    has()
  • -
  • Insert a document into a collection
    insert()
  • +
  • insert a document into a collection
    insert()
  • Remove a document from a collection, identified by the document itself
    remove()
  • Remove a document from a collection, identified by the collection id and document id
    removeById()
  • Replace an existing document in a collection, identified by the document itself
    replace()
  • Replace an existing document in a collection, identified by collection id and document id
    replaceById()
  • -
  • save a document to a collection
    save()
  • +
  • Insert a document into a collection
    save()
  • Sets the document class to use
    setDocumentClass()
  • Sets the edge class to use
    setEdgeClass()
  • Store a document to a collection
    store()
  • @@ -84,8 +84,7 @@ @@ -337,15 +338,47 @@

    Returns

    -

    Insert a document into a collection

    -
    insert($collection, $document, array $options = array()
    +

    insert a document into a collection

    +
    insert(mixed $collection, \ArangoDBClient\Document|array $document, array $options = array()) : mixed
    Inherited
    -

    This is an alias for save().

    +

    This will add the document to the collection and return the document's id

    +

    This will throw if the document cannot be saved

    + + + +
    since1.0

    Parameters

    -

    $collection

    -

    $document

    -

    $options

    +
    +

    $collection

    +mixed
      +
    • collection id as string or number
    • +
    +
    +

    $document

    +\ArangoDBClient\Documentarray
      +
    • the document to be added, can be passed as a document or an array
    • +
    +
    +

    $options

    +array
      +
    • optional, array of options +

      Options are :
      +

    • 'createCollection' - create the collection if it does not yet exist.
    • +
    • 'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
    • +
    • 'overwrite' - if set to true, will turn the insert into a replace operation if a document with the specified key already exists.
    • +
    • 'returnNew' - if set to true, then the newly created document will be returned.
    • +
    • 'returnOld' - if set to true, then the replaced document will be returned - useful only when using overwrite = true.
    • +

      +
    +

    Exceptions

    + + + +
    \ArangoDBClient\Exception
    +

    Returns

    +
    +mixed- id of document created
    @@ -425,8 +458,8 @@

    Replace an existing document in a collection, identified by the document its
    replace(\ArangoDBClient\Document $document, array $options = array()) : boolean
    Inherited
    -

    This will update the document on the server

    -

    This will throw if the document cannot be updated

    +

    This will replace the document on the server

    +

    This will throw if the document cannot be replaced

    If policy is set to error (locally or globally through the ConnectionOptions) and the passed document has a _rev value set, the database will check that the revision of the to-be-replaced document is the same as the one given.

    @@ -434,14 +467,14 @@

    Parameters

    $document

    \ArangoDBClient\Document
      -
    • document to be updated
    • +
    • document to be replaced

    $options

    array
    • optional, array of options

      Options are : -

    • 'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])
    • +
    • 'policy' - replace policy to be used in case of conflict ('error', 'last' or NULL [use default])
    • 'waitForSync' - can be used to force synchronisation of the document update operation to disk even in case that the waitForSync flag had been disabled for the entire collection
    @@ -501,47 +534,15 @@

    Returns

    -

    save a document to a collection

    -
    save(mixed $collection, \ArangoDBClient\Document|array $document, array $options = array()) : mixed
    +

    Insert a document into a collection

    +
    save($collection, $document, array $options = array()
    Inherited
    -

    This will add the document to the collection and return the document's id

    -

    This will throw if the document cannot be saved

    - - - -
    since1.0
    +

    This is an alias for insert().

    Parameters

    -
    -

    $collection

    -mixed
      -
    • collection id as string or number
    • -
    -
    -

    $document

    -\ArangoDBClient\Documentarray
      -
    • the document to be added, can be passed as a document or an array
    • -
    -
    -

    $options

    -array
      -
    • optional, array of options -

      Options are :
      -

    • 'createCollection' - create the collection if it does not yet exist.
    • -
    • 'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
    • -
    • 'overwrite' - if set to true, will turn the insert into a replace operation if a document with the specified key already exists.
    • -
    • 'returnNew' - if set to true, then the newly created document will be returned.
    • -
    • 'returnOld' - if set to true, then the replaced document will be returned - useful only when using overwrite = true.
    • -

      -
    -

    Exceptions

    - - - -
    \ArangoDBClient\Exception
    -

    Returns

    -
    -mixed- id of document created
    +

    $collection

    +

    $document

    +

    $options

    @@ -698,25 +699,22 @@

    Returns

    boolean- always true, will throw if there is an error

    -
    -

    createCollectionIfOptions() -

    -
    createCollectionIfOptions($collection, array $options) 
    +
    +

    Add a transaction header to the array of headers in case this is a transactional operation

    +
    addTransactionHeader(array $headers, mixed $collection) 
    Inherited

    Parameters

    -

    $collection

    mixed collection name or id

    -
    -

    $options

    +

    $headers

    array
      -
    • optional, array of options -

      Options are : -

    • 'createCollection' - true to create the collection if it does not exist
    • -
    • 'createCollectionType' - "document" or 2 for document collection
    • -
    • "edge" or 3 for edge collection
    • -

      +
    • already existing headers
    • +
    +
    +

    $collection

    +mixed
      +
    • any type of collection (can be StreamingTransactionCollection or other)
    @@ -821,6 +819,29 @@

    Returns

    string- json string of the body that was passed
    +
    +

    lazyCreateCollection() +

    +
    lazyCreateCollection(mixed $collection, array $options) 
    +
    Inherited
    +
    +
    +

    Parameters

    +
    +

    $collection

    +mixed

    collection name or id

    +
    +

    $options

    +array
      +
    • optional, array of options +

      Options are : +

    • 'createCollectionType' - "document" or 2 for document collection
    • +
    • "edge" or 3 for edge collection
    • +
    • 'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
    • +

      +
    +
    +

    Turn a value into a collection name

    makeCollection(mixed $value) : string
    @@ -970,7 +991,7 @@

    option for returning the old document

    + generated on 2019-08-19T13:30:49+02:00.
    diff --git a/docs/classes/ArangoDBClient.View.html b/docs/classes/ArangoDBClient.View.html index 3f108271..5de0ba56 100644 --- a/docs/classes/ArangoDBClient.View.html +++ b/docs/classes/ArangoDBClient.View.html @@ -31,11 +31,11 @@ Reports @@ -250,7 +250,7 @@

    View type index

    + generated on 2019-08-19T13:30:48+02:00.
    diff --git a/docs/classes/ArangoDBClient.ViewHandler.html b/docs/classes/ArangoDBClient.ViewHandler.html index b1f035b0..b1ef1fac 100644 --- a/docs/classes/ArangoDBClient.ViewHandler.html +++ b/docs/classes/ArangoDBClient.ViewHandler.html @@ -31,11 +31,11 @@ Reports @@ -74,6 +74,7 @@
  • Deprecated elements
  • +

    +CollectionHandler.php13 +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeLineDescription
    deprecated1009use CollectionHandler::createIndex instead
    deprecated1037use CollectionHandler::createIndex instead
    deprecated1073use CollectionHandler::createIndex instead
    deprecated1528use AQL queries instead
    deprecated1583use AQL queries instead
    deprecated1649use AQL queries instead
    deprecated1880use AQL queries instead
    deprecated1947use AQL queries instead
    deprecated2006use AQL queries instead
    deprecated878use CollectionHandler::createIndex instead
    deprecated911use CollectionHandler::createIndex instead
    deprecated942use CollectionHandler::createIndex instead
    deprecated976use CollectionHandler::createIndex instead

    UserHandler.php2

    @@ -86,7 +162,7 @@
    + generated on 2019-08-19T13:30:49+02:00.
    diff --git a/docs/errors.html b/docs/errors.html index 9f008861..8db9fdeb 100644 --- a/docs/errors.html +++ b/docs/errors.html @@ -31,11 +31,11 @@ Reports @@ -54,18 +54,19 @@ -
  • Document.php
  • +
  • Endpoint.php
  • +
  • CollectionHandler.php
  • +
  • StreamingTransactionHandler.php
  • Connection.php
  • QueryCacheHandler.php
  • -
  • DocumentHandler.php
  • -
  • CollectionHandler.php
  • -
  • HttpResponse.php
  • -
  • Exception.php
  • -
  • Endpoint.php
  • +
  • Document.php
  • QueryHandler.php
  • +
  • DocumentHandler.php
  • Statement.php
  • -
  • EdgeHandler.php
  • +
  • Exception.php
  • +
  • HttpResponse.php
  • GraphHandler.php
  • +
  • EdgeHandler.php
  • +
    +
    +

    +EdgeHandler.php1 +

    +
    + + + + + + + + + + +
    TypeLineDescription
    error270No summary for method lazyCreateCollection()
    +
    +
    + generated on 2019-08-19T13:30:49+02:00.
    diff --git a/docs/graph_class.html b/docs/graph_class.html index 94c50dda..dd580972 100644 --- a/docs/graph_class.html +++ b/docs/graph_class.html @@ -31,11 +31,11 @@ Reports @@ -62,7 +62,7 @@
    + generated on 2019-08-19T13:30:49+02:00.
    diff --git a/docs/index.html b/docs/index.html index 8135cece..a457564e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -31,11 +31,11 @@ Reports @@ -71,18 +71,18 @@

    Documentation

    + generated on 2019-08-19T13:30:48+02:00.
    diff --git a/docs/markers.html b/docs/markers.html index 933a03a2..c70c32cf 100644 --- a/docs/markers.html +++ b/docs/markers.html @@ -31,11 +31,11 @@ Reports @@ -63,7 +63,7 @@
    + generated on 2019-08-19T13:30:49+02:00.
    diff --git a/docs/namespaces/ArangoDBClient.html b/docs/namespaces/ArangoDBClient.html index 0fa1e79d..eed02a70 100644 --- a/docs/namespaces/ArangoDBClient.html +++ b/docs/namespaces/ArangoDBClient.html @@ -31,11 +31,11 @@ Reports @@ -63,55 +63,59 @@
  • DocumentClassable
  • -
  • AqlUserFunction
  • -
  • ViewHandler
  • -
  • BatchPart
  • -
  • View
  • -
  • UserHandler
  • -
  • Document
  • -
  • ConnectionOptions
  • -
  • Connection
  • +
  • Edge
  • Transaction
  • -
  • ExportCursor
  • +
  • StreamingTransaction
  • UrlHelper
  • -
  • QueryCacheHandler
  • -
  • DocumentHandler
  • -
  • Edge
  • -
  • Cursor
  • -
  • Database
  • -
  • FailoverException
  • +
  • Endpoint
  • Batch
  • -
  • TraceRequest
  • +
  • ExportCursor
  • +
  • FailoverException
  • ConnectException
  • -
  • ValueValidator
  • -
  • Autoloader
  • -
  • ClientException
  • -
  • FoxxHandler
  • +
  • Collection
  • +
  • TraceRequest
  • +
  • AqlUserFunction
  • +
  • Traversal
  • +
  • View
  • +
  • DefaultValues
  • User
  • -
  • BindVars
  • CollectionHandler
  • +
  • Database
  • +
  • StreamingTransactionHandler
  • +
  • BatchPart
  • +
  • FoxxHandler
  • +
  • Connection
  • +
  • TraceResponse
  • +
  • Autoloader
  • +
  • ServerException
  • +
  • UserHandler
  • +
  • QueryCacheHandler
  • +
  • HttpHelper
  • +
  • ViewHandler
  • +
  • Cursor
  • +
  • TransactionBase
  • Graph
  • -
  • EdgeDefinition
  • +
  • Document
  • Vertex
  • -
  • Collection
  • -
  • HttpResponse
  • -
  • HttpHelper
  • -
  • UpdatePolicy
  • -
  • Exception
  • -
  • Endpoint
  • QueryHandler
  • -
  • ServerException
  • +
  • DocumentHandler
  • +
  • Statement
  • +
  • Exception
  • Handler
  • -
  • Traversal
  • VertexHandler
  • -
  • Statement
  • +
  • HttpResponse
  • +
  • BindVars
  • +
  • UpdatePolicy
  • Urls
  • -
  • TraceResponse
  • -
  • AdminHandler
  • -
  • EdgeHandler
  • +
  • EdgeDefinition
  • +
  • ClientException
  • Export
  • +
  • ValueValidator
  • GraphHandler
  • -
  • DefaultValues
  • +
  • StreamingTransactionCollection
  • +
  • AdminHandler
  • +
  • EdgeHandler
  • +
  • ConnectionOptions
  • @@ -376,6 +380,27 @@

    Statement
    « More »

    +
    +

    StreamingTransaction +

    +

    Streaming transaction object

    +
    +« More » +
    +
    +

    StreamingTransactionCollection +

    +

    Streaming transaction collection object

    +
    +« More » +
    +
    +

    StreamingTransactionHandler +

    +

    Provides management of streaming transactions

    +
    +« More » +

    TraceRequest

    @@ -397,6 +422,13 @@

    Transaction
    « More »

    +
    +

    TransactionBase +

    +

    Transaction base class, used by Transaction and StreamingTransaction

    +
    +« More » +

    Traversal

    @@ -480,7 +512,7 @@

    ViewHandler
    + generated on 2019-08-19T13:30:48+02:00.

    diff --git a/docs/packages/ArangoDBClient.html b/docs/packages/ArangoDBClient.html index 390d3ed6..fc8b399c 100644 --- a/docs/packages/ArangoDBClient.html +++ b/docs/packages/ArangoDBClient.html @@ -31,11 +31,11 @@ Reports @@ -63,55 +63,59 @@
  • DocumentClassable
  • -
  • AqlUserFunction
  • -
  • ViewHandler
  • -
  • BatchPart
  • -
  • View
  • -
  • UserHandler
  • -
  • Document
  • -
  • ConnectionOptions
  • -
  • Connection
  • +
  • Edge
  • Transaction
  • -
  • ExportCursor
  • +
  • StreamingTransaction
  • UrlHelper
  • -
  • QueryCacheHandler
  • -
  • DocumentHandler
  • -
  • Edge
  • -
  • Cursor
  • -
  • Database
  • -
  • FailoverException
  • +
  • Endpoint
  • Batch
  • -
  • TraceRequest
  • +
  • ExportCursor
  • +
  • FailoverException
  • ConnectException
  • -
  • ValueValidator
  • -
  • Autoloader
  • -
  • ClientException
  • -
  • FoxxHandler
  • +
  • Collection
  • +
  • TraceRequest
  • +
  • AqlUserFunction
  • +
  • Traversal
  • +
  • View
  • +
  • DefaultValues
  • User
  • -
  • BindVars
  • CollectionHandler
  • +
  • Database
  • +
  • StreamingTransactionHandler
  • +
  • BatchPart
  • +
  • FoxxHandler
  • +
  • Connection
  • +
  • TraceResponse
  • +
  • Autoloader
  • +
  • ServerException
  • +
  • UserHandler
  • +
  • QueryCacheHandler
  • +
  • HttpHelper
  • +
  • ViewHandler
  • +
  • Cursor
  • +
  • TransactionBase
  • Graph
  • -
  • EdgeDefinition
  • +
  • Document
  • Vertex
  • -
  • Collection
  • -
  • HttpResponse
  • -
  • HttpHelper
  • -
  • UpdatePolicy
  • -
  • Exception
  • -
  • Endpoint
  • QueryHandler
  • -
  • ServerException
  • +
  • DocumentHandler
  • +
  • Statement
  • +
  • Exception
  • Handler
  • -
  • Traversal
  • VertexHandler
  • -
  • Statement
  • +
  • HttpResponse
  • +
  • BindVars
  • +
  • UpdatePolicy
  • Urls
  • -
  • TraceResponse
  • -
  • AdminHandler
  • -
  • EdgeHandler
  • +
  • EdgeDefinition
  • +
  • ClientException
  • Export
  • +
  • ValueValidator
  • GraphHandler
  • -
  • DefaultValues
  • +
  • StreamingTransactionCollection
  • +
  • AdminHandler
  • +
  • EdgeHandler
  • +
  • ConnectionOptions
  • @@ -373,6 +377,27 @@

    Statement
    « More »

    +
    +

    StreamingTransaction +

    +

    Streaming transaction object

    +
    +« More » +
    +
    +

    StreamingTransactionCollection +

    +

    Streaming transaction collection object

    +
    +« More » +
    +
    +

    StreamingTransactionHandler +

    +

    Provides management of streaming transactions

    +
    +« More » +

    TraceRequest

    @@ -394,6 +419,13 @@

    Transaction
    « More »

    +
    +

    TransactionBase +

    +

    Transaction base class, used by Transaction and StreamingTransaction

    +
    +« More » +

    Traversal

    @@ -477,7 +509,7 @@

    ViewHandler
    + generated on 2019-08-19T13:30:48+02:00.

    diff --git a/docs/packages/Default.html b/docs/packages/Default.html index 5565db20..966013a2 100644 --- a/docs/packages/Default.html +++ b/docs/packages/Default.html @@ -31,11 +31,11 @@ Reports @@ -65,7 +65,7 @@
    + generated on 2019-08-19T13:30:48+02:00.
    diff --git a/docs/packages/global.html b/docs/packages/global.html index 380e3b86..7bbe32ff 100644 --- a/docs/packages/global.html +++ b/docs/packages/global.html @@ -31,11 +31,11 @@ Reports @@ -65,7 +65,7 @@
    + generated on 2019-08-19T13:30:48+02:00.
    diff --git a/docs/structure.xml b/docs/structure.xml index 14c783e9..c80a6b91 100644 --- a/docs/structure.xml +++ b/docs/structure.xml @@ -1,344 +1,538 @@ - + - ArangoDB PHP client: AqlUserFunction + ArangoDB PHP client: single document - - - + + + - - - AqlUserFunction - \ArangoDBClient\AqlUserFunction - - Provides management of user-functions - AqlUserFunction object<br> -An AqlUserFunction is an object that is used to manage AQL User Functions.<br> -It registers, un-registers and lists user functions on the server<br> -<br> -The object encapsulates:<br> -<br> -<ul> -<li> the name of the function -<li> the actual javascript function -</ul> -<br> -The object requires the connection object and can be initialized -with or without initial configuration.<br> -<br> -Any configuration can be set and retrieved by the object's methods like this:<br> -<br> -<pre> -$this->setName('myFunctions:myFunction');<br> -$this->setCode('function (){your code};'); -</pre> - -<br> -or like this:<br> -<br> -<pre> -$this->name('myFunctions:myFunction');<br> -$this->code('function (){your code};'); -</pre> - - + + \ArangoDBClient\Document + Edge + \ArangoDBClient\Edge + + Value object representing a single collection-based edge document + <br> + + + - - ENTRY_NAME - \ArangoDBClient\AqlUserFunction::ENTRY_NAME - 'name' - - Collections index + + ENTRY_FROM + \ArangoDBClient\Edge::ENTRY_FROM + '_from' + + Document _from index - - ENTRY_CODE - \ArangoDBClient\AqlUserFunction::ENTRY_CODE - 'code' - - Action index + + ENTRY_TO + \ArangoDBClient\Edge::ENTRY_TO + '_to' + + Revision _to index - - $_connection - \ArangoDBClient\AqlUserFunction::_connection + + ENTRY_ID + \ArangoDBClient\Document::ENTRY_ID + '_id' + + Document id index + + + + + ENTRY_KEY + \ArangoDBClient\Document::ENTRY_KEY + '_key' + + Document key index + + + + + ENTRY_REV + \ArangoDBClient\Document::ENTRY_REV + '_rev' + + Revision id index + + + + + ENTRY_ISNEW + \ArangoDBClient\Document::ENTRY_ISNEW + '_isNew' + + isNew id index + + + + + ENTRY_HIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES + '_hiddenAttributes' + + hidden attribute index + + + + + ENTRY_IGNOREHIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES + '_ignoreHiddenAttributes' + + hidden attribute index + + + + + OPTION_WAIT_FOR_SYNC + \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC + 'waitForSync' + + waitForSync option index + + + + + OPTION_POLICY + \ArangoDBClient\Document::OPTION_POLICY + 'policy' + + policy option index + + + + + OPTION_KEEPNULL + \ArangoDBClient\Document::OPTION_KEEPNULL + 'keepNull' + + keepNull option index + + + + + KEY_REGEX_PART + \ArangoDBClient\Document::KEY_REGEX_PART + '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' + + regular expression used for key validation + + + + + $_from + \ArangoDBClient\Edge::_from - - The connection object + + The edge's from (might be NULL for new documents) - - \ArangoDBClient\Connection + + mixed - - $attributes - \ArangoDBClient\AqlUserFunction::attributes - array() - - The transaction's attributes. + + $_to + \ArangoDBClient\Edge::_to + + + The edge's to (might be NULL for new documents) - - array + + mixed - - $_action - \ArangoDBClient\AqlUserFunction::_action - '' - - The transaction's action. + + $_id + \ArangoDBClient\Document::_id + + + The document id (might be NULL for new documents) - + string - - __construct - \ArangoDBClient\AqlUserFunction::__construct() - - Initialise the AqlUserFunction object - The $attributesArray array can be used to specify the name and code for the user function in form of an array. - -Example: -array( - 'name' => 'myFunctions:myFunction', - 'code' => 'function (){}' -) - - \ArangoDBClient\Connection + + $_key + \ArangoDBClient\Document::_key + + + The document key (might be NULL for new documents) + + + string + + + + + $_rev + \ArangoDBClient\Document::_rev + + + The document revision (might be NULL for new documents) + + + mixed - + + + + $_values + \ArangoDBClient\Document::_values + array() + + The document attributes (names/values) + + array - - \ArangoDBClient\ClientException + + + + $_changed + \ArangoDBClient\Document::_changed + false + + Flag to indicate whether document was changed locally + + + boolean - - $connection - - \ArangoDBClient\Connection - - - $attributesArray - null - array - - - - register - \ArangoDBClient\AqlUserFunction::register() - - Registers the user function - If no parameters ($name,$code) are passed, it will use the properties of the object. - -If $name and/or $code are passed, it will override the object's properties with the passed ones - - null + + + $_isNew + \ArangoDBClient\Document::_isNew + true + + Flag to indicate whether document is a new document (never been saved to the server) + + + boolean - - null + + + + $_doValidate + \ArangoDBClient\Document::_doValidate + false + + Flag to indicate whether validation of document values should be performed +This can be turned on, but has a performance penalty + + + boolean - - \ArangoDBClient\Exception + + + + $_hiddenAttributes + \ArangoDBClient\Document::_hiddenAttributes + array() + + An array, that defines which attributes should be treated as hidden. + + + array - - mixed + + + + $_ignoreHiddenAttributes + \ArangoDBClient\Document::_ignoreHiddenAttributes + false + + Flag to indicate whether hidden attributes should be ignored or included in returned data-sets + + + boolean - - $name - null - null - - - $code - null - null - - - - unregister - \ArangoDBClient\AqlUserFunction::unregister() - - Un-register the user function - If no parameter ($name) is passed, it will use the property of the object. + + + set + \ArangoDBClient\Edge::set() + + Set a document attribute + The key (attribute name) must be a string. -If $name is passed, it will override the object's property with the passed one - - string - - - boolean +This will validate the value of the attribute and might throw an +exception if the value is invalid. + + \ArangoDBClient\ClientException - - \ArangoDBClient\Exception + + string - + mixed + + void + + - $name - null + $key + string - $namespace - false - boolean + $value + + mixed - - getRegisteredUserFunctions - \ArangoDBClient\AqlUserFunction::getRegisteredUserFunctions() - - Get registered user functions - The method can optionally be passed a $namespace parameter to narrow the results down to a specific namespace. - - null - - - \ArangoDBClient\Exception - - + + setFrom + \ArangoDBClient\Edge::setFrom() + + Set the 'from' vertex document-handler + + mixed + + \ArangoDBClient\Edge + - $namespace - null - null + $from + + mixed - - getConnection - \ArangoDBClient\AqlUserFunction::getConnection() - - Return the connection object + + getFrom + \ArangoDBClient\Edge::getFrom() + + Get the 'from' vertex document-handler (if already known) - - \ArangoDBClient\Connection + + mixed - - setName - \ArangoDBClient\AqlUserFunction::setName() - - Set name of the user function. It must have at least one namespace, but also can have sub-namespaces. - correct: -'myNamespace:myFunction' -'myRootNamespace:mySubNamespace:myFunction' - -wrong: -'myFunction' - - string + + setTo + \ArangoDBClient\Edge::setTo() + + Set the 'to' vertex document-handler + + + mixed - - \ArangoDBClient\ClientException + + \ArangoDBClient\Edge - $value + $to - string + mixed - - getName - \ArangoDBClient\AqlUserFunction::getName() - - Get name value + + getTo + \ArangoDBClient\Edge::getTo() + + Get the 'to' vertex document-handler (if already known) - - string + + mixed - - setCode - \ArangoDBClient\AqlUserFunction::setCode() - - Set user function code + + getAllForInsertUpdate + \ArangoDBClient\Edge::getAllForInsertUpdate() + + Get all document attributes for insertion/update - - string - - - \ArangoDBClient\ClientException + + mixed + - - $value - - string - - - getCode - \ArangoDBClient\AqlUserFunction::getCode() - - Get user function code + + __construct + \ArangoDBClient\Document::__construct() + + Constructs an empty document - - string + + array + + $options + null + array + + \ArangoDBClient\Document - - set - \ArangoDBClient\AqlUserFunction::set() - - Set an attribute + + createFromArray + \ArangoDBClient\Document::createFromArray() + + Factory method to construct a new document using the values passed to populate it - - - - \ArangoDBClient\AqlUserFunction - - + \ArangoDBClient\ClientException - + + array + + + array + + + \ArangoDBClient\Document + \ArangoDBClient\Edge + \ArangoDBClient\Graph + - $key + $values - + array - $value - - + $options + array() + array + \ArangoDBClient\Document - - __set - \ArangoDBClient\AqlUserFunction::__set() - - Set an attribute, magic method - This is a magic method that allows the object to be used without -declaring all attributes first. - + + __clone + \ArangoDBClient\Document::__clone() + + Clone a document + Returns the clone + + + void + + + \ArangoDBClient\Document + + + __toString + \ArangoDBClient\Document::__toString() + + Get a string representation of the document. + It will not output hidden attributes. + +Returns the document as JSON-encoded string + + + string + + + \ArangoDBClient\Document + + + toJson + \ArangoDBClient\Document::toJson() + + Returns the document as JSON-encoded string + + + array + + + string + + + + $options + array() + array + + \ArangoDBClient\Document + + + toSerialized + \ArangoDBClient\Document::toSerialized() + + Returns the document as a serialized string + + + array + + + string + + + + $options + array() + array + + \ArangoDBClient\Document + + + filterHiddenAttributes + \ArangoDBClient\Document::filterHiddenAttributes() + + Returns the attributes with the hidden ones removed + + + array + + + array + + + array + + + + $attributes + + array + + + $_hiddenAttributes + array() + array + + \ArangoDBClient\Document + + + set + \ArangoDBClient\Document::set() + + Set a document attribute + The key (attribute name) must be a string. +This will validate the value of the attribute and might throw an +exception if the value is invalid. + \ArangoDBClient\ClientException - - + string - + mixed + + void + $key @@ -350,37 +544,53 @@ declaring all attributes first. mixed + \ArangoDBClient\Document - - get - \ArangoDBClient\AqlUserFunction::get() - - Get an attribute - - + + __set + \ArangoDBClient\Document::__set() + + Set a document attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. +This function is mapped to set() internally. + + \ArangoDBClient\ClientException + + + string - + mixed + + void + $key string + + $value + + mixed + + \ArangoDBClient\Document - - __isset - \ArangoDBClient\AqlUserFunction::__isset() - - Is triggered by calling isset() or empty() on inaccessible properties. + + get + \ArangoDBClient\Document::get() + + Get a document attribute - + string - - boolean + + mixed @@ -388,18 +598,19 @@ declaring all attributes first. string + \ArangoDBClient\Document - + __get - \ArangoDBClient\AqlUserFunction::__get() - - Get an attribute, magic method + \ArangoDBClient\Document::__get() + + Get a document attribute, magic method This function is mapped to get() internally. - - + + string - + mixed @@ -408,4544 +619,4978 @@ declaring all attributes first. string + \ArangoDBClient\Document - - __toString - \ArangoDBClient\AqlUserFunction::__toString() - - Returns the action string + + __isset + \ArangoDBClient\Document::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - - + string + + boolean + + + $key + + string + + \ArangoDBClient\Document - - buildAttributesFromArray - \ArangoDBClient\AqlUserFunction::buildAttributesFromArray() - - Build the object's attributes from a given array - - - - \ArangoDBClient\ClientException - + + __unset + \ArangoDBClient\Document::__unset() + + Magic method to unset an attribute. + Caution!!! This works only on the first array level. +The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. + + - $options + $key + \ArangoDBClient\Document - - $name - - - - The name of the user function - - - string + + getAll + \ArangoDBClient\Document::getAll() + + Get all document attributes + + + mixed - - - string + + array - - - $code - - - - The code of the user function - - - string + + $options + array() + mixed + + \ArangoDBClient\Document + + + getAllForInsertUpdate + \ArangoDBClient\Document::getAllForInsertUpdate() + + Get all document attributes for insertion/update + + + mixed - - - string + + \ArangoDBClient\Document + + + getAllAsObject + \ArangoDBClient\Document::getAllAsObject() + + Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class + + + mixed + + + mixed - - - - - - _action - - - string + + $options + array() + mixed + + \ArangoDBClient\Document + + + setHiddenAttributes + \ArangoDBClient\Document::setHiddenAttributes() + + Set the hidden attributes +$cursor + + + array - - - string + + void - - - eJzFWltz27YSfvevQGc0Iykj2b28ybEb1XUSd1I3x44fOo5HA1GQhJgiWYCUo3by38/uAuAVpOQ2p8cPESUudpe737fYBfPyx2SdHB2dvHhxxF6wqeLRKv75J/b+7XsWhFJE6YRN/wjvtFCvsyhIZRyBHIq+4lm6jhWDv9ew6pH9yndC0Z0gTnZKrtYpu8ivvv/2ux9GLFWSr0Sk2ZvN/O0IbofxKhIj9kaoDY92sPrk6CjiG6ETHojcnQvy5DR3872Kt3IhNINFoG8DN1m8ZBl4OV5aN7X1s+Y9i+efRJC+nKtzuhs1BKRm3ImxdM1T/AVUL1gaW4Ns+p93DBcxt0ofO41XKVNiJXUqlB6xLBrn30DtgoVwTeoUyz1lYDVdCwY/boVyitznB7hjvRFRwBOdhTwVelKXe5mF5jOU56QO44hhwetlkbxCgAdpxkP2iW+5DpRM0qrYiVPYdESJPzKpIAGoJoijSJSDSw8aQBDngslIppKH8k+xQB1PMl0zQA1+xlnqbqOOpVxliqOa4/qjTaNdVcJp18IYUwKQJbaQo/mOfDKO9AEhAgwtNMT9UcAd6YlbogRd9PD2+Bx0XkPkBv3NLs/upLjuD0/dymLBRbyABS56bDD8axdnCnxeiC+nsMLE0xoqG4dQHO5Z9Cy3guf69CpRcSJUumMaohmtWI8QNKbEl8FUQa9/JVqxK+ny4JUzXikyUAYekXCsVgvoppZRgLcY++74B6odQci1bhSsv45QhmoH/r2wbtVQa286mVdbrqBAOSH78wl9JkpugYOsNyu0QHXyWEnBa20eCcDIU3jIeQbsPfZZ40rxXc1QnIJ6wHWvWMvO2P3DQebowmvKRLvNlk0CGOr3m4agaofCVi4ZLcTnihqIiE7Z5fWHm99n19NfL1EJgsejaGoLbqeOi99+Jh0II9RRV3JlC4wWhDB/ua+FAENVCugU426i7wqLq/c6EYFc7op6SqUNEb0E6jYgDc+CNzaId1BEKuvxv/zMN0koJu47CQ3cN2ajxc7OWRvVRyVhCgsJl5n+pe9EhlXrOQgSrvimhG+kbH5Nf+N6cYdw2MjUtJjI0V8jquNGgOx+YOr4gqe87lq6VvGTZh+rjP9oPi4/ByJpEjKbhzIorMxmBCGVBenA/4wj63XD4TMWZWFowmYKBz2XqaklvoNgr8x+JymXbCD1zGS1rn04LOks6Z1nMlxMc9nXKt5M/QoKQ1+OzL8NRtzkDYen5FZCfbVkUcwoiYIWDKjkj6h8DyFCAm5qSPiIyRT27DBEdaTW1m0J5cjWdsO0OtrBRM8R5wQoY3YGn+YYeh8FXV11/y7Zod6BbNNK6JqE9sMaM2jMem+gCy2gy+HF7A8i/wESa1o524IsuQxzKuR6oBPJVMQ28jMWEJWJxronrpnOgkBovczC404cu97R5MVic2SD2ILUykZh8VX85iqogyopbqCykL835egBdeFVGX9VRQYzHYqoVD0Y3iz8inrQUybAXFG4XqLc+DyJdTqoWLhToZ5M7m7ezaAnn93dXt7MXt9dX3y4+u165GPaCps1p3AwHJ9/0nE0g8YaXJo9KZ4kGO3C7WGuZHha+GmznLtLen/RqPG0jZZ3xSjwXGLmaYJJZA8hdwfS0aOpk4A7H/387LOdnJeA8zgOBeyMvXzIO4yIVR6iFziCCOgSkIaNMuBlYUG6fPzgLpNbHoKQ3dIrv8FCeFLDWoEDixud9u1BWdTG3mLAPQP3Qy3qHEY+Uak6O7O0axDLaixQTTPL0M+qTIEqpMpbEUIyJxPab+D7oIs+7J6sPJSBn5cM8r/hVcMQ8ilavMfca7SHEqC4v1JxllDfgtl5aPF7TzVYiBDYQTr/KTnfiGJsB8hU53NP92jGSuoWY4IlD8MdtkeWHLyc5YLH0EJF0BkAng3OYJZPNVvET9RdcdtuAoryxY3uvb7DfTUSHbiX/cssgtTd5Hkpd/Z6UOGRdyv8u7gv4zHn4jeOi/8Q+rkKgn+h8aHR2x3CAYhPgwA97KpRvpUB7sEkgBXWo/x938Cx/9BoUh2hqmI+b09O2Bwm9ieuFhpGh00CLc9chjLdNdiJylrpeGOEvKdLLSgttfmNyaWysD7tlqFWbg1qYHJ+N3LQ+hC3APTWY5NjPCjcZMC9Nd8CE1IG+yJ8Q5bkkBixOdIr1DFVGpLU2XycC+TnCPC0SoE/+VQJs+O1kyrPjqX7N3GclmVus3nXErfyScXRqmynRdDfFfSoHvwPRj53bGcMtMxviHYtwuVkUhxQjNjA+Da0znXvEpRR70NYhNgHLTU/rZXN7NmdQFt5PC4c9CCuOm77Rp1/LR90KvqsfOBhzzPzsf95n58Xcvx5eUHP2x29pXPq4vzPn5Leo9jVf+pCGrlSz9kzczRAoyPmzxJuEd9IPTOhI9HG5mA6i0g81S0P+lcRaJWL4rEZKOi39Hr1QfUerdG0SK55+jtccXDER2zDV/DspnFrdHQwDuF7n4qQefkDjR2GtZiJSudgrgNyehYiCDmhDFaVTnvZUirdmMW6M5ZLkUvdHIZIMTywKwLtGb1MG2fDCcLmE48x67BsO1PbBxcN4QjWzOCkBpOAa3xdUy1kbFKRKeGgVs1PG3JzJfjjabcJOjruMlEuUAeZWIglh+anS2c1Qnu15qd4+FErbfsrRhkA47zZaF1UaegdAsoLRuz67t075H0BJeBFFKdYK/aVTZN4Tw2xbaaf4q3tpl/cWz3sEuzT2/bGK41vn1crmu/meNAfhhg749sQpxaxSdIdXuIxNacxR87D8llnyzT299LgzkLMV20mLHCDjgRgEwQEwDcb+2Fn8GczG+KvmQD0pyva5GdbuOv43V9/i1cE+F4fhid6AbOi5MgI5j+asRsZOLA8/p/ZMZu18aPZVpDUntFIl+bn6su87sBUeyE7KGUwOkSpV1vb06TxrekJ9oxJvDoi1Z7lJxzHq8eN5U1TxRvYkldyK6LKu9F6j2ROYBqHgF+hiW1/L2NtdpDNStzXN70m3+p7XvvK1tP3Dpu4C3bZNJtg+8rmXgW26UX7DLo7rge1V66TCd0csf5H9999XArmH2uy2Az+FxAFr+Y= - - - - ArangoDB PHP client: view handler - - - - - - - - \ArangoDBClient\Handler - ViewHandler - \ArangoDBClient\ViewHandler - - A handler that manages views. - - - - - - - OPTION_RENAME - \ArangoDBClient\ViewHandler::OPTION_RENAME - 'rename' - - rename option - - - - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object + + $attributes + + array + + \ArangoDBClient\Document + + + getHiddenAttributes + \ArangoDBClient\Document::getHiddenAttributes() + + Get the hidden attributes - - \ArangoDBClient\Connection + + array - - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - + \ArangoDBClient\Document + + + isIgnoreHiddenAttributes + \ArangoDBClient\Document::isIgnoreHiddenAttributes() + - - string + + boolean - - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - + \ArangoDBClient\Document + + + setIgnoreHiddenAttributes + \ArangoDBClient\Document::setIgnoreHiddenAttributes() + - - string - - - - - create - \ArangoDBClient\ViewHandler::create() - - Create a view - This will create a view using the given view object and return an array of the created view object's attributes.<br><br> - - \ArangoDBClient\Exception - - - \ArangoDBClient\View - - - array + + boolean - - $view + $ignoreHiddenAttributes - \ArangoDBClient\View + boolean + \ArangoDBClient\Document - - get - \ArangoDBClient\ViewHandler::get() - - Get a view - This will get a view.<br><br> - - String - - - \ArangoDBClient\View - false + + setChanged + \ArangoDBClient\Document::setChanged() + + Set the changed flag + + + boolean - - \ArangoDBClient\ClientException + + boolean - - $view + $value - String + boolean + \ArangoDBClient\Document - - properties - \ArangoDBClient\ViewHandler::properties() - - Get a view's properties<br><br> + + getChanged + \ArangoDBClient\Document::getChanged() + + Get the changed flag - - \ArangoDBClient\Exception - - - mixed - - - array + + boolean - - - $view - - mixed - + \ArangoDBClient\Document - - setProperties - \ArangoDBClient\ViewHandler::setProperties() - - Set a view's properties<br><br> + + setIsNew + \ArangoDBClient\Document::setIsNew() + + Set the isNew flag - - \ArangoDBClient\Exception - - - mixed - - - array + + boolean - - array + + void - - $view - - mixed - - - $properties + $isNew - array + boolean + \ArangoDBClient\Document - - drop - \ArangoDBClient\ViewHandler::drop() - - Drop a view<br><br> + + getIsNew + \ArangoDBClient\Document::getIsNew() + + Get the isNew flag - - \ArangoDBClient\Exception + + boolean - - mixed + + \ArangoDBClient\Document + + + setInternalId + \ArangoDBClient\Document::setInternalId() + + Set the internal document id + This will throw if the id of an existing document gets updated to some other id + + \ArangoDBClient\ClientException - - boolean + + string + + + void - - $view + $id - mixed + string + \ArangoDBClient\Document - - rename - \ArangoDBClient\ViewHandler::rename() - - Rename a view - - - \ArangoDBClient\Exception - - - mixed + + setInternalKey + \ArangoDBClient\Document::setInternalKey() + + Set the internal document key + This will throw if the key of an existing document gets updated to some other key + + \ArangoDBClient\ClientException - + string - - boolean + + void - $view - - mixed - - - $name + $key string + \ArangoDBClient\Document - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler - - - \ArangoDBClient\Connection + + getInternalId + \ArangoDBClient\Document::getInternalId() + + Get the internal document id (if already known) + Document ids are generated on the server only. Document ids consist of collection id and +document id, in the format collectionId/documentId + + string - - $connection - - \ArangoDBClient\Connection - - \ArangoDBClient\Handler + \ArangoDBClient\Document - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object + + getInternalKey + \ArangoDBClient\Document::getInternalKey() + + Get the internal document key (if already known) - - \ArangoDBClient\Connection + + string - \ArangoDBClient\Handler + \ArangoDBClient\Document - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection - - - - mixed - - - \ArangoDBClient\ClientException + + getHandle + \ArangoDBClient\Document::getHandle() + + Convenience function to get the document handle (if already known) - is an alias to getInternalId() + Document handles are generated on the server only. Document handles consist of collection id and +document id, in the format collectionId/documentId + + string - - $optionName - - - - \ArangoDBClient\Handler + \ArangoDBClient\Document - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - - array - - - string - - - \ArangoDBClient\ClientException + + getId + \ArangoDBClient\Document::getId() + + Get the document id (or document handle) if already known. + It is a string and consists of the collection's name and the document key (_key attribute) separated by /. +Example: (collectionname/documentId) + +The document handle is stored in a document's _id attribute. + + mixed - - $body - - array - - \ArangoDBClient\Handler + \ArangoDBClient\Document - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array - - - array - - - array - - - array + + getKey + \ArangoDBClient\Document::getKey() + + Get the document key (if already known). + Alias function for getInternalKey() + + mixed - - $options - - array - - - $body - - array - - - $includeArray - array() - array - - \ArangoDBClient\Handler + \ArangoDBClient\Document - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name - - - \ArangoDBClient\ClientException + + getCollectionId + \ArangoDBClient\Document::getCollectionId() + + Get the collection id (if already known) + Collection ids are generated on the server only. Collection ids are numeric but might be +bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used + + mixed - + + \ArangoDBClient\Document + + + setRevision + \ArangoDBClient\Document::setRevision() + + Set the document revision + Revision ids are generated on the server only. + +Document ids are strings, even if they look "numeric" +To reliably store a document id elsewhere, a PHP string must be used + mixed - - string + + void - $value + $rev mixed - \ArangoDBClient\Handler + \ArangoDBClient\Document - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use + + getRevision + \ArangoDBClient\Document::getRevision() + + Get the document revision (if already known) - - string - - - \ArangoDBClient\DocumentClassable + + mixed - - $class - - string - - \ArangoDBClient\DocumentClassable + \ArangoDBClient\Document - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use + + jsonSerialize + \ArangoDBClient\Document::jsonSerialize() + + Get all document attributes +Alias function for getAll() - it's necessary for implementing JsonSerializable interface - - string + + mixed - - \ArangoDBClient\DocumentClassable + + array - $class - - string + $options + array() + mixed - \ArangoDBClient\DocumentClassable + \ArangoDBClient\Document - eJzVl1tvGjkUgN/5FecBiSGCZC992UmTbTZBSardFBGaqkoQMoNhpmvske0pQdv89x7bcwcWstutspYSwD5X+/OZOa9/jcO40Tg6OGjAAZxJwufi4jfoX/UhYBHl2ofPEV1CSPiUUYlCRu5NTII/yZwC5CrnVtoukkSHQuIavCUcbjWlC8K5XQpEvJLRPNRwnn/76Ycff+kUri8Xk6sOLjMx57QDl1Si9ipzrCIeGLcAPx++wpmjRoOTBVUYEK3FclyklYUPOiQa0B7Grmxi6rCe0oaEMqeZy4ARpeAO1a9Su/RRUz5VkP5u/NUwIVr3ZhyApCZMELGOBE8nj+xnILjS8K4/vH53Mx70bs7+6MEJtJxCC5OoWTqXlGgKxIafTmZrwzBSsIwYg6AsBQlmMMfkKcyjz5S7STH5RAMNGDFGpxPJ8SsQKckKxMwKOyPTsnhLAdFaRpNEU3X4eiJPzV8tjDc6lGKpoPcY0HLC+XpMJFnYDYSmNd7F0GklrGUYBSGEguGumlgiPhNIgrGWhWfFtYBJHmndT5aXSSqfrJxm6SDiZMKiAGYJD6wXZ9MromxbMXe0ZjRtGgq/ncB9PmuG0fH93s1w8HFsD9SNk1NnqHs6p/oGj9drd7bqDT/2N+oNV3FFb3RcBJRIlmrAe8mU778f/D6+u+59KMlIvCyIHEWZpkZerNFzwTm1aXvt7mkslPaMsU4m8kkJPqY8EFM6XkoSx1R6afrtdsm4kUsDyB1ZB2+VMV2SdPkoqq+nnlW7Lyd/fTFqp+ibkZ5jsQlnjGXWntZuyCXVu67HPBfZyrBj9BZZx6vjKMXhQHV3uaBwC3cmoy8zwhSt34yHapV5cB/1+7I/q5iPt5lRg4Sl4YoyPDXfnyQRm+Jvr0pIB+6tgcq+7wOLdY1eyoc7JZpsRaBiPWEaBTlurtksz2re16/PqAPrC+Z+jNrHdWs5U2sKW5hyartZwsoXS4FbqCOq/l3hW0SPWFWzymc/LFEEiysoRxw+QCN8MBBz/kja3XbKXMnuwsD+VJUqXqrV8MGAbwOEyKIrsapacSqlkDXmdhFX7MVm8NCFW8jTSLNol4TsuVmhk7XKWJzsU+Of49yBVhFpawMv+5G9hZq10vZk/9chuv2vIXLj+ShlthwvzSI0tOXmlpEOndli8UVxiLe9X0Oxs57P/5LOnY/pZK+ndLEJz3pSryFvNPIyWUf8Ar2kjL+k2jgRghmW2ZKs8D1SJthRLL8pf1NMPK2A8DIhq2C1BaUpZRTfdbdUO7Nvf1ffBq652fjO9V2OPbOSCjatqhtd+3JhJ7CBwG6LMZf2NydmMx+uj8sKk43sOxWjtDvB3mStHTENhYlktJsMU2QqQTynuinKZr5f6W1HtZZnjwYjl9+BJiZvO/MxYRFRXqk/9327gOX2AQnBLp+r7A188lCSa6GHr/G26dU= + eJy1V2FvGjkQ/c6vmEhIkAhK2o+k9NJrSJq211QpjVQlUWR2B/DF2CvbS0DX/Pcbe70bsrCBq45VpMB6/Oa9mfF4ePtHMklqtc7BQQ0O4L1mcqxO/oRvH79BJDhK2wXD5VggxCpKp/SC7JzpccKiezZGgGLXB7/BL7LUTpSmNfjEJHy3iFMmpV+KVLLQfDyx8KH49Obw9ZsWWM0JUBo4mw4/tmhZqLHEFpyhpt0L2t2p1SSboiHfWHJ7VIi4YiJFUMO/MbKgMdFoaJ1EAMu1REoIWuVKtofMYAwYj1cUvh3qd1uJJdDILQG8fnXoWUaCGQN9B4pzizI2cJKD/1Nzlp6rew5gMEHvv2FgpNUUmlMfkyHC1x9fvsCI4ijxoWBn9sPGfP/xjGmY8jnG4U3H/0+0sqSRxNXvHC4FqNqxVbtwa9Wq0zwO4EkBlzHOCwD/IVLSWOh/HVz+vDu9vPgLetDwxo1VtEuccUNpBPJVwipDDS48kFUOpozzHS1VR64VmKVaHKYWS5pdxO5xAc3CAFw97sM0NT50VGG0IMevVjZyAw9cCJgxwWNGGy1hzbJSHfkvT5hMxpBlw060eqDvOQ7OI0xc3QIfLSEQOJceuez42CMYyMq1n28vWyVMs2ngDnUnEaANz1WWjH3qAeoZg3Zg4sqmKnrHGm2qJcwUL9VMOhQ8glEq/ZkEg7bpSLQCelZ62cFxD2lv1i2FtP3uLlZXIaL7SxY+vZ11wU7oZOYlGx7fMAKK0t1uvqsZvB8V1o+15xyI4/XhLfR6rrIaZQK5iV83KEbdblaK5ydlU/cERST+XFrUkonz+InCinkWzKNn7x9r2xH43P+5HYPPuNgRhcv+1csU8qO9I/+us7xM4JRazo6cDy5edj1Q/9nxGgrO/V5+TqIJ3VsYr6vRPW78iQuW3rG5dsRv9+HXL1i3AHskKXBcI4XOHkFCcAojwcZVcnNm1J2tTnELXQTuOqShw7p0smtl3Gd0c7IZ/OP6G8BhNfxNAzPUFufFjdAmjrFAvb5vZq2w7i+0dnaJZ/srGqAfDNrZ0JHNKZvaYVaLDrncC3O13msvI7FUNMGjtyq0l6SfbSUdmlQrTGhk8QLupXqQKxNBcJaFo10VvPUix0FkWd+ygCCzSkeRQrrjfyuBNEO03Sj0PyfPnWarqhJH/nrO9e8m7QWxu08ZSduQMCesWgGjiWh16jJ+jODSkCxy1EkTdx1voE73uoo4s3xGA5TWbOHmqgr8TtYbNql7L8Sp0ueexw/PYUVtnd4yKJ4ezRfa/WrqVmx/am/LQ4w/vK6jylSIcj/1Lq7DCOw72cpZyAK8DpmqaxMuFdCtp15O2VLalhPrthU5pT//Y+eOZiZmmu5wdLv+TQsaN/kvupvwq2l44wwaFIV/AaDf7i0= - + - ArangoDB PHP client: batchpart + ArangoDB PHP client: transaction - + - - - BatchPart - \ArangoDBClient\BatchPart - - Provides batch part functionality - - - + + \ArangoDBClient\TransactionBase + Transaction + \ArangoDBClient\Transaction + + Transaction object + A transaction is an object that is used to prepare and send a transaction +to the server. + +The object encapsulates:<br /> +<ul> +<li> the collections definitions for locking +<li> the actual javascript function +<li> additional options like waitForSync, lockTimeout and params +</ul> + +The transaction object requires the connection object and can be initialized +with or without initial transaction configuration. +Any configuration can be set and retrieved by the object's methods like this:<br /> + +<pre> +$this->setAction('function (){your code};'); +$this->setCollections(array('read' => 'my_read_collection, 'write' => array('col_1', 'col2'))); +</pre> +<br /> +or like this: +<pre> +$this->action('function (){your code};'); +$this->collections(array('read' => 'my_read_collection, 'write' => array('col_1', 'col2'))); +</pre> +<br /> +There are also helper functions to set collections directly, based on their locking: +<pre> +$this->setReadCollections($array or $string if single collection) +$this->setWriteCollections($array or $string if single collection) +$this->setExclusiveCollections($array or $string if single collection) +</pre> +<br /> + + + - - $_cursorOptions - \ArangoDBClient\BatchPart::_cursorOptions - array() - - An array of BatchPartCursor options + + ENTRY_ACTION + \ArangoDBClient\Transaction::ENTRY_ACTION + 'action' + + Action index - - array - - - - $_id - \ArangoDBClient\BatchPart::_id - - - An array of BatchPartCursor options - - - array - + + + ENTRY_PARAMS + \ArangoDBClient\Transaction::ENTRY_PARAMS + 'params' + + Params index + - - - $_type - \ArangoDBClient\BatchPart::_type - - - An array of BatchPartCursor options + + + ENTRY_COLLECTIONS + \ArangoDBClient\TransactionBase::ENTRY_COLLECTIONS + 'collections' + + Collections index - - array - - - - $_request - \ArangoDBClient\BatchPart::_request - array() - - An array of BatchPartCursor options + + + ENTRY_WAIT_FOR_SYNC + \ArangoDBClient\TransactionBase::ENTRY_WAIT_FOR_SYNC + 'waitForSync' + + WaitForSync index - - array - - - - $_response - \ArangoDBClient\BatchPart::_response - array() - - An array of BatchPartCursor options + + + ENTRY_LOCK_TIMEOUT + \ArangoDBClient\TransactionBase::ENTRY_LOCK_TIMEOUT + 'lockTimeout' + + Lock timeout index - - \ArangoDBClient\HttpResponse - - - - $_batch - \ArangoDBClient\BatchPart::_batch + + + ENTRY_READ + \ArangoDBClient\TransactionBase::ENTRY_READ + 'read' + + Read index + + + + + ENTRY_WRITE + \ArangoDBClient\TransactionBase::ENTRY_WRITE + 'write' + + WRITE index + + + + + ENTRY_EXCLUSIVE + \ArangoDBClient\TransactionBase::ENTRY_EXCLUSIVE + 'exclusive' + + EXCLUSIVE index + + + + + $_action + \ArangoDBClient\Transaction::_action - - The batch that this instance is part of + + - - \ArangoDBClient\Batch - + - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - + + $_connection + \ArangoDBClient\TransactionBase::_connection + + + The connection object - - string + + \ArangoDBClient\Connection - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - + + $attributes + \ArangoDBClient\TransactionBase::attributes + array() + + The transaction's attributes. - - string + + array - + __construct - \ArangoDBClient\BatchPart::__construct() - - Constructor - - - \ArangoDBClient\Batch - - - mixed - - - mixed - - - mixed + \ArangoDBClient\Transaction::__construct() + + Initialise the transaction object + The $transaction array can be used to specify the collections, action and further +options for the transaction in form of an array. + +Example: +array( + 'collections' => array( + 'write' => array( + 'my_collection' + ) + ), + 'action' => 'function (){}', + 'waitForSync' => true +) + + \ArangoDBClient\Connection - - mixed + + array - - mixed + + \ArangoDBClient\ClientException + - $batch - - \ArangoDBClient\Batch - - - $id - - mixed - - - $type - - mixed - - - $request - - mixed - - - $response + $connection - mixed + \ArangoDBClient\Connection - $options - - mixed + $transactionArray + null + array - - setBatch - \ArangoDBClient\BatchPart::setBatch() - - Sets the id for the current batch part. - - - \ArangoDBClient\Batch + + execute + \ArangoDBClient\Transaction::execute() + + Execute the transaction + This will post the query to the server and return the results as +a Cursor. The cursor can then be used to iterate the results. + + \ArangoDBClient\Exception - - \ArangoDBClient\BatchPart + + mixed - - $batch - - \ArangoDBClient\Batch - - - setId - \ArangoDBClient\BatchPart::setId() - - Sets the id for the current batch part. + + setAction + \ArangoDBClient\Transaction::setAction() + + set action value - - mixed + + string - - \ArangoDBClient\BatchPart + + \ArangoDBClient\ClientException - $id + $value - mixed + string - - getId - \ArangoDBClient\BatchPart::getId() - - Gets the id for the current batch part. + + getAction + \ArangoDBClient\Transaction::getAction() + + get action value - - mixed + + string - - setType - \ArangoDBClient\BatchPart::setType() - - Sets the type for the current batch part. + + setParams + \ArangoDBClient\Transaction::setParams() + + Set params value - - mixed + + array - - \ArangoDBClient\BatchPart + + \ArangoDBClient\ClientException - $type + $value - mixed + array - - getType - \ArangoDBClient\BatchPart::getType() - - Gets the type for the current batch part. + + getParams + \ArangoDBClient\Transaction::getParams() + + Get params value - - mixed + + array - - setRequest - \ArangoDBClient\BatchPart::setRequest() - - Sets the request for the current batch part. + + set + \ArangoDBClient\Transaction::set() + + Sets an attribute - + + + + \ArangoDBClient\ClientException + + + + + $key + + + + + $value + + + + + + __set + \ArangoDBClient\Transaction::__set() + + Set an attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. + + \ArangoDBClient\ClientException + + + + string + + mixed - - \ArangoDBClient\BatchPart + + void + - $request + $key + + string + + + $value mixed - - getRequest - \ArangoDBClient\BatchPart::getRequest() - - Gets the request for the current batch part. - - - array + + __get + \ArangoDBClient\Transaction::__get() + + Get an attribute, magic method + This function is mapped to get() internally. + + + string + + mixed + + + + $key + + string + - - setResponse - \ArangoDBClient\BatchPart::setResponse() - - Sets the response for the current batch part. + + __isset + \ArangoDBClient\Transaction::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - - mixed + + string - - \ArangoDBClient\BatchPart + + boolean + - $response + $key - mixed + string - - getResponse - \ArangoDBClient\BatchPart::getResponse() - - Gets the response for the current batch part. + + __toString + \ArangoDBClient\Transaction::__toString() + + Returns the action string - - \ArangoDBClient\HttpResponse + + + string - - getHttpCode - \ArangoDBClient\BatchPart::getHttpCode() - - Gets the HttpCode for the current batch part. + + buildTransactionAttributesFromArray + \ArangoDBClient\Transaction::buildTransactionAttributesFromArray() + + Build the object's attributes from a given array - - integer + + + \ArangoDBClient\ClientException + + + $options + + + - - getProcessedResponse - \ArangoDBClient\BatchPart::getProcessedResponse() - - Get the batch part identified by the array key (0. - ..n) or its id (if it was set with nextBatchPartId($id) ) - - \ArangoDBClient\ClientException + + __construct + \ArangoDBClient\TransactionBase::__construct() + + Initialise the transaction object + + + \ArangoDBClient\Connection - - mixed + + \ArangoDBClient\ClientException + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\TransactionBase - - getCursorOptions - \ArangoDBClient\BatchPart::getCursorOptions() - - Return an array of cursor options + + getConnection + \ArangoDBClient\TransactionBase::getConnection() + + Return the connection object - + + \ArangoDBClient\Connection + + + \ArangoDBClient\TransactionBase + + + setCollections + \ArangoDBClient\TransactionBase::setCollections() + + Set the collections array. + The array should have 2 sub-arrays, namely 'read' and 'write' which should hold the respective collections +for the transaction + array + + $value + + array + + \ArangoDBClient\TransactionBase - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use + + getCollections + \ArangoDBClient\TransactionBase::getCollections() + + Get collections array + This holds the read and write collections of the transaction + + array + + + \ArangoDBClient\TransactionBase + + + setWaitForSync + \ArangoDBClient\TransactionBase::setWaitForSync() + + set waitForSync value - - string + + boolean - - \ArangoDBClient\DocumentClassable + + \ArangoDBClient\ClientException - $class + $value - string + boolean - \ArangoDBClient\DocumentClassable + \ArangoDBClient\TransactionBase - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use + + getWaitForSync + \ArangoDBClient\TransactionBase::getWaitForSync() + + get waitForSync value - - string + + boolean - - \ArangoDBClient\DocumentClassable + + \ArangoDBClient\TransactionBase + + + setLockTimeout + \ArangoDBClient\TransactionBase::setLockTimeout() + + Set lockTimeout value + + + integer + + + \ArangoDBClient\ClientException - $class + $value - string + integer - \ArangoDBClient\DocumentClassable + \ArangoDBClient\TransactionBase - - eJzdWltzGjcUfudXqDPMsHgIbl6dksbBJHFnknpsHtIShhG7AhQvu1TS2qGN/3uPLiu0dwNpnck+JFntuXznfOfoRn75dbPatFqnJyctdILOGY6W8cVrdPXuCvkhJZE4Q3Ms/NUGMwESUujVBvu3eEms9FAJqk84EauYIfQGPt2i93hLmBrnNPIJQuh5/7m2ctpqRXhNONjKG3ph4Vyx+I4GhGsISGJAiyTyBY0jHFKxzSNCZZhS36l3cN3yQ8w5ei3NXsnI/mnJ78qtfE7Q5XoTg7f2LIj9ZA2mhkoj513Jnqq/E07QhSuL5yGBUPKGzyOEGcNbFC92/ocJ45C2eCNtcyOaary6w8zotGfzVIVnvG8YvcOCgICvTP2uLaEBmkyfAAQNnsCp2G6eIuGM/JUQLr5xqt8JsbmG9oDP2on+ZyUGI1kBYrwipofECgv4g3JEIy6w7Az4t+qseFEGRGFO81DhXn0rcTsETIIlvohZ3jR4xOvUuIYGj7A44/ln4oueg1dhnJMwjpYciThnaU2/kAC1aYD0IyOGF0j6zqa00Efj9wmXhlASUWAO4ShA9zSUIxtoW7AiYqXECbsjDPKk3vw4EtDaz8DoiuCAsHIAsggtAPViIJgyAf8q+TIEFFAuaLRMKF8pmYAuFoSBl1RaWwAEMQOPUoURkbAI0DAG+YFXnoSC98vBpFYUmPQFGAGfVQqmjrSCeanTMCWMTC3jsJdWNQrpLejiiAr6NzFM+jgqJtogO7UOV8BJSFg/WzSnur42yTykvp2J0Wzmp2Xm6UrqyTroaS56Ngu9XXg9i7urTOrZXz7tFC900gKHHCYU+8mGOtAdPVsTtiReOi4dArXPXi6J6W8zCXvd7ouWNUMXyKMQvbCKk052kelMu10HkvKtLYNWZompM7ED/rBzTr4Ihn3hYB59HF/PLt/MRh8vb8Y3jtbOpWpSk9pSgcvAg4SXfhoDBZ4iovTztabGSzmqENKseZa/olh22Zvo/J+djT6Mr/+Y3Zx/uBxf/jmaAnOWYG3ioThp3RDBVVlCpy9gklbNnzDVls480jyh5SVM6+42HWlZl1V1Pu/5OjVha0AD49EpM+NMyf03odoZ99g4TflURAjQBtLLvrG9PSw2Y1sFVwt8qYDnUbvQFPjm3Ksp/tDsS+Vj8+/0aAUHCuJAezuYh33j3IcJFUIDFxp8ExvpKnkoIUb/WE4KE2MFM7vNZyp5MD8HRG4cqNWwiaI0ogaWbBTNRJnNwuFMZbbUR1BVWJ4qybK7dCt7BF37x288uGeLZtpMdI28pfE0AZfeh3FwCHAa1bMBeFPrDXgzkanXnWJdCLnTBCwugJwuKBTUfKs+6sPeLdki7+d+vx91Ye+OKMQO65AHmz8q0D3msnDg1CFWKII9ma01sxSibj4BYsXie470rcboi0/URqd0rkTtjbLUlKkrFvtEbsMrKc5ffgws25lxZzM2I8GS5IXtmFPrbbcXSijZ2eSQJci2507j+e2xj8FQZ0EZF52zzBfl6zOHiN3H6T/l9zcQcH2mj9yr/2Q269LIpEMYixnsrtHXryg7hAYDc2TIo7M47AHCBVJ1ZiiicW3Ahp/yD+Re+s0fVDLyNs+uzyx/Z2c+I3CQf8Pi9bms3jTYVKozdQ5MRT8PiID/qqDLAFQAfiiMzAHY7YsSriFfFt1jGH805ceStA9BR5BTS0hl1hpT9kSNYW9tBka3kAR9kLu8mDaVuTkr5AX2Ky05Y/1wZWWn4W9aUrWp+l7KaQQgn6KG+A9WRJOS1MEujmC1QNtUv9PXd2nGRxdvRzdTBJuedoAFrqQt9TiZNtartFO/Ju3FlR+HIVEbo1rCHs2TU0lDa7qi7fZptkfg/F5azo37f2w8fQ2Yy47+hMOwdHy+LUtmodUO7LRCo9W4yt4rF+500eBl+Qa8fnvmpjci90iD9zI3iDqqOIo0ZV63V1pGhy0RjKzju/r19JDOmpQWk/EW6GzpMk6Hpr1yFbqMYBLLqKRD04JGSRGXRC6fzEBAFjgJRTEJ6mSnicke7rzOME7CAEWxAG1B2JpGzrFfToHqTq3faSbjoXjL0HhgvzaXO87vl37tz5bubRB6ttPKimd/O3QPpLmuqr9vyNz32xgezC/7MxxSzD17roa5Vw73UOeTYBQvScQ/mf8pMP9kpWQi/wUUOgYo - - - - ArangoDB PHP client: View class - - - - - - - - - View - \ArangoDBClient\View - - Value object representing a view - <br> - - - - - ENTRY_ID - \ArangoDBClient\View::ENTRY_ID - 'id' - - View id index + + getLockTimeout + \ArangoDBClient\TransactionBase::getLockTimeout() + + Get lockTimeout value + + integer + - - - ENTRY_NAME - \ArangoDBClient\View::ENTRY_NAME - 'name' - - View name index + \ArangoDBClient\TransactionBase + + + setReadCollections + \ArangoDBClient\TransactionBase::setReadCollections() + + Convenience function to directly set read-collections without having to access +them from the collections attribute. + + array + - - - ENTRY_TYPE - \ArangoDBClient\View::ENTRY_TYPE - 'type' - - View type index + + $value + + array + + \ArangoDBClient\TransactionBase + + + getReadCollections + \ArangoDBClient\TransactionBase::getReadCollections() + + Convenience function to directly get read-collections without having to access +them from the collections attribute. + + array + - - - $_id - \ArangoDBClient\View::_id - - - The view id (might be NULL for new views) + \ArangoDBClient\TransactionBase + + + setWriteCollections + \ArangoDBClient\TransactionBase::setWriteCollections() + + Convenience function to directly set write-collections without having to access +them from the collections attribute. - - string + + array - - - $_name - \ArangoDBClient\View::_name - - - The view name + + $value + + array + + \ArangoDBClient\TransactionBase + + + getWriteCollections + \ArangoDBClient\TransactionBase::getWriteCollections() + + Convenience function to directly get write-collections without having to access +them from the collections attribute. - - string + + array - - - __construct - \ArangoDBClient\View::__construct() - - Constructs an empty view + \ArangoDBClient\TransactionBase + + + setExclusiveCollections + \ArangoDBClient\TransactionBase::setExclusiveCollections() + + Convenience function to directly set exclusive-collections without having to access +them from the collections attribute. - + array - - string + + + $value + + array + + \ArangoDBClient\TransactionBase + + + getExclusiveCollections + \ArangoDBClient\TransactionBase::getExclusiveCollections() + + Convenience function to directly get exclusive-collections without having to access +them from the collections attribute. + + + array - - + + \ArangoDBClient\TransactionBase + + + set + \ArangoDBClient\TransactionBase::set() + + Sets an attribute + + + + \ArangoDBClient\ClientException - $name + $key - array + - $type + $value - string + + \ArangoDBClient\TransactionBase - - getId - \ArangoDBClient\View::getId() - - Return the view id - - - string + + __set + \ArangoDBClient\TransactionBase::__set() + + Set an attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. + + \ArangoDBClient\ClientException - - - - setId - \ArangoDBClient\View::setId() - - Set the view's id - - + + string - + + mixed + + void - $id + $key - + string + + $value + + mixed + + \ArangoDBClient\TransactionBase - - getName - \ArangoDBClient\View::getName() - - Return the view name + + get + \ArangoDBClient\TransactionBase::get() + + Get an attribute - + string + + mixed + + + $key + + string + + \ArangoDBClient\TransactionBase - - getType - \ArangoDBClient\View::getType() - - Return the view type - - + + __get + \ArangoDBClient\TransactionBase::__get() + + Get an attribute, magic method + This function is mapped to get() internally. + + string + + mixed + + + $key + + string + + \ArangoDBClient\TransactionBase - - getAll - \ArangoDBClient\View::getAll() - - Return the view as an array + + __isset + \ArangoDBClient\TransactionBase::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - - array + + string + + + boolean + + $key + + string + + \ArangoDBClient\TransactionBase - - eJyNlUmP2jAUgO/5Fe+AxCIo3Q4VDHQog2bRFKEZijQqFXISQ9wGJ7INM6jqf6+XJJCN4Esgb/ve5lx9Db3QsrqtlgUtGDFEN8HNN5jdzcDxCaaiBwuCX+UfxLlUUVrXIXL+oA0GSAzGWlcL0U54AZMyeEAUngXGW0SpFjlBeGBk4wkYJ78+vv/wpX0MfLu179pS7Acbittwi5m0PsSBOaGOCgvw6d1n+aZrWRRtMZdAOMPST5JaIH+HIbB/Y0cAwyHDXMoJ3QCCvcwtcn5ls+FFCeYhdHF0nay/lhLoyOq0YO5hHQWIC42tTtnGMP3x+AhrWSYqJUrMm5FBbHe9Rwy4YIqzE3uIhF39DFkgZErYhdqKuDLfssiqRNXeT7Ty/pWwr99moyyi3Ah18VvK3gkoFzCZzp9eVvc3MIA6cet5zEUcvMLFdPR9opwo1foZFnEIq1zNX2balVItcTVW6mznCA5yivE2FIdoWNJ1DBFDW0CMoQPUdBbmdExKqsUnZrF+VPmaZo309zF8NkRm3tJC4bHglcMyPadL85i8OTgUJKDpvu5snziw3lFHyWC1cuJkGzqFtgEzE2kGWp2a8AjvDPUsyOrVjjNxKtUpDYwHI/2Xa/kTFjtGQRxXI5sWMxrn5z+TxwaLe7fRhAx25CrmU5tiqIra/oxFglXnBWCp/mW5svj7oAKZa+QacXPUR1xVzPPQ2XIW7XthQfMrny/pVOpUFvU4CpcRFo15IeGJYinhXOpUEp6O4yWESO+93usSULPzEaeLBCqwKWUe+X4p8s/khToc++teL7lF4zMYxqlFY98utdIXZ4GV6Wy5nb4lC+xMvY92v+K6ykXXX8IV8gniDXUb93r6TRvqS9lX+UmlPL6q7KVSqDf71n+69j+0 - - - - ArangoDB PHP client: user document handler - - - - - - - \ArangoDBClient\Handler - UserHandler - \ArangoDBClient\UserHandler - - A handler that manages users - . -A user-document handler that fetches vertices from the server and -persists them on the server. It does so by issuing the -appropriate HTTP requests to the server. - - - - - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object + + buildTransactionAttributesFromArray + \ArangoDBClient\TransactionBase::buildTransactionAttributesFromArray() + + Build the object's attributes from a given array - - \ArangoDBClient\Connection + + + \ArangoDBClient\ClientException - - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - - - - string + + $options + + + + \ArangoDBClient\TransactionBase + + + $collection + + + - The collections array that includes both read and write collection definitions + + + array + + + + array - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - - - + + $readCollection + + + - The read-collections array or string (if only one) + + + mixed + + + + mixed + + + + + $writeCollection + + + - The write-collections array or string (if only one) + + + mixed + + + + mixed + + + + + $action + + + - The action to pass to the server + + + string + + + string - - addUser - \ArangoDBClient\UserHandler::addUser() - - save a user to the user-collection - This will save the user to the users collection. It will additionally grant the user permissions -for the current database - -This will throw if the user cannot be saved - - \ArangoDBClient\Exception + + $waitForSync + + + - WaitForSync on the transaction + + + boolean - + + + boolean + + + + + $lockTimeout + + + - LockTimeout on the transaction + + + integer + + + + integer + + + + + eJy9WVtv2zYUfvev4AADkgonWbc3p83qZm3XoeuKJMUwtIVBS7TNhpZUkkriDf3vOzwkJepiO9ktQGKLPDrX71zIPPmhXJej0cmjRyPyiMwkzVfFj8/Ju5/ekVRwlusp0bCoaKp5kQONIXtW0vSarhgh9RvnSIybtNLrQsIeeQmb1+QXumUSd9Ki3Eq+WmtyXn/77tvH309ABgd+uSKvNoufJrAtilXOJuQVkxuab+Htk9EopxumQDTrSD2t9b9qVCXF4jNLtdN4FlpBuCLUExC9ptqsVIplRBeklKykkgFFRhSDP7TjAUOk1ww25Q2Tx07CFaw4jixPaakqQTVT0ycLSU7ODMWTSthPwc+QQVoIwZCrIhlb8pzb70vwnijSa56vWvSgQUUF+UxvqEolLzVZVnmtFZLRLEMmQFaUlpvg14zcUq5fFvJym6cT5H3FN6yoNFoJ5tKNQh4nVkdvkO75k0j2peKSKWdBnrPWtuGXgnMXjKA9VPA/WGb43XK9JmCZ+TSS3XZLBvBb8lUlqXk6xsDl2/aq566YFSYZYIfdQOwWW9TJKhIpsmEgKHMO0GsexAJthUBjPMZm7+gMGM5QizjybiVx8ue2qCRokLGvp1Fy2qY/bwIYUynpNo4ko1lEnp6RaLOdm4d5E+UJiW4l1wz3HT3szh9HsANfvouSxIp4cuKVa+BjQFFbMmQAfYj26f+pOkDJJJT5FaogayZKJmvwKpNQJpytfACMpVpsJ2RBTWKCORBcXifGoAeAyQXoHYZljMoa540VACVfEb4kCj5FmH9Jm8lvxtR/zOXFXSoqxW/+LqcBT9riKwtwn97aOBAybt4j+HOEuRt601LaSpeDVhnk76KAfDRhxjTC6AbvhAWpLXXD7yAeZCxbnvZSzepRXzTY68yNwd4iF7CUs2SY823b/Y4zrv5d1o5iTAM3Na5yq6b4U6Xa9b3NZ1EUghgVm3rq+PwWrFiwdttGw4Xn2rw0Dgux5fImWBnk0mq/A80XoJSavvz4+HtsmqkwFoV9kd1p6GqtteeQYqM/R0YFbKTmB0qva5Z5xu7c2gl+Qj1Wmrx4e3Xx+3x2fvX617fkKYksqwiacYfPO2wvB/i8m13Mfrk0fGw3GuDz7IZC1sydGS6iQfhq9xbLruOOW3KBUAOGAGueW1/Ya9e8FOvyqgcLJPT0Ro9xSGXB6ZqVny1UyVK+3Ha7/8SbYDJxWUnYlp6xb+NmKOhqwnOzvDEGUyfxuKPXizu6KQWb+mdbu/0TweLt1QiKe0NA+pU/3CTYLRomUWszCZ6SSSDVgQW7TdivvkYhVZBlSKplxfx20ja0BgnCBwbIejAZB0OKT/rO7AKRcUHqsHEVFpM1cPwMl486sXDTjp1SMqppVzW9lsWtIh/bafvRfkC3YKVN8hCq1ULwtG6VZD7HpJFVquNhGydO6b6+T0leCWH9ZpMdJUBbhil/GnIO2CUuNcwPlNeYq7kFQY9/kgRcrcewEy4qLrKg2Mw0ZO6igtn4pSw2sx3MTmtWX0f2by9FX9yxFNj0i2QnMWG2v+VCkLJQGom/VExu21Xej5KVtEUXBtxKaGgxqk4ccl5JVchj21zxO6Y3kLdyHHIFJlUWsukmpUdCHXOCC1Ca/TO4OgTXknIRgNMpavulSQocIqo0ZUotK1GP2NSbdEMFELkK0lrDlmnOBwpHMJ77k8YhJDLr/biLJ5gLVAlIYvbxqYfByozLHlVxcnRmwhG3APNeCjWdvr94M7+6mL29tK1lMoSpHrPPqsjncO6CSXd+K2kJjSD2Y3GNt6RmFcCr1tcnSb2AYn5WRsBpJwfAVXH7xQ+RjXX0qZcHzt+76EOkjzrvmNie7sI/noBsMDCWw5XQTz6DJP9CRWqOTVZEDw/1PBwrJpbTaTg3TEhs9UucgslOa1cHrHUec+beA8CrWvGuyj5gNdYGNN+t6CUoameYfWFxRfo/jIodu+JQ0D1jY2cxiA2+ezg0rw5Y7PxpNfGXDfsj45R/WGSs3nsjgxc/dUUYDs34mm27S/vi9MC4xIb/ZEdETHn5BnqshTGS9uqJ7RU5u+1KjqPXOXDlGcmKtNrAVmMqAU5RMlhrenXygxH7yZRC1HEv0kN3TsiGrsBae/Ey1IfNxVuLyJ5JqRDGkc3tTTCR+Wbm+WQMjjQ2x6Gn9w2FSZlLpXe13OFg1VSo2/5CCr4hZoZsXGvuJTvE/ihrm+yRa7Zmht8JPt+WC57thdB8fghEClyWrolFTwc8KRz1SL+ckWmLKoBFr76f9igXcOi/Pt0vxp3v9olxOf8QMRlbUmiifa7NVNtz1kHGOwfOVw/Gex00+L4xUwlOiKZuJeYSgMkcQNw7s90XhUeIPDz9HQCVhaOHYfjChLx9/+aNqTsNnkHZvNCmVh0A4sr59nCZRqqdheS1Mv8AWK2YtNe4KXgFr8Zw0ErM4Mo2pd6ar+akRXHS5QvB/KGfs/6Q/U8cZu55GMTaPio7ZIMaSyoA2LEZveDJeSk54CY3Lw44Kpgmh4vwrmGyGQydSzv7qOdOf194q5rLE+umewGxPWm5w3QlJZbhAW673KKLS9vl9sOnvqLZYcxzc75s3/yHzQDOmNBzVvyGuQlkR9N39yz/wSx2rwOwE7/rdP4gHr0jOwLM7X7oF/8+yvq1f9/bg0A8INn2g32SfTvY93a/aIMGeOU5hzmIqjhw2XSKGxMSffT/bfRRXXwM6MyU9Bd9s7Ux + + + + ArangoDB PHP client: streaming transaction + + + + + + + \ArangoDBClient\TransactionBase + StreamingTransaction + \ArangoDBClient\StreamingTransaction + + Streaming transaction object + + + + + + + ENTRY_ID + \ArangoDBClient\StreamingTransaction::ENTRY_ID + 'id' + + class constant for id values + + + + + ENTRY_COLLECTIONS + \ArangoDBClient\TransactionBase::ENTRY_COLLECTIONS + 'collections' + + Collections index + + + + + ENTRY_WAIT_FOR_SYNC + \ArangoDBClient\TransactionBase::ENTRY_WAIT_FOR_SYNC + 'waitForSync' + + WaitForSync index + + + + + ENTRY_LOCK_TIMEOUT + \ArangoDBClient\TransactionBase::ENTRY_LOCK_TIMEOUT + 'lockTimeout' + + Lock timeout index + + + + + ENTRY_READ + \ArangoDBClient\TransactionBase::ENTRY_READ + 'read' + + Read index + + + + + ENTRY_WRITE + \ArangoDBClient\TransactionBase::ENTRY_WRITE + 'write' + + WRITE index + + + + + ENTRY_EXCLUSIVE + \ArangoDBClient\TransactionBase::ENTRY_EXCLUSIVE + 'exclusive' + + EXCLUSIVE index + + + + + $_id + \ArangoDBClient\StreamingTransaction::_id + + + The transaction id - assigned by the server + + string - - mixed + + + + $_collections + \ArangoDBClient\StreamingTransaction::_collections + + + An array of collections used by this transaction + + + array - - mixed + + + + $_connection + \ArangoDBClient\TransactionBase::_connection + + + The connection object + + + \ArangoDBClient\Connection - + + + + $attributes + \ArangoDBClient\TransactionBase::attributes + array() + + The transaction's attributes. + + array - - boolean + + + + __construct + \ArangoDBClient\StreamingTransaction::__construct() + + Constructs a streaming transaction object + + + \ArangoDBClient\Connection - + + array + + - $username + $connection - string - - - $passwd - null - mixed - - - $active - null - mixed + \ArangoDBClient\Connection - $extra + $transactionArray null array - - replaceUser - \ArangoDBClient\UserHandler::replaceUser() - - Replace an existing user, identified by its username - This will replace the user-document on the server - -This will throw if the document cannot be replaced - - \ArangoDBClient\Exception + + getCollection + \ArangoDBClient\StreamingTransaction::getCollection() + + Get a participating collection of the transaction by name +Will throw an exception if the collection is not part of the transaction + + + \ArangoDBClient\ClientException - + string - - mixed - - - mixed - - - array - - - boolean + + \ArangoDBClient\StreamingTransactionCollection - $username + $name string - - $passwd - null - mixed - - - $active - null - mixed - - - $extra - null - array - - - updateUser - \ArangoDBClient\UserHandler::updateUser() - - Update an existing user, identified by the username - This will update the user-document on the server - -This will throw if the document cannot be updated - - \ArangoDBClient\Exception - - + + getId + \ArangoDBClient\StreamingTransaction::getId() + + Get the transaction's id + + string - - mixed - - + + + + setId + \ArangoDBClient\StreamingTransaction::setId() + + Set the transaction's id - this is used internally and should not be called by end users + + mixed - - array - - - boolean - - $username + $id - string - - - $passwd - null - mixed - - - $active - null mixed - - $extra - null - array - - - get - \ArangoDBClient\UserHandler::get() - - Get a single user-document, identified by the username - This will throw if the document cannot be fetched from the server - - \ArangoDBClient\Exception + + query + \ArangoDBClient\StreamingTransaction::query() + + Executes an AQL query inside the transaction + This is a shortcut for creating a new Statement and executing it. + + \ArangoDBClient\ClientException - - string + + array - - \ArangoDBClient\User + + \ArangoDBClient\Cursor - $username + $data - string + array - - removeUser - \ArangoDBClient\UserHandler::removeUser() - - Remove a user, identified by the username + + buildTransactionAttributesFromArray + \ArangoDBClient\StreamingTransaction::buildTransactionAttributesFromArray() + + Build the object's attributes from a given array - - \ArangoDBClient\Exception - - - string - - - boolean + + + \ArangoDBClient\ClientException + - $username + $options - string + - - grantPermissions - \ArangoDBClient\UserHandler::grantPermissions() - - Grant R/W permissions to a user, for a specific database + + __construct + \ArangoDBClient\TransactionBase::__construct() + + Initialise the transaction object - - \ArangoDBClient\Exception - - - string - - - string + + \ArangoDBClient\Connection - - boolean + + \ArangoDBClient\ClientException - - $username - - string - - - $databaseName + $connection - string + \ArangoDBClient\Connection + \ArangoDBClient\TransactionBase - - grantDatabasePermissions - \ArangoDBClient\UserHandler::grantDatabasePermissions() - - Grant R/W permissions to a user, for a specific database + + getConnection + \ArangoDBClient\TransactionBase::getConnection() + + Return the connection object - - string - - - string - - - string + + \ArangoDBClient\Connection - - boolean + + \ArangoDBClient\TransactionBase + + + setCollections + \ArangoDBClient\TransactionBase::setCollections() + + Set the collections array. + The array should have 2 sub-arrays, namely 'read' and 'write' which should hold the respective collections +for the transaction + + array - $username - - string - - - $databaseName + $value - string - - - $permissions - 'rw' - string + array + \ArangoDBClient\TransactionBase - - revokePermissions - \ArangoDBClient\UserHandler::revokePermissions() - - Revoke R/W permissions for a user, for a specific database - - - \ArangoDBClient\Exception - - - string - - - string + + getCollections + \ArangoDBClient\TransactionBase::getCollections() + + Get collections array + This holds the read and write collections of the transaction + + array - + + \ArangoDBClient\TransactionBase + + + setWaitForSync + \ArangoDBClient\TransactionBase::setWaitForSync() + + set waitForSync value + + boolean - + + \ArangoDBClient\ClientException + - $username - - string - - - $databaseName + $value - string + boolean + \ArangoDBClient\TransactionBase - - revokeDatabasePermissions - \ArangoDBClient\UserHandler::revokeDatabasePermissions() - - Revoke R/W permissions for a user, for a specific database + + getWaitForSync + \ArangoDBClient\TransactionBase::getWaitForSync() + + get waitForSync value - - \ArangoDBClient\Exception - - - string + + boolean - - string + + \ArangoDBClient\TransactionBase + + + setLockTimeout + \ArangoDBClient\TransactionBase::setLockTimeout() + + Set lockTimeout value + + + integer - - boolean + + \ArangoDBClient\ClientException - $username - - string - - - $databaseName + $value - string + integer + \ArangoDBClient\TransactionBase - - grantCollectionPermissions - \ArangoDBClient\UserHandler::grantCollectionPermissions() - - Grant R/W permissions to a user, for a specific collection + + getLockTimeout + \ArangoDBClient\TransactionBase::getLockTimeout() + + Get lockTimeout value - - string - - - string - - - string - - - string + + integer - - boolean + + \ArangoDBClient\TransactionBase + + + setReadCollections + \ArangoDBClient\TransactionBase::setReadCollections() + + Convenience function to directly set read-collections without having to access +them from the collections attribute. + + + array - $username - - string - - - $databaseName - - string - - - $collectionName + $value - string - - - $permissions - 'rw' - string + array + \ArangoDBClient\TransactionBase - - revokeCollectionPermissions - \ArangoDBClient\UserHandler::revokeCollectionPermissions() - - Revoke R/W permissions for a user, for a specific database + + getReadCollections + \ArangoDBClient\TransactionBase::getReadCollections() + + Convenience function to directly get read-collections without having to access +them from the collections attribute. - - \ArangoDBClient\Exception - - - string - - - string - - - string + + array - - boolean + + \ArangoDBClient\TransactionBase + + + setWriteCollections + \ArangoDBClient\TransactionBase::setWriteCollections() + + Convenience function to directly set write-collections without having to access +them from the collections attribute. + + + array - $username - - string - - - $databaseName - - string - - - $collectionName + $value - string + array + \ArangoDBClient\TransactionBase - - getDatabases - \ArangoDBClient\UserHandler::getDatabases() - - Gets the list of databases a user has access to + + getWriteCollections + \ArangoDBClient\TransactionBase::getWriteCollections() + + Convenience function to directly get write-collections without having to access +them from the collections attribute. - - \ArangoDBClient\Exception - - - string + + array - + + \ArangoDBClient\TransactionBase + + + setExclusiveCollections + \ArangoDBClient\TransactionBase::setExclusiveCollections() + + Convenience function to directly set exclusive-collections without having to access +them from the collections attribute. + + array - $username + $value - string + array + \ArangoDBClient\TransactionBase - - getDatabasePermissionLevel - \ArangoDBClient\UserHandler::getDatabasePermissionLevel() - - Gets the list of collections a user has access to + + getExclusiveCollections + \ArangoDBClient\TransactionBase::getExclusiveCollections() + + Convenience function to directly get exclusive-collections without having to access +them from the collections attribute. - - string - - - string + + array - - string + + \ArangoDBClient\TransactionBase + + + set + \ArangoDBClient\TransactionBase::set() + + Sets an attribute + + + + + \ArangoDBClient\ClientException - $username + $key - string + - $databaseName + $value - string + + \ArangoDBClient\TransactionBase - - getCollectionPermissionLevel - \ArangoDBClient\UserHandler::getCollectionPermissionLevel() - - Gets the list of collections a user has access to - - - string + + __set + \ArangoDBClient\TransactionBase::__set() + + Set an attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. + + \ArangoDBClient\ClientException - + + string - - string + + mixed - - string + + void - $username - - string - - - $databaseName + $key string - $collectionName + $value - string + mixed + \ArangoDBClient\TransactionBase - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler + + get + \ArangoDBClient\TransactionBase::get() + + Get an attribute - - \ArangoDBClient\Connection + + string + + + mixed - $connection + $key - \ArangoDBClient\Connection + string - \ArangoDBClient\Handler + \ArangoDBClient\TransactionBase - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object - - - \ArangoDBClient\Connection + + __get + \ArangoDBClient\TransactionBase::__get() + + Get an attribute, magic method + This function is mapped to get() internally. + + + string + + + mixed - \ArangoDBClient\Handler + + $key + + string + + \ArangoDBClient\TransactionBase - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection + + __isset + \ArangoDBClient\TransactionBase::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - - - mixed + + string - - \ArangoDBClient\ClientException + + boolean - $optionName + $key - + string - \ArangoDBClient\Handler + \ArangoDBClient\TransactionBase - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - - array - - - string - - + + buildTransactionAttributesFromArray + \ArangoDBClient\TransactionBase::buildTransactionAttributesFromArray() + + Build the object's attributes from a given array + + + \ArangoDBClient\ClientException - $body + $options - array + - \ArangoDBClient\Handler + \ArangoDBClient\TransactionBase - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array - - - array - - - array + + eJzVWNtuGzcQfddXTAABkgw5bhv0Ra7TyLLqKDBysdSmhW0I1IqS2K64G5JrW2jy753h3rjUrpI2yEOFAJaW5OGZw8OZ2fz0c7yJW62To6MWHMFQMbmOLs7h7cu3EISCSzMAbRRnWyHXYHBYs8CISOJsWvAiZsFfbM0BirUju8wOssRsIoVj8IpJmBrOt0xKOxRE8U6J9cbAqPj2w3ffP+vjJgIBpYbL7eJlH4fDaC15Hy65wtU7XH3Sakm25Rr35t62p0Uo0zrWEC3+5IHxyddQ10IGFNWzpz/aHYOQaV2CzhxM/mi4XGpwnp0zzVt/tyhyS4c+R5BiBJHUhkkDK5RGLOGehQnX2ZwT+9dOgfHr2fUf88kFnEFHLDsYmoc32/BKcAh2DLiFQL2WsNiBwQmaq3uusiX5yhf3TNG5kjzHHkaFSazEPTMc2nOx3CcwlMCUYjuIVsg5DLnF0JDofH+hq6bZZ5ECHDvrs0NyYXgNik/QIbDPdESKqoRQWb2hC2tUKcZMsS0tlxm5dlB+B+JtPQPlU29pGl/b2Wlon9BR2S8Pwmwa1DsQdrIIRQCrRKZM5vMgj7BbT7bfyOQMZBKGPYubetbuwBTd/oGL7MD1Mo3pI1bQFXpu8bt7+L2eg0qfNtni+PkiEeHSuTNDg35cJIbrX1S0HTaAnRZQn0oCJydocwNJTKyNCETMDB2vo2rL2921Cypwc1cC473kLNhAN5vKCmI3moerwSC9mKM3V1fj0Wzy5vX0rjIw/n109et08tv4Di8jtClVNUjgkrixE+/oNPhDbaIZFZNTZv0Uuw+1m9cr9bWxvb+ezA7ERU54IjQeRrc5xD1DfFtFLGVHjVSRb6DN9Xh48f+ShhgfUCbTx8+ll3jVWONNo1rgZS5KZrR5DvBehCHOUdEDMCqfAY/T2pOudLCwfMjI2L1qcP1cbSE1pFV8nMPWZ/Ss+FlRMBXbP5G/v79UcZMo+Rm962rZwdy95sY9LWseLxn/F/OkApM/PEG6HYcsyav4WmjDFZYdIV2BO5Ukkn/LVGgmctoqF9SZxzvGji67Dl/qL+pR9vWcLLu+hB5ramcyf3sMpw0MiQT1MyKr0EKiZJKF4Q5dvAS9iZJwafVcoIfweVrFsTWk+UrX+3ArHnFeO4Wv9nKYSWSyXXAFUd6sHYxb27gRyg8dW0KuDJXoFMXOgY8fMZQ57sCVCOwjv6aXWsGTs6xL8PLTAZNNS0GSeEk9GqmKWHjN7LVHz3k9WKe+aGX9RYVqhQfJdwbdNLoe/XRwYK/029nt0gGFT30rjB95QPmf+A7fXcGHhKsdHrwWS/6ZZDTLrMLIGMogjO33A8wcNmqWZW7UZUv9I1mI2+1oVJinX5Pcsk4PRWdoq5Q1/eiTp5CU4h8SoVJ/FhSqrV6v4UKOEqUxjhw1sD8tbjphDzQNiheA9d61aF2Ht+9h+/Cm45qFyp890vKw27oQ9KwqcG5mm2zzJrbb62e7lRB5niiQjp8XITSljHNqZa0h0nSP+aJsHmCF7Sye91rc8+x9qf7U2lHstKp7J39bfUu9rXdC/lYUGeSBh1Eo/EXtdsag6V3gX2HsvSDY6pWNVhqnycV+45MdV5bTmlb55QmPBv/Z9+w5CwXTXYftYGAH+tC5zf+PIdd0cVtX0ykd/QNGwTZW + + + + ArangoDB PHP client: URL helper methods + + + + + + + + UrlHelper + \ArangoDBClient\UrlHelper + + Some helper methods to construct and process URLs + + + + + + getDocumentIdFromLocation + \ArangoDBClient\UrlHelper::getDocumentIdFromLocation() + + Get the document id from a location header + + + string - - array + + string - $options + $location - array + string + + + buildUrl + \ArangoDBClient\UrlHelper::buildUrl() + + Construct a URL from a base URL and additional parts, separated with '/' each + This function accepts variable arguments. + + string + + + array + + + string + + - $body + $baseUrl - array + string - $includeArray + $parts array() array - \ArangoDBClient\Handler - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name - - - \ArangoDBClient\ClientException + + appendParamsUrl + \ArangoDBClient\UrlHelper::appendParamsUrl() + + Append parameters to a URL + Parameter values will be URL-encoded + + string - - mixed + + array - + string - $value + $baseUrl - mixed + string - \ArangoDBClient\Handler - - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use - - - string - - - \ArangoDBClient\DocumentClassable - - - $class + $params - string + array - \ArangoDBClient\DocumentClassable - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use + + getBoolString + \ArangoDBClient\UrlHelper::getBoolString() + + Get a string from a boolean value - - string + + mixed - - \ArangoDBClient\DocumentClassable + + string - $class + $value - string + mixed - \ArangoDBClient\DocumentClassable - eJztWm1v2zYQ/u5fcQMK2A6cBNtHd+7apS/p0BVB1mAfkiKlJdrmSosaScUxivz3HUlRr5bfErfuGqFALfHueLx7+Bx10a+/xZO41To+OGjBAbyQJBqLl7/D2ekZBJzRSPchUVRCKIJkircwIVHIqURpo/A8JsFnMqYAme6JVbODJNETIXEMXuPgZ/iTzK0mPFcsCowSwM9Hv+CT41YrIlOq0BytWHqae+cnBz0hGqYkwpmV9U+Z8SMnZO4Pq/46lRHVwQRVbqjULMAfIymmOEQBdfAhoLAxEqNFprQyQ1MQUUHkCN5qjAbqKgHDOTClEhaNjYTRJHEsRSwZ0RROP3w4A0n/Tag1JYpW1opfPUoBJ0rBBRo5TddFbzWNQgXpfetLq2UUbMjMdQCK3FAgLo2pEzZEgeCcBpqJKJX0Ch8mTMGMce5UvUJRWUGubSNixUkYMvOEcD6HMa5H58oY0inGCkeVn2ckpB0PEilNqkKiyZAo2uiOnkgxAzbKrQYkioSGIbWuhhXN51ZBwavbgMYLForRl2QKSkuTwSfGokEhHOKcFOxPUZiMKAyjEz5yXuE/RCH6LeT8qGJ1ym5pCPAkxozN8Edq1QXDPBMyLJt8O4JI5GNoXMU0YCNGw571gk5jPffu2ogMrcGwaW6CCbqhdm4SgYhdcmDEydhtCD8BBnhCcQqZrxand+qpY7rsjc9JSEck4dqCQya06gmRkszRE4SpJFDzxA3PmJ7gzyFDGTkHJ2vQAGQokhxER9X8SaoTGcFQCE7R7KF1oWcQ4tAhEh5WweG3ld1S9smx/T9OhpwFMEoii2oDZrPPOhkselkuBxAlnPey+Gb3znN327VWv7g58LJ2Xnpa8hfK0pnd0J3u08Wyh8/sYoxs5kujaOZh6mujYOZ6uohGwTRzg3R1BTmboeo1qOqPqX7BuVldrmngY0dORBQ5Ful00XmhdOdCctXvX5y/u77469V5zwv/o0R0TaNAhPR6JpFmTWqMB92iZY3wyUNuruPjMi0pqmuEBCxaSESqZMl7bXjtLFcuAaRhYfjgZWqz0y3k+Q4JDCsSdK4yisIwdwtLuMvXloLdQNxZuKtR/TmNuamguBfoLRYwwxPGO9wSIS7Mbl5btLQrm8brRraVqbGsYGQ1tVQQ12PrTDdn7NT+1yPtHpKcaKt0MQa86OpY2Ootih49svu+sbsxzGdkrlKGrwFMUrskxL2UQi4l9jTL+0Lu+8zY+QSS1/RQEbn6lHJk0n5/mDAe4n2Nvy+zGH8sWmwqAYnumNk25P1F3Fglx4s4NKfyVdzo4biUGxNna1fU6MzvETOmDj0S4/+ZGF2S94UXm+kOF9Yxk8FPg4w1u5Vj39oke9dg1k26wmyzj01mbbBWWPUBrdJ34SxoCXkn/GvOo2sw8OKKsTEnv8HTODIBbmxeYdKtaHkVr7r+T1ht+zwYz2Y/CwTXsHkN+s0La62CLPdx8c7F+Odbtr4HffG+F2AkVTG+7li0N7/mWOiU3vUsoQ1yfSv2hzIaRTHHjQolL9vXTL2nszYMnsGIcEU/FgWvfaRObC8s86b8/GkVhhW9fj+QFNnuNUb5hWFjd6joZY50GzF7Tqci66htANOHhVWvVMttVWMqrdYh5XTB8WFn52kTj3LZqGIQ38LtLo0RBQbOpn84Ra5hQ8YZFnffChQ8hFig+TnYaOAyfPkDe6jAZxYjJUjcmwxrBgzLReGZnc7YSQnRzb8GjboM1DbDWpRo+6bnx3+XOhSYWA84EyviTyVBU9d0W7SZaymRVTX9/O8dVv0x0z9egwq3B2RmKaSIrMAcUY3rxQZ5v28bNr79clbq+ihNSbgU3Eu7PcWlVxHvaafQNFrgQ7O5HeNjD2BQtVBcDloo3qYin+Tsk10eUnd4OJMMX8E66Um828NhURgWEZ8vAdzqrG+Srl7Z/QG05axdK8RpKbwsHf7adjJb7J7U/kiC172Zrgdt72q74vY3fiM/pzfiM61h2QH4key2ITtpQ7ot2znt+9Ndoxdb8N0jSB7iiLZxPjblrnYkItr+EVhr0wLc9Hf2dXB3H+TBdmU4d7eC33xg02K+F+X8JHN/zYJeDsR3WuFr63gs+d/Rrvo6deGeO2OfS8W+wf8NdR+VAWdKFyGk/BdaE4OCIKDKlJSddpAaMOb+NlFEt/0yL2vR5B5n3adFPjc2Kv0pRO2iY1mEwlfsXvrTr5G+bKMsVrD2x/VRkGN0PRzs+KRaTHMDSkpmV+Y655V39Iby9U+dDwKEZcfHHwYXD1XzFmBj7Vpnv7Fq+up0M2QtqlnLsbW6bu0CbMsL0DdFH/6znxNfE86I6pTaCHYAl3WFySBjGqmr9PPk4VVBro2z/Qcr0Cf/ + eJydVm1v2zgM/p5fwRXFOSncutePadNu67D1DsOhuPY+XYdAlplYmCx5krwtOOy/j5JfYnteu2sKNLHJh3pIPqR9cVXm5WyWHB3N4AheGaa2+s1ruL25BS4FKreEf/5+DznKEg0U6HKdWXL13i9Lxj+yLQJ0wOuACUZWka8hG/zJFNw5xIIpFUxclzsjtrmD6+7X2envZzE4IyigsvCuSG9iMku9VRjDOzSE3hE6mc0UK9DS2Tg69rzL404XOOIMTgPXyjpTcQdMZVAazdFan98PGU3kY4XiPtXTk7NAg6UUi1EsLpmPYuRNOHD238wnHZj4zxGRd+ByhEzzqqBwIDLYGF0AA6k5c0IrIssywtaIFkh0DCuAzhFqC4ed8zHc3N/fgqEqUEb4VBSDrjKqDXM84EEnWGzoDNBJ+C6rVApOUIrPYVMpHs7ZonvTBPkje0vY9w2DeUdyEfB1LfxHbGD+Qth1zaLnt+g5hcIlwJmKHNGkNu1c7kmzVFfE1/kwXbbCgtIO8DMqKmUdeBCqSVxVUp53hm+zAadTWK1WHlxqu2cVQ5SsszSJpugFy0WWeh1eJmtWiqQtaXLBtZQYqnSZXHzE3eUA/VIK6+YxtH+He/e/KBrdENkCVoBfS6kznEdJFO8bv+hlASip8xPcnkvn+VSGBe31mAKMy0f3KGZlZIbcR/U+k6Ga3o1YwQk1JqL/hKthDaQ3btf7KQ+7qxm1lFG9/LWffZZlwsdk0k+AszFY9MPmaBa+CJeHU5DxfDRL9zmJrhsDxjmWzsJnRmsrlQjMbEPd7cnjk+y50MKgWWxZjRyZMWxH1QrkyHAcmNdXtMhYWaLKnppzWktYEK2sd8CjY51WQmbEa94SjBsiDY8V/PthPNeH1EsytIjzfQc32vgKwrxBM1vHGUvCi6adP2/3sxct4AWN5YaRyMf+PeE28cYiDXfPB6CesjrWJ6tGTHSBqpbjCDohyMrInynvVWgLhBaiQ1P3qlf91vG29SDpyAotaU5KSIMSjmsqP3T3+QpihfUKoqdwfVNvehSfEpF/cP1vIdX6DFnaoZ4aPmMVDbTi+Xqx0LqC1SX8dhiKNCUb2jWp1hS/9phSSm0iiViUm+WSnlyvCXHXbKgaN5bKI91v60576MpLJ3euXIe5WX+q0OzaBBY/04h/GWgfVt1qIkZI7QlspvteiK9U/iaZuiuT3uP2HdAmxANfrAaL/ov2XNCmN8ZwEMbsADRFNV+ExV9p8WQhR11ti1affAWRPy+CJUThxKitEVUpvEStmRTMzrtXqeUy3KaF8NC+GD40b2bpQ+cVUa2/Ax4tFgg= - + - ArangoDB PHP client: single document + ArangoDB PHP client: endpoint - - + - \JsonSerializable - Document - \ArangoDBClient\Document - - Value object representing a single collection-based document - <br> - - + Endpoint + \ArangoDBClient\Endpoint + + Endpoint specification + An endpoint contains the server location the client connects to +the following endpoint types are currently supported (more to be added later): +<ul> +<li> tcp://host:port for tcp connections +<li> unix://socket for UNIX sockets (provided the server supports this) +<li> ssl://host:port for SSL connections (provided the server supports this) +</ul> + +Note: SSL support is added in ArangoDB server 1.1<br> + +<br> + + - - ENTRY_ID - \ArangoDBClient\Document::ENTRY_ID - '_id' - - Document id index + + TYPE_TCP + \ArangoDBClient\Endpoint::TYPE_TCP + 'tcp' + + TCP endpoint type - - ENTRY_KEY - \ArangoDBClient\Document::ENTRY_KEY - '_key' - - Document key index + + TYPE_SSL + \ArangoDBClient\Endpoint::TYPE_SSL + 'ssl' + + SSL endpoint type - - ENTRY_REV - \ArangoDBClient\Document::ENTRY_REV - '_rev' - - Revision id index + + TYPE_UNIX + \ArangoDBClient\Endpoint::TYPE_UNIX + 'unix' + + UNIX socket endpoint type - - ENTRY_ISNEW - \ArangoDBClient\Document::ENTRY_ISNEW - '_isNew' - - isNew id index + + REGEXP_TCP + \ArangoDBClient\Endpoint::REGEXP_TCP + '/^(tcp|http):\/\/(.+?):(\d+)\/?$/' + + Regexp for TCP endpoints - - ENTRY_HIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES - '_hiddenAttributes' - - hidden attribute index + + REGEXP_SSL + \ArangoDBClient\Endpoint::REGEXP_SSL + '/^(ssl|https):\/\/(.+?):(\d+)\/?$/' + + Regexp for SSL endpoints - - ENTRY_IGNOREHIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES - '_ignoreHiddenAttributes' - - hidden attribute index + + REGEXP_UNIX + \ArangoDBClient\Endpoint::REGEXP_UNIX + '/^unix:\/\/(.+)$/' + + Regexp for UNIX socket endpoints - - OPTION_WAIT_FOR_SYNC - \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC - 'waitForSync' - - waitForSync option index + + ENTRY_ENDPOINT + \ArangoDBClient\Endpoint::ENTRY_ENDPOINT + 'endpoint' + + Endpoint index - - OPTION_POLICY - \ArangoDBClient\Document::OPTION_POLICY - 'policy' - - policy option index - - - - - OPTION_KEEPNULL - \ArangoDBClient\Document::OPTION_KEEPNULL - 'keepNull' - - keepNull option index + + ENTRY_DATABASES + \ArangoDBClient\Endpoint::ENTRY_DATABASES + 'databases' + + Databases index - - $_id - \ArangoDBClient\Document::_id - - - The document id (might be NULL for new documents) - - - string - - - - - $_key - \ArangoDBClient\Document::_key + + $_value + \ArangoDBClient\Endpoint::_value - - The document key (might be NULL for new documents) + + Current endpoint value - + string - - $_rev - \ArangoDBClient\Document::_rev - - - The document revision (might be NULL for new documents) - - - mixed - - - - - $_values - \ArangoDBClient\Document::_values - array() - - The document attributes (names/values) - - - array - - - - - $_changed - \ArangoDBClient\Document::_changed - false - - Flag to indicate whether document was changed locally - - - boolean - - - - - $_isNew - \ArangoDBClient\Document::_isNew - true - - Flag to indicate whether document is a new document (never been saved to the server) - - - boolean - - - - - $_doValidate - \ArangoDBClient\Document::_doValidate - false - - Flag to indicate whether validation of document values should be performed -This can be turned on, but has a performance penalty - - - boolean - - - - - $_hiddenAttributes - \ArangoDBClient\Document::_hiddenAttributes - array() - - An array, that defines which attributes should be treated as hidden. - - - array - - - - - $_ignoreHiddenAttributes - \ArangoDBClient\Document::_ignoreHiddenAttributes - false - - Flag to indicate whether hidden attributes should be ignored or included in returned data-sets - - - boolean - - - - + __construct - \ArangoDBClient\Document::__construct() - - Constructs an empty document + \ArangoDBClient\Endpoint::__construct() + + Create a new endpoint - - array + + string - - - $options - null - array - - - - createFromArray - \ArangoDBClient\Document::createFromArray() - - Factory method to construct a new document using the values passed to populate it - - + \ArangoDBClient\ClientException - - array - - - array - - - \ArangoDBClient\Document - \ArangoDBClient\Edge - \ArangoDBClient\Graph - - $values + $value - array - - - $options - array() - array + string - - __clone - \ArangoDBClient\Document::__clone() - - Clone a document - Returns the clone - - - void - - - - + __toString - \ArangoDBClient\Document::__toString() - - Get a string representation of the document. - It will not output hidden attributes. - -Returns the document as JSON-encoded string - - + \ArangoDBClient\Endpoint::__toString() + + Return a string representation of the endpoint + + + string - - toJson - \ArangoDBClient\Document::toJson() - - Returns the document as JSON-encoded string + + getType + \ArangoDBClient\Endpoint::getType() + + Return the type of an endpoint - - array + + string - + string - $options - array() - array + $value + + string - - toSerialized - \ArangoDBClient\Document::toSerialized() - - Returns the document as a serialized string + + normalize + \ArangoDBClient\Endpoint::normalize() + + Return normalize an endpoint string - will convert http: into tcp:, and https: into ssl: - - array + + string - + string - $options - array() - array + $value + + string - - filterHiddenAttributes - \ArangoDBClient\Document::filterHiddenAttributes() - - Returns the attributes with the hidden ones removed + + getHost + \ArangoDBClient\Endpoint::getHost() + + Return the host name of an endpoint - - array - - - array + + string - - array + + string - $attributes + $value - array - - - $_hiddenAttributes - array() - array + string - - set - \ArangoDBClient\Document::set() - - Set a document attribute - The key (attribute name) must be a string. -This will validate the value of the attribute and might throw an -exception if the value is invalid. - - \ArangoDBClient\ClientException - - + + isValid + \ArangoDBClient\Endpoint::isValid() + + check whether an endpoint specification is valid + + string - - mixed - - - void + + boolean - - $key - - string - $value - mixed + - - __set - \ArangoDBClient\Document::__set() - - Set a document attribute, magic method - This is a magic method that allows the object to be used without -declaring all document attributes first. -This function is mapped to set() internally. - - \ArangoDBClient\ClientException - - - - string + + listEndpoints + \ArangoDBClient\Endpoint::listEndpoints() + + List endpoints + This will list the endpoints that are configured on the server + + \ArangoDBClient\Connection - - mixed + + + array - - void + + \ArangoDBClient\Exception - $key - - string - - - $value + $connection - mixed + \ArangoDBClient\Connection - - get - \ArangoDBClient\Document::get() - - Get a document attribute + + normalizeHostname + \ArangoDBClient\Endpoint::normalizeHostname() + + Replaces "localhost" in hostname with "[::1]" in order to make these values the same +for later comparisons - + string - - mixed - - - - $key - - string - - - - __get - \ArangoDBClient\Document::__get() - - Get a document attribute, magic method - This function is mapped to get() internally. - - + string - - mixed - - $key + $hostname string - - __isset - \ArangoDBClient\Document::__isset() - - Is triggered by calling isset() or empty() on inaccessible properties. + + + Name of argument $value does not match with the DocBlock's name $mixed in isValid() + Parameter $mixed could not be found in isValid() + + eJy9WG1v2zYQ/u5fcTM8RE4dK8mXAWqTNEuNpkWRBYk7tIhTg5Zpm4hMCiSdly397ztSpCzJsut0w4wglsnjcy987njUm5N0ljYa4e5uA3bhVBI+Fe9+h8vzS4gTRrmOgPJxKhjXKGBk3qYkviNTCpCLn1lJO0kWeiYkzsFHwuFaUzonnNupWKRPkk1nGs7yp8P9g8MOaMkQkCt4Px+dd3A6EVNOO/CeSlz9hKvDRoOTOVWom1bUvs6t7zlDQaU0ZhMWE80Ed2af8twRiAXXhKE+PaOgqLynEhKRiduxzHUjx2msUU4YCDMzEUkiHhifLtH0U0oVEInLFlLiuuQJ1CJNhdR0DMFc4IwWMKJAxmMcSYimsh0ZxDeL5Nh+J+wYdJxGYTgTSkdmLaqSZsxbgbapXHbB2SMKKxHf0Uzy88WHL5D9VhCkUtwzo6zgobPJeM1UO4dSKllRe339qah2a7ww88c8XwhNIwvk5IApFwDGl0RzWAfdgzcj6dcWHjezTTEemymA/e6hpUmcEKVyJjT+bphJyw/z2YWzbIuWu3dPkgV1s17o7T1B95CVfOqGQvudSnaPmwetoV2FzKug988uy7woLceIKg39r5e9oRE8gh3c3p1VFBO0rVCMIKLgDtagFAixHZpdgHCGWzV4V3RKH1NLj6Kbqgbuqve+9+XSOxl+C9DP55nWaTsahIMw6L46aUfBYPyqPQhPWuFmZcVobFDmYoHKMBxWmfoZbXVR26DVxyz8ZjPS6WvXasnLE+Nj+liD2bvoX30d9i7eXf7x4aJvYL0FNWjviCYjorDybIZ7d9o//f30undt8MZ+kQFcSQ1JDbkJcPpQKPrlzEiJJHOXG9CyaQB7S35VKm95rZ5J8aAgy9/eY0zTVSmXaItRwmKYLLgtQDAcWpfkItZBprRt5bL0Nh82geAXRZNJFDH1J0nY2Au2C1LmY62wPlYMCRTmN9eToMn4vUFY4xbs/Kp2mh3w+K9z+O+N/LFliuLecVYoMPQtVzEKYiUC6oXkGHoXWElTSRUalykUE1t31+3JnExZXB2UGaQD3HsR8rpN0OLaogTV6DtlJad/4KtRa6qRMYHw/4Rv9bW8Goj1tdA5rExsCn5Pqe6j6AbiYUinwznR8SzIKLgsgEuaVGjozbLy/kyopdImDVj1XqABpV+swVS4F6gw4rU6nChfJIlnhvm//LdKES6w/UvYX7RIkOVGPrAkMaUO+wcNpuBHWAqx0TJ9VAeXjO2gcqOmzXkpuYodwFo+5VaO16zcSK589Rp6OW12dzB3E+x/gxtohtbfEKtQ9qjwGW47gFPGfTNuHLZjDniLfDRNIJg++39Pylzzlgl5jvL/LiHx2wpQtY7VpZg3w2/LkLsQe4Cbw9v6Q2DLzP05U1Rmi93mLWypyb8qE3B9fAcPM4pckOWcK+0oNvL2fNxMizl7xJTYTAsIYlRjbkZ+mbCKiZTkyZAwG1XtNfwZCZGgCmwMqAn2D+ztwIQkCslt/HtgaiuyVbqJGrIxNczMXNdxtHwTcOMfb4tb5J/KvQyi2ih4UHh+xmK34Dnt4ejoCPbXEMY6WssDbHIpiWfgYIAoaNG0CuNN8I6hRFVkvbayWzYC9qQ/cgdFfqAi6uvGil4njN4Zsv6s2u9V5huS5MyvUv8TU6v9vp/sY1eTnTaJESs2TObyS3R2+Rd8wqYLiaR3bxGyu219lpzlt2toLW/ahsszWrh6uxcHC0VXsi1h/M6dcGE4FrHqEntBHo+6sZiH5/3+ZeivHCq0l4TuTM+Tag5ludbCrjDFHpue2p976DQFP5bJdKuN/KB8Ix9UW/qNeWVCmZsX1Iejmm25kaahXortHSOjgs8yUVH0+epTfoMqkst3qB7BrvmosOtvr7QjpcPR1lwFTfN+KDHHVNO8vzAP9qB8YHoGzZsoOri1E0KOsXbirs3JHTWbicbaRHMvm5ZHnL1u2ndBuN9zZAVT9g1PHVt8Tc3V7i0teEF/4te8qDE5d4uCXHsxJcMQ3LlUCpENi42KKTCOmDAWVG3sbJruXUF+hT9xd/gc+vng8LdBd9/+HbSzI3AwOMAUsNrMUbgMU3lrMe3t26EhukVU4MkXRXa0AzsD/x7SE3s08EI7CPUPvDch/w== + + + + ArangoDB PHP client: batch + + + + + + + + Batch + \ArangoDBClient\Batch + + Provides batching functionality + + + + + + $_batchResponse + \ArangoDBClient\Batch::_batchResponse + + + Batch Response Object - - string - - - boolean + + \ArangoDBClient\HttpResponse - - $key - - string - - - - __unset - \ArangoDBClient\Document::__unset() - - Magic method to unset an attribute. - Caution!!! This works only on the first array level. -The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. - - - - - $key - - - - - - getAll - \ArangoDBClient\Document::getAll() - - Get all document attributes + + + $_processed + \ArangoDBClient\Batch::_processed + false + + Flag that signals if this batch was processed or not. Processed => true ,or not processed => false - - mixed - - - array + + boolean - - $options - array() - mixed - - - - getAllForInsertUpdate - \ArangoDBClient\Document::getAllForInsertUpdate() - - Get all document attributes for insertion/update + + + $_batchParts + \ArangoDBClient\Batch::_batchParts + array() + + The array of BatchPart objects - - mixed + + array - - - getAllAsObject - \ArangoDBClient\Document::getAllAsObject() - - Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class + + + $_nextBatchPartId + \ArangoDBClient\Batch::_nextBatchPartId + + + The next batch part id - - mixed - - - mixed + + integer + string - - $options - array() - mixed - - - - setHiddenAttributes - \ArangoDBClient\Document::setHiddenAttributes() - - Set the hidden attributes -$cursor + + + $_batchPartCursorOptions + \ArangoDBClient\Batch::_batchPartCursorOptions + array() + + An array of BatchPartCursor options - + array - - void - - - $attributes - - array - - - - getHiddenAttributes - \ArangoDBClient\Document::getHiddenAttributes() - - Get the hidden attributes + + + $_connection + \ArangoDBClient\Batch::_connection + + + The connection object - - array + + \ArangoDBClient\Connection - - - isIgnoreHiddenAttributes - \ArangoDBClient\Document::isIgnoreHiddenAttributes() - - + + + $_sanitize + \ArangoDBClient\Batch::_sanitize + false + + The sanitize default value - + boolean - - - setIgnoreHiddenAttributes - \ArangoDBClient\Document::setIgnoreHiddenAttributes() - - - - - boolean + + + $_nextId + \ArangoDBClient\Batch::_nextId + 0 + + The Batch NextId + + + integer + string - - $ignoreHiddenAttributes - - boolean - - - - setChanged - \ArangoDBClient\Document::setChanged() - - Set the changed flag + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + - - boolean - - - boolean + + string - - $value - - boolean - - - - getChanged - \ArangoDBClient\Document::getChanged() - - Get the changed flag + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - - boolean + + string - - - setIsNew - \ArangoDBClient\Document::setIsNew() - - Set the isNew flag - - - boolean + + + __construct + \ArangoDBClient\Batch::__construct() + + Constructor for Batch instance. Batch instance by default starts capturing request after initiated. + To disable this, pass startCapture=>false inside the options array parameter + + \ArangoDBClient\Connection - - void + + array - $isNew + $connection - boolean + \ArangoDBClient\Connection - - - getIsNew - \ArangoDBClient\Document::getIsNew() - - Get the isNew flag - - - boolean - - - - - setInternalId - \ArangoDBClient\Document::setInternalId() - - Set the internal document id - This will throw if the id of an existing document gets updated to some other id - - \ArangoDBClient\ClientException - - - string - - - void - - - $id - - string + $options + array() + array - - setInternalKey - \ArangoDBClient\Document::setInternalKey() - - Set the internal document key - This will throw if the key of an existing document gets updated to some other key - - \ArangoDBClient\ClientException - - - string + + setConnection + \ArangoDBClient\Batch::setConnection() + + Sets the connection for he current batch. (mostly internal function) + + + \ArangoDBClient\Connection - - void + + \ArangoDBClient\Batch - $key + $connection - string + \ArangoDBClient\Connection - - getInternalId - \ArangoDBClient\Document::getInternalId() - - Get the internal document id (if already known) - Document ids are generated on the server only. Document ids consist of collection id and -document id, in the format collectionId/documentId - - string + + startCapture + \ArangoDBClient\Batch::startCapture() + + Start capturing requests. To stop capturing, use stopCapture() + see ArangoDBClient\Batch::stopCapture() + + \ArangoDBClient\Batch - - getInternalKey - \ArangoDBClient\Document::getInternalKey() - - Get the internal document key (if already known) - - - string + + stopCapture + \ArangoDBClient\Batch::stopCapture() + + Stop capturing requests. If the batch has not been processed yet, more requests can be appended by calling startCapture() again. + see Batch::startCapture() + + \ArangoDBClient\ClientException + + + \ArangoDBClient\Batch - - getHandle - \ArangoDBClient\Document::getHandle() - - Convenience function to get the document handle (if already known) - is an alias to getInternalId() - Document handles are generated on the server only. Document handles consist of collection id and -document id, in the format collectionId/documentId - - string + + isActive + \ArangoDBClient\Batch::isActive() + + Returns true, if this batch is active in its associated connection. + + + boolean - - getId - \ArangoDBClient\Document::getId() - - Get the document id (or document handle) if already known. - It is a string and consists of the collection's name and the document key (_key attribute) separated by /. -Example: (collectionname/documentId) - -The document handle is stored in a document's _id attribute. - - mixed + + isCapturing + \ArangoDBClient\Batch::isCapturing() + + Returns true, if this batch is capturing requests. + + + boolean - - getKey - \ArangoDBClient\Document::getKey() - - Get the document key (if already known). - Alias function for getInternalKey() - - mixed + + activate + \ArangoDBClient\Batch::activate() + + Activates the batch. This sets the batch active in its associated connection and also starts capturing. + + + \ArangoDBClient\Batch - - getCollectionId - \ArangoDBClient\Document::getCollectionId() - - Get the collection id (if already known) - Collection ids are generated on the server only. Collection ids are numeric but might be -bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used - - mixed + + setActive + \ArangoDBClient\Batch::setActive() + + Sets the batch active in its associated connection. + + + \ArangoDBClient\Batch - - setRevision - \ArangoDBClient\Document::setRevision() - - Set the document revision - Revision ids are generated on the server only. - -Document ids are strings, even if they look "numeric" -To reliably store a document id elsewhere, a PHP string must be used - - mixed + + setCapture + \ArangoDBClient\Batch::setCapture() + + Sets the batch's associated connection into capture mode. + + + boolean - - void + + \ArangoDBClient\Batch - $rev + $state - mixed + boolean - - getRevision - \ArangoDBClient\Document::getRevision() - - Get the document revision (if already known) + + getActive + \ArangoDBClient\Batch::getActive() + + Gets active batch in given connection. - - mixed + + \ArangoDBClient\Connection + + \ArangoDBClient\Batch + + + + $connection + + \ArangoDBClient\Connection + - - jsonSerialize - \ArangoDBClient\Document::jsonSerialize() - - Get all document attributes -Alias function for getAll() - it's necessary for implementing JsonSerializable interface + + getConnectionCaptureMode + \ArangoDBClient\Batch::getConnectionCaptureMode() + + Returns true, if given connection is in batch-capture mode. - - mixed + + \ArangoDBClient\Connection - - array + + boolean - $options - array() - mixed + $connection + + \ArangoDBClient\Connection - - - No summary for method isIgnoreHiddenAttributes() - No summary for method setIgnoreHiddenAttributes() - - eJztHGtz2zbyu38F3PFVUk6y00zvZs6Oc3VtJ1HT2hnbTS9n5zQQBUtsKEJDUHbUJv/9dgGQBAmApGxneteJvlgWgcW+sNgX+PSfi9liY2Pn0aMN8ogcJDSe8qPvyeuXr0kQhSxOd4kI42nEyIQHyzn8AONw6HcLGrynU0ZIPutQTpAP6TKd8QSekR9oTM5TxuY0jiuPnsO89+QnumKJfBLwxSoJp7OUHObfnjz+5kmfpEkIS8WCvJiPX/bhccSnMeuTFywBuCuYvbOxEdM5E4AVqyC0l5P3hkZLRvj4VxakJGGLhAl4DuQRmlEZ8CiCpyGPB2Mq2KRK9tNx8qwVBwBegI8Iebz9RCIYRFQIcqThkXC+iBh+E+TqB8HjcwZERuFvdByxjd83cKZEGz+PyMWskAAJJ6Q7l+wZM3Ly848/kmvgaMxu8yGipydm87+7oQkRwEcgdmBC0gN25N9FwlOgHsjeGoUTYFwdFu/Z6qHQAFBePOBZAyIJuwkFSOxu2MzDD8zPBYDdsDpNgZzxMmWCdKUK7tygmrkXo0lC/aSqiWSfXL6zF30e0SlJOQnjSRjQlJHbGUtnLCkwuaWCBDPQRAAW8YBG0cqFw5jzyItCNn+fXNNIsLugEQrYTibfgS/sBkaMGYuJoDcAHgDAJCJYAg+cnKrFMhQnAH8f7MJyHRSBv+GE4uYm/LpAT7NdzPgymqD2LFgCujPP1QIEDkQFYMngYbpMYkCCx30CUicziuTqGRT3/ILFNErXZ/2Ev1H4MT/3D2KlQmASZzQlE3YdxoD67SwMZqYmFrSkCaMIH9CchZMJi7fX10s18aAAv6aGqvlu/MJpzBPkZwLzgmg5ge9hDHta8xn4QQeCpWJ9JZGQX9q4e3h7ZJhXIIF9KEEOeCxScnxycfZ2NDwCKB2wkJ0aKGge68G8On4r4cBIB6CzzKo1onN2/EbCAVvlgKP2SjNN5yfHvyiycIIDUFWKDQBfDo+Ojk8OLi7Oht//fHF8LmFXNen+ywxfnJyeHTsXcyuAY8lbGqbPeXK+igPCF9I++BY9fX0xPD0Z/XIwvBg9Pz0bnb89OcTFDBCOBRY8CoNVS9ivT38cHkrNUNMc8N4ztjhZRlFLiK+Oj1/LExFgZlMdUA9xTrIMwCMBU8fmi3RluD/l3begCZ0rs0G2FBaCFJ+BxoxGfUAuTMGzKYbhuVyBS5o+TxfPTvV0mjCyq/ywlnOj8JlD9QDJc5YiqYoMOBJsQ4W4BtqE5n7E9nore/QQ1sfzCy0mmMNbe/FtcsSu6TICecAYabWe7gDENXhWFpu2kcsxqBW5XsbSzyWjUZAJvlsR6D6JQVXU+axcUvyE16QbipEc283G9nrGCPzs7Eg1RU8Pj/oYPOolqGkiAmnv4dyX1g0ZPAZH+pYmEzEI+HwBB/Q4jMLsBC0tCgdBvuJlxxLpOwsL/GylcHwPnsHcqgzqYe2VIH1qQkew6Hp312387o5YPdR7oOg2nE2IDp26vN4K90EaT6lGHPEAq52/JgadkfYcWb2GlV0453TfyurbJ9unokHKkxWZgyfFpd+cb9aql70U2V7TDu0C4k3lay/4YhkhVqFlyNNZwm8FUZHr8YeASaRrzb0GD/YrM+36F5dhd58UrvOh5njIgSm3MHeyPh5Ppuzji4QuZi4TJ1KwJYalU4b8ecLnB8p2Kbz7VezQva0ava2cz/uS7Qp2Yf4KwQL+jII7noFH13sLvcH9Z5p3VRXKYUv17eLgfjZ0z1ARGxk54VDFbF08TXp7xSjNrHzwnkfHDiMeM9AmD9PPJBghNSvAoVWhzOk0DDySuuHVFIN9+iDMrsVvvaXAcdXH0J71TDLV8wycYesZHEkTDidRqsNkSVIe8l5j+ALhCvOw6QU6C1nyIs8e5eFkaiQFqjHWEILzENw1XJov0wXGjdZpX8P2ItkgyA/npycDFgccIyWFzToCyZMvJTgV0ftElfJzOd2SVqZqivkpx4RWt+dTuHuQ1mhNcl8ueygDZcl9jOxzk4hrT1l6AL9nBNb7VVUPtGG08vxURDuMU5YAdiWfTz+TiIR6wL2dvz/C4Xy6U/UzH0LZtA61sMx6rV9h+Egt0dV6qORruKjrKiTFDJXMyn5RyD+XQmKBw5BtS5U8z2esoZj5MvdSSyMmvQ3TmfxN84tjCjBhc36TZyzd6mnAGJgAzeyfe6YVPXv4q4Z7gbv5eh1GoG12TFEA6XvxcPtqjlGOqZv7ykEg/3Q93SWFuCzcTDcLA4aAL2Nw3KpAeuQZeVz19gr/0FoTPcXKjyd0bvmL2ao6TCn4dOma7Q5Z8LOM283fs2aXQyYzjMm/SuCkBL0plrXciWKub4vIDI6jGFPRT6zYyHpVkVaMJWPnSyELRpljt13MCIWy0lnwVoRWmbtXAKPxhKjik4yn4P8MDstCKpRYAQGAh7GEbOXj14nItD2T4QUx950krzJYVrqIDixgsPqL4ZaPba29eCtsqexI1FY7SHakjBzMVkdkaaAs5GooPNndzWZ164ImiQPgePn4HdnfxwRxp4pANkQ+L+UNjhpSDvq8HE4KFKzhipnVDEA7BF4dv22HwSu2+kwonB2/qUchq1h8pvVl7qZV5mfN5R2IIBKbmcLqANGlLJvaBOuRKuC/RPTf9cjHj8T1QJ477kQAfmAToOE0o1IfxUa1VlVCG+kC4GiqBOwaY4tZwXMJ3QzZdU1wn8g4VKeuLIOMFhA9bHOQ8o1pFKEBRPR0rwY4f2Cjl+gpo/MDIXQGZ8KCiEobCLOcRfnrMBFp2aznZgu+z+lioRxwFGQv93yj1R0NszP4/t+y1qNRk70utpQrG+XLjTQeww4+DCTteKI2kaUYMiiOYEPTZHUrvDarhkJmW4CCWlZMNYXuGod3b1c3bjn/URrrPIv0+CI91Z6lzdvKrd7TJvVuqbh/sMBGI5/IyjLIR+X8rTJ4KLCvbDplWI4arwg2zCCVSuw97EiQNVD8iiVWGgRMiHAcMWwzWLAkDe2s3b0Yhu0MjGbND0IFx4CGDHxJF48FbGlSXOo1sElr74PpdvmEsXVZd1W4lfmnkpHnOjigRqyfW+hDukQKNjc3tQ/Ok/cCJBCtUAx4KEiLriPCiN2wyLDuKBt2zRKUqbVccSiEChI2l2CbXx+1Tx0B8DsXMiUhQ0M8LSccMV0upIfZK8JvFb/vGjV1TPFLPqyzubas7jdLljpQc8hSP3HJsdawuA9LN4JqH7dLbuH55Mhk9Yn+PVPx4jTbquakstXdny9ZL9+a/qxXnpXJpOURv+5cbDowMXnVIv0FvqbcwLJQktzAritV93NV4dGEVCVEpOYx+G+78EmsQeqzb5oeNdDX+aX3ye/NVepPBjg7N6TXdYFzACpHFc2dEzahRTHZsMCE4anwWZsuXJhI5LH0NmIfQpGKrhWddKz91rcjGE1P6UEPM3F51dyC8g5zctVfK1HeHTG2TcSdULbBtMH5wYXmU/82onPbrLsJ0A1LscT5zBLm3Slp3uJ3oalFe0t76lzJ7PUIe2iSnMRYaHpaEsCXylfYr4RChjUF9TY3J2wancXo9ElHD4evtWhVbKpj0++rlIg/947oNXdm5CuU84bk66/JY5nHAUd/wYUOkjsjTCnCs80wzoy8ip5NovsKM19SXjLSmXoxPy0S8Ioznh20r09NuxUFxZiLz1eawVF9h2r4M6/Sm5aZr6J5w7n4pWqIfkdKQ+siDzntDt6utKghONAJ7oQd5eA3xLJUCB6EYHhv2AO6U895MpR4/KyDjIorlUnl0sgmlFU532nNOl1KsMoudpmpLH7BPnKXdgYcL0vZecY66ChK3BE6jbWvS26exCfOUwMxyF0xIx3QAg/zv/pd9Km8SYx2ok0Pgg+immvoZl9Gnpn/nnVj63RoWO42UikeCF4gTs1b435J8OeEyFtnX+K6P2Vcdw+jJAWX69V5OjmUtxMrmuXDbMKZytbNKC4Z1+cvlM4ciFOpvW1Cxy0IGYFPxT6rtkzslTawrr6rST1pZKyqe5ZxZbfkSmhyu+7jKtu7Cl5d2cNowrCSKGQrWCaCJ+695+zIyEXX1GbRph5rHdrWkp6kf304izJpLsu/aGCOO0PRlh1eNbP7NCoklnPETYG7m7ZKtrYWp1B4GubXQKw2QeFATylYZpA9HmCT9vj6/N3Q2miShwzQpy7i2vNHTfX7zy6UulhR1NF0669ruCHYJv5kPdfu8lmlHFSUaTNSawuqL1pQZqCanTuhcaXVuArc1+UDjlcxb0PBakmbFqS1I6pJPOr6YZNw1KiBHCdPIbTTWIDBIBgTI0DZPWyh7guQq3gbzfWd4lwb8f8mEfmpMwW0DnlesSgaGoRSi3Qukswdsl8DkA0tup9UP5P2C8KJtMdxCXEFAjAUukaiqul8rnXOhn6nFqdwIi+cNKK+ll4YbTvhpK5pCVbP2wUxnCn/jJMr/obiG8q5QmW3c64uP6P/pBjWwNtO2U0p4be5SNh0NKdpMOt2dv5zSQe/HQz+/Xjwj9Hg3e/f9P/+7aerHePH3e3vrgbd3l/7+3tbm4+uOn/BQU/+9u2nrZ1OX5KxBh1D1cBG5M33tHRvB6jpeK6uFJyDvaaEi7ut2ZBYoi/qZg1qi4HdHfTWhn/n3jyX5jrA30F1Zb+Xp8jrCmxN7c1+33LkYtbW3xome1ShXn8bVBVRfiBdxZi+XlnVRaNCW/Oov+ZkcFgq0sWOhyhhdLIi72N+G1dffWG8g0DFwVMWs0Tqpi5+q1dmyHr4dnk4XgwExqMQirfY4Ko0zl9kYSDTz4rgmiXFnOFkJxs39FnXvJHeRWeflF/EYnomeeiI2R0dPlqvoXGcfoWlbjoCvZbELxrZGtwkmxaky2TvWrTbr77x045bvYH4GsU85PENi2FbBMy80oALlO+9gF83iZiDH0iyfDUA7CQq9FxLMA5lVhDXUuhsyp9aqV9KIhtkWuFxk3KXzI1p5RRHe6QqVsddRdmXqZmBaUgtBJH1vRdc7QjV3ISjSqvLHSXtZh6990DUeDKmqt1qJ+/aOf5A8V1Yu5jIyQAjVENgVdW6cCgsYC37WuX7Y4rOOUARnQ2r0agq/CyZdj+Rbzdu5gcwYA12K2fsgdynxT0bUAenOWnBjM9j2ZotWhXfxpi5ZCQabfqhObyNgXJMiIEFCRCGb4PKOJTBH8v+QmxrjvHK2Wh4cjH66eBf2+SCA6EgnnG00t3YtII7dnfc4nXkPjyS19XUhixenbQU9n2vivxKID+DBTs07Kslye8iMBrdLdMG98CNYh8WEV7S7Eg/Llf6PnniugJkzm4KEaw3wlW4Y7xSqYWsm1wzJQ/RJwzOVR1qrEjE+XvyldaJr3J75RC3aal9ws6uJ7lEXSri4HX3QfEmvHtFxcU9DoDnS5eo+/WFSyxflNfSbBUv7Gvrc2X6bBD4GbQ5J7zBQjfQWt9c6bHKWN6QHhYeWDHDVmOaqCa5/E2RqBHVV0UqX+WaBp5e+y9Fvv/zIt9DNm/+aigPW+MKc20V7tMGbANZZh7JwKCbWcrdXflrn3SuUv0C1yv9ptTxVTYII+//Av+Z+fo= - - - - ArangoDB PHP client: connection options - - - - - - - - \ArrayAccess - ConnectionOptions - \ArangoDBClient\ConnectionOptions - - Simple container class for connection options. - This class also provides the default values for the connection -options and will perform a simple validation of them.<br> -It provides array access to its members.<br> -<br> - - - - - OPTION_ENDPOINT - \ArangoDBClient\ConnectionOptions::OPTION_ENDPOINT - 'endpoint' - - Endpoint string index constant + + setBatchRequest + \ArangoDBClient\Batch::setBatchRequest() + + Sets connection into Batch-Request mode. This is necessary to distinguish between normal and the batch request. + + boolean + + + \ArangoDBClient\Batch + + - - - OPTION_HOST - \ArangoDBClient\ConnectionOptions::OPTION_HOST - 'host' - - Host name string index constant (deprecated, use endpoint instead) + + $state + + boolean + + + + nextBatchPartId + \ArangoDBClient\Batch::nextBatchPartId() + + Sets the id of the next batch-part. The id can later be used to retrieve the batch-part. + + mixed + + + \ArangoDBClient\Batch + - - - OPTION_PORT - \ArangoDBClient\ConnectionOptions::OPTION_PORT - 'port' - - Port number index constant (deprecated, use endpoint instead) + + $batchPartId + + mixed + + + + nextBatchPartCursorOptions + \ArangoDBClient\Batch::nextBatchPartCursorOptions() + + Set client side cursor options (for example: sanitize) for the next batch part. + + mixed + + + \ArangoDBClient\Batch + - - - OPTION_TIMEOUT - \ArangoDBClient\ConnectionOptions::OPTION_TIMEOUT - 'timeout' - - Timeout value index constant + + $batchPartCursorOptions + + mixed + + + + append + \ArangoDBClient\Batch::append() + + Append the request to the batch-part + + mixed + + + mixed + + + \ArangoDBClient\HttpResponse + + + \ArangoDBClient\ClientException + - - - OPTION_FAILOVER_TRIES - \ArangoDBClient\ConnectionOptions::OPTION_FAILOVER_TRIES - 'failoverTries' - - Number of servers tried in case of failover -if set to 0, then an unlimited amount of servers will be tried + + $method + + mixed + + + $request + + mixed + + + + splitWithContentIdKey + \ArangoDBClient\Batch::splitWithContentIdKey() + + Split batch request and use ContentId as array key + + mixed + + + mixed + + + array + + + \ArangoDBClient\ClientException + - - - OPTION_FAILOVER_TIMEOUT - \ArangoDBClient\ConnectionOptions::OPTION_FAILOVER_TIMEOUT - 'failoverTimeout' - - Max amount of time (in seconds) that is spent waiting on failover + + $pattern + + mixed + + + $string + + mixed + + + + process + \ArangoDBClient\Batch::process() + + Processes this batch. This sends the captured requests to the server as one batch. + + \ArangoDBClient\HttpResponse + \ArangoDBClient\Batch + + + \ArangoDBClient\ClientException + + + \ArangoDBClient\Exception + - - - OPTION_TRACE - \ArangoDBClient\ConnectionOptions::OPTION_TRACE - 'trace' - - Trace function index constant + + + countParts + \ArangoDBClient\Batch::countParts() + + Get the total count of the batch parts + + integer + - - - OPTION_VERIFY_CERT - \ArangoDBClient\ConnectionOptions::OPTION_VERIFY_CERT - 'verifyCert' - - "verify certificates" index constant - + + + getPart + \ArangoDBClient\Batch::getPart() + + Get the batch part identified by the array key (0. + ..n) or its id (if it was set with nextBatchPartId($id) ) + + mixed + + + mixed + + + \ArangoDBClient\ClientException + - - - OPTION_VERIFY_CERT_NAME - \ArangoDBClient\ConnectionOptions::OPTION_VERIFY_CERT_NAME - 'verifyCertName' - - "verify certificate host name" index constant - + + $partId + + mixed + + + + getPartResponse + \ArangoDBClient\Batch::getPartResponse() + + Get the batch part identified by the array key (0. + ..n) or its id (if it was set with nextBatchPartId($id) ) + + mixed + + + mixed + + + \ArangoDBClient\ClientException + - - - OPTION_ALLOW_SELF_SIGNED - \ArangoDBClient\ConnectionOptions::OPTION_ALLOW_SELF_SIGNED - 'allowSelfSigned' - - "allow self-signed" index constant - + + $partId + + mixed + + + + getProcessedPartResponse + \ArangoDBClient\Batch::getProcessedPartResponse() + + Get the batch part identified by the array key (0. + ..n) or its id (if it was set with nextBatchPartId($id) ) + + mixed + + + mixed + + + \ArangoDBClient\ClientException + - - - OPTION_CIPHERS - \ArangoDBClient\ConnectionOptions::OPTION_CIPHERS - 'ciphers' - - ciphers allowed to be used in SSL + + $partId + + mixed + + + + getBatchParts + \ArangoDBClient\Batch::getBatchParts() + + Returns the array of batch-parts + + array + - - - OPTION_ENHANCED_TRACE - \ArangoDBClient\ConnectionOptions::OPTION_ENHANCED_TRACE - 'enhancedTrace' - - Enhanced trace + + + getCursorOptions + \ArangoDBClient\Batch::getCursorOptions() + + Return an array of cursor options + + array + - - - OPTION_CREATE - \ArangoDBClient\ConnectionOptions::OPTION_CREATE - 'createCollection' - - "Create collections if they don't exist" index constant + + + getConnection + \ArangoDBClient\Batch::getConnection() + + Return this batch's connection + + \ArangoDBClient\Connection + - - - OPTION_REVISION - \ArangoDBClient\ConnectionOptions::OPTION_REVISION - 'rev' - - Update revision constant + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + string + + + \ArangoDBClient\DocumentClassable + - - - OPTION_UPDATE_POLICY - \ArangoDBClient\ConnectionOptions::OPTION_UPDATE_POLICY - 'policy' - - Update policy index constant + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + string + + + \ArangoDBClient\DocumentClassable + - - - OPTION_UPDATE_KEEPNULL - \ArangoDBClient\ConnectionOptions::OPTION_UPDATE_KEEPNULL - 'keepNull' - - Update keepNull constant + + $class + + string + + \ArangoDBClient\DocumentClassable + + + eJztW+tz2zYS/+6/AvU4JynVw+lMZ26UyK3jOI2nTeKx3Wt7SUYDkZDEhiJ1BOXHtfnfb3fxIECCspzmPt1p2olEAovd3y72BfjZd+vlem9v9PjxHnvMjgueLfIXz9n5q3MWpYnIyjGb8TJawlsc8P2aRx/5QtiRJzSIXvFNucwLxl7Cq4/sNb8TBT2XSRYJxtiT4RNFZbS3l/GVkECrTuipZeW8yK+TWEi1fJIt2HyTRWWSZzxNyrs6PyzEkVnZrD3ai1IuJXtOEv2xh29oOfw8ZmerdV6U7GAa59FmBUROaHRtXRo7on83UrAX7lg+SwWIUKNLy7ELEDjPYMbb2e8iKvVLM+b7a16wV2W5tsMOpiS5+e0tvN7M0iSqD4GV60u/TPmClUteMpksQALJkjn8TjSs7IZLti7ySEgpYgbay/JyiNjrJ5MjVhYbwfrqlTMW3syBngjJMcvzVPAM+LPjffaL5JqXwn3PJopcQIarpWC8KPgdy+cKy3MOasoJRhlaX43W6OBg2bJ8NQDWf/ehZfFM3JYarzWunMShRZOsFAtR/CnLAq31YIrTLLtnbQjURgVYOM4C4p9sCgk6yddomV8IBEXzrSK5DZAozzJBe0JrIbT+STXoYFrNaGGiGtDcP7ik5FlSJv8WLBZzvklLds3TTavxAUEzoWU9S6+yu8Cqaue+ARWd7a7zrao+Q0s/DOAKcAGVTVSCVufwv1o6gYccnNiw9pvN7iwS8AQNOOLrckNsFOJfGyFLxuelQB5BUGAgHlrJchYn5KvIFfTBqsHNEZkTIiImRwQKLgc+GEYJY2narGAfgAcv0cP7qNALT/eOsZAjcryP8sY3SZqyVQ5satE1/+CrwL6KGGQocz0DOFkNXfKWEQZUVzyLOVC5G9b4UUzT58AIAh93Z5nHFfaR0Qg8H7JLAaCLNL+hEXr0uCb+s/XRW4uTYGP7PE2OOtbmOmzArtCrgliFWOXXgk2TmAHzbFqIa8ZLMKfZpoTgNy/yFYyRqGcTlSQ8ACVl4DTpdQXokL1QNiGRNKlw+GwEa3t8uIpGVi7xt9GINaJktRIx2k16pw1p5lggWhTB4i6IkSKwHs271HLD+CQDwTibJ7cggcJf4k5EXJd5GuPqaHGVx5VD2o1J3JGoqtpLYBrsJAM+Z8LsSGktoPn5ZSkyBZrSIlpOTGzFfYf2SkRLUJhcKQPFWA/rXK7Tl8j4MfGNYAgeG6ayvFjxlJInkmsbF2cZ2Dxs0ohLIfuKH1pIaxtsH7KXQnAMjmtRzJE27nxYi8/yTcm+fYSgP/n2UR/YX4uMgANxFPsEKZoU7Ahe08pofeS7KJVOmESHTafW9rvhrdw34SV3okWPiKm0iraaa2kwAu3jqfPWuGD8WDdsX1uzUa8PnVfOFsZXxMp0JYqF6Jp3fXaAkA6OFsKPa91er6IEDrngIGQ16/TXq4vp2cvp6a9nl1eXzlBNzg0cVoLGqIr3iSOIjjH4gSys2xh7xA57Dnzuql6ikokb9t4zxAYth/FPe3XuJEBiNdl1tNpzOByNGIyzQSby8g1whwYGMFt4V4Bfgg1IgQJ3YppHsBHyTAwbALanG+rBeHz65urit+nl8Zuzq7N/nmKm2cWg3mvo4EMdUd/gJsrkWjB1x3Y9vDRq9Qh9KdDN+ekP+SxhEDBeuIs7O70jZ1RA1m13Vu8h4bI+Vnl9Xbyoh+Ht267f+gbVeDoCTVwOHHj14jTjaStCFEkaiQi67xzyi3xdveuTQ8VnVgU1eaWoF4fvSfTxeNusEErbwfLMIAwQuAjK4bq9hyPiCu0AcuaGsSVUYVhdzQREpqokuhNlH4IEmLLNiDDUQZTja/T3MATSQNhoKdL2BWF8wZNsGMDUgtiQ20GxXBb5jWQK99PbSKwdi3yIKTZUVYELHiZaiuhjrSRN1CYjzAW5kOGQApmFEdBbQKgVfZx5IzqFIPSq98PK6ziONpHHRBPA+dvfmH14YqZBZGjxFMICRUHKtYKwJWhrMF8JTXLbNUC7nROeIe/+5oBEoFx6ed1zAw0OVtCAlJ1eq+FdEE+SHGC/ibBGF5MMsCrIwvOIagTHt9VtxygdXfFWnVc413eTWlXJMnECtB7fdEeh/eYRmUzu2YD34BDYmp8vtmNJNcldC1EpiRVRW9brPG4BoEWwY+2TZOVHMEsGmaSJU0rKHVRN2wssO2/Ukm1oKPiJ362gVJ4z7FmlVX4z1XK2HYXxB/veB+PwV6V1pLk30jqyE3ml/L8oZKdNwZCJ5FqrAkJKLBqiqkzEdu7AEMpGe+XhcBgFKno7oqInaVjUzIfi8gPiolVuCle2gF/ZNn1/Rjp2PwyOg9uSirkYLHzLeLDwDadXFxxdX6IrxcEOZvEgRO71lO3+rx0fI7cLUyLPMkLIpdHuMWmr1PcEzR9c6I4ZQaC8KMZagYkYL+6wzo4TWYJD3CRyCRlYeYOpmq730XtWfkYHkr+ywQI2pZuI7t56rnr/tNrDNlhoZrPSdXvzqnT/TNeUVA0S20kfYOvGtHUorU05NZkEFgaxao2VRSKuRYWtmhQGdkXtpANbXTYbtjsnrbWWfNcl2oZwbY6t+21X/6HQ6eM3Rg1Yv/pmXSw7xS1frVMxtq3xHlWjZfPAYkfEvHr8y4Dnd15almqDtLVR0ELnoSAfUxFFgJmOOTYxPWPbitxKlMs8ZtjNhUn6l7Z0Q7H7w+lVn52/vbyCfL0XpmPGKjqWF2yWU0cQ/GVV8bkstijJPUasD9GF3ftaZR0u9FpyOmKlq8XvW/7relwXYjFdUQTrPBpN+ToZyQRNdtT97vyZ+nr0/uZx70/1Ep/GSQF+ip4+Sm47FXH6tvDyIyztvkrAQYEPw3fvOmp250OzkPPfgw11OvWOjzK9uzX17Grjv5rgDPZd48XYPFHidBodKW0VWKh0wBQ6qvSkVSaNdZr1p2KnAxbQYUP1O1hh4lrZBmzFVkRNn1SnjnMSOeXdxoaT/Vp/cTymo5oGrsQkLvNmsxIFGIm/ODq+xnDv/ddf+yM+MYHnTveuEuWbrAww3quR8+Gc+Q7aIemAGuLAm+l8WrF+WtNjW5BAnYVbtSIHZdJWfiXStcC26NufHOs60OcEYB2vrq7OR0+GT9g3h99AXYh7WMRkL0DkaWPGEKZgfxY385iNpvFsNJV3shQrtQ/NOdPocHS4nQqkFSUMHKBZjtEvgJ8gsqPfZZ49ZdGSF7A9J5tyPvj7dlKi5Isx2z/cv3dFnciM2UmaS2GGb531x74oirzYH1P7pr8/TeL98T6It9/fV1/hCx697Y8P+/tLLl/nhdgfP+mzfUVlf/zuj08f4Kc9g1NPPjWW99ZXFzl0x971yl3NnZt1WRPT462hKDPve0bYV76g5h8V8T5751lfJ3KjZIdhQ317jO378/37MB13vvemmvbB9dPNXfrOFeWDF9FDCFY5q4LDDg4VRoW9DKN3VCO3Aist/VydMnjsR58og4atyc1J90dh7vyEg/eal9jkD79U9wJawrQ+QVP/DNixOYmuso9GFvYFordE8X9JyqWV9Udx1zVi9A3Pzd6dOUJX90Lsc3G7TvOYigT9NUCsGg8pquCAfLeaCFAfAMpkVnSrIxC9t20lNafmcSOryYlrSBBIXwkei6Lb0fIPzuJOvaFroynG/YpUMPoRLu+qQWTOxNKukU1TAAha54YihO2H4vRWazdXuaTXTtZ9wizWB1qqfo6rcwadZUpRXENRBhrKM9Nk3CHp/FN1iAambT03hxp0Qu2efOD9M7mJ8N18kzJdv3j34NQNI2xX4FE5HX+zOU9SYHjIjt3ZehH2+wZLeaiypblxwvVNgRtRiOqAZchOubnThUcwSYn3C24yZu0NcrfNYknuQcLXNMb6lA4t8Lac6iTChAYm9xyftGzj3TawZr/RYvROOnY41HBPZsK5sOnCeu0C3Yq1o/B6gf7uZ9WVm5Zes986ctmtZ/M6q3PSOcpnG6fi289T3nfsPUUmVuvyThtup+VQPMpXM7z88QIkUc4BJRkMMLa7+dfrs9en0+dvf37z4vjit9o7ys22UcQ0xHicq0a6dDvgZAoD4hQNsr64n/zBBlcX0A5w7D/QYzg3I7Xh4Kdyt4420OHaeaGqoPJ93rCm6yLlDychiZuZfwtl5aLtT7KRs7hpt41FHQ8+ZohXV0cbn7iP4+Xp+fHF8dXbiyZ/rR7aW7VV6wHTakwOcEjyms3V22ZWinhgmQqR+402MMSBpCJJaYysyVEL/ZsibQI1YT8XqSGtWgXnRAsed+F/OR7/fPHT9Pnx1cmrvlkn0H30bjY7hZbbylzn2L8ENvoKg7o/CdJSSQDIf0LtYrLGbw4bPsY/sqtftA5pYZbHdxaE9qWfwzDvtMubB/ax6tKj/q7qDBYRjs8NZ3wPd3B9xaoL8lb38qPO6VpdjZPXBT6hVK8iVUv3HAxDlPwMsK6Bz+NFY+GzYVAww6DU0VB8cNkItgeAM1Xf6Bk9Cr7OgluIh0PbridllHSVeclT1VgJXLJsyfr0dUsMAJvMdEvDeQuN0HG/lrpoYvc0dbbw7l3OBxNP5om6HFPavx3ACqN7OBwOsx6mmZi5JTHrgpuAapDSUFGqexeN9n8CmX/LzS1bBFI/p8EKZJhAES8nY2qZ6fYVsgIscH0sh38L05ZV13v0D0o0W0/fKjNrHmi4XdVA4a4mNTusW1Iyc7jmIBPnQl1lEbeJLNsys5AL9tn4nzeMdfCk6wu0CbSV+K63aS2Niy2eaencRpP4/zb+r2rLVLVfSG2W3g76s/cN3L/U2tLG8htgrX+h1BTSrR23iuTQvIdrvNRveY62/lWVx/aA1f90xGe+fmDfvIe+owC1M87twlRNno5716FFkpP6gB3ua9zHt3t7WPMK/9Hx0ZSnCZddfQGVHkGS+x5SXr4QmTQbYKbu+WJQ+A9cdS4W + + + + ArangoDB PHP client: result set cursor for exports + + + + + + + + ExportCursor + \ArangoDBClient\ExportCursor + + Provides access to the results of a collection export + The cursor might not contain all results in the beginning.<br> + +If the result set is too big to be transferred in one go, the +cursor might issue additional HTTP requests to fetch the +remaining results from the server. + + + + + ENTRY_ID + \ArangoDBClient\ExportCursor::ENTRY_ID + 'id' + + result entry for cursor id - - OPTION_REPLACE_POLICY - \ArangoDBClient\ConnectionOptions::OPTION_REPLACE_POLICY - 'policy' - - Replace policy index constant + + ENTRY_HASMORE + \ArangoDBClient\ExportCursor::ENTRY_HASMORE + 'hasMore' + + result entry for "hasMore" flag - - OPTION_DELETE_POLICY - \ArangoDBClient\ConnectionOptions::OPTION_DELETE_POLICY - 'policy' - - Delete policy index constant + + ENTRY_RESULT + \ArangoDBClient\ExportCursor::ENTRY_RESULT + 'result' + + result entry for result documents - - OPTION_WAIT_SYNC - \ArangoDBClient\ConnectionOptions::OPTION_WAIT_SYNC - 'waitForSync' - - Wait for sync index constant + + ENTRY_FLAT + \ArangoDBClient\ExportCursor::ENTRY_FLAT + '_flat' + + "flat" option entry (will treat the results as a simple array, not documents) - - OPTION_LIMIT - \ArangoDBClient\ConnectionOptions::OPTION_LIMIT - 'limit' - - Limit index constant + + ENTRY_COUNT + \ArangoDBClient\ExportCursor::ENTRY_COUNT + 'count' + + result entry for document count - - OPTION_SKIP - \ArangoDBClient\ConnectionOptions::OPTION_SKIP - 'skip' - - Skip index constant + + ENTRY_TYPE + \ArangoDBClient\ExportCursor::ENTRY_TYPE + 'type' + + "type" option entry (is used when converting the result into documents or edges objects) - - OPTION_BATCHSIZE - \ArangoDBClient\ConnectionOptions::OPTION_BATCHSIZE - 'batchSize' - - Batch size index constant + + ENTRY_BASEURL + \ArangoDBClient\ExportCursor::ENTRY_BASEURL + 'baseurl' + + "baseurl" option entry. - - OPTION_JOURNAL_SIZE - \ArangoDBClient\ConnectionOptions::OPTION_JOURNAL_SIZE - 'journalSize' - - Wait for sync index constant + + $_connection + \ArangoDBClient\ExportCursor::_connection + + + The connection object + + \ArangoDBClient\Connection + - - - OPTION_IS_SYSTEM - \ArangoDBClient\ConnectionOptions::OPTION_IS_SYSTEM - 'isSystem' - - Wait for sync index constant + + + $_options + \ArangoDBClient\ExportCursor::_options + + + Cursor options + + array + - - - OPTION_IS_VOLATILE - \ArangoDBClient\ConnectionOptions::OPTION_IS_VOLATILE - 'isVolatile' - - Wait for sync index constant + + + $_result + \ArangoDBClient\ExportCursor::_result + + + The current result set + + array + - - - OPTION_AUTH_USER - \ArangoDBClient\ConnectionOptions::OPTION_AUTH_USER - 'AuthUser' - - Authentication user name + + + $_hasMore + \ArangoDBClient\ExportCursor::_hasMore + + + "has more" indicator - if true, the server has more results + + boolean + - - - OPTION_AUTH_PASSWD - \ArangoDBClient\ConnectionOptions::OPTION_AUTH_PASSWD - 'AuthPasswd' - - Authentication password + + + $_id + \ArangoDBClient\ExportCursor::_id + + + cursor id - might be NULL if cursor does not have an id + + mixed + - - - OPTION_AUTH_TYPE - \ArangoDBClient\ConnectionOptions::OPTION_AUTH_TYPE - 'AuthType' - - Authentication type + + + $_fetches + \ArangoDBClient\ExportCursor::_fetches + 1 + + number of HTTP calls that were made to build the cursor result - - - OPTION_CONNECTION - \ArangoDBClient\ConnectionOptions::OPTION_CONNECTION - 'Connection' - - Connection + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + string + - - - OPTION_RECONNECT - \ArangoDBClient\ConnectionOptions::OPTION_RECONNECT - 'Reconnect' - - Reconnect flag + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + string + - - - OPTION_BATCH - \ArangoDBClient\ConnectionOptions::OPTION_BATCH - 'Batch' - - Batch flag + + + __construct + \ArangoDBClient\ExportCursor::__construct() + + Initialize the cursor with the first results and some metadata + + \ArangoDBClient\Connection + + + array + + + array + + + \ArangoDBClient\ClientException + - - - OPTION_BATCHPART - \ArangoDBClient\ConnectionOptions::OPTION_BATCHPART - 'BatchPart' - - Batchpart flag - + + $connection + + \ArangoDBClient\Connection + + + $data + + array + + + $options + + array + + + + delete + \ArangoDBClient\ExportCursor::delete() + + Explicitly delete the cursor + This might issue an HTTP DELETE request to inform the server about +the deletion. + + \ArangoDBClient\Exception + + + boolean + - - - OPTION_DATABASE - \ArangoDBClient\ConnectionOptions::OPTION_DATABASE - 'database' - - Database flag + + + getCount + \ArangoDBClient\ExportCursor::getCount() + + Get the total number of results in the export + + integer + - - - OPTION_CHECK_UTF8_CONFORM - \ArangoDBClient\ConnectionOptions::OPTION_CHECK_UTF8_CONFORM - 'CheckUtf8Conform' - - UTF-8 CHeck Flag - + + + getNextBatch + \ArangoDBClient\ExportCursor::getNextBatch() + + Get next results as an array + This might issue additional HTTP requests to fetch any outstanding +results from the server + + \ArangoDBClient\Exception + + + mixed + - - - OPTION_MEMCACHED_SERVERS - \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_SERVERS - 'memcachedServers' - - Entry for memcached servers array + + + setData + \ArangoDBClient\ExportCursor::setData() + + Create an array of results from the input array - - - - OPTION_MEMCACHED_OPTIONS - \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_OPTIONS - 'memcachedOptions' - - Entry for memcached options array - - - - - OPTION_MEMCACHED_ENDPOINTS_KEY - \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_ENDPOINTS_KEY - 'memcachedEndpointsKey' - - Entry for memcached endpoints key - - - - - OPTION_MEMCACHED_PERSISTENT_ID - \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_PERSISTENT_ID - 'memcachedPersistentId' - - Entry for memcached persistend id - - - - - OPTION_MEMCACHED_TTL - \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_TTL - 'memcachedTtl' - - Entry for memcached cache ttl - - - - - OPTION_NOTIFY_CALLBACK - \ArangoDBClient\ConnectionOptions::OPTION_NOTIFY_CALLBACK - 'notifyCallback' - - Entry for notification callback - - - - - $_values - \ArangoDBClient\ConnectionOptions::_values - array() - - The current options - - + array - - - - $_currentEndpointIndex - \ArangoDBClient\ConnectionOptions::_currentEndpointIndex - 0 - - The index into the endpoints array that we will connect to (or are currently -connected to). This index will be increased in case the currently connected -server tells us there is a different leader. We will then simply connect -to the new leader, adjusting this index. If we don't know the new leader -we will try the next server from the list of endpoints until we find the leader -or have tried to often - - - integer - - - - - $_cache - \ArangoDBClient\ConnectionOptions::_cache - null - - Optional Memcached instance for endpoints caching - - - \ArangoDBClient\Memcached - - - - - __construct - \ArangoDBClient\ConnectionOptions::__construct() - - Set defaults, use options provided by client and validate them - - - array + + void - + \ArangoDBClient\ClientException - $options + $data array - - getAll - \ArangoDBClient\ConnectionOptions::getAll() - - Get all options + + fetchOutstanding + \ArangoDBClient\ExportCursor::fetchOutstanding() + + Fetch outstanding results from the server - - array + + \ArangoDBClient\Exception + + + void - - offsetSet - \ArangoDBClient\ConnectionOptions::offsetSet() - - Set and validate a specific option, necessary for ArrayAccess + + url + \ArangoDBClient\ExportCursor::url() + + Return the base URL for the cursor - - \ArangoDBClient\Exception - - + string - - mixed - - - void + + + + getFetches + \ArangoDBClient\ExportCursor::getFetches() + + Return the number of HTTP calls that were made to build the cursor result + + + integer - - $offset - - string - - - $value - - mixed - - - offsetExists - \ArangoDBClient\ConnectionOptions::offsetExists() - - Check whether an option exists, necessary for ArrayAccess + + getId + \ArangoDBClient\ExportCursor::getId() + + Return the cursor id, if any - + string - - boolean - - - $offset - - string - - - offsetUnset - \ArangoDBClient\ConnectionOptions::offsetUnset() - - Remove an option and validate, necessary for ArrayAccess + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use - - \ArangoDBClient\Exception - - + string - - void + + \ArangoDBClient\DocumentClassable - $offset + $class string + \ArangoDBClient\DocumentClassable - - offsetGet - \ArangoDBClient\ConnectionOptions::offsetGet() - - Get a specific option, necessary for ArrayAccess + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use - - \ArangoDBClient\ClientException - - + string - - mixed + + \ArangoDBClient\DocumentClassable - $offset + $class string + \ArangoDBClient\DocumentClassable - - getCurrentEndpoint - \ArangoDBClient\ConnectionOptions::getCurrentEndpoint() - - Get the current endpoint to use + + eJytWVtPGzkUfs+v8CJUQhtg24d9gNItDeFSUUAQpK0KipwZJ/F2xs7aHkJ2xX/fczyeGc8tAamjFsLY5/6di52Pf85n805n7+3bDnlLjhQVU3n8hVyfXZMg4kyYfaKYTiJDNDMkSJSWikzgP3uaS2U0UCHh5zkNftIpIyTn0bfkdpEmZgYk8HylgtwaxmIqhF0K5Hyp+HRmSD//9OH39x96xCgODIUmp/H4rAfLkZwK1iOnTAH1Eqj3Oh1BY6ZBNquIPchNulbykYdMExoETGtiJDEz5ozSRE4IJYGMIhYYLoUzy1k1hI3O5NhqJiT4QApDuSA0inIu8CcyHbMpF4KL6e7HsfrkmJxPPIHWixy1kGTMp6jNmIGpVOgJU4qFyEoKRqayh2TIoKQB1zphhIYhR3VpRM6Gw2tg/k/CtLHWTZgJZhmtAk9z1ChXdaJkbBXSTD0ytfuiAGouAlwi5MPuH9bzQUTBmQPrrb5VsPNfBzdYt+MDlse4SjZHoQySGHj1LdEkEUGqPDdLt3fP/k40I8f+XjqOGISywteGRQrhQibHf8Mnt5jt+fxIFWAm21QSM1f8kRoGihVc6lJSq4ic47JuYk+VossWzo6sRfkEQi2Mh4nXsk8p69w3ZlSTWCq2AUAKeUANmLBDOGBQJaznBZ5kOzNkNKkwljJq0QDIvwF1XQUHVx6C3BSzgPDLu4sL1MIthhISEpNpRh8BzQJ2N4mP+RMLW+TzsC5aJPEYLIOctlkRQIpCSsyoIQsGhsY0ZDbjEh6F1hVOndQDLYJsPoG6h+R9XaKLIARTLW1ZzK0vcQOcaUMGl8Ob76PzY2C1xcOtF3DbcF7eIJOITltZnh3dfru6GSBfR/AS5u5Flpy6lf3N4PbuYojcU5IG5hugn9lwyeJkdBccSqRRDPzvl1zAHSWax/OIpRjvWSjkemy3KnJycWTVGKG0l5iY8QQuiTCtfPtXd5eWsd3WZJ5ZzlnVPCjjULBCspgxgewgqQxWWq/acwFwyw0j2DbDKWApLVkrLB1+v7bhRLlN+oypZomKyirttrL7cnQ7uLu5QI6OsoHpuYCeAkX5X+bnxoIb203IhCttiiCKkGgZQ1IxQ0NqaDV/51TR2KvAZNMr2Tt+/U57ILqyQmzBYV+RTRSRfsRylmqaIxjXAFWKmUQJiMh46RW6FUxdkU6ZBivrvZkpudDkvtwc79Nfg6eAzettJhlHPMjbHRmNbEhUEphus196Tjtrbf6H0ygFS9pkrfZmxvXOJ6+HQXg3/Y5W2em5EHfin7U9UFZJsUckUeRwgg/UbwA9dKuuJf6hWTTZ38+q2sP2tqddhaeTVyUp5D83inGm/9gqjxBbrbKAqjRArGLRKHxvj1ADo+c4geIfJ9p2LwCTYvkWoIZMb/WEK8agYt27rjqDO7rYWrcbvJKRe37PqDO4HuaYqEtwKQF7fjzUVtE7IK/btchqkp6W+sw34JdqkYCJD0DNTbQkIYuY8WtFJWeGILM8tYq0Lx8PLgbDQTa0Yv5zAdXaH0sJHcskK9j2vZUGNu+2ZGY1B8nntBzYGQbSG+cfOwd5MoKfQi4iLMlhSUamWo9MaAQzqUQALLhmK/M79Ue3mqcI5yITqrjFTlJ+40ezyGZI35S9W4IS3t0mu2Rrbwt+evw93GSPcwR64KC0+AwjEh4WurnzyCaravjclCaOpXVPK1ZOWdr4jTRQrIvhrHJqyo5c5bA6CdBBMXjNHFaGY8pMH9t5LSCOs1cVSylgh4GH3KgGmwR7MqVpRpRm9Xb8rz21wbmWAO61gfYKo0R5rqmd3V6bCXacBm9m+ha9vWQRHvAt7F22ZCOthkjNKJTE6kxed/wl8PuC0FqZDa5WHR5isSJv3lTLZBWJUJthmAzTU4v1he8H9zge1p9XhSu7zeW+QZ3frDq1/pIV1vQ5rBTcgyYdcgNtLS7tyDBYpS53olbPk5YMrIC1j7M3K+Lt5V4OJS7miWnEb2lgSgcwHL0CGRf3CS1Z+yh5WIXlq0Ynd/rKMZV1Lk+Z2jxUuWYoQlR67zXFEVb+6ub8XfPgU27FpcKBpxPAjYfjFbuaJ6UcMJXp7JkwTMg1RDWU+ehu0gVPGQ82//r5Ddj+Pr4dDY5PB1Ut8YE+zSi2jM1s6t6E6DbtrKsISX7oe31/P7AAPQEsHmFgu8irV3Xf9kGN93PpTaN3fpGyJez8MoU75U8NvfPE9gOvF/yqJuClZkuu1UtnJdOwMkkBZ92EFhJIWiPnYD/z0smfYKDQrBtfemRry3Pfu3fZkruF8adiG9PDQurOJ+g8X7UU3e2G4flVo3eFOKs+q+blUrH4bX0nW7D08is1zF1HSbwUMaXLYjxoB1DBE6HdOAXHKRhb209a6amthrAKwG7cUIjX1hRChtcDeGXSOs5nAIITbDGatEDIhreh868vou6mon7AK09tK2nb2imS2st3O+pPaN6/CvZ3KoIsByajwV/XVzfDts7qee+XXDo2jL3rZqyTNCPWjLdF4qw1JL+67GGs7FcsLwZAXb3zcJ1meIPrlIJ/9guFEY041V3/awWoubgCheE++0YomyTG9/5GrBv/A0pyseQ= + + + + ArangoDB PHP client: failover exception + + + + + + + \ArangoDBClient\Exception + FailoverException + \ArangoDBClient\FailoverException + + Failover-Exception + This exception type will be thrown internally when a failover happens + + + + + + $_leader + \ArangoDBClient\FailoverException::_leader + + + New leader endpoint - + string - - - haveMultipleEndpoints - \ArangoDBClient\ConnectionOptions::haveMultipleEndpoints() - - Whether or not we have multiple endpoints to connect to + + + $enableLogging + \ArangoDBClient\Exception::enableLogging + false + + - - boolean + + + + __toString + \ArangoDBClient\FailoverException::__toString() + + Return a string representation of the exception + + + string - - addEndpoint - \ArangoDBClient\ConnectionOptions::addEndpoint() - - Add a new endpoint to the list of endpoints -if the endpoint is already in the list, it will not be added again -as a side-effect, this method will modify _currentEndpointIndex + + setLeader + \ArangoDBClient\FailoverException::setLeader() + + Set the new leader endpoint - + string - + void - $endpoint + $leader - string + - - nextEndpoint - \ArangoDBClient\ConnectionOptions::nextEndpoint() - - Return the next endpoint from the list of endpoints -As a side-effect this function switches to a new endpoint + + getLeader + \ArangoDBClient\FailoverException::getLeader() + + Return the new leader endpoint - + string - - getDefaults - \ArangoDBClient\ConnectionOptions::getDefaults() - - Get the default values for the options + + __construct + \ArangoDBClient\Exception::__construct() + + Exception constructor. - - array + + string + + + integer + + + \Exception + + $message + '' + string + + + $code + 0 + integer + + + $previous + null + \Exception + + \ArangoDBClient\Exception - - getSupportedAuthTypes - \ArangoDBClient\ConnectionOptions::getSupportedAuthTypes() - - Return the supported authorization types + + enableLogging + \ArangoDBClient\Exception::enableLogging() + + Turn on exception logging - - array - + \ArangoDBClient\Exception - - getSupportedConnectionTypes - \ArangoDBClient\ConnectionOptions::getSupportedConnectionTypes() - - Return the supported connection types + + disableLogging + \ArangoDBClient\Exception::disableLogging() + + Turn off exception logging - - array - + \ArangoDBClient\Exception - - validate - \ArangoDBClient\ConnectionOptions::validate() - - Validate the options + + eJyVk99v2jAQx9/zV9wDEhRBWduXie5XR7dWVTVVyx6RoiMciTVztmwDRRX/ex0nDZCm05oXR7773n2+d/KnrzrXUTTq9yPow5VBztT1d3i4fYBUCmI3hgUKqdZkgB5T0k4o9qlF9jeN6V/MCKAWToImBHHlcmV8DO6QIXZES2QOoVTprRFZ7mBS/51/OPs42APcLGe3Ax+WKmMawA0Zr9569SiKGJdkfW9qtL2sffyskIc/Gsh/cmH3PsBtNcFGSAkzApcbtWEQ7MgwSrmFTU4MuB9AjloT26b9FvNWcFrM5eL0IjCnEq2tsWoqj+KI5xb2nE9RMbLgo/j68Is2IAnnxQJ4rpUoWoTQS4YHMbgE64zgrLochVMbsUZH0EnKCpfhttnhN7mVKYyWFcCQNmS9FQyMauFHQ4fbP+5uSnklHrZXOcZazaRIYbHiNHRIEqfioOqdhIRyCMVXFU+Syf1VHCcJnEJ3DF1/dJzf5fBLRu4+eOudlO52rR5jcsEFv2+a3s5/qirQtRLzf3q1NW+nrNh0XPmqNgafoXO4u130xvbeh1m7e1vSjn8w7vZNHeO/QHvs8AQSlAJt79VDGI9DeADdqSfzj4rttHpWs+mr7K5f9TMcvmlo + + + + ArangoDB PHP client: connect exception + + + + + + + \ArangoDBClient\Exception + ConnectException + \ArangoDBClient\ConnectException + + Connect-Exception + This exception type will be thrown by the client when there is an error +during connecting to the server.<br> +<br> + + + + + + $enableLogging + \ArangoDBClient\Exception::enableLogging + false + + - - \ArangoDBClient\ClientException - - - void + + + + __toString + \ArangoDBClient\ConnectException::__toString() + + Return a string representation of the exception + + + string - - loadOptionsFromCache - \ArangoDBClient\ConnectionOptions::loadOptionsFromCache() - - load and merge connection options from optional Memcached cache into -ihe current settings + + __construct + \ArangoDBClient\Exception::__construct() + + Exception constructor. - - void + + string + + + integer + + + \Exception + + $message + '' + string + + + $code + 0 + integer + + + $previous + null + \Exception + + \ArangoDBClient\Exception - - storeOptionsInCache - \ArangoDBClient\ConnectionOptions::storeOptionsInCache() - - store the updated options in the optional Memcached cache + + enableLogging + \ArangoDBClient\Exception::enableLogging() + + Turn on exception logging - - void - + \ArangoDBClient\Exception - - getEndpointsCache - \ArangoDBClient\ConnectionOptions::getEndpointsCache() - - Initialize and return a memcached cache instance, -if option "memcachedServers" is set + + disableLogging + \ArangoDBClient\Exception::disableLogging() + + Turn off exception logging - - \ArangoDBClient\Memcached - + \ArangoDBClient\Exception - eJzFXOtTGzkS/85foaW4s9kYyO6Hqy0ScuuYIXhjjAsbcjmScgmPjGeZV82MIexu/vfr1mtemoeBrfOH4HjUv261Wq1WqzVv/x2uwq2tgx9/3CI/kn5E/dvg+D2ZnE7IwnWYnxySReD7bJE4gU+CEP/E0BRb/xrSxR29ZYRowgGn4Q/pOlkFETwjv1GfTBPGPOr7/NEiCB8j53aVkIH+9vPrn37ukSRyANCPyQfv5rQHj93g1mc98oFFQP0I1AdbWz71WAy8WYHtG92PqeOFLkPJE+r4LIK+0DgmS5Cn3Jt92Z3ZyollQ+rGAQmj4N6xWUySFSM2W9K1m5B76q6ZQMKfUzREkICE+jZ5cFyXhCyClh6hJBYSAbljU8F9iQje/tub6B0SD5OUI40i+kjoYsFAmCQgThITj3k3LIp1e/m3eSBix1/gI0Je7//MNSg6OdCyn0u5uYwe0MXkSx9F6HMJtv7cQmquW/ygqqDr6yiCpqlN8Eeqxa/3NBLdkL8c8L9h5NzThJGduVTkEbn+CuNmwHd8m32Df6H7qGnm22HgoGhCOcmKJuSBCT3LYUBVdQPkq8VzFX/VhtnQandfjLbgwSFukOMiYjSGFo5PFvBFDLECShEUZMyiezCuhLluTNbcUIAz4FJiO8sl4/pxGbVZtE8+SVmhkS/MQSMqPNlVnz1Iqh6h9u/rOHH8W3iiBN4nwyV23Q78TkLu/OChQKbwlHqS6FG2+JYooZdR4PEfXSdO0BhTBa/9xHGReAnsRJscLGh4Re8ZTlauTaBOmG8yAMdPKoZfatWSTId8II7I67ItCOOkLjlj3oIuVnx44oSiUeM0TOXGp6ApkyCatkocfAj8/bXrlkVQUpIYugxDIcwGBg/FyPeQ/0jOJ7Ph+XhujY8n58PxDIA7SsxOGf40ABJ0amZ80rVZGLEFSGr3wMzSucAVAUOzWy3C6fmUs18BDwPrSRAB6zV6lpfkOjm/4FxDgDdwnTkeC9bSmbbW5mx4Zp1fctxEAAA0tirCj0V/wKaFrcfSUtWshgdL6rjBfWrSDrbl/uN1T8xQWLPWvut4DnoM6gVrP8kiKp/BkatlPukPR+dX1sV8djG0pii64jwDwriiA2f0W4YldpZ0QfiYAbYd7wrfB94gDtHBPFCHOwhYUwrdqhUo1aYWSWu1NGARrrbLtS8WztYjdtEfWHy8kN6Auw1cnSX4QRYlztJBY4u3W8NDN4Ynn+cDSxibwBqwqMouDNzISs29J7Gdj/tnVp73GLBMPaWuC346Zu5yL3YgprHbM+yPRuef5lNrdDKfDj+MrWPkyPGmADflaAaWCydcoanylsJRg8Gu5fo2nY6qOQ6Gk1PrgturRDHgW/4KnTAA4+jWecHT/nhgHafmwCTlrMosBrAOJxhdua6IUGKcoTAvH+Wix77BqtVeg4MLqz/jrBcceaCBDdwvQxuZR+zeidHam+EvrKvhFL4gAyCrxgwD11k8thb7cnIMYoM3HQ0Hn4U/Rfpq/DvGwvFaBETtsD9a1mR8ORohuqI24F+w0EUXsGEHLqzJCMa8TQ+Omcs219CxNbLaaegTeEkeL8SP/qI1/qf+cDaffh4PEBsd7UkQTQHAwGCEa0Vr4NHwbMi9Fl9iDHDTOydsjTb9OJwgWAxEBqz3NFmsIOb8o/1i+74/G5xOh//lk+YG6adA/mJ6/e388mLcH80Vh9+DdQQx3ovyGE5h5KYz6wwZOPH0EaIW7yXRr85H/dlwZAn8q8CFjZ1rkr+/xpAiwRUHHQq44IivOTUu/3J2Or+cWheIjeSXQNOMHMK+7iGIagISDjzpT6efjhX0BIlMC0gBPHkMmySefZ5YCnYGzQ2gg8yOuQprcD4eW4OZ9KgphdExqb3f0qW31ZAXlgRFRE1UOVfqwfjkQCDeuAokpFGTVBxo0hfxCyeaUGPEfEwTeoOxaz0euPT++/6Uj4EtSUyrxexk7xcyOGWLO3JSCzg4tQYf59D+FxyUk/MLPpkGK6C8TJa/wNBgfkPGW+pTDhRwA4ozzNNbOBVHl1MEOf5n1tmgD0IcQ/hzcSVDEo0yFSAV4Z6Jrc7QtGUrfsizlemSDdime9Q71oqt2jlOYYH+nGOu9qLxR/a4gQQh6AlCJhCEODXuIZVgAsoegvccz+bD45wEEwWVDO0NJBBb7CRx23CfzUY5nrPEbWTlBzKq50EbRL03dHFXzWx8PuNhPETX7/uDj8iOIzwOJKlpUYY9oswExmJTrAxKpu5scvMoE6c8CyjzfTyT5EkUBfYrOAjqyXTWjgLagxUI9nPUrUqsJasoeOAJumym74v4Y31bsLDkXMP1DURF6f5tPueaiNaLpJtnL/b0f+rpvINZp713abaON597LLplXdzMHB7esuRYqqS720uRUp+gv0AM33Vi2Gh387jXAqmQNfm6S/75z5QYPz848ZxL0BJgN9OVcncqqDAn2bLl17ST37eKSnMDqlzFSRR4AzTkbkYtspkyEfXoe8nqPoDVgU1WGUTEEgiepB3tZVsSirloUxq2YBAwhn3X7RZHXyLndVElJc6NnMlTzE8scEpKeXoE1lwWx1RO2GyK2WzkRXMuTB2ZLtsJlkvM3uyJJFqwlPwKrT3nG8xPsiOyTtBafEFJAiMT2f37oOAxi9oT7Kdo1uJrTzKpn03XsjUanGj/BNvgSzF5WDHMPeNgi66IDXK8gcbNGjUqtKigmyBwQZ3gTxhO8YIES+qin0T5HpyYtdCkxSmVMiuM0uhHlEYr1XXBvOCeZfSUtdj/k30+0d4u/Ti1uKKS1n6zdjayM+6Dnj+hzavUi6hNTG81q3Xrnjp1Af4Z63RijBcw6dtC1R+qFY1L2g9iUYTQbs5yptsrzPjSeiSkwoObgmK6naHPB0XJ2yH7SiG7xkXH6Kv1kNcNa+aQK83xJwGGNxWqlgO0VzoYAar0KK5pxRnkj4C6u6SgW9iXsijpbrrmv2nQiZnuWrUynUxp/eG/RR1+ks5XhKB4bsZPxzyIiBw8802Df5N6GpypRgsiDCLRcfksN0wtFY4oZ1IkvYf4+3S+wNOLtmHeO/JTlYH2bRv8Ds6QbJ+N55aKRGSKM8dVmAKPGLUxrahJe8RJhGvAQbuBNcHG8J3eUkcHDhg+kRjC+j22XIKOe+IQ1oPxDuQJvxfYeKRgtJp676bl28uLC90DUZ66NgCpnlCaRWmUudeCMRayZBv+9Rf5QQEcHjrxFTqhTIP2HiwOATtZdrcd6cl0D9UqInZqnX/Ene0eybDI+jf1LVXXEUnl84PIA+w/WEbCzOKmH9tmKjx4xbUlR/1yU2FnCZMAWfMQKP0dlkoGmwHSDhGtcAfWFnL0ToWVhTHA0cz19aihtwKlCMNFrnGCGKaCHG/KRKqf6LTKj2+gt3f5n78bRjhnnArySCqvKOvBQdErKEcpVnUGjpShnjff/l3zeFzhvjECVKhnI6e3p5yeUEMxJIsTkF5uH4d+bvP4vaTi7Kcc8nLPoes/tMaqK0C08y34P+H+tK+JH5wExOLrWn40muKGkjC1Pg1b/o1Rgh5rzG+0os44iR1RPHG+tDIg0g40btar1JnQq1dv8rOgztzeHRmYVyU8qsttTBaY8bUZ7TRFSHnRy3qBVb5CvBpbL4imIrr89KyOayvK9lpmUvhfmBgKxVQJmbVbWU4UJ7Cy5WPdNENm3s1e59RitDpS+MBycE2+9qoJeemP4QOEWOZUQ8nLd8yUsiNXXJ+Hh8fWSf9yNOMUNYCFMpgWgHmKVtCyoGUDaEFRA17AbCF3M2Zliv0d6VCe07Vv9sJVuBfCTqDTCkgdUmjh6g2j8pihKIGe+u3EwKR9Tkf/ev26hlAWZWygXEFRA5kvmGgDmaOoQS5UMrRAzlPUQOdrGNpA5yhqhZZ1KWUNN3iAtO6h7dhoihrUtKhgU3ly9QKt5MlS1ACnRQIlkXjgWU+qKwDayZShqJsX6el3S9yUos6X8eqr8qdZ+YUCrk10lC3Ra9eXDEU7XFGDtwkup6gBL9fbNYGXKOqGV9bWGcahangFRZ3Eulxk07HN1oM8gZIXfLTth6aodVmqTqOE2mRroiqj/GlLyuswNibVJRdl0s48FjVHddZQLrBo0GKZoga+eMid7ZgKT7s7Hubwb3GTnW4tK1PGmf1kvA6xwhvTZvyyj/NHWinULriGHeSqFUxjhD1VIKr2qDrW7rynsbPobNbDTOz/5O5VYLTvW1oK1dDDgRvErNMjnY+MhXt917ln1f29yhQpNFQdmM9vculJ6Hz+xIViwXjuMEPW/eN+bO2br2To7qdHU4YcZnMxAW6CRCFBNt/ZSLDBQQ2vII9Xwdq1eRpZZjk65g1sO6lxO5VK7TQklUTrDURGY8qKjAOUsFsWVQh9cEAW1BeXQBx+1qEzBHgXCBRwgJBPGZriEVnbSo6a3nlrLOkPVJ75kdwEMAv5MOFpr76I85wByplV+4IWQxpzHd5G1GapFnk2zS9kxuSnff1KJ1mEhwcH/NiwqR/QpnPY1JIbWbbgBT/GY2aDokwZ/ZzGn1vYA4r06B36a3FMxvPB1H2gj7FIC6syGEOec2PdPqE2qNTpZ2ctX/oQoeUhKWB8rTqCEbiNY73p0aBhrB/whlb5aBST1f5t5si1h424P5C2sJaXOiNdNpytKTCronRPthysfi0dfuS9p66JKs3qHRamWWfToXg+I2w8mwv/zlO5cNfsJ3cwgslZAkiPUQkXqJjH5m1zx1K4D5hfjof/MU1lHDEs/VD+8DXP3GJrYgcexbtwweKObTCDhfvKZ7wJg9C+Vr7pdNRePGicifBeQLQcZ5QzjNjt3MMy8e72wWH3i/1qd+dAjBL8wx+YPOOtElVe9OQHP+kUgQ7gagmiL3F62OyeuUHILzniNLPXXqhv1aagmVjWZgl13M073OUnzkLu659yS0vjAWHzqqt3m2qd9qWrzcnZJGuK0ivR6fpX096jxx1CjmZX/2+DaAaW2IrtkShDeFYYkyaOnqWkDEwbLZV2MS+kqzJr6exKD/CzndVsxprF5kT4PyNhS02UaHfzHTQOm7jHN+GX2A4P9d6njmUug50NtZ6Alc9ZPxMsl6XOlGQWt59YJ80jc15VbjhkEw4rKL8HQFwpwFdEKCwnU8sGxo/3oqt26uVSmuLW01zAXTx/3lHvDkgXcX3mqY8y88uhpDgS7xsoGriQrzaMyh9ZczjOuHY8Ko59vhYXa9Z0mNwUIacI+d3CSwT6m8jxhEg9r+/vW+m/RavlZ9Y8llzzqZHeLZJFZlX2+mRzNJ6Sl6zxCcUMmnbTWoaKg/63R+WgvWzU2fiYv8IEX1ISGPQqz+6lWjM6JC0nX07c5889IZewr5bFEVkTw1Cxu+PwgI/A37cGvb8hr17tOMY6L4f8cHRUW9dhnDJC6HxtEwjt1Nh+JtRP3DRca+VhZrNR1rCkh2oKR6o8VE/J3+Oy6CEtpzKH4u4U3nTGFUUlZUvX0NQbZHpErxy6NHy7eL9wm79rg1VVNaXze690wTF9VQ3gY4Tt3K4j9BURNz/8FWLv+nlvsGlTPac2iVoDlz64/UjIe5dmTyw1IN6aY7YjzZS/dEoVyHe00jryhsim+PmVSV0nrfd55V7VLlAS1ChZi8r98mVXLLTbzydedVJKtsmG86aO6hcVAecvWondNhUmu+XOMi9MHruZAEJY/Ajk7O6a117ZltpqdqR6qjOBEutNbFDWt1REA2rdbTv2Cq1cqVoYf3WT0cR1YxtQUtbZgGxTtIGyNrMjAWqUQUHXcPdS0BrDOL108i+G65opz8JFigzB9y1AF1MbOkzjriFbxh/3SOeLerufurt686XUGvv+P2ga8g0= + eJyFkk1rAjEQhu/7K+ZQ8AO/6lHFam1RSgul9igs2Tjuhq6TZZKtleJ/bxJXLVJoLpNl5nln3smO7oqsiKJusxlBE6YsKNUP9/C6eAWZKyQ7AKmJUFrAL4mFVZpcpS+eFEJ+iBQBztwsICEpSptpdjl4EgRLi7gVRCEldbFnlWYWZudbv3fbb4Fl5QTJwHybLFouneuUsAVzZEfvHd2NIhJbNK43XrUdnm3MjhO3H68mfs+UudgAuy8QdirPIUGwGesdQbJ3N6y8wy5D8t+M4EjnA5k1e6l1yYrS02781epAGuRP5M4o4bGvq+L/+zKKpE8B9Dr9YFTmwpiTl7MVN79FWhu4mPuOPBa8+9OEN7QlEwgwNkzJWDAa10kEBb0Jk/56z4Cd6Akf8Qpu/61SVXdDLMokVxI2JcnQIY6tXgaq3ggFxxH9qcTjePY8XS7jGDpQG0DNhRvrnqc9TtG+oDFuUfXGMGCH6BAdtxGLXAlTv97JYBCyLaitTn/QqlpxsrourjnVH36V7/s= - + - ArangoDB PHP client: connection + ArangoDB PHP client: single collection - + - Connection - \ArangoDBClient\Connection - - Provides access to the ArangoDB server - As all access is done using HTTP, we do not need to establish a -persistent connection and keep its state.<br> -Instead, connections are established on the fly for each request -and are destroyed afterwards.<br> - - + Collection + \ArangoDBClient\Collection + + Value object representing a collection + <br> + + - - $_options - \ArangoDBClient\Connection::_options - - - Connection options + + ENTRY_ID + \ArangoDBClient\Collection::ENTRY_ID + 'id' + + Collection id index - - array - - - - $_httpHeader - \ArangoDBClient\Connection::_httpHeader - '' - - Pre-assembled HTTP headers string for connection -This is pre-calculated when connection options are set/changed, to avoid -calculation of the same HTTP header values in each request done via the -connection + + + ENTRY_NAME + \ArangoDBClient\Collection::ENTRY_NAME + 'name' + + Collection name index - - string - - - - $_baseUrl - \ArangoDBClient\Connection::_baseUrl - '' - - Pre-assembled base URL for the current database -This is pre-calculated when connection options are set/changed, to avoid -calculation of the same base URL in each request done via the -connection - - - string - + + + ENTRY_TYPE + \ArangoDBClient\Collection::ENTRY_TYPE + 'type' + + Collection type index + - - - $_handle - \ArangoDBClient\Connection::_handle - - - Connection handle, used in case of keep-alive + + + ENTRY_WAIT_SYNC + \ArangoDBClient\Collection::ENTRY_WAIT_SYNC + 'waitForSync' + + Collection 'waitForSync' index - - resource - - - - $_useKeepAlive - \ArangoDBClient\Connection::_useKeepAlive - - - Flag if keep-alive connections are used + + + ENTRY_JOURNAL_SIZE + \ArangoDBClient\Collection::ENTRY_JOURNAL_SIZE + 'journalSize' + + Collection 'journalSize' index - - boolean - - - - $_batches - \ArangoDBClient\Connection::_batches - array() - - Batches Array + + + ENTRY_STATUS + \ArangoDBClient\Collection::ENTRY_STATUS + 'status' + + Collection 'status' index - - array - - - - $_activeBatch - \ArangoDBClient\Connection::_activeBatch - - - $_activeBatch object + + + ENTRY_KEY_OPTIONS + \ArangoDBClient\Collection::ENTRY_KEY_OPTIONS + 'keyOptions' + + Collection 'keyOptions' index - - \ArangoDBClient\Batch - - - - $_captureBatch - \ArangoDBClient\Connection::_captureBatch - false - - $_captureBatch boolean + + + ENTRY_IS_SYSTEM + \ArangoDBClient\Collection::ENTRY_IS_SYSTEM + 'isSystem' + + Collection 'isSystem' index - - boolean - - - - $_batchRequest - \ArangoDBClient\Connection::_batchRequest - false - - $_batchRequest boolean + + + ENTRY_IS_VOLATILE + \ArangoDBClient\Collection::ENTRY_IS_VOLATILE + 'isVolatile' + + Collection 'isVolatile' index - - boolean - - - - $_database - \ArangoDBClient\Connection::_database - '' - - $_database string + + + ENTRY_DISTRIBUTE_SHARDS_LIKE + \ArangoDBClient\Collection::ENTRY_DISTRIBUTE_SHARDS_LIKE + 'distributeShardsLike' + + Collection 'distributeShardsLike' index - - string - - - - __construct - \ArangoDBClient\Connection::__construct() - - Set up the connection object, validate the options provided + + + ENTRY_NUMBER_OF_SHARDS + \ArangoDBClient\Collection::ENTRY_NUMBER_OF_SHARDS + 'numberOfShards' + + Collection 'numberOfShards' index - - \ArangoDBClient\Exception - - - array - - - $options - - array - - - - __destruct - \ArangoDBClient\Connection::__destruct() - - Close existing connection handle if a keep-alive connection was used + + + ENTRY_REPLICATION_FACTOR + \ArangoDBClient\Collection::ENTRY_REPLICATION_FACTOR + 'replicationFactor' + + Collection 'replicationFactor' index - - void - - - - setOption - \ArangoDBClient\Connection::setOption() - - Set an option set for the connection + + + ENTRY_MIN_REPLICATION_FACTOR + \ArangoDBClient\Collection::ENTRY_MIN_REPLICATION_FACTOR + 'minReplicationFactor' + + Collection 'minReplicationFactor' index - - \ArangoDBClient\ClientException - - - string - - - string - - - $name - - string - - - $value - - string - - - - getOptions - \ArangoDBClient\Connection::getOptions() - - Get the options set for the connection + + + ENTRY_SHARDING_STRATEGY + \ArangoDBClient\Collection::ENTRY_SHARDING_STRATEGY + 'shardingStrategy' + + Collection 'shardingStrategy' index - - \ArangoDBClient\ConnectionOptions - - - - getOption - \ArangoDBClient\Connection::getOption() - - Get an option set for the connection + + + ENTRY_SHARD_KEYS + \ArangoDBClient\Collection::ENTRY_SHARD_KEYS + 'shardKeys' + + Collection 'shardKeys' index - - \ArangoDBClient\ClientException - - - string - - - mixed - - - $name - - string - - - - get - \ArangoDBClient\Connection::get() - - Issue an HTTP GET request + + + ENTRY_SMART_JOIN_ATTRIBUTE + \ArangoDBClient\Collection::ENTRY_SMART_JOIN_ATTRIBUTE + 'smartJoinAttribute' + + Collection 'smartJoinAttribute' index - - \ArangoDBClient\Exception - - - string - - - array - - - \ArangoDBClient\HttpResponse - - - $url - - string - - - $customHeaders - array() - array - - - - post - \ArangoDBClient\Connection::post() - - Issue an HTTP POST request with the data provided + + + OPTION_PROPERTIES + \ArangoDBClient\Collection::OPTION_PROPERTIES + 'properties' + + properties option - - \ArangoDBClient\Exception - - - string + + + + TYPE_DOCUMENT + \ArangoDBClient\Collection::TYPE_DOCUMENT + 2 + + document collection type + + + + + TYPE_EDGE + \ArangoDBClient\Collection::TYPE_EDGE + 3 + + edge collection type + + + + + STATUS_NEW_BORN + \ArangoDBClient\Collection::STATUS_NEW_BORN + 1 + + New born collection + + + + + STATUS_UNLOADED + \ArangoDBClient\Collection::STATUS_UNLOADED + 2 + + Unloaded collection + + + + + STATUS_LOADED + \ArangoDBClient\Collection::STATUS_LOADED + 3 + + Loaded collection + + + + + STATUS_BEING_UNLOADED + \ArangoDBClient\Collection::STATUS_BEING_UNLOADED + 4 + + Collection being unloaded + + + + + STATUS_DELETED + \ArangoDBClient\Collection::STATUS_DELETED + 5 + + Deleted collection + + + + + $_id + \ArangoDBClient\Collection::_id + + + The collection id (might be NULL for new collections) + + + mixed - + + + + $_name + \ArangoDBClient\Collection::_name + + + The collection name (might be NULL for new collections) + + string - - array - - - \ArangoDBClient\HttpResponse - - - $url - - string - - - $data - - string - - - $customHeaders - array() - array - - - - put - \ArangoDBClient\Connection::put() - - Issue an HTTP PUT request with the data provided + + + $_type + \ArangoDBClient\Collection::_type + + + The collection type (might be NULL for new collections) - - \ArangoDBClient\Exception + + integer - - string + + + + $_waitForSync + \ArangoDBClient\Collection::_waitForSync + + + The collection waitForSync value (might be NULL for new collections) + + + boolean - - string + + + + $_journalSize + \ArangoDBClient\Collection::_journalSize + + + The collection journalSize value (might be NULL for new collections) + + + integer - - array + + + + $_isSystem + \ArangoDBClient\Collection::_isSystem + + + The collection isSystem value (might be NULL for new collections) + + + boolean - - \ArangoDBClient\HttpResponse + + + + $_isVolatile + \ArangoDBClient\Collection::_isVolatile + + + The collection isVolatile value (might be NULL for new collections) + + + boolean - - $url - - string - - - $data - - string - - - $customHeaders - array() - array - - - - head - \ArangoDBClient\Connection::head() - - Issue an HTTP Head request with the data provided + + + $_distributeShardsLike + \ArangoDBClient\Collection::_distributeShardsLike + + + The distributeShardsLike value (might be NULL for new collections) - - \ArangoDBClient\Exception + + mixed - - string + + + + $_numberOfShards + \ArangoDBClient\Collection::_numberOfShards + + + The collection numberOfShards value (might be NULL for new collections) + + + mixed - - array + + + + $_replicationFactor + \ArangoDBClient\Collection::_replicationFactor + + + The replicationFactor value (might be NULL for new collections) + + + mixed - - \ArangoDBClient\HttpResponse + + + + $_minReplicationFactor + \ArangoDBClient\Collection::_minReplicationFactor + + + The minimum replicationFactor value for writes to be successful + + + mixed - - $url - - string - - - $customHeaders - array() - array - - - - patch - \ArangoDBClient\Connection::patch() - - Issue an HTTP PATCH request with the data provided + + + $_shardingStrategy + \ArangoDBClient\Collection::_shardingStrategy + + + The shardingStrategy value (might be NULL for new collections) - - \ArangoDBClient\Exception - - - string - - - string + + mixed - + + + + $_shardKeys + \ArangoDBClient\Collection::_shardKeys + + + The collection shardKeys value (might be NULL for new collections) + + array - - \ArangoDBClient\HttpResponse - - - $url - - string - - - $data - - string - - - $customHeaders - array() - array - - - - delete - \ArangoDBClient\Connection::delete() - - Issue an HTTP DELETE request with the data provided + + + $_smartJoinAttribute + \ArangoDBClient\Collection::_smartJoinAttribute + + + The smartJoinAttribute value (might be NULL for new collections) - - \ArangoDBClient\Exception + + mixed - - string + + + + $_status + \ArangoDBClient\Collection::_status + + + The collection status value + + + integer - + + + + $_keyOptions + \ArangoDBClient\Collection::_keyOptions + + + The collection keyOptions value + + array - + + + + __construct + \ArangoDBClient\Collection::__construct() + + Constructs an empty collection + + string - - \ArangoDBClient\HttpResponse + + \ArangoDBClient\ClientException - $url - - string - - - $customHeaders - array() - array - - - $data - '' + $name + null string - - handleFailover - \ArangoDBClient\Connection::handleFailover() - - Execute the specified callback, and try again if it fails because -the target server is not available. In this case, try again with failing -over to an alternative server (the new leader) until the maximum number -of failover attempts have been made + + createFromArray + \ArangoDBClient\Collection::createFromArray() + + Factory method to construct a new collection - - \ArangoDBClient\Exception + + \ArangoDBClient\ClientException - - mixed + + array - - \ArangoDBClient\HttpResponse + + \ArangoDBClient\Collection - $cb + $values - mixed + array - - updateHttpHeader - \ArangoDBClient\Connection::updateHttpHeader() - - Recalculate the static HTTP header string used for all HTTP requests in this connection + + getDefaultType + \ArangoDBClient\Collection::getDefaultType() + + Get the default collection type + + string + - - getHandle - \ArangoDBClient\Connection::getHandle() - - Get a connection handle - If keep-alive connections are used, the handle will be stored and re-used - - \ArangoDBClient\ClientException - - - \ArangoDBClient\ConnectException + + __clone + \ArangoDBClient\Collection::__clone() + + Clone a collection + Returns the clone + + + void - - resource + + + + __toString + \ArangoDBClient\Collection::__toString() + + Get a string representation of the collection + Returns the collection as JSON-encoded string + + + string - - closeHandle - \ArangoDBClient\Connection::closeHandle() - - Close an existing connection handle + + toJson + \ArangoDBClient\Collection::toJson() + + Returns the collection as JSON-encoded string - - void + + string - - executeRequest - \ArangoDBClient\Connection::executeRequest() - - Execute an HTTP request and return the results - This function will throw if no connection to the server can be established or if -there is a problem during data exchange with the server. - -will restore it. - - \ArangoDBClient\Exception - - + + toSerialized + \ArangoDBClient\Collection::toSerialized() + + Returns the collection as a serialized string + + string - - string + + + + getAll + \ArangoDBClient\Collection::getAll() + + Get all collection attributes + + + array - + + + + set + \ArangoDBClient\Collection::set() + + Set a collection attribute + The key (attribute name) must be a string. + +This will validate the value of the attribute and might throw an +exception if the value is invalid. + + \ArangoDBClient\ClientException + + string - - array + + mixed - - \ArangoDBClient\HttpResponse + + void - $method + $key string - $url + $value - string + mixed + + + setId + \ArangoDBClient\Collection::setId() + + Set the collection id + This will throw if the id of an existing collection gets updated to some other id + + \ArangoDBClient\ClientException + + + mixed + + + boolean + + - $data + $id - string + mixed + + + getId + \ArangoDBClient\Collection::getId() + + Get the collection id (if already known) + Collection ids are generated on the server only. + +Collection ids are numeric but might be bigger than PHP_INT_MAX. +To reliably store a collection id elsewhere, a PHP string should be used + + mixed + + + + + setName + \ArangoDBClient\Collection::setName() + + Set the collection name + + + \ArangoDBClient\ClientException + + + string + + + void + + - $customHeaders - array() - array + $name + + string - - parseResponse - \ArangoDBClient\Connection::parseResponse() - - Parse the response return the body values as an assoc array + + getName + \ArangoDBClient\Collection::getName() + + Get the collection name (if already known) - - \ArangoDBClient\Exception + + string - - \ArangoDBClient\HttpResponse + + + + setType + \ArangoDBClient\Collection::setType() + + Set the collection type. + This is useful before a collection is create() 'ed in order to set a different type than the normal one. +For example this must be set to 3 in order to create an edge-collection. + + \ArangoDBClient\ClientException - - \ArangoDBClient\HttpResponse + + integer + + + void - $response + $type - \ArangoDBClient\HttpResponse + integer - - stopCaptureBatch - \ArangoDBClient\Connection::stopCaptureBatch() - - Stop capturing commands + + getType + \ArangoDBClient\Collection::getType() + + Get the collection type (if already known) - - \ArangoDBClient\Batch + + string - - setActiveBatch - \ArangoDBClient\Connection::setActiveBatch() - - Sets the active Batch for this connection - - - \ArangoDBClient\Batch + + setStatus + \ArangoDBClient\Collection::setStatus() + + Set the collection status. + This is useful before a collection is create()'ed in order to set a status. + + \ArangoDBClient\ClientException - - \ArangoDBClient\Batch + + integer + + + void - $batch + $status - \ArangoDBClient\Batch + integer - - getActiveBatch - \ArangoDBClient\Connection::getActiveBatch() - - returns the active batch + + getStatus + \ArangoDBClient\Collection::getStatus() + + Get the collection status (if already known) - - \ArangoDBClient\Batch + + integer - - setCaptureBatch - \ArangoDBClient\Connection::setCaptureBatch() - - Sets the batch capture state (true, if capturing) + + setKeyOptions + \ArangoDBClient\Collection::setKeyOptions() + + Set the collection key options. - - boolean + + \ArangoDBClient\ClientException + + + array + + + void - $state + $keyOptions - boolean + array - - setBatchRequest - \ArangoDBClient\Connection::setBatchRequest() - - Sets connection into Batch-request mode. This is needed for some operations to act differently when in this mode. + + getKeyOptions + \ArangoDBClient\Collection::getKeyOptions() + + Get the collection key options (if already known) - + + array + + + + + setWaitForSync + \ArangoDBClient\Collection::setWaitForSync() + + Set the waitForSync value + + boolean + + void + - $state + $value boolean - - isInBatchCaptureMode - \ArangoDBClient\Connection::isInBatchCaptureMode() - - Returns true if this connection is in Batch-Capture mode + + getWaitForSync + \ArangoDBClient\Collection::getWaitForSync() + + Get the waitForSync value (if already known) - + boolean - - getBatches - \ArangoDBClient\Connection::getBatches() - - returns the active batch - - - - - doBatch - \ArangoDBClient\Connection::doBatch() - - This is a helper function to executeRequest that captures requests if we're in batch mode + + setJournalSize + \ArangoDBClient\Collection::setJournalSize() + + Set the journalSize value - - mixed - - - string - - - mixed + + integer - - \ArangoDBClient\ClientException + + void - $method - - mixed - - - $request + $value - string + integer - - detect_utf - \ArangoDBClient\Connection::detect_utf() - - This function checks that the encoding of a string is utf. - It only checks for printable characters. - - array + + getJournalSize + \ArangoDBClient\Collection::getJournalSize() + + Get the journalSize value (if already known) + + + integer - + + + + setIsSystem + \ArangoDBClient\Collection::setIsSystem() + + Set the isSystem value + + boolean + + void + - $string + $value - array + boolean - - check_encoding - \ArangoDBClient\Connection::check_encoding() - - This function checks that the encoding of the keys and -values of the array are utf-8, recursively. - It will raise an exception if it encounters wrong encoded strings. - - array + + getIsSystem + \ArangoDBClient\Collection::getIsSystem() + + Get the isSystem value (if already known) + + + boolean - - \ArangoDBClient\ClientException + + + + setIsVolatile + \ArangoDBClient\Collection::setIsVolatile() + + Set the isVolatile value + + + boolean + + + void - $data + $value - array + boolean - - json_encode_wrapper - \ArangoDBClient\Connection::json_encode_wrapper() - - This is a json_encode() wrapper that also checks if the data is utf-8 conform. - internally it calls the check_encoding() method. If that method does not throw -an Exception, this method will happily return the json_encoded data. - + + getIsVolatile + \ArangoDBClient\Collection::getIsVolatile() + + Get the isVolatile value (if already known) + + + boolean + + + + + setDistributeShardsLike + \ArangoDBClient\Collection::setDistributeShardsLike() + + Set the distribute shards like value + + + string + + + void + + + + $value + + string + + + + getDistributeShardsLike + \ArangoDBClient\Collection::getDistributeShardsLike() + + Get the distributeShardsLike (if already known) + + mixed - + + + + setNumberOfShards + \ArangoDBClient\Collection::setNumberOfShards() + + Set the numberOfShards value + + + integer + + + void + + + + $value + + integer + + + + getNumberOfShards + \ArangoDBClient\Collection::getNumberOfShards() + + Get the numberOfShards value (if already known) + + mixed - - string + + + + setReplicationFactor + \ArangoDBClient\Collection::setReplicationFactor() + + Set the replicationFactor value + + + mixed - - \ArangoDBClient\ClientException + + void - $data + $value mixed + + + getReplicationFactor + \ArangoDBClient\Collection::getReplicationFactor() + + Get the replicationFactor value (if already known) + + + mixed + + + + + setMinReplicationFactor + \ArangoDBClient\Collection::setMinReplicationFactor() + + Set the minReplicationFactor value + + + integer + + + void + + - $options - 0 - mixed + $value + + integer - - setDatabase - \ArangoDBClient\Connection::setDatabase() - - Set the database to use with this connection - Sets the database to use with this connection, for example: 'my_database'<br> -Further calls to the database will be addressed to the given database. - + + getMinReplicationFactor + \ArangoDBClient\Collection::getMinReplicationFactor() + + Get the minReplicationFactor value (if already known) + + + mixed + + + + + setShardingStrategy + \ArangoDBClient\Collection::setShardingStrategy() + + Set the shardingStrategy value + + string + + void + - $database + $value string - - getDatabase - \ArangoDBClient\Connection::getDatabase() - - Get the database to use with this connection, for example: 'my_database' + + getShardingStrategy + \ArangoDBClient\Collection::getShardingStrategy() + + Get the sharding strategy value (if already known) - - string + + mixed - - test - \ArangoDBClient\Connection::test() - - Test if a connection can be made using the specified connection options, -i.e. endpoint (host/port), username, password + + setShardKeys + \ArangoDBClient\Collection::setShardKeys() + + Set the shardKeys value - - boolean + + array + + + void + + $value + + array + - - getCurrentEndpoint - \ArangoDBClient\Connection::getCurrentEndpoint() - - Returns the current endpoint we are currently connected to -(or, if no connection has been established yet, the next endpoint -that we will connect to) + + getShardKeys + \ArangoDBClient\Collection::getShardKeys() + + Get the shardKeys value (if already known) - - string + + array - - notify - \ArangoDBClient\Connection::notify() - - Calls the notification callback function to inform to make the -client application aware of some failure so it can do something -appropriate (e.g. logging) + + setSmartJoinAttribute + \ArangoDBClient\Collection::setSmartJoinAttribute() + + Set the smart join attribute value - + + string + + void - $message + $value - + string + + getSmartJoinAttribute + \ArangoDBClient\Collection::getSmartJoinAttribute() + + Get the smart join attribute value (if already known) + + + mixed + + + - - Argument $message is missing from the Docblock of notify - - eJztPWtzG7eu3/MrmHN9Kjkjy25uT6fXqXOr2ErsNrE9frS3k2Y0qxVlbbPa1d2HHZ3T/PcDgI/lcsmV5Dz6mKPJTCwtCYAgAAIgyP32fxezxYMHu48ePWCP2CALkpv06Bk7Pz5nYRzxpNhnYZokPCyiNIEm2Oq7RRC+DW44Y7rDIbWlh0FZzNIMnrHvg4RdFpzPgyShR2G6WGbRzaxgh/qvx3tfPu6xIosAYJKzF/PxcQ8ex+lNwnvsBc+g9xJ67z54kARzngNubqF9ouk/z9LbaMJzFoQhz3NWpKyYVc1ZzrNbnslhDKBZHKumUc4macJZmUfJDTu+ujrvsTsOv7EkLVjC+QSh8bwIxnGUz1iAIBY8y6O8ABoMLrEgmbC3nC9YVOQMOhS8/+04e4odThJoHUx6RnOgIuMVYMADIJDqabxkU+AkD8IZy/j/l9AGYSB47ALjLLJ0CR2CacGzuyCb5ArR6mmCYYb4iLG9/mPibxgHwIfDarb/9QAfE2vx88h4xtIF0S6fqAbf3QYZ0JYFS/nLLv2/yKJb4ALbGsluMGMW6POM7wB6Ph/HMCBkP5sBo4C/wMEMpwRZYYqi6Hc1i2juFtA/DOKwjAHRhN3NeGJOicRLfMt5sRvOgCEc5gHmNLhNo4mCp2BQpynNQw5iZ1LEboMY5oJFSW1qhPjcRgF20uBsgmucEiPzsGpWFItjgfCAdTpP6HE728ZBztn1xUviFZIellmGwjkJQLrg4efmmiboE/MK8VxnsWRUi9jCACYx2JUyh+ECUSESCBSjuu4EcXTLXbgznqdlFnLfTBHQJt7ncXDDIhN4Q+2RDhfGcZrGHmzQ5QcAOEB4TZzPgiKcgXAODCVcWzvHsvMBe/2mCXprFADlt5xQsHT8KwzEhYGeezAYEFwIwmBRlJnEgDzggVMY6o9sJDUoB2waxLmDU3K4F1Ii742tBqUFm9LBuiSvL+O6v1vIL3nByoXQekODaZZ6aLKiCcLB50qtF2K1bAhgMcvSu5wN34V84VLHRZAFcyFIbEsB2wF1ioooiB0GpA5ADqyE5S5k0zIRTUcj6AcMKMOiWwe9Te3FYoSfrQKs185TtZaIHw9gib4zNP1MPOxqIE8a/U1Fgv5dC+7rBrD9/bPzq5Oz09Hh2enp8BD/fMMODmA+EM4OAeo0EYHlPJJztwGOo8HV4NngcvhmW861AbFc4Fwe6wWiK5G+b5q+OAWJ4e/AScE1NLQtIZqnwG2g2F2QO+1TxkG7EmbYf9+MkoeCE2pPIWDtOqfhiy9gWRope6vbCGK3tw0Q+PluGuL47GbVDLz3sAWVJVDiiUtbtWJ6FyGpFcKFWqEb0mXZQo+VgWrQ/7DMpGYfuzG5FdBY/G+3dvMYSBeC0yVcPQnFyW8iAsXVL3TD06Pzs5PTK/bbbzVGr9P3+OzyXv3Ozy7u1e/H4cXJ859Hh8P7dT88OT8eXlzep+vg5cuzn0aXw5fPR5cnL06HRxqCLaAkM8Iy1cWm23lVwnKBoQVKnxTEDusrMejDF3LrTY0Ejy3MOLpq/U5Nyn228TUNB4yUBGuYkt1dli94iAab1Ea52DmHCAl+rJnuDUTo6uTV8Oz6yuYEooOBoooV0ZynpRr0PlvQOk0+YwGjm6Pog3I6jFYNIhK0ga3Aj4A/AkJGkgirl9afJ7W+7ytWMw7L+9rMqBYKDz8MyzsFb7Euip51CkZRQHx8B3ZfUisWoQpWTTg2o1gtOx5664FEndDaOmezsSmj6y9iL6TgqAV/PXstl6nGUFvt6Y2yp3ljzZLwLA1ro/mzrTCeBcZmxTx6x9uX7Jv6cmKzACPNrECtE+hlK9NDcXNJ2iHNLJtbJ3kONg/4RWH2i+FVle9wsmhN5pQQEu4QOIhBne4r2wrBDqdzIYKNdIYcDQrpBc8XMBK+in9dxNpT3nENOsVV7WIlzNDzIIpTMMNdBbi7jZ4Yk7DrUG1N3cokpWj1BVT+jodlwWWQ0hU6Fy94tr//anh1fHY0Ah71mIDe6TQwGPPbJBnYmXPFna7Gbuq+V7Pr836OHoTKENxFhVgU0OR8YKhiygMIBOFpSoRqRQh3IOqbLDHRsUi1GH5S2UE8aoKRhE8sQwLFJxAl5K6SJTeWzyVO159Hmq7/iMJU/jVk6fqPIUqI7pPLkk+UPomAYCr7z7lUHQ8HR3+AtWpwdXj8WcwLIVppYBYyZTpZfg7pIWybGRj2B7UwyN4/hI05Gr4cXg0/g5WRiDYzNB6xm/CYF9yUu3vLlAC1yibJSaIk+Ee3TxL4RxEsweXfSbKGgjyRVMEszzTiE9yli8dB+LZHW8hFtmTBTRAlmBuIID4FTuVszMOgrDYKKV8TZBDXyL1zzEFh1iq4hebBOOZ9doLb1ZiagsC/Z4AlCUao1Z4Gw6mg3cOEBXHBsyTA/SAFu4voMFsWE4NgppIiiomIefAumpdzlpTzMe7gS3BTQkBQg6Lg80WRs1kAEMecQ8ALUFZpDAgxB0IRgMoVVM9S/FWJUP1nncV1faqmoLiTMsS92aWI/uUcaLl3ayyF6iAuYyDP2Y2KEcQsb6x4ckup8gXqmgJYt5mlWls5SAFub82jMEsxedYtslqCBxNMD62wH5Xwlr8q4yJaxHyYTBZplBR5t5Gc290VohrNoR0J0j77FROkuE2sijaMz90sgnaCBEeeD2Ww+St+lIqF466V48PPe0CNy2i3OeVbTkRq4BZXYNIkw54eNFIh/tzb88HJy7Mfhxcqh/rGh1KxTCZSM9xax235Ow5KhyUt4zTD5PKdt7ckCjQ5mi67HcFiodkEDTVb5p8llo6DX5rflObe4u4W752/Av1hCuqdlFwZHaSflBfJWHI9MDNr7IRV5jHni+7jPRD/L/f29lxT+8D9zchLAkVgBogKVe6DghQVlSVLTUHcgqUQmonNcv0j0H6hOVh/1iK1W3zBGqKy8xTs7qEo4VDKY4st4MvmQRz9kyhRrfb39c/HEHFi8q0LKOwFR6TQc0xamWS/NoC+cSbSLfFJUjZPM6WpebU4KB6qnCd4DkXqkiRjo8SywR8KvSl9tR/cpgJEYR5kb0nwuOQpC3B1JCQ47w6e4M813sGM4GQ3h+s3Q9oENdYitwUiNSrjCemMZEQfVd9eiAM2iaZTTuVAaimfYj4ij4CVDbjmDu0mluviZHj5hj1le+yLL5y6CtQmuO2CzNqGhvdG4jOOlmwKJS1SEKIgWTaYQGVcSrV9Ns5v35rSpUTHFJsy0Ua1KTZezdPS48QB9DLhBiT8XaHRNeG7LQt28tkUSdZGdsXq7pQnaWqaeuK0MarXn31tBfOlRM1eWrXv+pdcYzd1poDaG4wsNFs+hh0DoFoT8xlZShq+LGVEt1zPAvjq4KmXmUNJN1iem7L/QWs0fv5jjI3PJsb4r2B1QoyV/2N01jM6Lv23/HnEmfEwnc/BMMDPItcgTEyje5ms8I7bnE3AHWMZAKwaKWUYuLaAxXLBc8bzMFhAIJ6lcwo9HtThNPM6F1xXa8uCmaCIwlpxukzQUYEzlhwgdnouE4ukYyJfYxcieNIDzUINOzmgamjMinUzJTY8e2kWMWqDvHHEg5pZ2U9oewV87GqA2+zhgWlgr34+H46uT0/+rxFuNSnuH7Achp4U024H7fE++3v+97zTYzV8x7RJq/H17GG6K15MM7Su6RhcXx2PcACY8tys1/Xl8KJp3UAag8mEieM50T8DvQ1k5Va2ai1+pGq0A6rk//qrEU/CdMK7voBwIwqxxm2/w/ofCux8cHn509GbGhh7FW2f8AYFnYHJAxQFKQ0fSquY0CaUJs+bjSxRs8er/vxAuTNqm30iZFYRO+SnXbcqzFrD7kXcBqqn4FcV9Ae0feAxCsZhkt3RZLw7ypd5weedRk3det2xqLPMYqk5Ni1rFCtTKVmzdNtK+56sPGfSoyVD1n1TLDPGFSTN8ARZgvvbO65y79aqNJ1tVmWY4Cj5KNWgfqkfR/vFTnW0L0dohQnsRlXl9TrPDevMQe4N3iKvFBcDXZELCy38obbBlEzIdgcWfss6ocs04+FbHEG93DcvcJ7o9EYjc/dwytNpd6ul3lW4YgqcDxZ+VEJKkWc+e98klk4VmJOrxitGSc/VJDlyjvY+QYvGXwylzjtdZ6AF4KE3R/1VuaUsq+4JPwf+yTxeW9rRrs++FLHlDGcYhzOxj9bI+e77E4713DK45IYQgWcGP0jxqDKa6BzTppMeU+U2aVkyDZ+Qvop/tqU32b/2qQuPSFk6dNAUF2PELokSrLHtmzij4q74dts68wgKq1kL+a1hNGoSKRuZgzNZcy8TscZhlHp40GBmUsaxbOzf0FXFAqpKQNhtYoaIa/IyLuzyDjrtqVlBll8IPowahNDgtjwvLfMqGHmOraPJmG1RcAvaLgHYVJ8A4jtnk5KiD9qih2iHkixVKYOA27fII4KAclyJWFTYjzescZhz8KQmiss7dXaJh56eVHDDrJ4rCm+M5vRdlvhhjLVuLQ50xVyIeIaRM8ShiEDGcxzYCpZp85IdWwWskgXJKKtAYe1aMFkK7nD2HgrnytgSg1VykC+TsDodaaodKBlh7drVPaSA5LzWHrw2zd/g8ufTQyoJc4U8Jub6RoxhqExw6pjkK+KN4pE5lpI8O9vX69OD+ukaYZmrE8/AX6clrp8fPZA8wqE01k3VpX7A9UAMrmWfrgqv0+kUOHoJTPUvuc+wJOp8cHHVY9Yevwab6eOuJvfGZRRPtHzVUfcccUGPuYWwUSXzsYclOGxvvDl8+t97sO8/hgyQgJ2L8g3Ze5I+ExV8miQ5SAezESmuTaTYFTBfJlOt+7rhBnvx7WGV95i13XRzsXBK+u858R8yFFu61XkbATcLQv68JJO4vhd+dTE4HL55YtkvBcoRLmG9EqMGGa1AXjFejXt4ejw4PRweSSJccgfOCUzFTBaN1aeLyujwh1c8z4MbqqSjudPT0TDymlkzvQA2IYpHGqvLSCn+dDHAuMJvWmwk5NeP37jFY3tt61Rh6eQQ4nS8uvzeKRAwV+mCC+8xT8O3nKoHCr4vYqc53dGjvUUrBAIHEUOtuo/oCFjkZBuRux2VyKZoYtDWOE8fgqtLPhb6vDe0iSCrMrEwzmUoffKpxp3ES/QwShj5MieJhX5qtyBybKXTDtBVhIco/YVwksO1jsIvt+QI6EvyKRbc6cOnlWhqofwc48JhXAVvQQwa49IbXzjs9kHiZkSJyiLkaARzNBK/6YjySXM0osXrDqKcjHA/yhfpg7R1dI0LetoyTFGbTHjxjNhL6jv3gXAzWadZ1I5UMJlEKMtBrDfMitRA4lwO71vmaA6mGgbVb6it7ISMmbPXlrzN56XaYrlHuZiGBSbJD8cuDnGCECeKNRjw1s2v5CzUCPZyQ3HEd1WFt5M727SitevYsb9PtWMnLhhp1DJ0//aCahbUzq2o8bsLokIdqK8C306ubdbfeuyrvW/aqNWY6WC1YKHB4DU2bRWAdTdv3zf50JIfW3/Yvxjj7rjG7fByH7ryVB67MMdCYSE9rvPVxkdlaJzWyGGzVdE/MsAMtLvSoFsuRK8KOC3YmxvxVgeqgvIRnSgadOVNeMXLcGYkN7xNa3wU6790m7Z79gNg7yFukDSePEsnS/i1HYlewbzNtp1PnEXgHldLIKrcrYyHHC9b6Kn1fY2y49pXFSqp4TrTEy0q+NMsTRe5zHLL4qaEi6z1Apw6lYRpphPP0YVVGUMh5UYWkQ6rykvugpzOauSwpteuDtswO2dqj6FaO3UaAFleLhZxVJ2XMIv/P+S8mnmWxk1Mo6phJkUSV0iPrDbcWNXlW/Z4b4/99psB5ekBmL49h2eLBTkQyTO6J6Jx1GGLZsMmQSiFw52i1g+d+5sSnekCYYZ3GqFjzQs6/hMl9RmpkpgmSar1Afs1T5PRhIutTWysI2kXaunlNyrpzRFU6UCJxUwEyp9ed3iWpdlpOe+0V3G5OlCy5Muv/ucf2+ahRAe12AaGKOqD8lm0wKLBOOaY0gaFS5ObVJ9scnzW8B2+s+iTIWoHgkLjETK3Y1camZ91F/x7senrNdj0NY6Q/IG4WQ9gNTfbVQWe4AaTHFaHv/x8jbXfWlMJ4Rcpt7V+p4x34Oqgmd8zlWSLYMGoWFxBZZ1SR82nxu2nkGDYvjkELNo1Xw+E92HrStccxMY15BrP/cj788YEH0mvPTHAykn/iAHAhhZZD7Qt9F3ynApbsdhbdnf7WjajxZZ8xWY/l9dkssXgI9GpGmd7AbKfvb4EN34amVK1HOdVwYGwa1icKkrek6UsIP3H3n9XazNaUrGiTrBA+LZeilH3R9CYQ2df2T1PeAb+EpIQhZyVSVWRkNX8q7bpaepBxwEQ3GUkxHcEzMfWZhFKkmqvZZqWCZU3katMFraqtX3QROIUptpickEOPQUjiofu+jK3D++4cbJIwX+gPRthyeZzmDrfrq7Y1dlhF/RV1K+Iq3PZuHn7rudqSMB4aGwSect2W67LNUcoW9du8JVjbQyWFzWaBWiRFXAVHlvBgmgudpCACRraDcBKJAMwLiHgrRw0edbOLF4MqoF1BW4fw8xrkNWW2GYMs/iVeab544ztpj62FffabTS/Yi6kAImr7sX51h6Vsilx33bPs7xXWWSOOQUOVIGC5NDuggArkMxBBeXelm4UFSydTldNbE0JBK41VUE0bmeDWa+XAGHUd0cXnADVfX3dOibgZVl+nuKFfQueBaJIE+9ECIvKv4yX4jZ2VaxPgNZiY64mp1b6RwxOJS/1NsMc+qE5AkaiXop0LaCeYGQD7m6teX8Vo58ZW7QrGG3t5q5gtDaDKCG0DRXlVqFkJNViR842McyjP83L1a2xRPlJQtAksFcU7LfrjSk63oGsUHSv/spb3VfRIO9v96JXchiwGe1BuW6TUJNSzIJCqWBuHB7BvEEHC7USQzHdgikusahKsnaAAC5rsNRrApSidOkGQrw7rt/ve+yFqrxSfQQ89Q1Lr/AAX+4sfyM3y0e+UUZHxWxxEPJZGmPYIy9QV7DEWzOME0VyBoQ6U1vBOUDJ3y3ga/3qj6r6rSIF/bg6ORG+IIGr6xgIAfiAMMnJDd3d4pFrwW+SlQWWe2CNaSl2/2o4KjfEmDt/dbaz8NtTZOYvLLENgVmVYpQ+sjWrXOre4CN5gb70GURzVRJaw1jbja4ti3YxSa1shr5A8I1p1Ulr2YzhG/4Xvj1GYJWSaeaLPIUyTe+gXr4pBZmETJQ1Q4iDc4m3JisVgQ5lMdWidlKITWHZF9cfOo5BDn44A+UCOc1ya32xtE+WBkoM+mYq3C1FsC22FhcnZborAq+vnu98o1Z0IaIuMyiPuBnXRBWgVSMYXlfS4joGsMj4zWhOE9vZ3S0xRy8b2yGQynv7ygPlc6Nw0WdY15oi/P6WL3NDjVWqXT4VfKZDG8UUOZSBXc5yENR4ac6oKJsNIlU7rYIxcZsT4iwTnFV2l6WAW5w/mcgJsOfammQxs6umuPVkSOskEriR4ktXlLw4pvGhkXugqhjn5DnnDYSc3jgjemK8sAV8ZwdP1RXfFigLnWizKoVON1Phvv94CVYwjsZZkC1NPwKMLow9juURGyxT0BXOFnLVa0TprrzbmY9HUtgVozqtFQVEFCUM5mNFi7OxTOqoO5yBLZTRaeKjZz3WIVXtyNR+vUbVBR8/LdtWZ2iKCKQWSqERMV5qPumznyqBJVuR4HMpuPviknyked20lmPIUgI8g6ann2PYao/NP3DxMoDa0F0X1PsH35rjpc0nebEYuU/KaAph8u1ueOQn5/F0f9+0z/TkLyUuzTEaN/D/CaWj9otXVsSobaO94k0Jq4MQ2jyU5yK3YZlC7yoTyyZwMjV8dr0UCccGmATRH1j4eeVNJ3SbYBzThV3oassguE70tgw/+nhekjDJcET72zRHCiosrHqO5D67bE+rL26zR4DR2Ds3xiTKFT0LrbzgTx0iMdda0dvdXr0CwXwdgqq2qbMTWeDxyQwXThYmStfDgPBBUYEVwBpgR3KWu6oIWg3igO21Hedc42jw8fDwhxFo0Dd4Svj52cWrN96yeLc8k4fxxBJgRQheLenzQsxSIXMS7DH+xr6/xEtBzi4Oh6OzZ98PD6+aL+q4F+gNc9OORJaWQDogDVJI13aIg1ttKVudClynb0+8z/JdgNc8gsGaL/U56I54caUA+rzMaLtDqnFaR6COLgeTCYwslzd76PywaudRPPP4lqC3SXyrNNdec6KPcdvh7dpyq9/zhWGmAvekAUhTuManBsiGtPlrVz50Zlut0KrMl2b1itRXnXOV7jZWH0wV0UvP6nXsKFB4Xax8/6t1cW7jjXY6IRT1eb+6Yao7S/Nid5FmeDUI8CoTL+VaBHl+l2a+vA3GyFgKpbOb9dxtGYacT/LVoXKVzcMEbOMO1+ZVh1UmpHudxSCT1xcvR4OjVyf0dq1LfG2RaZ/Wv5mwGTTXIFh7b5sDsFaf9QHY4lOF/Z57Il1ZaOPFqnrm7ziF7FUKXc4gWScFoZtmveah2xldLAmWyzxouxTH17nrdr9HwnNRN9JVpeSNvGl9wd9xk66AEf1Nqr2q2Sg1twXO/S6gtjL1NSpFzIPj2suja6+iMJDa7LgrOSJ3Ef+aB2/J6Cso4jXXLMC6QwkhuENegFNEaV1VnwceKbmWmOWkJ5SQ1a7iYpGliyyiLTDev+mzOL25cW1+ed+faCdT5WVeW3NR2LB9r/Xl9OyKXpM3ePny2eDwhzcVOMVysPz06udREEdBbpwvAxcJf4dI+Bf1fm7lBo5/qZphmem/AdBMboQ= + eJy1XG1z2zYS/u5fgXQ8tZyRkyZpvzi1r4qtJEpsySPJyeWajoaSIJkJRWpIKo7u2v9+uwBIggRAgJbi6Vx8JrD77CsWC5C//2t9tz44ePr48QF5TDqxFy6jy1fk5u0NmQU+DdNTkvjhMqBkFgUBnaV+FMJIHPzH2pt99ZaUkHzeBZvCHnqb9C6K4Rl554VklFK68sKQPZpF623sL+9ScpH/9vyXZ8/bJI19IBgm5M1q+rYNj4NoGdI2eUNjmL2F2U8PDkJvRRPgTStsX+ZifPCCDSXR9AvgJTFdxzSB5yAG8VQxfp/G504SgR5m+IiQX548Z1BmgZckiDKj+L8DfMxQ4M9jMr6TFUf8OWmtmLxTSvq3V1dkAToK6b00KDkWkzMaf3zzYrLyv9M5OSkTEyOesn/Xsf/NSyk5nPhzUEU9ENThQ6EkYCVQ5UmVngENPrLiSbfrB+Pxw7QMBokZwOAjK5h7z09fR/FoG87IN+ZKD0Q2jaIAoCn0DOCkcVaMX6JNHHrByP8v3Q0j155CzgBRGmeF6CejbZLS1V50WCZmcnwxyAHahyjwUj/YUXk5uDI5I7xs2Ev2RAdy7mN4TTcpHd158Ty58r/uiDHLHGbKBri6CfbEsllNaTxY8Cn7Qa6jaUo2paFmNcOiEPgzD3m/9mYpANoLUgNZA1hltBnvyg/91WZlxI1A72M/pQlJI4SfbGYzmiSLTVCH10LWgBtmDd2hJ2gKWDBGaQzTl9v9aFpP1QC4OtjqxWzCe7rd0YG9OPa2GdiCXB1KHFWjy5UXp+8iP+ykIjT3pE0DXRNSZbhdo6mXbsrya5YhzSiFNxti5feVbgdrJriZZ2Yew9gq52KYyv2iVOP54Zx+L1GZwayUdPvj4adJ75KckSN/flRLhlVo9YT6nesuksKh9cRYeVVPbPzphhHDofXEjqQ65chC9WOnN56MPvUvkLQ8r56DVGbYOLwb3A77navJqPcfhl+eWs+Ee5KN/mjcGd+OkLIYX0+0cBIb4ffdT5PBzbg36DPq0sR6DlmRY6PfG4HiR+PuNfO2bJKNdlahOFD/MLjqjHtXXU4/n6jPXjIXXWFh43fZG42HvVe34+5k9LYzvBxNrnrvGWsttXoxy1WCjXX/9vpVdzgZvBacWciVKdhlVlZYG9dh9+aqd9FB/5i87lyMB0Pkq5Kxs9Yt1zbu172+AYGWmh1EdQm2hh2qutd/A/E37Iy7bz6xCKwSceSLi6oTQwzKUc6JTXNgoayGVl7XneEYMhcouTMWbs24qpRUR17H0ZrGqQ+lXrTmfQyFDc8rk5vh4KY7HPe6TKZioobqPJptVhQW4bp9NCeOK8XkcnBxew3SAOHnKjU6XyrbexOl7uUbFP6FSqUPFcw0isNSz0YhwhP0pN/9OHk1GPaB1DOV1G0YRN4cah0XUrf9q0Hnsnupl+3KnVBORiOc5EFTiv2UjYBoJveqiwEhoftVJXtJA5o6wrvsXnXHjNBvOnwwMt7M0oR4IaGrdbpViebl1NqLvVXWGTpktcsJL2GwFE3vaM3c9C6O7hPyudxy+8z/6X6fUdXL15spZCCy2IRcg5PJLIPb4tzPYNcYBLzo5V05/PEXRDx/dCZGSE/x5zC985OT84SmfRjGBx+/zIf8c8D/t6otnge3ZEXTu2iOe7AcEPEqpbhBfr28FQ3zkvWQlakJdh5CP/W9gIg/oLLNjGKaQm0k9ys1OsUqR1btLKaQa1/H0aqDvFslBFX9Hkoxf8bETmiwaB0L98IfgEi92R3YQWD2EnIIxQ85OxdUFZMURJlhWji8nQ2WbZP/KiSVZr40GO4NTZl7zunC2wSm9FdVYd4CVfueei0uaXrJOYyBaquqt4wsKOv0tJRfTbgvgiiklXZ2CeqQkUx47OHgqigrb+nPDPJ9i6rNZTXgkKYiiAifCWyC1B8ecS+VwSwgXQfLzVTrYLmtaR2ctxhdYEgtP/tgbevNqI1yt6uestq4qRmsK92Mg5UGSx3losHhoA1Ns6E8WB+lXhZ1+YEOE4NEi/r1pRQIRXRD2nk3GvRPaDiLcD3nxJsESZ4ESnQMC68aQGk0YgRMyUCoK43eJVHYOjapZifx9iFJBlAvxRd4NuEUW0IiyIWdIGgdP0Ak8AEaw3oH8ewqEp5kSpOchRrlc8zZWoxwFoy5cRCUhMpiIDEIkjWp+L/g7DYCeoEybNV8DZGEy94Z+bO05vKVKO9XFT+4Suc5vm2cw1pTmjmY6s2zim5ReZaU882Ty42gc90aYJ5cNEsqMoo1oXZm3ggpz8wWCPNc1nPTaAkrD/Ms0ZFSZvH+lHme3HCS5xWdp3zqX0XWLtXOmKNZ6Vy3sin1G/exP2Us+nbOX6SesrbW0+IqL6IuiKpdHhmL7lSJo3DTkrJKuwBS2y8yJMPZURNUunLABZi+NySDMx8QNcFXrUBcsCltIxmWegxkgeQnE5Z2W0qdc+wMhrWUFBTFMU8jjSiVkxMMTbepBEhzmlMgU8oSzsG0xI1YpaZbnyrrG57X4LavlQ9gm6ljstok7CArq/eeKBP9hNz7Adv0+nM8m8FCgZ+DiWKwoOmFc8LPxtg2G/5/RodmO23UdUEBiPsho1xl3GijnrVCUESCy3dJyspgfgwndrQwuDjTNWnPeaOm7JcrBQD62SPwc46XDVV8m2sOd/MV0VtHPa4qrcHZBvpIv0FnjRi26wf3Lhcb5o5Mb95SNv2FZzbjgwWKrfezL155WWNm+LGocPbHV66IzKzfFfXR/ljn9VSNNUVptVemWSlWxzary/bHGOs4M0fW8dkbL179mbmNWBW4P35S1Whm+j4vIV0ZZ7/ZAehLRTOWS03huMe8USkTa3JIqWjcv17UEsyMRanG9g9HXxWaIV1rasT9o1LqwZrAqVSHPwgMqwctKLA6/AHsNXVgDRClKmyK6OlTsgm/htG9VBO0eeUG5Z2/DKNYnHbpy8i0enfaWAjyAkWUcVCNYJckhAIPMgEWYRKRJU0Tsllj1chOaZJoBUUjTItV+o3qPV7CHfqmO9rVwg1vjtoKN6x3/Ln2DKtos2cHWeTnn0nlzzjZvZQb3UWbYE7CKBUKsmrTUNuV+5cI5oy0eH15jJhsRzGV+/I+trxi6s23hDlT9SJb6epVQryYgpVDGjMTYysP783R+BuYOAqDbbWq10yH7T6NwRbgsCS/Vzf1l0uKR5mgi5u3N5Nefzy57vz7Se6NEQge+N402ELxD65d3gaBJDRI6D14GgSBx9uSfI+QcMUDj01CTf6ivf/fJuVrf6Aq6fk8ogkz5xYUe+d9w82Q8tKA2ibsGRuehUXrdn+p+qbBPjZS0pnyDnsh6VC3IqOXgJOkLWkrxEbJR5dy5JUOkeXYyx/w+bvGHyPXNAJLWOTg4+9iOIcff0vEFoDOh6KylzFDWPysDq3G03C7qW0WwH8QWYsNrjsLNTITccbdOiZHFC9vkiieY6hH6DEweO4vFhC2YcrvUbIUwGwTxSsvgKySsyWwhwM7eat1gOOAdNbNQEpA8EWJPOfLbDtf0pMC1E6tB7xKe8iQnnDAZ+Q5OTnP4BZc2tnjF/i4AmGHIOMbHqStX7sY0zO8uicuHR2pZQgHZjwQZ07BMmqVJorhQg+vHZlLf6kRr43y/AEXc9coZ+SaRnkh+KMzrao4YM0AlP0BTR5GCteoyj0TA74io4JHCn+QRpZUKRTZIDfxN8Z+SG6qu6Iho26Qm/jZzG7ZSZ+c9JSbJwxx9T67gw+lwxl5xtKGuIXXzm7ni3SS3VeT/s7yiPLXX/Gv5Ttu0tPf8Omc31rbIedkbQ9O17y4M1cUg0xru8Cmi3vpUUZl19gXJB8S/Y/8UBxQlLOd7iSwfL6LPzwhVK5PtuuHZZcPLcOcBpWvM1oGi7uKpUF/4QvD2esa8HNc/NY8uQkzuKe3ikvkDtEgh4mpzllMfknGlsREQFjSWD1kTSLDxgK/drxbzhHXCKVXb05IB+94JNHM91IfdytsyCwKU88PMSY4XyhhYFZyylaANl6HiO5vIbyxadIGFUG6xJqiDRG1gMSgoGyQVOS2ZoHUnFzEYaE0VE4x6nk7Oo38VpGz40hWcPce9XUnmw9J8lv8yC5F5kuml6Er/sHerM0PxKyTGhhVc9SiNyjL/VhTChh//w2r8QSBZfM01YyMNJtpM6zmfXNXm7q9Ya5aVlaCxbSlt9LrbWt6i1xXb2Smtc5pYFrNUZYxVkWTp8aUMjJXU2pey2+W3C0v4quWlGW2WLL08n69JbWv29eGaDbjlCw82JadnMNKGpc3m7BWn5wnnO5eNprVI8Q9xnGuAFfLV7920DCC675voOnRZYLbOnX5BxFs5tZ+wMBi8Po5jexYPZPdqyVznO62rH4eorE16z4IobNnrgCrRcvfkODHLSa7Fpfo+DvoCQmqX32o2Dhrt2ZWtn414iH2rjuirYhvuULvZk/tZGebNv2AhmperbwWQ5vvP5rDuOZDGXVLsMu0Jj127cF3k4i2r80VyK6OoP86SVNHsH+PRNPvLivF1vnWXDiVIt1k//rPeFRcQJxYZk5g/CIK9dnxqCfEhn1VTH5KvJQGgZ/Sn0zKcvEU4wWAHZwF/yqes35wjvRI40aq0K6eZFRXU2dy+vSK6k+q6iwuZbgwXL9+aN8Yck0r7pMbuEzdtZH9phjD21Ju7mGWvbmHWPVodBKtsix+Yr67Xe8qtR/ksRQZbnObdIMNd3kMxYXC39XM2USUqPRxo6Y2dvmckabHVxXT1u3TXoB3sKvy7aKKQeWXgo3fO3qwIeXrUE1iXLTjjBFewGxkb/m7UE17b7VfgjIYmInvYtnipQKLSfFqF/kS+fJl7SbhWv+1qAfZ2XjbzBSyKgZnIxrFf0Dc2lRpNq0qsc3Ghvc0/jkAWdmnSCde4HtJq7jSdHrK/t4mR5+zT6tmn1mYfr4onXD8H33Kbwc= - + - ArangoDB PHP client: transaction + ArangoDB PHP client: connection - - + + + - + - Transaction - \ArangoDBClient\Transaction - - Transaction object - A transaction is an object that is used to prepare and send a transaction -to the server. - -The object encapsulates:<br /> -<ul> -<li> the collections definitions for locking -<li> the actual javascript function -<li> additional options like waitForSync, lockTimeout and params -</ul> - -The transaction object requires the connection object and can be initialized -with or without initial transaction configuration. -Any configuration can be set and retrieved by the object's methods like this:<br /> - -<pre> -$this->setAction('function (){your code};'); -$this->setCollections(array('read' => 'my_read_collection, 'write' => array('col_1', 'col2'))); -</pre> -<br /> -or like this: -<pre> -$this->action('function (){your code};'); -$this->collections(array('read' => 'my_read_collection, 'write' => array('col_1', 'col2'))); -</pre> -<br /> -There are also helper functions to set collections directly, based on their locking: -<pre> -$this->setWriteCollections($array or $string if single collection) -$this->setReadCollections($array or $string if single collection) -</pre> -<br /> - - + TraceRequest + \ArangoDBClient\TraceRequest + + Class TraceRequest + + + + - - ENTRY_COLLECTIONS - \ArangoDBClient\Transaction::ENTRY_COLLECTIONS - 'collections' - - Collections index + + $_headers + \ArangoDBClient\TraceRequest::_headers + array() + + Stores each header as an array (key => value) element + + array + - - - ENTRY_ACTION - \ArangoDBClient\Transaction::ENTRY_ACTION - 'action' - - Action index - - - - - ENTRY_WAIT_FOR_SYNC - \ArangoDBClient\Transaction::ENTRY_WAIT_FOR_SYNC - 'waitForSync' - - WaitForSync index - - - - - ENTRY_LOCK_TIMEOUT - \ArangoDBClient\Transaction::ENTRY_LOCK_TIMEOUT - 'lockTimeout' - - Lock timeout index - - - - - ENTRY_PARAMS - \ArangoDBClient\Transaction::ENTRY_PARAMS - 'params' - - Params index - - - - - ENTRY_READ - \ArangoDBClient\Transaction::ENTRY_READ - 'read' - - Read index - - - - - ENTRY_WRITE - \ArangoDBClient\Transaction::ENTRY_WRITE - 'write' - - WRITE index + + + $_method + \ArangoDBClient\TraceRequest::_method + + + Stores the http method + + string + - - - $_connection - \ArangoDBClient\Transaction::_connection + + + $_requestUrl + \ArangoDBClient\TraceRequest::_requestUrl - - The connection object + + Stores the request url - - \ArangoDBClient\Connection + + string - - $attributes - \ArangoDBClient\Transaction::attributes - array() - - The transaction's attributes. + + $_body + \ArangoDBClient\TraceRequest::_body + + + Store the string of the body - - array + + string - - $_action - \ArangoDBClient\Transaction::_action - - - + + $_type + \ArangoDBClient\TraceRequest::_type + 'request' + + The http message type - + + string + - + __construct - \ArangoDBClient\Transaction::__construct() - - Initialise the transaction object - The $transaction array can be used to specify the collections, action and further -options for the transaction in form of an array. - -Example: -array( - 'collections' => array( - 'write' => array( - 'my_collection' - ) - ), - 'action' => 'function (){}', - 'waitForSync' => true -) - - \ArangoDBClient\Connection - - + \ArangoDBClient\TraceRequest::__construct() + + Set up the request trace + + array - - \ArangoDBClient\ClientException + + string + + + string + + + string - $connection + $headers - \ArangoDBClient\Connection + array - $transactionArray - null - array + $method + + string - - - execute - \ArangoDBClient\Transaction::execute() - - Execute the transaction - This will post the query to the server and return the results as -a Cursor. The cursor can then be used to iterate the results. - - \ArangoDBClient\Exception - - - mixed - - - - - getConnection - \ArangoDBClient\Transaction::getConnection() - - Return the connection object - - - \ArangoDBClient\Connection - - - - - setCollections - \ArangoDBClient\Transaction::setCollections() - - Set the collections array. - The array should have 2 sub-arrays, namely 'read' and 'write' which should hold the respective collections -for the transaction - - array - - - $value + $requestUrl - array + string + + + $body + + string - - getCollections - \ArangoDBClient\Transaction::getCollections() - - Get collections array - This holds the read and write collections of the transaction - + + getHeaders + \ArangoDBClient\TraceRequest::getHeaders() + + Get an array of the request headers + + array - - setAction - \ArangoDBClient\Transaction::setAction() - - set action value + + getMethod + \ArangoDBClient\TraceRequest::getMethod() + + Get the request method - + string - - \ArangoDBClient\ClientException - - - $value - - string - - - getAction - \ArangoDBClient\Transaction::getAction() - - get action value + + getRequestUrl + \ArangoDBClient\TraceRequest::getRequestUrl() + + Get the request url - + string - - setWaitForSync - \ArangoDBClient\Transaction::setWaitForSync() - - set waitForSync value - - - boolean - - - \ArangoDBClient\ClientException - - - - $value - - boolean - - - - getWaitForSync - \ArangoDBClient\Transaction::getWaitForSync() - - get waitForSync value + + getBody + \ArangoDBClient\TraceRequest::getBody() + + Get the body of the request - - boolean + + string - - setLockTimeout - \ArangoDBClient\Transaction::setLockTimeout() - - Set lockTimeout value + + getType + \ArangoDBClient\TraceRequest::getType() + + Get the http message type - - integer - - - \ArangoDBClient\ClientException + + string - - $value - - integer - - - getLockTimeout - \ArangoDBClient\Transaction::getLockTimeout() - - Get lockTimeout value + + eJylVk1vm0AQvfMr5mDJHyJ1k97skqZxVVuVKkWpe6ora40nBgUWurtYsqr+987uAsaATa1y8cfMm/fmzbDw/kMapM54NHJgBB8F47vk0yM8LZ7Aj0LkagJ+wjn6Kkw4peish5T5r2yHACVgZnJNkGUqSATF4Avj8E0hxozzWugz4fxQwizIqIAJ+kl6EOEuUDArv929vb1zQYmQ2LiEebxZuBSOkh1HF+YoqPSB0GPH4SxGScKwpmnqFM3NIiYlLAXlPOOvDKUq+rmo62KzMuS+DgHcvnlnhPhNlt+OTjAq9DUiUxKBEpD5AQTItiiASSC3mBDsAINXPIB3D3sWZTgEjDA2fAZc1HjYM2Hz83/G5jMV4Z4phN7aFpbgwY+fZEK7BBUgBEqlECNZsG3jkGS/tqKVxMIulhfWBchEdHX5HPtdRGcoDIMtAcmL+bVJtoeriTSoSbE8uiOl3gF1SPHq2hpEU+jnzfRbWkGyJz1xS+kFqlOlTLA4XxLoFQOm68ZgbYBsMJrzcA2ce9Wzg4MjuCA+WYQ66jiPGuo43DpEOwtQITpOy8isjCs3LttEoQ8vGTdnDqzXdAARKPPVoOjZLRpwq5pcyzY0ZexNp6+eCkJ5c7+u+OWV7k0baRVnvIKmmVVxwqtqaGZWDPCsQJvzp7EGc1qD8hDIt7kw+HSapdcCVSZ42zlQc3GHamFLDOr+5DVqNl0SeXZf6rra7oumsK+mRJeu6iS6ZbWcNldpei4n2qWrPvvz2swmnM71vzQ+Ur0udV37pv7liLtK1ZIKdKnSJIUq0mWemWsWhUwOqk/OycREXOivineAVf4Q3qyqif3h1PkLRzV67g== + + + + ArangoDB PHP client: AqlUserFunction + + + + + + + + AqlUserFunction + \ArangoDBClient\AqlUserFunction + + Provides management of user-functions + AqlUserFunction object<br> +An AqlUserFunction is an object that is used to manage AQL User Functions.<br> +It registers, un-registers and lists user functions on the server<br> +<br> +The object encapsulates:<br> +<br> +<ul> +<li> the name of the function +<li> the actual javascript function +</ul> +<br> +The object requires the connection object and can be initialized +with or without initial configuration.<br> +<br> +Any configuration can be set and retrieved by the object's methods like this:<br> +<br> +<pre> +$this->setName('myFunctions:myFunction');<br> +$this->setCode('function (){your code};'); +</pre> + +<br> +or like this:<br> +<br> +<pre> +$this->name('myFunctions:myFunction');<br> +$this->code('function (){your code};'); +</pre> + + + + + ENTRY_NAME + \ArangoDBClient\AqlUserFunction::ENTRY_NAME + 'name' + + Collections index - - integer + + + + ENTRY_CODE + \ArangoDBClient\AqlUserFunction::ENTRY_CODE + 'code' + + Action index + + + + + $_connection + \ArangoDBClient\AqlUserFunction::_connection + + + The connection object + + + \ArangoDBClient\Connection - - - setParams - \ArangoDBClient\Transaction::setParams() - - Set params value + + + $attributes + \ArangoDBClient\AqlUserFunction::attributes + array() + + The function's attributes. - + + array + + + + + __construct + \ArangoDBClient\AqlUserFunction::__construct() + + Initialise the AqlUserFunction object + The $attributesArray array can be used to specify the name and code for the user function in form of an array. + +Example: +array( + 'name' => 'myFunctions:myFunction', + 'code' => 'function (){}' +) + + \ArangoDBClient\Connection + + array - + \ArangoDBClient\ClientException - $value + $connection + \ArangoDBClient\Connection + + + $attributesArray + null array - - getParams - \ArangoDBClient\Transaction::getParams() - - Get params value - - - array + + register + \ArangoDBClient\AqlUserFunction::register() + + Registers the user function + If no parameters ($name,$code) are passed, it will use the properties of the object. + +If $name and/or $code are passed, it will override the object's properties with the passed ones + + null + + + null + + + \ArangoDBClient\Exception + + + mixed + + + + $name + null + null + + + $code + null + null + + + + unregister + \ArangoDBClient\AqlUserFunction::unregister() + + Un-register the user function + If no parameter ($name) is passed, it will use the property of the object. + +If $name is passed, it will override the object's property with the passed one + + string + + + boolean + + + \ArangoDBClient\Exception + + + mixed + + + + $name + null + string + + + $namespace + false + boolean + + + + getRegisteredUserFunctions + \ArangoDBClient\AqlUserFunction::getRegisteredUserFunctions() + + Get registered user functions + The method can optionally be passed a $namespace parameter to narrow the results down to a specific namespace. + + null + + + \ArangoDBClient\Exception + + + mixed + + $namespace + null + null + - - setWriteCollections - \ArangoDBClient\Transaction::setWriteCollections() - - Convenience function to directly set write-collections without having to access -them from the collections attribute. + + getConnection + \ArangoDBClient\AqlUserFunction::getConnection() + + Return the connection object - - array + + \ArangoDBClient\Connection + + + + + setName + \ArangoDBClient\AqlUserFunction::setName() + + Set name of the user function. It must have at least one namespace, but also can have sub-namespaces. + correct: +'myNamespace:myFunction' +'myRootNamespace:mySubNamespace:myFunction' + +wrong: +'myFunction' + + string + + + \ArangoDBClient\ClientException $value - array + string - - getWriteCollections - \ArangoDBClient\Transaction::getWriteCollections() - - Convenience function to directly get write-collections without having to access -them from the collections attribute. + + getName + \ArangoDBClient\AqlUserFunction::getName() + + Get name value - - array + + string - - setReadCollections - \ArangoDBClient\Transaction::setReadCollections() - - Convenience function to directly set read-collections without having to access -them from the collections attribute. + + setCode + \ArangoDBClient\AqlUserFunction::setCode() + + Set user function code - - array + + string + + + \ArangoDBClient\ClientException $value - array + string - - getReadCollections - \ArangoDBClient\Transaction::getReadCollections() - - Convenience function to directly get read-collections without having to access -them from the collections attribute. + + getCode + \ArangoDBClient\AqlUserFunction::getCode() + + Get user function code - - array + + string - + set - \ArangoDBClient\Transaction::set() - - Sets an attribute + \ArangoDBClient\AqlUserFunction::set() + + Set an attribute - - - + + + + \ArangoDBClient\AqlUserFunction + + \ArangoDBClient\ClientException + $key @@ -4958,26 +5603,23 @@ them from the collections attribute. - + __set - \ArangoDBClient\Transaction::__set() - + \ArangoDBClient\AqlUserFunction::__set() + Set an attribute, magic method This is a magic method that allows the object to be used without -declaring all document attributes first. - +declaring all attributes first. + \ArangoDBClient\ClientException - - + + string - + mixed - - void - $key @@ -4990,16 +5632,16 @@ declaring all document attributes first. mixed - + get - \ArangoDBClient\Transaction::get() - + \ArangoDBClient\AqlUserFunction::get() + Get an attribute - + string - + mixed @@ -5009,18 +5651,17 @@ declaring all document attributes first. string - - __get - \ArangoDBClient\Transaction::__get() - - Get an attribute, magic method - This function is mapped to get() internally. - - + + __isset + \ArangoDBClient\AqlUserFunction::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. + + string - - mixed + + boolean @@ -5029,17 +5670,18 @@ declaring all document attributes first. string - - __isset - \ArangoDBClient\Transaction::__isset() - - Is triggered by calling isset() or empty() on inaccessible properties. - - + + __get + \ArangoDBClient\AqlUserFunction::__get() + + Get an attribute, magic method + This function is mapped to get() internally. + + string - - boolean + + mixed @@ -5048,26 +5690,14 @@ declaring all document attributes first. string - - __toString - \ArangoDBClient\Transaction::__toString() - - Returns the action string - - - - string - - - - - buildTransactionAttributesFromArray - \ArangoDBClient\Transaction::buildTransactionAttributesFromArray() - + + buildAttributesFromArray + \ArangoDBClient\AqlUserFunction::buildAttributesFromArray() + Build the object's attributes from a given array - - + + \ArangoDBClient\ClientException @@ -5077,293 +5707,142 @@ declaring all document attributes first. - - $collection - - - - The collections array that includes both read and write collection definitions - - - array - - - - array - - - - - $readCollection - - - - The read-collections array or string (if only one) - - - mixed - - - - mixed - - - - - $writeCollection - - - - The write-collections array or string (if only one) - - - mixed - - - - mixed - - - - - $action + + $name - - The action to pass to the server + - The name of the user function - + string - - + + string - - $waitForSync - - - - WaitForSync on the transaction - - - boolean - - - - boolean - - - - - $lockTimeout + + $code - - LockTimeout on the transaction + - The code of the user function - - integer + + string - - - integer + + + string - eJzNG9tu2zj2PV/BBQzYLpxk23lLmux4Mmkns2lSJCmKQVsItEzbamTJQ0pJvIP++57Di0RKlGS7me4aaGyJR+d+JdXX/1otVnt7hy9e7JEXZMxpMk9//YW8/+09CeOIJdkRyeCmoGEWpQnAINjPKxre0zkjpHjiTALLRZpni5TDGnkDi/fkHV0zLlfCdLXm0XyRkbPi16t/vvxpBDQiwJcI8nY5+W0Ey3E6T9iIvGV8SZM1PH24t5fQJRNAmlWoHhf835WsknTylYWZ5nhsS0EiQagBINmCZngnF2xKspSsOFtRzgBiSgSDP7SiAQTKFgwW+QPjB5rCHdzRGFkS0pXIY5oxcfR6wsnhKUK8zmP1HUenEkGYxjGTWAWZslmUROr3DLQXp+F9lMwdeOAgpzH5Sh+oCHm0ysgsTwquJBidTiUSAEtXClsc3TPySKPsTcpv10k4krjvoiVL80xKCeLSpZA4DhWPRqCspk/C2Z95xJnQEiQJc5YRXwjKnTAi5aFx9B82RXyPUbYgIBl+I2W97NAAfLNonnOKVwfScMnavWuwC6aIcQa+wx7AdpO15Ekx0hdkyYDQVCsgW0SWLaSsYGhpjx6u7Z8CwrHkYtA3aiWD4V/rNOfAwZR9O+4Pj134s9KAA8o5XQ/6nNFpn5yckv5yHeBFUFp5RPqPPMqYXNfwsBq87MMK/HjVHw4VideHhrnSfdApCkl8AtBtuA9/JOvgShhQ+C8WKVmweMV44bwCAwrN6cQD+FiYxesRmVAMTBAHjBsVgeHVACD5iFzadulJblF7PQGeksxJNCMCvmM7AIculhuQfkckHvlVyuQpCJ2tlfYI6ZXPEfnZlxFn60BBqvyUhHE+haibpBBFaBzp/NIm1jN2GnGpLqMn0CLpcUcyQxXv7tdJg7xa3AHImyYx3ErY0I/50dW8xizv7opaQ/SopaZSVfoupmwqhJuVXTyTNI0JslhmQY3no3VHuVg12ZdYoiTDh3p2+lRYLq07XixO0fSUTHClEKvpy4OfZKkLY5TIqmZ7f+0hKVnm8PNCO0sl/epFA/PzA+VQSw2Qvn0ov1c8eoACRXpBiQUKqYeKJQpkVZqBUSY5lLYDHzVp3QqhNAP04CO98llyQj59qZOzYg7UPWVPDiZgVGTk/Oru5o/g7Pry8vzs7uL66hZw9S0H69fRjnXZb8U4ltgQmZa1jsf2lnZkH8cXd8Gb65vg9o+rM8RpuZ4HMToQybQHtWO+vD77d3B38e78+sMdIra80YP4vSztHSjfj2/G76QaVSfgwYMJsQPLzfn4V8Qhy4hHdzcXd+ddWpMwJ6bW1JFIF+sFOvJ1erByQRGr6awahQdNTqmx1Yld6P5FsCouf7QhHz0bSmU63a+Y9lKsWBjN1tUGcGREwLQ+yzksc4PYdHLYF1Y5iRK8vUSBqaZYjcvzJ7pcxezIXKvyba6IGzxlfS8BSL3424tENgwlkr6zOLSuhiOLqo4y2XDYLcu3vg1lxw2CZjxnZnnoClo4ifRiK+9hrS1+q89+tX0Fy2gjVdDoco0f27hjeXu/Ygvd8KpGdUozWmUtW/D0UZDPbg34rL7On0K2qifqfBJHYdEtkSCQIcPzMBv4ZRxppuv8npAkj2OlN1VRlFyy77EKAQD27LJgIKFUDyIRKB+ooR8OLaQW4kkexVOrmI2LMvCGp8txA7KS6rc99bcWoedPLAQ09YJbiUuY7h6jOCarVGQS+M+c8bXbMZhhIueqgMOIk8cZ1DtRxA05y7lI+YGqvfK3jG4Ad0IcQoVTzZZGU6uV2hEKkxN5g7DiGlRt+9aMRrHlm5pR1XthTMiGNA9DJsQsj4shixqRHmgMQDqBOPdk+4UTopBNeJSYWbPLEZnS/qDmTiDzClyUqcsTj3/tn6IpBo6zfOCxODr6cHMZ3N2Mr25VOR75/GmOk5dBNRjun34VaRLA1A1zTvDI6QpqwMAMRYWvDQtUlmsVvJr4KG5IMr8LJFD1f1DTwH3wU1/Zuf+lFgNa103wtpfvVZ5Bux43+f5N6aqdbaDGZ2WLWv5zHqzWyMLkFc1XDG9ErZm7UYhbltV2Qrw1TNZ4aSIBfh1PyYI+MPIKXH6yL+9DAcXtIRgj9ByL4WzK1uMiChfFkyn80aG5QqIPDn1D0VNs/XVG51oZTK3x4tsw0M9VNYl+JteDe7YO2FMkMqEH9JF5pCHZ+qZX+cAn9fyXWmJtJqjUtwHF+tStSSoMdZoeX3hb2QGwJwknlaMBhbZgwxwsPA1gQ1BsbL65a7525wfggWDx7OioNq4MG6NBbmkpYjY7FX8zQ7EX5Bn6i3IfzO+bpdUdCXW+JgPF39A4TaO08w5ptUK1uBvUo3nB+Ha2UZy3m8XeOWixjdxo+DstY02g25nHGUjBSsjpZjbqFF1rV8puAXfZyhZlO4M5sjQzj8XF3qtpsRtu7fydZrM2iLYzmz3tg9WAz26jvd1Ebq1hFNyC7bKZLcd2NrMFaTeZ2oNos5YnZT+zvdS2SWuJbjCY2ksZ6Wq6mbHaJHaqlDmoaTeSZn47+yi+m/mEtu+BJaDEkJXEYNYx+/QqS9Y2e80cAu0aZnF4gMoZxaCFGr0kM5gC622gadxro9P2bVdDe2I0VLVpOTN8aqjhX5wFuW31BYcHiXZ3Hc5/mA53cKuaEtsdbDclfp//1Y4x/j/cz9+PP5f34b7rcznfD1HgDr5X1eDzup7UYFtNkq8LFFj9DtGDwal6q61CbVmRBoh/1DIu/iMSgeqVJWhtWFP7Swl7rFIe9C8SwBpNyTQN8yUslaISwNR3hrcWb0WyGzjirTy4L2mMyJLOQVp1XF/Rlhz48HUNB0ididI4RkWWZ/7WJq5xXINnysKYqkEijj2CCjKLuMiatun8xiqgJG9+tzDTGuiG4LZzqVrcrqgAm6NUtTG3rzfocCei0fnMVl4aTVtdKAi6nEiAysIFUd5TcZ6QCtwn9cYSOXJALd+obHg4rZD9mUDauT+uE+xXjpRFv5VWU5XfgqB7Ot5BryGtb06uPoS20nOn8t3IuOeSrdqsT5q7kXQOLNsoeoak3Sjq88w2WrpH3obMlM1oHmdtWN346sTauhXWXXHs1LIv04k8BezIFCrHmNxiPzAiVx8uL7GYlEkKUm+SZliAukq0yhvb5pSNQrw2udRb0eeN8RrBWv+xgW2d6qwPDfw1s/HMwA/edmSAx3uts+Z2lbcwMPxe4rmKPN9Caw9x64DxBMppbbN+03r4P3baIGhy2/qoLKEaFXsh8AXW+Zxx9RpiCFqRL4lJqw/x2I0tV9kaf+Kei+qho0nMzBsLked1mu9RGG7GMbC1uhTqiBDYmNEYYmCAwxJcaS0NO9SkndejqJ1duzza8vux5LPj7EtYB5VaTRs5oruxrE/Ccs5lQ+jB1qSWLL1V/XbHOZh5v6RBmF/wdNx9c9VuS3G2omQewfDmPRIxs4Z+SaShgf2e/bCNju81+RYH0RCNI1nL8ZLTZXXi6UrCPgSq/WrjwXRfbU/vQtnpyNoYcBqyDTDtwozdq7Xx4rRq3Yh2YUU1cW1MmB6u7el6swUcyLcrAxh5qRhYfn10JBdGpP/Z/HcEEzaTzxYcDsT/BWjOaJI= + eJzFWt1z2zYSf/dfgc5oRlJGsq/XNzl2o7pO4pvUzTnxQ8fxaCASkhBTJAuQcnSd/O+3uwD4CVJ2m+v5IaKE/cLu/ha7YF7+mG7So6OTFy+O2As2VzxeJz//xN6/fc+CSIo4m7H579GtFup1HgeZTGKgQ9JXPM82iWLw9xq4HtgvfC8UrQRJuldyvcnYRfH0z398/8OEZUrytYg1e7Ndvp3AcpSsYzFhb4Ta8ngP3CdHRzHfCp3yQBTmXJAlp4WZ71Wyk6HQDJhA3hYWWbJiOVg5XVkztbWzYT1Llp9FkL1cqnNajVsEUjPuyFi24Rn+AqJDliVWIZv/+x1DJua49LGTeJUxJdZSZ0LpCcvjafENxIYsgmcSp1hhKQOt2UYw+HEnlBPkPj/CirVGxAFPdR7xTOhZk+5lHpnPSJ6TOPQjugWfV2XwSgIeZDmP2Ge+4zpQMs3qZCdOYNsQJX7PpYIAoJggiWNRdS5tNAAnLgWTscwkj+R/RIgyHmW2YZA1+JnkmVtGGSu5zhVHMcfNrc3jfZ3CSdfCKFMCMkvsIEbLPdlkDBlChghQFGrw+4OAFenxW6oEPQxweXoOMq/Bc6Phdl9Ed1Y+D8enjrNkuEhCYHDeY6PxH/skV2BzKL6eAofxp1VUVQ6ueLpl8bPMCp5r06tUJalQ2Z5p8Ga8ZgPKoCkFvppMtez1c6IWy0mPHZyGmQcPCCrWwDstahkHuMTY98c/UH0IIq51qyj9cYQ0VB/w74VV3chMu+hoXu24giLkiOzPJ/SZKrkDnLHBopQCFcijxe0Hso1nsP9lDvA89qniSvF9Q0uSgWxI3EHJy87Y3X1bF1TLSNiKIeNQfKlJAit1xi6vP978trie/3IJQoYYtGFb0NwWul4ZF7/+TDIwfCijKeTKAlsLiqy/zDacgN6q7HOO7jBOcYB2dVanIpCrfVnHqKRgJq0AMq1Ugr3gwhbzDASRyGYELr/wbRqJmftORCP3jVlvsbNz1gWxSYWY3ELEVYR9HTqScV17kQYpV3xbyTmESvFMf9NmUQV3WM80pBjP0V/Lq9OWg2wdNvUz5BlvmpZtVPKo2ac6Cj+Zj8svgUjbIMmXkQxKLYsFpZDKg2zk3+PEWt0y+IzFeRQZtxkw075MLatgEAgHVUQ6SrliI6kXJqpN6eNxRWZF7jKXUTgvaF+rZDv3CygVfT0y/7YQcVMc9J5SV3P11YrFCaMgCmIYUamdUNkcg4cELGoI+ITJDM7KKEJxJNZWWglVwtZUg7RmtoOKgQPOCUDGVGSf5AR6DgXdVP3crOihM5t0Eyd0K0L70xojaNR6F9CEjqQr0ovZH0TxAwTWtFD26F9xGRVQKORAB5CrmG3lFywgKhctvkeumc6DQGi9yqPj3jx2PZuJi83NiXViR6bW6rfNr/I3V0FdqpLgVlaW9HemHN2jLHyq5l9dkMmZHkFUqu4NbkK/oAH0cikgV5SmVyA3PU8TnY1qGm5VpGez25t3C+iFF7cfLm8Wr2+vLz5e/Xo98SFtjU2SEzgaT88/6yReQEMLJi0eFU9T9HZp9rgQMj4t7bRRLswluf/SKPG0C5a3ZQv+XGAWYYIJ4AAg90+Eo0dSLwD3Pvj50Wd7Ly8Al0kSCTgZB8Vw9TQg1nGIVmDrL6BLQBi2yoAXhSXoirafu0jueARE9kiv/QaMsFODWoGDghtZDp1BedyF3nKwPAPzIy2aGEY8Uak6O7OwawHLSiyzmmaFsR9VuQJRCJW3IoJgzmZ03sD3UR982B1pua8mflEyyP6WVS1FiKc4fI+x16gPKUDwcK2SPKW+BaNz32H3gWoQigjQQTL/KjjfiHJchpSpz8We7tGMc9QtJpSWPIr22B5ZcPBqlEscQwsVQ2cA+WzyDGZomMLD5JG6K27bTciigrnVvzdPuG8GoieeZX8ziiB0N0Vcqp29HtVw5D0K/2zeV/OxwOJ3Dot/MfULEZT+pcT7Vm/3FAyAf1oAGGBXjfSdCHAbk5CswI/0d0OTjsP7VpPqAFUn81l7csKWMEU/chVqGB22KbQ8SxnJbN9CJwrrhOONIfLe6nRkaaXNb00uNcbmwFtNtWpr0EgmZ3crBp2b+ACJ3nldcYwXdNscsLfhO0BCxuBchG+IkiIlJmyJ8Ip0QpWGKHW+nBYExXgPu1UK7CmmSpgdrx1VdXasrN8kSVal+ZAv+1gc56NK4nVVTwehvysYUD34H4x87rrMKOiY3zDbtYhWs1l5QTFhI2Pb2BrXf0pQRL2bsBliN1ppfjormzmzexNt7bG4NNCTcfVx2zfq/G3xoNvIZ8UDL3ueGY/D+31+XMjw58UFLe829APdD5fXcv6QDB7EvvlTX6aRKc2YPTNGI1Q6Yf4o4RHxndQL4zoibR0OprOIxWNT82h4FYNUGZbbZiBg2NHrNQfVO9RG0yKZ5unvkOPJHp+wLV/D3k3j1uroYBzC9y01IvPSBRo7dGs5E1XuwVwH5OSEIog4ZRlwVS5h2Uoq3ZrF+iNWUJFJ/RgGTzG8sCsd7Rm9TBtn3QnE5hOvMZtp2XWndihdNLgj2DCTJ400CbjG1yT1QsZmNZpKHjSq+WmLbqkEfzjtV0FXx30qqgXqSSpCseLQ/PTJrHvooNTiFg8/GqXtcMWoJsC0aDY6mWoNvcuAKsOEXd++e4e4L1MJcBEnGdaKQ2XTBN5TQ2yb6Yd4Z7vpJ/dWD8uCfXrX2Xil8a3vek3z3RIv+qMIfWdsG+PUIrZptsdHvKbmNObIZVS96+yYxv5cGNxdiPmqzYQFZtCVAByCkAHwzfp+3Ov8xcK6+FsGAO3p8zbZ2eXuZv4err/lKwJ8nw7DE72AWVNwZAzzH83YrQg8sTz+n9GxWHTho91WEFXnwfYTjrD1K7rqQaOSLRxja7kTce01X7OvMLcWrYuzb9D4db/LsDp7EtRS3DUPinaONs+Jbs7OG+senXhy9Ok0B0c3Z7u+g256YbyAjojrUeM15WxGixM2/OT+a4oLwfJTgxYbqP8CsBdRSQ== - + - ArangoDB PHP client: result set cursor for exports + ArangoDB PHP client: Traversal - - - + + + - + - ExportCursor - \ArangoDBClient\ExportCursor - - Provides access to the results of a collection export - The cursor might not contain all results in the beginning.<br> + Traversal + \ArangoDBClient\Traversal + + Provides graph traversal + A Traversal object is used to execute a graph traversal on the server side.<br> +<br> -If the result set is too big to be transferred in one go, the -cursor might issue additional HTTP requests to fetch the -remaining results from the server. - - +The object requires the connection object, the startVertex, the edgeCollection and the optional parameters.<br> +<br> + + + - - ENTRY_ID - \ArangoDBClient\ExportCursor::ENTRY_ID - 'id' - - result entry for cursor id - - - - - ENTRY_HASMORE - \ArangoDBClient\ExportCursor::ENTRY_HASMORE - 'hasMore' - - result entry for "hasMore" flag - - - - - ENTRY_RESULT - \ArangoDBClient\ExportCursor::ENTRY_RESULT - 'result' - - result entry for result documents - - - - - ENTRY_FLAT - \ArangoDBClient\ExportCursor::ENTRY_FLAT - '_flat' - - "flat" option entry (will treat the results as a simple array, not documents) - - - - - ENTRY_COUNT - \ArangoDBClient\ExportCursor::ENTRY_COUNT - 'count' - - result entry for document count + + OPTION_FIELDS + \ArangoDBClient\Traversal::OPTION_FIELDS + 'fields' + + count fields - - ENTRY_TYPE - \ArangoDBClient\ExportCursor::ENTRY_TYPE - 'type' - - "type" option entry (is used when converting the result into documents or edges objects) + + ENTRY_STARTVERTEX + \ArangoDBClient\Traversal::ENTRY_STARTVERTEX + 'startVertex' + + Collections index - - ENTRY_BASEURL - \ArangoDBClient\ExportCursor::ENTRY_BASEURL - 'baseurl' - - "baseurl" option entry. + + ENTRY_EDGECOLLECTION + \ArangoDBClient\Traversal::ENTRY_EDGECOLLECTION + 'edgeCollection' + + Action index - + $_connection - \ArangoDBClient\ExportCursor::_connection + \ArangoDBClient\Traversal::_connection - + The connection object - + \ArangoDBClient\Connection - - $_options - \ArangoDBClient\ExportCursor::_options - - - Cursor options + + $attributes + \ArangoDBClient\Traversal::attributes + array() + + The traversal's attributes. - + array - - $_result - \ArangoDBClient\ExportCursor::_result + + $_action + \ArangoDBClient\Traversal::_action - - The current result set + + - - array - + - - $_hasMore - \ArangoDBClient\ExportCursor::_hasMore - - - "has more" indicator - if true, the server has more results - - - boolean - - - - - $_id - \ArangoDBClient\ExportCursor::_id - - - cursor id - might be NULL if cursor does not have an id + + __construct + \ArangoDBClient\Traversal::__construct() + + Initialise the Traversal object - - mixed + + \ArangoDBClient\Connection - - - - $_fetches - \ArangoDBClient\ExportCursor::_fetches - 1 - - number of HTTP calls that were made to build the cursor result - - - - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - - - + string - - - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - - - + string - - - - __construct - \ArangoDBClient\ExportCursor::__construct() - - Initialize the cursor with the first results and some metadata - - - \ArangoDBClient\Connection - - - array - - + array - + \ArangoDBClient\ClientException @@ -5373,4039 +5852,3589 @@ remaining results from the server. \ArangoDBClient\Connection - $data + $startVertex - array + string - $options + $edgeCollection + string + + + $options + null array - - delete - \ArangoDBClient\ExportCursor::delete() - - Explicitly delete the cursor - This might issue an HTTP DELETE request to inform the server about -the deletion. - - \ArangoDBClient\Exception - - - boolean - - - - - getCount - \ArangoDBClient\ExportCursor::getCount() - - Get the total number of results in the export - - - integer - - - - - getNextBatch - \ArangoDBClient\ExportCursor::getNextBatch() - - Get next results as an array - This might issue additional HTTP requests to fetch any outstanding -results from the server - - \ArangoDBClient\Exception - - - mixed - - - - - setData - \ArangoDBClient\ExportCursor::setData() - - Create an array of results from the input array + + getResult + \ArangoDBClient\Traversal::getResult() + + Execute and get the traversal result - + array - - void + + \ArangoDBClient\Exception - + \ArangoDBClient\ClientException - - $data - - array - - - fetchOutstanding - \ArangoDBClient\ExportCursor::fetchOutstanding() - - Fetch outstanding results from the server + + getConnection + \ArangoDBClient\Traversal::getConnection() + + Return the connection object - - \ArangoDBClient\Exception - - - void + + \ArangoDBClient\Connection - - url - \ArangoDBClient\ExportCursor::url() - - Return the base URL for the cursor - - + + setStartVertex + \ArangoDBClient\Traversal::setStartVertex() + + Set name of the user function. It must have at least one namespace, but also can have sub-namespaces. + correct: +'myNamespace:myFunction' +'myRootNamespace:mySubNamespace:myFunction' + +wrong: +'myFunction' + string - - - - getFetches - \ArangoDBClient\ExportCursor::getFetches() - - Return the number of HTTP calls that were made to build the cursor result - - - integer + + \ArangoDBClient\ClientException + + $value + + string + - - getId - \ArangoDBClient\ExportCursor::getId() - - Return the cursor id, if any + + getStartVertex + \ArangoDBClient\Traversal::getStartVertex() + + Get name value - + string - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use + + setEdgeCollection + \ArangoDBClient\Traversal::setEdgeCollection() + + Set user function code - + string - - \ArangoDBClient\DocumentClassable + + \ArangoDBClient\ClientException - $class + $value string - \ArangoDBClient\DocumentClassable - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use + + getEdgeCollection + \ArangoDBClient\Traversal::getEdgeCollection() + + Get user function code - + string - - \ArangoDBClient\DocumentClassable + + + + set + \ArangoDBClient\Traversal::set() + + Set an attribute + + + + + \ArangoDBClient\ClientException - $class + $key - string + - \ArangoDBClient\DocumentClassable - - - eJytWVtPGzkUfs+v8CJUQhtg24d9gNItDeFSUUAQpK0KipwZJ/F2xs7aHkJ2xX/fczyeGc8tAamjFsLY5/6di52Pf85n805n7+3bDnlLjhQVU3n8hVyfXZMg4kyYfaKYTiJDNDMkSJSWikzgP3uaS2U0UCHh5zkNftIpIyTn0bfkdpEmZgYk8HylgtwaxmIqhF0K5Hyp+HRmSD//9OH39x96xCgODIUmp/H4rAfLkZwK1iOnTAH1Eqj3Oh1BY6ZBNquIPchNulbykYdMExoETGtiJDEz5ozSRE4IJYGMIhYYLoUzy1k1hI3O5NhqJiT4QApDuSA0inIu8CcyHbMpF4KL6e7HsfrkmJxPPIHWixy1kGTMp6jNmIGpVOgJU4qFyEoKRqayh2TIoKQB1zphhIYhR3VpRM6Gw2tg/k/CtLHWTZgJZhmtAk9z1ChXdaJkbBXSTD0ytfuiAGouAlwi5MPuH9bzQUTBmQPrrb5VsPNfBzdYt+MDlse4SjZHoQySGHj1LdEkEUGqPDdLt3fP/k40I8f+XjqOGISywteGRQrhQibHf8Mnt5jt+fxIFWAm21QSM1f8kRoGihVc6lJSq4ic47JuYk+VossWzo6sRfkEQi2Mh4nXsk8p69w3ZlSTWCq2AUAKeUANmLBDOGBQJaznBZ5kOzNkNKkwljJq0QDIvwF1XQUHVx6C3BSzgPDLu4sL1MIthhISEpNpRh8BzQJ2N4mP+RMLW+TzsC5aJPEYLIOctlkRQIpCSsyoIQsGhsY0ZDbjEh6F1hVOndQDLYJsPoG6h+R9XaKLIARTLW1ZzK0vcQOcaUMGl8Ob76PzY2C1xcOtF3DbcF7eIJOITltZnh3dfru6GSBfR/AS5u5Flpy6lf3N4PbuYojcU5IG5hugn9lwyeJkdBccSqRRDPzvl1zAHSWax/OIpRjvWSjkemy3KnJycWTVGKG0l5iY8QQuiTCtfPtXd5eWsd3WZJ5ZzlnVPCjjULBCspgxgewgqQxWWq/acwFwyw0j2DbDKWApLVkrLB1+v7bhRLlN+oypZomKyirttrL7cnQ7uLu5QI6OsoHpuYCeAkX5X+bnxoIb203IhCttiiCKkGgZQ1IxQ0NqaDV/51TR2KvAZNMr2Tt+/U57ILqyQmzBYV+RTRSRfsRylmqaIxjXAFWKmUQJiMh46RW6FUxdkU6ZBivrvZkpudDkvtwc79Nfg6eAzettJhlHPMjbHRmNbEhUEphus196Tjtrbf6H0ygFS9pkrfZmxvXOJ6+HQXg3/Y5W2em5EHfin7U9UFZJsUckUeRwgg/UbwA9dKuuJf6hWTTZ38+q2sP2tqddhaeTVyUp5D83inGm/9gqjxBbrbKAqjRArGLRKHxvj1ADo+c4geIfJ9p2LwCTYvkWoIZMb/WEK8agYt27rjqDO7rYWrcbvJKRe37PqDO4HuaYqEtwKQF7fjzUVtE7IK/btchqkp6W+sw34JdqkYCJD0DNTbQkIYuY8WtFJWeGILM8tYq0Lx8PLgbDQTa0Yv5zAdXaH0sJHcskK9j2vZUGNu+2ZGY1B8nntBzYGQbSG+cfOwd5MoKfQi4iLMlhSUamWo9MaAQzqUQALLhmK/M79Ue3mqcI5yITqrjFTlJ+40ezyGZI35S9W4IS3t0mu2Rrbwt+evw93GSPcwR64KC0+AwjEh4WurnzyCaravjclCaOpXVPK1ZOWdr4jTRQrIvhrHJqyo5c5bA6CdBBMXjNHFaGY8pMH9t5LSCOs1cVSylgh4GH3KgGmwR7MqVpRpRm9Xb8rz21wbmWAO61gfYKo0R5rqmd3V6bCXacBm9m+ha9vWQRHvAt7F22ZCOthkjNKJTE6kxed/wl8PuC0FqZDa5WHR5isSJv3lTLZBWJUJthmAzTU4v1he8H9zge1p9XhSu7zeW+QZ3frDq1/pIV1vQ5rBTcgyYdcgNtLS7tyDBYpS53olbPk5YMrIC1j7M3K+Lt5V4OJS7miWnEb2lgSgcwHL0CGRf3CS1Z+yh5WIXlq0Ynd/rKMZV1Lk+Z2jxUuWYoQlR67zXFEVb+6ub8XfPgU27FpcKBpxPAjYfjFbuaJ6UcMJXp7JkwTMg1RDWU+ehu0gVPGQ82//r5Ddj+Pr4dDY5PB1Ut8YE+zSi2jM1s6t6E6DbtrKsISX7oe31/P7AAPQEsHmFgu8irV3Xf9kGN93PpTaN3fpGyJez8MoU75U8NvfPE9gOvF/yqJuClZkuu1UtnJdOwMkkBZ92EFhJIWiPnYD/z0smfYKDQrBtfemRry3Pfu3fZkruF8adiG9PDQurOJ+g8X7UU3e2G4flVo3eFOKs+q+blUrH4bX0nW7D08is1zF1HSbwUMaXLYjxoB1DBE6HdOAXHKRhb209a6amthrAKwG7cUIjX1hRChtcDeGXSOs5nAIITbDGatEDIhreh868vou6mon7AK09tK2nb2imS2st3O+pPaN6/CvZ3KoIsByajwV/XVzfDts7qee+XXDo2jL3rZqyTNCPWjLdF4qw1JL+67GGs7FcsLwZAXb3zcJ1meIPrlIJ/9guFEY041V3/awWoubgCheE++0YomyTG9/5GrBv/A0pyseQ= - - - - ArangoDB PHP client: URL helper methods - - - - - - - - UrlHelper - \ArangoDBClient\UrlHelper - - Some helper methods to construct and process URLs - - - - - - getDocumentIdFromLocation - \ArangoDBClient\UrlHelper::getDocumentIdFromLocation() - - Get the document id from a location header - - - string - - - string - - - $location + $value - string + - - buildUrl - \ArangoDBClient\UrlHelper::buildUrl() - - Construct a URL from a base URL and additional parts, separated with '/' each - This function accepts variable arguments. - + + __set + \ArangoDBClient\Traversal::__set() + + Set an attribute, magic method + This is a magic method that allows the object to be used without +declaring all attributes first. + + \ArangoDBClient\ClientException + + string - - array + + mixed - - string + + + void - $baseUrl + $key string - $parts - array() - array + $value + + mixed - - appendParamsUrl - \ArangoDBClient\UrlHelper::appendParamsUrl() - - Append parameters to a URL - Parameter values will be URL-encoded - + + get + \ArangoDBClient\Traversal::get() + + Get an attribute + + + string - - array - - - string + + mixed - $baseUrl + $key string + + + __get + \ArangoDBClient\Traversal::__get() + + Get an attribute, magic method + This function is mapped to get() internally. + + + string + + + mixed + + - $params + $key - array + string - - getBoolString - \ArangoDBClient\UrlHelper::getBoolString() - - Get a string from a boolean value + + __isset + \ArangoDBClient\Traversal::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - - mixed - - + string + + boolean + - $value + $key - mixed + string + + __toString + \ArangoDBClient\Traversal::__toString() + + Returns the action string + + + + string + + + - eJydVm1v2zgM/p5fwRXFOSncutePadNu67D1DsOhuPY+XYdAlplYmCx5krwtOOy/j5JfYnteu2sKNLHJh3pIPqR9cVXm5WyWHB3N4AheGaa2+s1ruL25BS4FKreEf/5+DznKEg0U6HKdWXL13i9Lxj+yLQJ0wOuACUZWka8hG/zJFNw5xIIpFUxclzsjtrmD6+7X2envZzE4IyigsvCuSG9iMku9VRjDOzSE3hE6mc0UK9DS2Tg69rzL404XOOIMTgPXyjpTcQdMZVAazdFan98PGU3kY4XiPtXTk7NAg6UUi1EsLpmPYuRNOHD238wnHZj4zxGRd+ByhEzzqqBwIDLYGF0AA6k5c0IrIssywtaIFkh0DCuAzhFqC4ed8zHc3N/fgqEqUEb4VBSDrjKqDXM84EEnWGzoDNBJ+C6rVApOUIrPYVMpHs7ZonvTBPkje0vY9w2DeUdyEfB1LfxHbGD+Qth1zaLnt+g5hcIlwJmKHNGkNu1c7kmzVFfE1/kwXbbCgtIO8DMqKmUdeBCqSVxVUp53hm+zAadTWK1WHlxqu2cVQ5SsszSJpugFy0WWeh1eJmtWiqQtaXLBtZQYqnSZXHzE3eUA/VIK6+YxtH+He/e/KBrdENkCVoBfS6kznEdJFO8bv+hlASip8xPcnkvn+VSGBe31mAKMy0f3KGZlZIbcR/U+k6Ga3o1YwQk1JqL/hKthDaQ3btf7KQ+7qxm1lFG9/LWffZZlwsdk0k+AszFY9MPmaBa+CJeHU5DxfDRL9zmJrhsDxjmWzsJnRmsrlQjMbEPd7cnjk+y50MKgWWxZjRyZMWxH1QrkyHAcmNdXtMhYWaLKnppzWktYEK2sd8CjY51WQmbEa94SjBsiDY8V/PthPNeH1EsytIjzfQc32vgKwrxBM1vHGUvCi6adP2/3sxct4AWN5YaRyMf+PeE28cYiDXfPB6CesjrWJ6tGTHSBqpbjCDohyMrInynvVWgLhBaiQ1P3qlf91vG29SDpyAotaU5KSIMSjmsqP3T3+QpihfUKoqdwfVNvehSfEpF/cP1vIdX6DFnaoZ4aPmMVDbTi+Xqx0LqC1SX8dhiKNCUb2jWp1hS/9phSSm0iiViUm+WSnlyvCXHXbKgaN5bKI91v60576MpLJ3euXIe5WX+q0OzaBBY/04h/GWgfVt1qIkZI7QlspvteiK9U/iaZuiuT3uP2HdAmxANfrAaL/ov2XNCmN8ZwEMbsADRFNV+ExV9p8WQhR11ti1affAWRPy+CJUThxKitEVUpvEStmRTMzrtXqeUy3KaF8NC+GD40b2bpQ+cVUa2/Ax4tFgg= + eJzVWG1v2zYQ/u5fwQEGLAeKvW775HRZvdRNPHhpYLvFhqYQKImW1cikSlJJvGH/fUfqnZLsGuswTB8sSzrey3MPj0e+/Cnexr3e+Oysh87QlGMasNc/o7ubO+RFIaFygtYcPxIucAQSSugVTuSWcQTXG5B/QL/iPeH6i8fiPQ+DrURXxb/vvn3xvY0kD3FAqEDXO/fGhs8RCyix0TXhO0z3MHrc61G8IyLGHikcudI+XBQO3nH2GPpEoIDjeAta665NS2cRcz8RT6JQoEQQH0mGyDPxEkkQNkcjRpHcEiQIhxdIgIXRS5dfKpXZXf1dg0imlZPPScjBDzXMY5TCyxC0pJ/tVJvEXL4nXJLn9AXxAwKBR5kspr5+zWL1CF7EmAMAElxqs/4qCgFrfW2ljMVkPPaZJ0ZYQ+W7I4/txjfr9d24wGAcUp88j7ZyV+QO0H2ARICSOsT6owipR7SFF6MfdEq8CAtRYcCfPfVVJ0NdKSaN+LOPucyrR8wh47lQ9nqs7zEPHzHkpO+UWiDdLVaKbA0EwhL45EIuxajNFuYc7w0zTIJy4EG/HIt+RB8+No15LKESbUIS+aKmBDwUEr29W8/f3jpv5rPF6xWoGKSSg6aiMtcC6Uy0aJvdrpe/O6v1dLl+P1uuZ78pjRXmtKidplAf1jh7fT27ertYzK6Ut0ppnX0tejV0fQen6gWgRAONfPYGMIzBpz1iG83bIiGjLqgzXU1TcxrKEEehIFqTOWnNnOqJUWEQ6lcop65zcx7CbHeJnviGkiwsdfUrMKdKQJ6jTUJzgFMn/8D60ccSH1BmTO7TlWnSpvO7n5YEYeIgt5w9CXRfn7r36W327JG4Ob8SNwq90g/H0SzhiSetdkDtGjC2GZmdOZr7CNSiSRQNtbW0POgQ5DYU55eVWQ2C/eocNyQFkavSrFX1YdgmPKt5ZRleDjPOqSvcICsUjnbbyt0eDivOVjTXqoMe4uwID4jV+G4XEFT8+6uX/jYYP8vXHij6AZH1CQTLiUiiBu05kQmnOd4gE4MxMq0Ut05KmGT4KtwBv5faUWvYM9PtMn9/p3iscGtgddEr01EEUgpWWHJ+GTMhrVpq3vFITCbvlgtnvZxClVxNF3Zb7sC/ktLW8Pzyk2DUIdRjPnGeYMmH8mVVPB0WSqp0yVAv3NR6fxFK40VXdpfpmNZmoCOrlcnXqF61gWZVraajGq6RkTyMBsKdQayAlqoDy+t7rYCN0FyiXQLryxZICwswigiGJ0YJKto2G0G2EY4EQx6mqaRI3PNCoFiuIVrOwZ9J/jzY7W9zqclu/yYzO6h8XzImqzKrxD00JB/5xBkNqnY6BNtre/8RRwn5FwqxWe+0nY4qCrKWINFmMmm0CzayUk+HmavdJL3O89saUsaXLGwld6wWVN0/zL6g2//S3RY21pdQNY3/s1yZy80p6ar3Yidm7DgGp2fOCOa05NWj6XZeJRCKQLEItKeu/0D25qtDaTwxbZbSb6P2dKnG4BvoDFLktGijLdBmESVPpmVrMKegNfTLCBEoGNSaAZMZ5Yr4QVn7qJZA7doXo2ijHQ4gSNgnbplvgLQGI2rDi2tCEANWVTlS+MlyD1v2yOgpBMEkX3GQT2Dfp9kEoyqbLdgUcSEbW66DqemYqhA9Ui13CV6FuLnwLnwG5zKIQDi9bxjvZpUOvGOGPLLQP0gYxzlGGQFIeVuUcsWgioeFOkJoLXNoUhOtUKJ9HbhoiLuc4IeLwwaNTd8hm+317IvM+mSDoQk8pL2O4VGtRdesbkb9O1RCWpPd5Nl50dZ0asoYkhIuJ1p1gI1u3y0WqmSUjIWZRplUZeZYwU350lJ+QqHRaq8OjWJUL8ymeGvhyYaoLVrXSmuifLzElLtaAbLQVuvjNRXnEDa6knAKdWPfqBP/j3Q5TlfCmuuiluqs3XOhjj2DgHDw0t3DfI0iFWWa9CGCOkZ2sdyrv+qEAHvQIYvQjUh+1hK2HHD9E8BcxqBtp1kkyj2FG/QX0LMT6EuACfCUoTQ8AlPG3a/JbOXPIRprP4/swtI1rnaKdcoikQGb7ckS2KVQ2aqtCxbJVmk/cWRHhmu7MQhHn7U60FJgYRUnYpOJfm2jwX1+hJ53su59IaW6jr8BeLzhcA== - + - ArangoDB PHP client: AQL query result cache handling + ArangoDB PHP client: View class - + + - - \ArangoDBClient\Handler - QueryCacheHandler - \ArangoDBClient\QueryCacheHandler - - A base class for REST-based handlers - - - + + + View + \ArangoDBClient\View + + Value object representing a view + <br> + + - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object + + ENTRY_ID + \ArangoDBClient\View::ENTRY_ID + 'id' + + View id index - - \ArangoDBClient\Connection - - - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - + + + ENTRY_NAME + \ArangoDBClient\View::ENTRY_NAME + 'name' + + View name index - + + + + ENTRY_TYPE + \ArangoDBClient\View::ENTRY_TYPE + 'type' + + View type index + + + + + $_id + \ArangoDBClient\View::_id + + + The view id (might be NULL for new views) + + string - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - + + $_name + \ArangoDBClient\View::_name + + + The view name - + string - - enable - \ArangoDBClient\QueryCacheHandler::enable() - - Globally turns on the AQL query result cache + + __construct + \ArangoDBClient\View::__construct() + + Constructs an empty view - - \ArangoDBClient\Exception + + array - - - - disable - \ArangoDBClient\QueryCacheHandler::disable() - - Globally turns off the AQL query result cache - - - \ArangoDBClient\Exception - - - - - enableDemandMode - \ArangoDBClient\QueryCacheHandler::enableDemandMode() - - Globally sets the AQL query result cache to demand mode - - - \ArangoDBClient\Exception - - - - - clear - \ArangoDBClient\QueryCacheHandler::clear() - - Clears the AQL query result cache for the current database - - - \ArangoDBClient\Exception - - - - - getEntries - \ArangoDBClient\QueryCacheHandler::getEntries() - - Returns the entries from the query cache in current database - - - \ArangoDBClient\Exception - - - array - - - - - setProperties - \ArangoDBClient\QueryCacheHandler::setProperties() - - Adjusts the global AQL query result cache properties - - - \ArangoDBClient\Exception - - - array + + string - - array + + + \ArangoDBClient\ClientException - $properties + $name array - - - getProperties - \ArangoDBClient\QueryCacheHandler::getProperties() - - Returns the AQL query result cache properties - - - \ArangoDBClient\Exception - - - array - - - - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler - - - \ArangoDBClient\Connection - - - $connection + $type - \ArangoDBClient\Connection + string - \ArangoDBClient\Handler - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object + + getId + \ArangoDBClient\View::getId() + + Return the view id - - \ArangoDBClient\Connection + + string - \ArangoDBClient\Handler - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection + + setId + \ArangoDBClient\View::setId() + + Set the view's id - - - mixed - - - \ArangoDBClient\ClientException - - - - $optionName - - - - \ArangoDBClient\Handler - - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - - array - - + string - - \ArangoDBClient\ClientException - - - - $body - - array - - \ArangoDBClient\Handler - - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array - - - array - - - array - - - array + + void - $options - - array - - - $body + $id - array - - - $includeArray - array() - array + - \ArangoDBClient\Handler - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name + + getName + \ArangoDBClient\View::getName() + + Return the view name - - \ArangoDBClient\ClientException - - - mixed - - + string - - $value - - mixed - - \ArangoDBClient\Handler - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use + + getType + \ArangoDBClient\View::getType() + + Return the view type - + string - - \ArangoDBClient\DocumentClassable - - - $class - - string - - \ArangoDBClient\DocumentClassable - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use + + getAll + \ArangoDBClient\View::getAll() + + Return the view as an array - - string - - - \ArangoDBClient\DocumentClassable + + array - - $class - - string - - \ArangoDBClient\DocumentClassable - - No summary for class \ArangoDBClient\QueryCacheHandler - - eJzVV9tO20AQffdXjBBSEpRAW6kvplDSEBFVVAqpeKigitb2ODFd77q760KE+PfObpz7BdOGByzFt9k5M3M8Z+x8+pwNM887Ojjw4ACaiomBPP8C3U4XQp6gMD40ry7hd45qBAp1zg2ELBwiDJmIeCIG5GddzzIW/mIDBJiitByAM7LcDKUiG3xlAr4bxJQJ4UyhzEYqGQwNtKZnH969/1gHoxICFBou0qBTJzOXA4F1uEBF3iPyPvI8wVLUFBuXwh57XsiZ1nBlU2/ZlDs2Y1SADwZFpKG49h49z2bmOLDbAVxwGTDOR2ByRfGlAEMVryei8Jm4npmhkvca2g8hZiaRojAcuWOWBzwJIc5FaG2AggUcqzVnfBwvpW0/VxxO4FrxDvIMle8HecIjuq7ST/v+de+yf3Xd7v3ot5qtTrsON5VMSVppEtSVn7XjGZQZJrpxOkDTkkKgC1utNU6z3FRtmPpkxZ2Woo8ilBH27xXLCKx6U0npsgInp1CRgnAL4CfvWcri+LU4ixL9dkiL43KsaTR6C2FgJERWMxFY8B303LlD+0Zgb4LIcfELXC5R2eLI1FYOY5pA1hzmStGEgIgZFjD9f2yGNuwuKCxDW4QcDTrmpjzY/TIXPRyr0FZLlSp6LBArmbobY2bGlCTiX9mY2pWLBUwpNoLGNBwhzwVaoHAtj1Rre+y6k34s0lhsxqIbTjbySzcm5E69ivoKZ7fmq7bLNzViM7rLdaHmgdP3poaciealpGdMsRQK0vdnOM7emHvMG+IdTpC2b8aphnN5Ty/6OXfCExAg5BojvxxUA1L20HPZaN+eJ2megsjTgN7IMi4S1WXzYmZTkfcJ5zCUPCoHRRUtt/7zldBY8mEmsTVZUEdLW1dcLwdKi90rIDFLo/4QulLrhCY2/GE8J+6ZKpnonhR7ddrHMR0owN4Ydu9wm4S3DjtKsTttgupK960IN5DRqGtbVVvRzRbOycuJ220vUPiSqDMpNG6Rdam3zVyytQ36d3FKTID58btz6Zd+WIOFh7V2qL4y78+M0010PhWf7n3GE6arKx/wvu/MdajcTv4i3BYf/8HtyuoK4f4FYBu70Q== + eJyNlUmP2jAUgO/5Fe+AxCIo3Q4VDHQog2bRFKEZijQqFXISQ9wGJ7INM6jqf6+XJJCN4Esgb/ve5lx9Db3QsrqtlgUtGDFEN8HNN5jdzcDxCaaiBwuCX+UfxLlUUVrXIXL+oA0GSAzGWlcL0U54AZMyeEAUngXGW0SpFjlBeGBk4wkYJ78+vv/wpX0MfLu179pS7Acbittwi5m0PsSBOaGOCgvw6d1n+aZrWRRtMZdAOMPST5JaIH+HIbB/Y0cAwyHDXMoJ3QCCvcwtcn5ls+FFCeYhdHF0nay/lhLoyOq0YO5hHQWIC42tTtnGMP3x+AhrWSYqJUrMm5FBbHe9Rwy4YIqzE3uIhF39DFkgZErYhdqKuDLfssiqRNXeT7Ty/pWwr99moyyi3Ah18VvK3gkoFzCZzp9eVvc3MIA6cet5zEUcvMLFdPR9opwo1foZFnEIq1zNX2balVItcTVW6mznCA5yivE2FIdoWNJ1DBFDW0CMoQPUdBbmdExKqsUnZrF+VPmaZo309zF8NkRm3tJC4bHglcMyPadL85i8OTgUJKDpvu5snziw3lFHyWC1cuJkGzqFtgEzE2kGWp2a8AjvDPUsyOrVjjNxKtUpDYwHI/2Xa/kTFjtGQRxXI5sWMxrn5z+TxwaLe7fRhAx25CrmU5tiqIra/oxFglXnBWCp/mW5svj7oAKZa+QacXPUR1xVzPPQ2XIW7XthQfMrny/pVOpUFvU4CpcRFo15IeGJYinhXOpUEp6O4yWESO+93usSULPzEaeLBCqwKWUe+X4p8s/khToc++teL7lF4zMYxqlFY98utdIXZ4GV6Wy5nb4lC+xMvY92v+K6ykXXX8IV8gniDXUb93r6TRvqS9lX+UmlPL6q7KVSqDf71n+69j+0 - + - ArangoDB PHP client: mixin for $_documentClass functionality + ArangoDB PHP client: default values - + - - DocumentClassable - \ArangoDBClient\DocumentClassable - - Add functionality for $_documentClass - - - + + + DefaultValues + \ArangoDBClient\DefaultValues + + Contains default values used by the client + <br> + + - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - - - - string - - - - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - - - - string - - - - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use - - - string - - - \ArangoDBClient\DocumentClassable - - - - $class - - string - - - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use + + DEFAULT_PORT + \ArangoDBClient\DefaultValues::DEFAULT_PORT + 8529 + + Default port number (used if no port specified) - - string - - - \ArangoDBClient\DocumentClassable - - - $class - - string - - - - eJydUU1PwkAQve+vmAMJSlD8OhjxAwWC8UTClcQs26Hd2O42u1MjMfx3t1uoFAoS59Jm5817897cP6VRylin1WLQgmfDVagHLzB+HYOIJSq6g0R+SQVzbaDxHmiRJe61H3NrYZ4pQVIrHktauPmcopdy8cFDBCjZ+p7IN3lGkSNy9cYVTAgx4Ur5ltDpwsgwIuiXf1cXl7dtICMdobIwSmavbdeOdaiwDSM0bjoX7jCmeILWaeOWbPfXXBBUN67ztO2ixoOVSuT2rs9vvDQZLgkGmyx8FiP7ZrlPL56Xm/zkBqxzo8IS7lLOkyQNmcUVsOO/qdGEgjDYif0BmtPqXtM1XbPrZw8pDwNn6yhVdMi9ijmNU9tWmiA53gghOGCwXCvlhifrxRoF8lAy0DNImVE1aVdMZLNYivLYYJEqAyeF1KkHF2fKq0GRtGePO2kX6G6JW+3g4cXrsjb1MgvcE/nBHPbd6f8ZDNf3/MP/5t2P8c6W7AdpWkd8 - - - - ArangoDB PHP client: document handler - - - - - - - - \ArangoDBClient\Handler - DocumentHandler - \ArangoDBClient\DocumentHandler - - A handler that manages documents - A document handler that fetches documents from the server and -persists them on the server. It does so by issuing the -appropriate HTTP requests to the server.<br> - -<br> - - - - - - ENTRY_DOCUMENTS - \ArangoDBClient\DocumentHandler::ENTRY_DOCUMENTS - 'documents' - - documents array index + + + DEFAULT_TIMEOUT + \ArangoDBClient\DefaultValues::DEFAULT_TIMEOUT + 30 + + Default timeout value (used if no timeout value specified) - OPTION_COLLECTION - \ArangoDBClient\DocumentHandler::OPTION_COLLECTION - 'collection' + DEFAULT_FAILOVER_TRIES + \ArangoDBClient\DefaultValues::DEFAULT_FAILOVER_TRIES + 3 - collection parameter + Default number of failover servers to try (used in case there is an automatic failover) +if set to 0, then an unlimited amount of servers will be tried - OPTION_EXAMPLE - \ArangoDBClient\DocumentHandler::OPTION_EXAMPLE - 'example' + DEFAULT_FAILOVER_TIMEOUT + \ArangoDBClient\DefaultValues::DEFAULT_FAILOVER_TIMEOUT + 30 - example parameter + Default max amount of time (in seconds) that is spent waiting on failover - OPTION_OVERWRITE - \ArangoDBClient\DocumentHandler::OPTION_OVERWRITE - 'overwrite' + DEFAULT_AUTH_TYPE + \ArangoDBClient\DefaultValues::DEFAULT_AUTH_TYPE + 'Basic' - overwrite option + Default Authorization type (use HTTP basic authentication) - OPTION_RETURN_OLD - \ArangoDBClient\DocumentHandler::OPTION_RETURN_OLD - 'returnOld' + DEFAULT_WAIT_SYNC + \ArangoDBClient\DefaultValues::DEFAULT_WAIT_SYNC + false - option for returning the old document + Default value for waitForSync (fsync all data to disk on document updates/insertions/deletions) - OPTION_RETURN_NEW - \ArangoDBClient\DocumentHandler::OPTION_RETURN_NEW - 'returnNew' + DEFAULT_JOURNAL_SIZE + \ArangoDBClient\DefaultValues::DEFAULT_JOURNAL_SIZE + 33554432 - option for returning the new document + Default value for collection journal size - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object + + DEFAULT_IS_VOLATILE + \ArangoDBClient\DefaultValues::DEFAULT_IS_VOLATILE + false + + Default value for isVolatile - - \ArangoDBClient\Connection - - - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - + + + DEFAULT_CREATE + \ArangoDBClient\DefaultValues::DEFAULT_CREATE + false + + Default value for createCollection (create the collection on the fly when the first document is added to an unknown collection) - - string - - - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - + + + DEFAULT_CONNECTION + \ArangoDBClient\DefaultValues::DEFAULT_CONNECTION + 'Keep-Alive' + + Default value for HTTP Connection header - - string - - - - get - \ArangoDBClient\DocumentHandler::get() - - Get a single document from a collection - Alias method for getById() - - \ArangoDBClient\Exception - - - string - - - mixed - - - array - - - \ArangoDBClient\Document - + + + DEFAULT_VERIFY_CERT + \ArangoDBClient\DefaultValues::DEFAULT_VERIFY_CERT + false + + Default value for SSL certificate verification + - - $collection - - string - - - $documentId - - mixed - - - $options - array() - array - - - - has - \ArangoDBClient\DocumentHandler::has() - - Check if a document exists - This will call self::get() internally and checks if there -was an exception thrown which represents an 404 request. - - \ArangoDBClient\Exception - - + + + DEFAULT_VERIFY_CERT_NAME + \ArangoDBClient\DefaultValues::DEFAULT_VERIFY_CERT_NAME + false + + Default value for SSL certificate host name verification + + + + + DEFAULT_ALLOW_SELF_SIGNED + \ArangoDBClient\DefaultValues::DEFAULT_ALLOW_SELF_SIGNED + true + + Default value for accepting self-signed SSL certificates + + + + + DEFAULT_CIPHERS + \ArangoDBClient\DefaultValues::DEFAULT_CIPHERS + null + + Default value for ciphers to be used in SSL + + + + + DEFAULT_UPDATE_POLICY + \ArangoDBClient\DefaultValues::DEFAULT_UPDATE_POLICY + \ArangoDBClient\UpdatePolicy::ERROR + + Default update policy + + + + + DEFAULT_REPLACE_POLICY + \ArangoDBClient\DefaultValues::DEFAULT_REPLACE_POLICY + \ArangoDBClient\UpdatePolicy::ERROR + + Default replace policy + + + + + DEFAULT_DELETE_POLICY + \ArangoDBClient\DefaultValues::DEFAULT_DELETE_POLICY + \ArangoDBClient\UpdatePolicy::ERROR + + Default delete policy + + + + + DEFAULT_CHECK_UTF8_CONFORM + \ArangoDBClient\DefaultValues::DEFAULT_CHECK_UTF8_CONFORM + false + + Default value for checking if data is UTF-8 conform + + + + + eJydVltP4zgUfu+vOG8UBFO2DBJbZi+ZNKWZCU2VpoxYIUVu4rReHDuKHdjOav/7HLsX6EjNFvqSNOfyfedqf/qjXJStVufkpAUn4FREzGX/M4yHY0g5o0L3IKM5qbmGJ8JrqlDNaP5ZkvSRzCnA1si1+lZIar2QFcrgCxEw0ZQWRAgrSmW5rNh8ocHdvnXPf+megq4YOhQKborZ8BTFXM4FPYUbWqH1Eq07rZYgBVWITX+Cvd7G4EqhCUM3u7yhVjSD2RL0gq5DW4fyaVb9flBUionUiADOP3QtHTJTuiKpRodEKeivEO9Wifq3ZVQtK/M72YihlJUGURczWkHb0mI5CLn6rkqaspzR7Hht1rHPVAqloe8NnGkQJ+MwiuE3uLrs/oqB74HRrKCyXse/A7QrOQgx9m+9cGpAL86vrXwf7DowmUNOGJdP+K5ohQ8FGqGr5YaKgJQoaupRUWAKsFOwb2RBNEu3thtOhrmi2rg4PzU2wujXgrOCafRGClkLbVA3YM+Mc5hR01Y0a4hs4PhBeOdFSRz53sQE2BxfQf55hWZSCW2MRVF0m6lj5Ea0CQfTiirPhGkm5iDFNqSDuBycbseOGvuOWUMMvSxXpYZhHI9hRhTm0kwjcmGp1WmqsjONh0l8P/YQ+OizMT7a31+r7slxzk2QA1lNliKFdq7Mg2DyM6KJKVjG1KNJQCbTujBJqUsUUdXBKaWV4aQ6GeXUvjXR++b4cTK5H7lILydc0UPIpZJzmtrs/C3rShAOin2nDTBfwmk0coJk4v9lEnFxcXn58eNF9xAwpu4kxzTzJv/+JLkLAyf2A+9NgVQUs+a+hNNefVlttJfPpg3wS86X8GzmxP5hFRLYFsBMW5bh2GB17Bg9CvksXjlpqoIbeU78Jua2F3EvizXDBSVZ4xy44WjkubEfjkwjfqW0PHM4e6IHdeNkEkBq+io3HU8BR271itANmDh2/uA+cT27WtexNU3efsSFRL/mpHoHdjJybt+UXJKmtLQ7RlGenymGh2b2MyXVNPRBEH5LJl4wwI6/GXl9RNdVfVhPsnKx3uy4ajd7HcGbiuuPh15kNq2oOd+PstoSeCpyli4b/E3HfexHPBMD371Hr1NrN7ZmvZ4XRWG0H6SiJTe3if9Fibxx4LjvhbHr7QCUvhd4747lVVkWNH00LYGnpt3COPDTeHB2ZeBQoWgqz9BzvyaofWXGcBBGty/d+F+rZW86CeGMqPbOfafXs6JTOHrY3OQe1peo2cOO5tHxdesHwdIT5g== + + + + ArangoDB PHP client: single user document + + + + + + + \ArangoDBClient\Document + User + \ArangoDBClient\User + + Value object representing a single User document + <br> + + + + + + ENTRY_ID + \ArangoDBClient\Document::ENTRY_ID + '_id' + + Document id index + + + + + ENTRY_KEY + \ArangoDBClient\Document::ENTRY_KEY + '_key' + + Document key index + + + + + ENTRY_REV + \ArangoDBClient\Document::ENTRY_REV + '_rev' + + Revision id index + + + + + ENTRY_ISNEW + \ArangoDBClient\Document::ENTRY_ISNEW + '_isNew' + + isNew id index + + + + + ENTRY_HIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES + '_hiddenAttributes' + + hidden attribute index + + + + + ENTRY_IGNOREHIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES + '_ignoreHiddenAttributes' + + hidden attribute index + + + + + OPTION_WAIT_FOR_SYNC + \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC + 'waitForSync' + + waitForSync option index + + + + + OPTION_POLICY + \ArangoDBClient\Document::OPTION_POLICY + 'policy' + + policy option index + + + + + OPTION_KEEPNULL + \ArangoDBClient\Document::OPTION_KEEPNULL + 'keepNull' + + keepNull option index + + + + + KEY_REGEX_PART + \ArangoDBClient\Document::KEY_REGEX_PART + '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' + + regular expression used for key validation + + + + + $_id + \ArangoDBClient\Document::_id + + + The document id (might be NULL for new documents) + + string - - mixed - - - boolean - - - $collection - - string - - - $documentId - - mixed - - - - getById - \ArangoDBClient\DocumentHandler::getById() - - Get a single document from a collection - This will throw if the document cannot be fetched from the server. - - \ArangoDBClient\Exception - - + + + $_key + \ArangoDBClient\Document::_key + + + The document key (might be NULL for new documents) + + string - + + + + $_rev + \ArangoDBClient\Document::_rev + + + The document revision (might be NULL for new documents) + + mixed - - array - - - \ArangoDBClient\Document - - - $collection - - string - - - $documentId - - mixed - - - $options - array() - array - - - - getHead - \ArangoDBClient\DocumentHandler::getHead() - - Gets information about a single documents from a collection - This will throw if the document cannot be fetched from the server - - \ArangoDBClient\Exception + + + $_values + \ArangoDBClient\Document::_values + array() + + The document attributes (names/values) + + + array - - string + + + + $_changed + \ArangoDBClient\Document::_changed + false + + Flag to indicate whether document was changed locally + + + boolean - - mixed + + + + $_isNew + \ArangoDBClient\Document::_isNew + true + + Flag to indicate whether document is a new document (never been saved to the server) + + + boolean - + + + + $_doValidate + \ArangoDBClient\Document::_doValidate + false + + Flag to indicate whether validation of document values should be performed +This can be turned on, but has a performance penalty + + boolean - - string + + + + $_hiddenAttributes + \ArangoDBClient\Document::_hiddenAttributes + array() + + An array, that defines which attributes should be treated as hidden. + + + array - + + + + $_ignoreHiddenAttributes + \ArangoDBClient\Document::_ignoreHiddenAttributes + false + + Flag to indicate whether hidden attributes should be ignored or included in returned data-sets + + + boolean + + + + + __construct + \ArangoDBClient\Document::__construct() + + Constructs an empty document + + array - $collection - - string - - - $documentId - - mixed - - - $revision - null - string - - - $ifMatch + $options null - boolean + array + \ArangoDBClient\Document - - createFromArrayWithContext - \ArangoDBClient\DocumentHandler::createFromArrayWithContext() - - Intermediate function to call the createFromArray function from the right context + + createFromArray + \ArangoDBClient\Document::createFromArray() + + Factory method to construct a new document using the values passed to populate it - - - - \ArangoDBClient\Document - - + \ArangoDBClient\ClientException + + array + + + array + + + \ArangoDBClient\Document + \ArangoDBClient\Edge + \ArangoDBClient\Graph + - $data + $values - + array $options - - + array() + array + \ArangoDBClient\Document - - store - \ArangoDBClient\DocumentHandler::store() - - Store a document to a collection - This is an alias/shortcut to save() and replace(). Instead of having to determine which of the 3 functions to use, -simply pass the document to store() and it will figure out which one to call. - -This will throw if the document cannot be saved or replaced. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document + + __clone + \ArangoDBClient\Document::__clone() + + Clone a document + Returns the clone + + + void - - mixed + + \ArangoDBClient\Document + + + __toString + \ArangoDBClient\Document::__toString() + + Get a string representation of the document. + It will not output hidden attributes. + +Returns the document as JSON-encoded string + + + string - + + \ArangoDBClient\Document + + + toJson + \ArangoDBClient\Document::toJson() + + Returns the document as JSON-encoded string + + array - - mixed + + string - - - $document - - \ArangoDBClient\Document - - - $collection - null - mixed - $options array() array + \ArangoDBClient\Document - - save - \ArangoDBClient\DocumentHandler::save() - - save a document to a collection - This will add the document to the collection and return the document's id - -This will throw if the document cannot be saved - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\Document - array - - + + toSerialized + \ArangoDBClient\Document::toSerialized() + + Returns the document as a serialized string + + array - - mixed + + string - - - $collection - - mixed - - - $document - - \ArangoDBClient\Document|array - $options array() array + \ArangoDBClient\Document - - insert - \ArangoDBClient\DocumentHandler::insert() - - Insert a document into a collection - This is an alias for save(). + + filterHiddenAttributes + \ArangoDBClient\Document::filterHiddenAttributes() + + Returns the attributes with the hidden ones removed + + + array + + + array + + + array + - $collection - - - - - $document + $attributes - + array - $options + $_hiddenAttributes array() array + \ArangoDBClient\Document - - update - \ArangoDBClient\DocumentHandler::update() - - Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document. - Attention - The behavior of this method has changed since version 1.1 - -This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the document to-be-replaced is the same as the one given. - - \ArangoDBClient\Exception + + set + \ArangoDBClient\Document::set() + + Set a document attribute + The key (attribute name) must be a string. +This will validate the value of the attribute and might throw an +exception if the value is invalid. + + \ArangoDBClient\ClientException - - \ArangoDBClient\Document + + string - - array + + mixed - - boolean + + void - $document + $key - \ArangoDBClient\Document + string - $options - array() - array + $value + + mixed + \ArangoDBClient\Document - - updateById - \ArangoDBClient\DocumentHandler::updateById() - - Update an existing document in a collection, identified by collection id and document id -Attention - The behavior of this method has changed since version 1.1 - This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the document to-be-updated is the same as the one given. - - \ArangoDBClient\Exception + + __set + \ArangoDBClient\Document::__set() + + Set a document attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. +This function is mapped to set() internally. + + \ArangoDBClient\ClientException - + + string - + mixed - - \ArangoDBClient\Document - - - array - - - boolean + + void - $collection + $key string - $documentId + $value mixed - - $document - - \ArangoDBClient\Document - - - $options - array() - array - + \ArangoDBClient\Document - - replace - \ArangoDBClient\DocumentHandler::replace() - - Replace an existing document in a collection, identified by the document itself - This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document - - - array + + get + \ArangoDBClient\Document::get() + + Get a document attribute + + + string - - boolean + + mixed - $document + $key - \ArangoDBClient\Document - - - $options - array() - array + string + \ArangoDBClient\Document - - replaceById - \ArangoDBClient\DocumentHandler::replaceById() - - Replace an existing document in a collection, identified by collection id and document id - This will update the document on the server - -This will throw if the document cannot be Replaced - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given. - - \ArangoDBClient\Exception - - - mixed + + __get + \ArangoDBClient\Document::__get() + + Get a document attribute, magic method + This function is mapped to get() internally. + + + string - + mixed - - \ArangoDBClient\Document - - - array - - - boolean - - $collection - - mixed - - - $documentId - - mixed - - - $document + $key - \ArangoDBClient\Document - - - $options - array() - array + string + \ArangoDBClient\Document - - remove - \ArangoDBClient\DocumentHandler::remove() - - Remove a document from a collection, identified by the document itself + + __isset + \ArangoDBClient\Document::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document - - - array + + string - + boolean - $document + $key - \ArangoDBClient\Document + string + \ArangoDBClient\Document + + + __unset + \ArangoDBClient\Document::__unset() + + Magic method to unset an attribute. + Caution!!! This works only on the first array level. +The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. + + + - $options - array() - array + $key + + + \ArangoDBClient\Document - - removeById - \ArangoDBClient\DocumentHandler::removeById() - - Remove a document from a collection, identified by the collection id and document id + + getAll + \ArangoDBClient\Document::getAll() + + Get all document attributes - - \ArangoDBClient\Exception - - - mixed - - - mixed - - + mixed - + array - - boolean - - - $collection - - mixed - - - $documentId - - mixed - - - $revision - null - mixed - $options array() - array + mixed + \ArangoDBClient\Document - - getDocumentId - \ArangoDBClient\DocumentHandler::getDocumentId() - - Helper function to get a document id from a document or a document id value + + getAllForInsertUpdate + \ArangoDBClient\Document::getAllForInsertUpdate() + + Get all document attributes for insertion/update - - \ArangoDBClient\ClientException - - - mixed - - + mixed - - $document - - mixed - + \ArangoDBClient\Document - - getRevision - \ArangoDBClient\DocumentHandler::getRevision() - - Helper function to get a document id from a document or a document id value + + getAllAsObject + \ArangoDBClient\Document::getAllAsObject() + + Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class - - \ArangoDBClient\ClientException - - + mixed - + mixed - $document - + $options + array() mixed + \ArangoDBClient\Document - - createCollectionIfOptions - \ArangoDBClient\DocumentHandler::createCollectionIfOptions() - - + + setHiddenAttributes + \ArangoDBClient\Document::setHiddenAttributes() + + Set the hidden attributes +$cursor - - + array + + void + - $collection - - - - - $options + $attributes array + \ArangoDBClient\Document - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler + + getHiddenAttributes + \ArangoDBClient\Document::getHiddenAttributes() + + Get the hidden attributes - - \ArangoDBClient\Connection + + array - - $connection - - \ArangoDBClient\Connection - - \ArangoDBClient\Handler + \ArangoDBClient\Document - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object + + isIgnoreHiddenAttributes + \ArangoDBClient\Document::isIgnoreHiddenAttributes() + + - - \ArangoDBClient\Connection + + boolean - \ArangoDBClient\Handler + \ArangoDBClient\Document - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection + + setIgnoreHiddenAttributes + \ArangoDBClient\Document::setIgnoreHiddenAttributes() + + - - - mixed - - - \ArangoDBClient\ClientException + + boolean - $optionName + $ignoreHiddenAttributes - + boolean - \ArangoDBClient\Handler + \ArangoDBClient\Document - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - - array - - - string + + setChanged + \ArangoDBClient\Document::setChanged() + + Set the changed flag + + + boolean - - \ArangoDBClient\ClientException + + boolean - $body + $value - array + boolean - \ArangoDBClient\Handler + \ArangoDBClient\Document - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array - - - array + + getChanged + \ArangoDBClient\Document::getChanged() + + Get the changed flag + + + boolean - - array + + \ArangoDBClient\Document + + + setIsNew + \ArangoDBClient\Document::setIsNew() + + Set the isNew flag + + + boolean - - array + + void - $options - - array - - - $body + $isNew - array - - - $includeArray - array() - array + boolean - \ArangoDBClient\Handler + \ArangoDBClient\Document - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name + + getIsNew + \ArangoDBClient\Document::getIsNew() + + Get the isNew flag - - \ArangoDBClient\ClientException + + boolean - - mixed + + \ArangoDBClient\Document + + + setInternalId + \ArangoDBClient\Document::setInternalId() + + Set the internal document id + This will throw if the id of an existing document gets updated to some other id + + \ArangoDBClient\ClientException - + string + + void + - $value + $id - mixed + string - \ArangoDBClient\Handler + \ArangoDBClient\Document - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use - - + + setInternalKey + \ArangoDBClient\Document::setInternalKey() + + Set the internal document key + This will throw if the key of an existing document gets updated to some other key + + \ArangoDBClient\ClientException + + string - - \ArangoDBClient\DocumentClassable + + void - $class + $key string - \ArangoDBClient\DocumentClassable + \ArangoDBClient\Document - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use - - + + getInternalId + \ArangoDBClient\Document::getInternalId() + + Get the internal document id (if already known) + Document ids are generated on the server only. Document ids consist of collection id and +document id, in the format collectionId/documentId + string - - \ArangoDBClient\DocumentClassable - - - $class - - string - - \ArangoDBClient\DocumentClassable + \ArangoDBClient\Document - - - Name of argument $revision does not match with the DocBlock's name $ifMatch in getHead() - The type hint of the argument is incorrect for the type definition of the @param tag with argument $revision in getHead() - Name of argument $ifMatch does not match with the DocBlock's name $revision in getHead() - The type hint of the argument is incorrect for the type definition of the @param tag with argument $ifMatch in getHead() - Argument $collection is missing from the Docblock of insert - Argument $document is missing from the Docblock of insert - Argument $options is missing from the Docblock of insert - No summary for method createCollectionIfOptions() - - eJztXetT28YW/85fse0w1yZjoGn7iYbcUOMW91JgCGluhzKMLK2xiiy5ekCY2/zv95x9aXf1sGQbQlL7Q2Ks3bOv89rfObt69e/ZZLaxsfvixQZ5QQ5iJ7yJDn8kZ0dnxA18GqZ7xIvcbArfyMQJvYDGUBDLvpk57q1zQwlR1fqsBnvoZOkkiuEZ+cUJyduU0qkThtajn6DeLfnVeWBEyRs3mj3E/s0kJX317dtvXn7bI2nsQ1NhQn6ejo568DiIbkLaIz/TGOg+QO3djY3QmdIEekWtDv2wkQ9QDoKkEyclUBfIJmqIiRjbQWHQvPyYpu5EL0/GcTSFZ5QkNL6DYlAaCcxonPgJPIdHUxKFWpEdMkyBAFBJIjJ6IH6SZH54gyWwpjObxdEMhptScnRxcUZi+ldGGalIp/JqFL8WvdW+1i9K4ocuPiLkm51v2Zy5gZMk5FAM50iMlX5IaeglRPy98b8NrMOmED8vtPE7cezAGEKPfhAPd9n/bhQmKRmcXJz/fn142n/3K3x9S/ZJR1XtwLJYZN0oCKib+jBfMyeG1UyRMQpUT88uhqcn1/3T4+NBH78i3bxuCWH6wZnOAtqE6uC/B7+eHQ+QpKgF9LCUTTOCVbiPfVimaMa6XE3z9LfB+fvz4QWjqupV0eXUxiAiMU2zOBTMQaLAUxNf3db54OLdOTR5fIiNcQqngde2sZDeN2/sZPA+b+yE3uMK2C39TFPiEODAG1gHJV1MfBxt4UVxWesg8J2EwJJNIo/18oamPz4Mve6WVfBNOomj+4QMPrh0VkLoDVt6koAigRFuapxGtnW+8z0CDTqyILQYZtORYhhJZ+p/oB4hm3IgQw/pqGH5Hvzrj/1CPS4uZJPPe8IebotVcIKeeB6NxU+JrF7zeTV7fSqoOTEle02qBP7rzjUogyDz6DAEeYDGkw70JI0ziopGPGOs4IsCxElhUkZZSpMdckjHThZwrTSGyvTVLhBt3vZNGMX0yPdgog4UWb0HySS6JxNWYIUNx/TOT1BHYEsTqiky+aQVOX/8qwMWAamNoiigYOr8Mbnx76DTkiCOJAPRnWJJxlBR2riR3dlrm5G5lCmdbQ1EmCjPNkyGDM+yUeC7ZJyFnOlBqLqaSPR0vpY8qVh2n1xecenjZgE/ok+b6cRPtl9LGa0mKYltca30sagu+hPq3uJkOvnQ6Ac0qdZ8XECT5N4PAuI68E9Cg/HeHg5oSzFu8IBmmbhIMkGaMC0xlQTuUd5DIC4UB2GaJCT3Ex/WK6azmCbc1IXk+2++l/Z4Z54CIu8nyLohiDO2R2gcR8yNgB8Zoch1s9geTrWeWpGaqtNSNo8Jnq7lnYmTVC60zSZp/KD9xVZ8l68dmzzylrFqPoOwVEAHKrlMgkBwyIgis8U+vaOeQSnnveruCMfA4lrUOD+oBx+Bj1BQu3ZnNulWSecpU7r0wwzbg5XgSwu6yZxCrqqM2jC47iZlPe5HHgV+3d/fx9p2M1pXGZUfjKcfN+w+/ZmBgYYKOKXGMz7Jm/pgN6rkbzFznQsjb4vLWl7fhT0AX8QKNTVXqtZmvabKP9asP7odtn2HC52r/UTIJ/AONOunvA2a7CKzi++qHzvPz/jPsdYNHABUZiBbswiMgV61s9vZIl+BXmNramu2NwEYdL1h0tPVNbQEijVA5Qh0bFUuiXxU3zY9J3XMOdzX7IKctO67OEj29t6dH6udaY809lVYQ+KnS+D4BPc7V2Rf6uYKn8iNKezof4J1OcDZfO+nk34EEvgBxo/dbuITlevkrhJkvk2yd0ZMJ4sdlM8ACXIfxbeTKE6ouaUClUCwtwrzQK8Jy1MPQRIF/5gs2U5DZ3GgFmdbY9HtBJQrgTUB44AF0ZmTFn6t5s0qazX/pat5uWgV6p/z2SK6P45SEBUspal/pRhROutUYQNDoMumUr5T55b21e+6wtddckM3ENTdoKiPaDCj8d7eKPMDD/4Wfbys6uSVrqYn1PHAhQ8o3+Jjf/OnaLLYgK5v6cM131t2FYtp+pj861+kWFCxiVbStm/MxVe2QpK+Yo4+SkqZp291+rIzHG+reqTzdYfsaPZH9eIKfoaH1t6AUBCxho2cRCFdvCV7S8FagZ3zDCpTwwyD2QsFI2yJ/RpnO7NPOmeweZTEWJ2jNJ1pu6bvirsmvgFBGJMD4Mo+dTvKe4K9K9tUumDabqi309kqbI3wIy250YNfEhxAna1OQPeCfQXFgMLgjKKsxHwnj7+nMuktZrfbIxE7FiFhc+djEXZFqek3hfzgw23SzgDYNNWoVCWypLafo6kd+dUFp8/xFczuRhhhSCnhzC8st3wK+oZMBKfLFiqd+COgUAe5qaHuwwoFKHByQvkP9Zge9q+t4yxbzJuq923BSXW2mQ+PbunjeLpslp7C0zXM2aKe7qoAwMYIYKGeISDS080JyMePKLNLOUWKpea5QYy/5/k/rWXo8/KG8uHhjh3Hg66PGqL8sdTLkQK+qEejmn4cN6aWfL3vYqxBlRujs0/Bj7G6mxCLpunZ8DLdknqXHWkM2NCqPKISDEIQqNS+bBc5pR7LOlAyAXs0FlNhhsrEL/JCytng6RouBzXKVeOmJonqN3OvXIV02Ur4DzO94Q/LyZsn7i3gGFukr6V49VnuhOIJ8/eSRTAL7O1ZfWiOA71NYfetB8ZgoeY5kD6LXzkYTt8FZRunbsbqJc4dOtFo/2I6CxwX/toBfkhSYBmEMibOHXNHIuJh4sTUD6kIjUXcEf1OzSrb1WcJ7cmWEx+8mwcyw3ky1DI2jIMQLYNzxRzcsX+TwcjQURZNhFRyoW0OmrvFOESPsAwHNkBvwSCD2jYoBSsWeLswOGjV8TwKJgO6gX/hFFBhslVBdHKE3aowvybURUrRrjkegMCsLNSKLA1csY+NXvFMpIZ1EWzhMpBbQwRd+G/CPc4Hy3xwljeF6/pARTy4Mc6SN3rv+OlPUfz2IXSxPSSdULZuuCnvYcsoKgEwzDS6A3cnAqPr8GEyjvNBPJwwBdZG9gIywD+hjwuMYuInt2SXDMfcw/R5f5MZddHR8gR5c3SdBKSLIWOMHJBFsYMlZc0hN81moOC8loOtDiBwBttGFoJVz4WGTX3ujPKEsZc739RuPrgoF8WjZ/k/3GVqGE1QVJh1GyLM3mUAS9H30Bup8FHwU4MIHFhixTZ/f2V+zJc0EQpXT4oywAL8WIFYtM64nso+ME1b7qiVBhkYkXwSEjkJPJJSHsoWjZaiGNZUtcBLDkIuaqhmyvQrzo6HQHMk5khj7HpEhc+MNDzV81FiBHE6W9pAJkyglwvq2lI13Bjy3ACtJAip71XSbWSFFjM8yhoIpqjfE86xB1JM/xZyqNmy1dsxZXxEzzUTtArzs5wB+kQm6B9mhMRw86zXssFyCZICByOjcSoVitAO+fitrLB78N05vCJHx3AzJ4A19B5E0thCfc7zWSsXSKTKwiII06n3i8+aRBGX6ALm79Z2QXq21a1DdfDMxxnwUQi9vceaWcIUhcpj5kGJ1v18Ki+jzn62jEzhpxkeo2q33vZtMhWolRRRWaGvhuEZe941Db4YQY9cFvwXU2XwMbzmTlWxbOIHaLK0n6Ascx1KChdVIBSuidjwIXTz38WY9vZkav754OBisFXSlKYH8n51ERjcIm9UtIlncdrZ81cl9DQBaUovz5CvJsiEviXBk8F7i+CV+stA9vSMkHzSh2MxixaTczYqQIMGHgiamYYeZyiEBYtAPQJfuwwKm0Mc3UQ/uXYEJCGYuxDa5Lk2+7kM6hmUJXBdoTxjpIMgAIYeMn3/bgZFaLfcYWwSSpxFiYol8iJ/JlF4TUM38uj1fYyTFHOUZUuXbCzFF7oixKeK7u6KGANoDHC0EKtgx4Jgzu4pcA6GFUYMK51Ckz2Fa6DtvYlAlcUsE5gnI0e3VB4MEpnJIxpE9zt6a30nw9Ht6YCMZvqGhz2ZgWqe3mCdgLUF32z0J8yQOQJKhp5Eb37EkmdYUnh4KrsWzyYh8II0cQeGYRM0vqnRw/ds3CMn8V2WaJ33A8jxxglmW/dwbqIYY1w4G2jZXZeFH1g1sE15xwnrOfdmDY/U9ww23RypzttLp4bVLXCu3HuoymWpZPJjtDdfn5C//26gJKp6hIxYuXVrIJM6ncsC3MjPYv1n8PtVuYQFkevIQIUxl8fiAUemdQHFfn2lKraJwPs8m3vsgyiohlUMVB6mk92o2EVuAhVDDWq5LEMPgVXZ9W7eSV2PmrtrEV7CVMi6GRweGlEVg8a5CDPUUzgf/HZVSG+AsWCAxYI9vCL/1kzrzzClGF4LYb/ge2r67ISAqulsAjZIHit0U27UldQY4QXm0GuaS/j2hf26PERXAK1Z/JaD1fWRcL55aOUoEstTNNGJNrjNxwJMwa0aP2BiQyh+aExBLw/HMuXLt0IyH+Aa9SFIi9w1g9K8jukdj2TjxhwVpwKnZPMHaYokGVKAil/t6SKxMxThcsyEEVkwhLvjd3iCFeq93HlZiXlkfHCGjjbOui6MlnDKNl4C29lZBKuNh2blTogfq+mifOOcYJQ/iEbsOzaS3fDNYcFXlckDKvQvoA3t4C+CHGyOQZwyHFLa4/0FDwIsHhXHjtB4S2LMHeA7MhFwjKwxptH2iG6rDZvIU0icKZXmDoMeLDy+ujgFX3yTR3hfK9cR+IqdcyoG90siCsuBOe1zYNnemLMCboxF/wVvcNwqSxgmCTwFCwW9caNwDI9T0u0wlun0SAeUMmyRgGVO3h0fk0t0QgQCcrXVcBfMenJL6ewE9mEMOuJuVCaAGERp4gyaVUfrWSSN5fwojZBnyLLy6OgBs6XCm/NjzoAsvIbbPTONlqXcdrELOh22wRciwgDxNuOxsClrSKCJXR1x4sbb5nOxJjlqI1EpiokfcmGUvGhNknHg3ID4gRKkUBQqOaOA8uO/LEcHFFqsA1dNh1YNVOD2DrO0gnvnITEwKU1PoX/Pjwoi/9QaIT740pBI69OUnBY/omFYXW3rCPa3V3LSQa+yNcdurdBwWZB06BU9+LVleq6WSYzvMQyTTGqzoLj2MYw8PK6f4DAT21qEQqyA/rZtKHkugsjc5FOhaVpcpVw/FzhkThx++TDIAidIyHOyoKo3X5AVVWP6Mi0pG95TW9M5hxRXYmuZ4LdNc34kqzo33bm11jUySrcXSUdea+615i7pzVpzf+6ae05u/dIavZiBy1XtvIz7BbX6FxbrrYjGzg3Dvj8YXly//f2kXxaJzYWWsBgnW9ViMSOQXBND5meCz+ld0qkjJxWXJLfQuN6dHR5cDK7PTo+H/d/LxmZEhVcZEF5VLDjnHHkmoHgcw4ddX9oVrHXZcDau8LiqyWYtCbAcSu6nnLHF2tsbnJ+fnuf9t5Mw9WMxJkSh4iFWXiMOj50vYSEPWb308Ijovc5f2m0LheLqqIQ/3p6KUyDtj4HIb/kyFULuCx3BmRu4F/pQheWLHbHTSothcF2x1sXB5wXit9RZlqQkXL4vu1I4DctKLR4WKwz5k4ZeC3dElTj15yJDbdEgT142xX6vQa3lQS0ryqKf6n2ScIuVRNt4Y/EPD6R8mU73E0IlMpV+Ub9Z25WXXZ1kBBQq7zoSnTBDFsugJsso2CbBiKdUtWIsa11rykPLkxDPHYdaVP/z2mtgaYX2QDAmF+HnYxTYGJ/cMDwJiJ61vmLvsYzBo2PoC17rsdZf9XKx1l+fh/56ikv5CHmEe/meCQaezb9zb42APxoC/hyh7fPB2fFB/7PGttXqLg9tm7OxCLZtUWgEbustmEh1yW2Ijw9aL3UFY4tjVyZMTVZx5VQZoaaQdwOkO2t83msNZTeFsqeRea9C4XrK9gj2CoFUdhh+DaQ+CZBauHjg0zudT7phRk57aiDVCKWqWrnSaQK+Yr/rsVftYs4G2+2FNEIb2LUV+Gc5totunc19c+uNsyCi3Y5JjAsya5KsURB5AlS5GrPu6Vp2N73IXvr5KLMvW519AoU278VchRtOW8N/MLsJXeKq4FVopBXjfqtB/VaE+S2H+EkihuZajeJaMQy4Vlyfm+J6egCN65r21zY/8oss1ljYSrCww8Hx4CnSPB8NvjIGsAh6ZRJon5n53PMsTaToOeRXNkNoCrchzcWquOE0rwgv3PbJ8Kh6NAo/c5GeRTvRBCHiM2tcEn5Dzbs9POmQ5akzsVWApZ1U+GTlV3nX7+IsP+j0vD6CaZsmeVGdRqOtbfLvjLvTq/b69TiB/Mu6l18Lb+Odjy4FF0FSL17MVUrRuqfFYhh2kQ9eMeTjW6ByClsIRcLP3KksezIOIqdYBYpPzR9RdXU6bS6z6fOUKSdIaWzf98hfpaOt1px7ZvOerPl6ab4uQaNsrrYcLvuuo1b83OpwQelbm3ixqht6xMSL1ow9Gp8+7acQc9lg0f0m0M0nejNg2X228rV8je61ZVk1rV6ZZzd58TBj97x+Ldfra5y0b9m2I0+JbL3pwLYqH36Nr+5h7XzH2sE/F2kj39fMeXnE/JsbK94gwZRt4YVyObkj/vYh6zLN6/7p8fGgj7/UvHGOM325U8BTPfell6ycnBYtX1mS/BUn2qYXrt0a6gjU//bv3XIvxr44rfhmvlJurJmzPMCaYkn2ahX1UymxK9Mfy0K2HZhTp/SVtfOqGtVKX5/upCmdztJK6TaHWph9eQ9pBevqt3qK96LPeSO6plemoPImeE07Wxm8NpzfyWzNw8cN4A8Xw6fX7Ko3FXNR7Mge9kjnD/ArnBsaJvLtL6M/rLLoB/wfuY5eBA== - - - - ArangoDB PHP client: single document - - - - - - - \ArangoDBClient\Document - Edge - \ArangoDBClient\Edge - - Value object representing a single collection-based edge document - <br> - - - - - - ENTRY_FROM - \ArangoDBClient\Edge::ENTRY_FROM - '_from' - - Document _from index + + getInternalKey + \ArangoDBClient\Document::getInternalKey() + + Get the internal document key (if already known) + + string + - - - ENTRY_TO - \ArangoDBClient\Edge::ENTRY_TO - '_to' - - Revision _to index - - - - - ENTRY_ID - \ArangoDBClient\Document::ENTRY_ID - '_id' - - Document id index - - - - - ENTRY_KEY - \ArangoDBClient\Document::ENTRY_KEY - '_key' - - Document key index - - - - - ENTRY_REV - \ArangoDBClient\Document::ENTRY_REV - '_rev' - - Revision id index - - - - - ENTRY_ISNEW - \ArangoDBClient\Document::ENTRY_ISNEW - '_isNew' - - isNew id index - - - - - ENTRY_HIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES - '_hiddenAttributes' - - hidden attribute index - + \ArangoDBClient\Document + + + getHandle + \ArangoDBClient\Document::getHandle() + + Convenience function to get the document handle (if already known) - is an alias to getInternalId() + Document handles are generated on the server only. Document handles consist of collection id and +document id, in the format collectionId/documentId + + string + - - - ENTRY_IGNOREHIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES - '_ignoreHiddenAttributes' - - hidden attribute index - + \ArangoDBClient\Document + + + getId + \ArangoDBClient\Document::getId() + + Get the document id (or document handle) if already known. + It is a string and consists of the collection's name and the document key (_key attribute) separated by /. +Example: (collectionname/documentId) + +The document handle is stored in a document's _id attribute. + + mixed + - - - OPTION_WAIT_FOR_SYNC - \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC - 'waitForSync' - - waitForSync option index - + \ArangoDBClient\Document + + + getKey + \ArangoDBClient\Document::getKey() + + Get the document key (if already known). + Alias function for getInternalKey() + + mixed + - - - OPTION_POLICY - \ArangoDBClient\Document::OPTION_POLICY - 'policy' - - policy option index - + \ArangoDBClient\Document + + + getCollectionId + \ArangoDBClient\Document::getCollectionId() + + Get the collection id (if already known) + Collection ids are generated on the server only. Collection ids are numeric but might be +bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used + + mixed + - - - OPTION_KEEPNULL - \ArangoDBClient\Document::OPTION_KEEPNULL - 'keepNull' - - keepNull option index - + \ArangoDBClient\Document + + + setRevision + \ArangoDBClient\Document::setRevision() + + Set the document revision + Revision ids are generated on the server only. + +Document ids are strings, even if they look "numeric" +To reliably store a document id elsewhere, a PHP string must be used + + mixed + + + void + - - - $_from - \ArangoDBClient\Edge::_from - - - The edge's from (might be NULL for new documents) + + $rev + + mixed + + \ArangoDBClient\Document + + + getRevision + \ArangoDBClient\Document::getRevision() + + Get the document revision (if already known) - + mixed - - - $_to - \ArangoDBClient\Edge::_to - - - The edge's to (might be NULL for new documents) + \ArangoDBClient\Document + + + jsonSerialize + \ArangoDBClient\Document::jsonSerialize() + + Get all document attributes +Alias function for getAll() - it's necessary for implementing JsonSerializable interface - + mixed + + array + - - - $_id - \ArangoDBClient\Document::_id - - - The document id (might be NULL for new documents) - - + + $options + array() + mixed + + \ArangoDBClient\Document + + + + + + user + + + string + + + string - - $_key - \ArangoDBClient\Document::_key - - - The document key (might be NULL for new documents) - - - string + + + + + passwd + + + mixed|null + + + + mixed + null - - $_rev - \ArangoDBClient\Document::_rev - - - The document revision (might be NULL for new documents) - - + + + + + active + + + mixed|null + + + mixed + null - - $_values - \ArangoDBClient\Document::_values - array() - - The document attributes (names/values) - - + + + + + extra + + + array|null + + + array + null - - $_changed - \ArangoDBClient\Document::_changed - false - - Flag to indicate whether document was changed locally + + eJyFkM1OwzAQhO9+ir0VIkQFxxSJvwpxQeoFTpHQ1lmloY5trW1oBLw764RWKgXh436zszO+uPQrr9S0KBQUcM1oGze/gcX9ArRpycYSQmsbQ5ACMdROp06mIs76K496jQ0B7FZvh60BYoorx8LgTuAaHrAnHohY6rwEcHZ6LpOpUhY7CmJHP5xmu3BPaBKBW76QjsDkmYJwCQe4zfj4a0Z2njj2ECJndX65zD7s2g3VHzYZAx5DeKv/xKhj+0r7GJmxHzFtIuP/n3P4BdrI3bGCeJCtA8y3Vd6V+lSj4hlNi+Eo68pymJzApJJqcsqG6vvUssqCyfFMfQHFdZsR + + + + ArangoDB PHP client: collection handler + + + + + + + \ArangoDBClient\Handler + CollectionHandler + \ArangoDBClient\CollectionHandler + + Provides management of collections + The collection handler fetches collection data from the server and +creates collections on the server. + + + + + + ENTRY_DOCUMENTS + \ArangoDBClient\CollectionHandler::ENTRY_DOCUMENTS + 'documents' + + documents array index - - boolean - - - - $_isNew - \ArangoDBClient\Document::_isNew - true - - Flag to indicate whether document is a new document (never been saved to the server) + + + OPTION_COLLECTION + \ArangoDBClient\CollectionHandler::OPTION_COLLECTION + 'collection' + + collection parameter - - boolean - - - - $_doValidate - \ArangoDBClient\Document::_doValidate - false - - Flag to indicate whether validation of document values should be performed -This can be turned on, but has a performance penalty + + + OPTION_EXAMPLE + \ArangoDBClient\CollectionHandler::OPTION_EXAMPLE + 'example' + + example parameter - - boolean - - - - $_hiddenAttributes - \ArangoDBClient\Document::_hiddenAttributes - array() - - An array, that defines which attributes should be treated as hidden. + + + OPTION_NEW_VALUE + \ArangoDBClient\CollectionHandler::OPTION_NEW_VALUE + 'newValue' + + example parameter - - array - - - - $_ignoreHiddenAttributes - \ArangoDBClient\Document::_ignoreHiddenAttributes - false - - Flag to indicate whether hidden attributes should be ignored or included in returned data-sets + + + OPTION_CREATE_COLLECTION + \ArangoDBClient\CollectionHandler::OPTION_CREATE_COLLECTION + 'createCollection' + + example parameter - - boolean - - - - set - \ArangoDBClient\Edge::set() - - Set a document attribute - The key (attribute name) must be a string. - -This will validate the value of the attribute and might throw an -exception if the value is invalid. - - \ArangoDBClient\ClientException - - - string - - - mixed - - - void - - + + + OPTION_ATTRIBUTE + \ArangoDBClient\CollectionHandler::OPTION_ATTRIBUTE + 'attribute' + + attribute parameter + - - $key - - string - - - $value - - mixed - - - - setFrom - \ArangoDBClient\Edge::setFrom() - - Set the 'from' vertex document-handler + + + OPTION_KEYS + \ArangoDBClient\CollectionHandler::OPTION_KEYS + 'keys' + + keys parameter - - mixed - - - \ArangoDBClient\Edge - - - $from - - mixed - - - - getFrom - \ArangoDBClient\Edge::getFrom() - - Get the 'from' vertex document-handler (if already known) + + + OPTION_STREAM + \ArangoDBClient\CollectionHandler::OPTION_STREAM + 'stream' + + stream parameter - - mixed - - - - setTo - \ArangoDBClient\Edge::setTo() - - Set the 'to' vertex document-handler + + + OPTION_LEFT + \ArangoDBClient\CollectionHandler::OPTION_LEFT + 'left' + + left parameter - - mixed - - - \ArangoDBClient\Edge - - - $to - - mixed - - - - getTo - \ArangoDBClient\Edge::getTo() - - Get the 'to' vertex document-handler (if already known) + + + OPTION_RIGHT + \ArangoDBClient\CollectionHandler::OPTION_RIGHT + 'right' + + right parameter - - mixed - - - - getAllForInsertUpdate - \ArangoDBClient\Edge::getAllForInsertUpdate() - - Get all document attributes for insertion/update + + + OPTION_CLOSED + \ArangoDBClient\CollectionHandler::OPTION_CLOSED + 'closed' + + closed parameter - - mixed - - - - - __construct - \ArangoDBClient\Document::__construct() - - Constructs an empty document + + + OPTION_LATITUDE + \ArangoDBClient\CollectionHandler::OPTION_LATITUDE + 'latitude' + + latitude parameter - - array - - - $options - null - array - - \ArangoDBClient\Document - - - createFromArray - \ArangoDBClient\Document::createFromArray() - - Factory method to construct a new document using the values passed to populate it + + + OPTION_LONGITUDE + \ArangoDBClient\CollectionHandler::OPTION_LONGITUDE + 'longitude' + + longitude parameter - - \ArangoDBClient\ClientException - - - array - - - array - - - \ArangoDBClient\Document - \ArangoDBClient\Edge - \ArangoDBClient\Graph - - - - $values - - array - - - $options - array() - array - - \ArangoDBClient\Document - - - __clone - \ArangoDBClient\Document::__clone() - - Clone a document - Returns the clone - - - void - - \ArangoDBClient\Document - - - __toString - \ArangoDBClient\Document::__toString() - - Get a string representation of the document. - It will not output hidden attributes. - -Returns the document as JSON-encoded string - - - string - + + + OPTION_DISTANCE + \ArangoDBClient\CollectionHandler::OPTION_DISTANCE + 'distance' + + distance parameter + - \ArangoDBClient\Document - - - toJson - \ArangoDBClient\Document::toJson() - - Returns the document as JSON-encoded string + + + OPTION_RADIUS + \ArangoDBClient\CollectionHandler::OPTION_RADIUS + 'radius' + + radius parameter - - array - - - string - - - $options - array() - array - - \ArangoDBClient\Document - - - toSerialized - \ArangoDBClient\Document::toSerialized() - - Returns the document as a serialized string + + + OPTION_SKIP + \ArangoDBClient\CollectionHandler::OPTION_SKIP + 'skip' + + skip parameter - - array - - - string - - - $options - array() - array - - \ArangoDBClient\Document - - - filterHiddenAttributes - \ArangoDBClient\Document::filterHiddenAttributes() - - Returns the attributes with the hidden ones removed + + + OPTION_INDEX + \ArangoDBClient\CollectionHandler::OPTION_INDEX + 'index' + + index parameter - - array - - - array - - - array - - - $attributes - - array - - - $_hiddenAttributes - array() - array - - \ArangoDBClient\Document - - - set - \ArangoDBClient\Document::set() - - Set a document attribute - The key (attribute name) must be a string. -This will validate the value of the attribute and might throw an -exception if the value is invalid. - - \ArangoDBClient\ClientException - - - string - - - mixed - - - void - + + + OPTION_LIMIT + \ArangoDBClient\CollectionHandler::OPTION_LIMIT + 'limit' + + limit parameter + - - $key - - string - - - $value - - mixed - - \ArangoDBClient\Document - - - __set - \ArangoDBClient\Document::__set() - - Set a document attribute, magic method - This is a magic method that allows the object to be used without -declaring all document attributes first. -This function is mapped to set() internally. - - \ArangoDBClient\ClientException - - - - string - - - mixed - - - void - + + + OPTION_FIELDS + \ArangoDBClient\CollectionHandler::OPTION_FIELDS + 'fields' + + fields + - - $key - - string - - - $value - - mixed - - \ArangoDBClient\Document - - - get - \ArangoDBClient\Document::get() - - Get a document attribute + + + OPTION_UNIQUE + \ArangoDBClient\CollectionHandler::OPTION_UNIQUE + 'unique' + + unique - - string - - - mixed - - - $key - - string - - \ArangoDBClient\Document - - - __get - \ArangoDBClient\Document::__get() - - Get a document attribute, magic method - This function is mapped to get() internally. - - - string - - - mixed - + + + OPTION_TYPE + \ArangoDBClient\CollectionHandler::OPTION_TYPE + 'type' + + type + - - $key - - string - - \ArangoDBClient\Document - - - __isset - \ArangoDBClient\Document::__isset() - - Is triggered by calling isset() or empty() on inaccessible properties. + + + OPTION_SIZE + \ArangoDBClient\CollectionHandler::OPTION_SIZE + 'size' + + size option - - string - - - boolean - - - $key - - string - - \ArangoDBClient\Document - - - __unset - \ArangoDBClient\Document::__unset() - - Magic method to unset an attribute. - Caution!!! This works only on the first array level. -The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. - - + + + OPTION_GEO_INDEX + \ArangoDBClient\CollectionHandler::OPTION_GEO_INDEX + 'geo' + + geo index option + - - $key - - - - \ArangoDBClient\Document - - - getAll - \ArangoDBClient\Document::getAll() - - Get all document attributes + + + OPTION_GEOJSON + \ArangoDBClient\CollectionHandler::OPTION_GEOJSON + 'geoJson' + + geoJson option - - mixed - - - array - - - $options - array() - mixed - - \ArangoDBClient\Document - - - getAllForInsertUpdate - \ArangoDBClient\Document::getAllForInsertUpdate() - - Get all document attributes for insertion/update + + + OPTION_HASH_INDEX + \ArangoDBClient\CollectionHandler::OPTION_HASH_INDEX + 'hash' + + hash index option - - mixed - - \ArangoDBClient\Document - - - getAllAsObject - \ArangoDBClient\Document::getAllAsObject() - - Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class + + + OPTION_FULLTEXT_INDEX + \ArangoDBClient\CollectionHandler::OPTION_FULLTEXT_INDEX + 'fulltext' + + fulltext index option - - mixed - - - mixed - - - $options - array() - mixed - - \ArangoDBClient\Document - - - setHiddenAttributes - \ArangoDBClient\Document::setHiddenAttributes() - - Set the hidden attributes -$cursor + + + OPTION_MIN_LENGTH + \ArangoDBClient\CollectionHandler::OPTION_MIN_LENGTH + 'minLength' + + minLength option - - array - - - void - - - $attributes - - array - - \ArangoDBClient\Document - - - getHiddenAttributes - \ArangoDBClient\Document::getHiddenAttributes() - - Get the hidden attributes + + + OPTION_SKIPLIST_INDEX + \ArangoDBClient\CollectionHandler::OPTION_SKIPLIST_INDEX + 'skiplist' + + skiplist index option - - array - - \ArangoDBClient\Document - - - isIgnoreHiddenAttributes - \ArangoDBClient\Document::isIgnoreHiddenAttributes() - - + + + OPTION_PERSISTENT_INDEX + \ArangoDBClient\CollectionHandler::OPTION_PERSISTENT_INDEX + 'persistent' + + persistent index option - - boolean - - \ArangoDBClient\Document - - - setIgnoreHiddenAttributes - \ArangoDBClient\Document::setIgnoreHiddenAttributes() - - + + + OPTION_TTL_INDEX + \ArangoDBClient\CollectionHandler::OPTION_TTL_INDEX + 'ttl' + + ttl index option - - boolean - - - $ignoreHiddenAttributes - - boolean - - \ArangoDBClient\Document - - - setChanged - \ArangoDBClient\Document::setChanged() - - Set the changed flag + + + OPTION_EXPIRE_AFTER + \ArangoDBClient\CollectionHandler::OPTION_EXPIRE_AFTER + 'expireAfter' + + expireAfter option - - boolean - - - boolean - - - $value - - boolean - - \ArangoDBClient\Document - - - getChanged - \ArangoDBClient\Document::getChanged() - - Get the changed flag + + + OPTION_IN_BACKGROUND + \ArangoDBClient\CollectionHandler::OPTION_IN_BACKGROUND + 'inBackground' + + inBackground option - - boolean - - \ArangoDBClient\Document - - - setIsNew - \ArangoDBClient\Document::setIsNew() - - Set the isNew flag + + + OPTION_SPARSE + \ArangoDBClient\CollectionHandler::OPTION_SPARSE + 'sparse' + + sparse index option - - boolean - - - void - - - $isNew - - boolean - - \ArangoDBClient\Document - - - getIsNew - \ArangoDBClient\Document::getIsNew() - - Get the isNew flag + + + OPTION_COUNT + \ArangoDBClient\CollectionHandler::OPTION_COUNT + 'count' + + count option - - boolean - - \ArangoDBClient\Document - - - setInternalId - \ArangoDBClient\Document::setInternalId() - - Set the internal document id - This will throw if the id of an existing document gets updated to some other id - - \ArangoDBClient\ClientException - - - string - - - void - + + + OPTION_QUERY + \ArangoDBClient\CollectionHandler::OPTION_QUERY + 'query' + + query option + - - $id - - string - - \ArangoDBClient\Document - - - setInternalKey - \ArangoDBClient\Document::setInternalKey() - - Set the internal document key - This will throw if the key of an existing document gets updated to some other key - - \ArangoDBClient\ClientException - - - string - - - void - + + + OPTION_CHECKSUM + \ArangoDBClient\CollectionHandler::OPTION_CHECKSUM + 'checksum' + + checksum option + - - $key - - string - - \ArangoDBClient\Document - - - getInternalId - \ArangoDBClient\Document::getInternalId() - - Get the internal document id (if already known) - Document ids are generated on the server only. Document ids consist of collection id and -document id, in the format collectionId/documentId - - string + + + OPTION_REVISION + \ArangoDBClient\CollectionHandler::OPTION_REVISION + 'revision' + + revision option + + + + + OPTION_RESPONSIBLE_SHARD + \ArangoDBClient\CollectionHandler::OPTION_RESPONSIBLE_SHARD + 'responsibleShard' + + responsible shard option + + + + + OPTION_SHARDS + \ArangoDBClient\CollectionHandler::OPTION_SHARDS + 'shards' + + shards option + + + + + OPTION_PROPERTIES + \ArangoDBClient\CollectionHandler::OPTION_PROPERTIES + 'properties' + + properties option + + + + + OPTION_FIGURES + \ArangoDBClient\CollectionHandler::OPTION_FIGURES + 'figures' + + figures option + + + + + OPTION_LOAD + \ArangoDBClient\CollectionHandler::OPTION_LOAD + 'load' + + load option + + + + + OPTION_UNLOAD + \ArangoDBClient\CollectionHandler::OPTION_UNLOAD + 'unload' + + unload option + + + + + OPTION_TRUNCATE + \ArangoDBClient\CollectionHandler::OPTION_TRUNCATE + 'truncate' + + truncate option + + + + + OPTION_RENAME + \ArangoDBClient\CollectionHandler::OPTION_RENAME + 'rename' + + rename option + + + + + OPTION_EXCLUDE_SYSTEM + \ArangoDBClient\CollectionHandler::OPTION_EXCLUDE_SYSTEM + 'excludeSystem' + + exclude system collections + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection - \ArangoDBClient\Document - - - getInternalKey - \ArangoDBClient\Document::getInternalKey() - - Get the internal document key (if already known) + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + - + string - \ArangoDBClient\Document - - - getHandle - \ArangoDBClient\Document::getHandle() - - Convenience function to get the document handle (if already known) - is an alias to getInternalId() - Document handles are generated on the server only. Document handles consist of collection id and -document id, in the format collectionId/documentId - + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + string - \ArangoDBClient\Document - - - getId - \ArangoDBClient\Document::getId() - - Get the document id (or document handle) if already known. - It is a string and consists of the collection's name and the document key (_key attribute) separated by /. -Example: (collectionname/documentId) - -The document handle is stored in a document's _id attribute. - + + + create + \ArangoDBClient\CollectionHandler::create() + + Creates a new collection on the server + This will add the collection on the server and return its id +The id is mainly returned for backwards compatibility, but you should use the collection name for any reference to the collection. * +This will throw if the collection cannot be created + + \ArangoDBClient\Exception + + mixed - - \ArangoDBClient\Document - - - getKey - \ArangoDBClient\Document::getKey() - - Get the document key (if already known). - Alias function for getInternalKey() - + + array + + mixed - \ArangoDBClient\Document + + $collection + + mixed + + + $options + array() + array + - - getCollectionId - \ArangoDBClient\Document::getCollectionId() - - Get the collection id (if already known) - Collection ids are generated on the server only. Collection ids are numeric but might be -bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used - + + has + \ArangoDBClient\CollectionHandler::has() + + Check if a collection exists + This will call self::get() internally and checks if there +was an exception thrown which represents an 404 request. + + \ArangoDBClient\Exception + + mixed + + boolean + - \ArangoDBClient\Document + + $collection + + mixed + - - setRevision - \ArangoDBClient\Document::setRevision() - - Set the document revision - Revision ids are generated on the server only. - -Document ids are strings, even if they look "numeric" -To reliably store a document id elsewhere, a PHP string must be used - + + count + \ArangoDBClient\CollectionHandler::count() + + Get the number of documents in a collection + This will throw if the collection cannot be fetched from the server + + \ArangoDBClient\Exception + + mixed - - void + + integer - $rev + $collection mixed - \ArangoDBClient\Document - - getRevision - \ArangoDBClient\Document::getRevision() - - Get the document revision (if already known) - - + + get + \ArangoDBClient\CollectionHandler::get() + + Get information about a collection + This will throw if the collection cannot be fetched from the server + + \ArangoDBClient\Exception + + mixed + + \ArangoDBClient\Collection + - \ArangoDBClient\Document + + $collection + + mixed + - - jsonSerialize - \ArangoDBClient\Document::jsonSerialize() - - Get all document attributes -Alias function for getAll() - it's necessary for implementing JsonSerializable interface - - + + getProperties + \ArangoDBClient\CollectionHandler::getProperties() + + Get properties of a collection + This will throw if the collection cannot be fetched from the server + + \ArangoDBClient\Exception + + mixed - - array + + \ArangoDBClient\Collection - $options - array() + $collection + mixed - \ArangoDBClient\Document - - eJy1V2FvGjkQ/c6vmEhIkAhK2o+k9NJrSJq211QpjVQlUWR2B/DF2CvbS0DX/Pcbe70bsrCBq45VpMB6/Oa9mfF4ePtHMklqtc7BQQ0O4L1mcqxO/oRvH79BJDhK2wXD5VggxCpKp/SC7JzpccKiezZGgGLXB7/BL7LUTpSmNfjEJHy3iFMmpV+KVLLQfDyx8KH49Obw9ZsWWM0JUBo4mw4/tmhZqLHEFpyhpt0L2t2p1SSboiHfWHJ7VIi4YiJFUMO/MbKgMdFoaJ1EAMu1REoIWuVKtofMYAwYj1cUvh3qd1uJJdDILQG8fnXoWUaCGQN9B4pzizI2cJKD/1Nzlp6rew5gMEHvv2FgpNUUmlMfkyHC1x9fvsCI4ijxoWBn9sPGfP/xjGmY8jnG4U3H/0+0sqSRxNXvHC4FqNqxVbtwa9Wq0zwO4EkBlzHOCwD/IVLSWOh/HVz+vDu9vPgLetDwxo1VtEuccUNpBPJVwipDDS48kFUOpozzHS1VR64VmKVaHKYWS5pdxO5xAc3CAFw97sM0NT50VGG0IMevVjZyAw9cCJgxwWNGGy1hzbJSHfkvT5hMxpBlw060eqDvOQ7OI0xc3QIfLSEQOJceuez42CMYyMq1n28vWyVMs2ngDnUnEaANz1WWjH3qAeoZg3Zg4sqmKnrHGm2qJcwUL9VMOhQ8glEq/ZkEg7bpSLQCelZ62cFxD2lv1i2FtP3uLlZXIaL7SxY+vZ11wU7oZOYlGx7fMAKK0t1uvqsZvB8V1o+15xyI4/XhLfR6rrIaZQK5iV83KEbdblaK5ydlU/cERST+XFrUkonz+InCinkWzKNn7x9r2xH43P+5HYPPuNgRhcv+1csU8qO9I/+us7xM4JRazo6cDy5edj1Q/9nxGgrO/V5+TqIJ3VsYr6vRPW78iQuW3rG5dsRv9+HXL1i3AHskKXBcI4XOHkFCcAojwcZVcnNm1J2tTnELXQTuOqShw7p0smtl3Gd0c7IZ/OP6G8BhNfxNAzPUFufFjdAmjrFAvb5vZq2w7i+0dnaJZ/srGqAfDNrZ0JHNKZvaYVaLDrncC3O13msvI7FUNMGjtyq0l6SfbSUdmlQrTGhk8QLupXqQKxNBcJaFo10VvPUix0FkWd+ygCCzSkeRQrrjfyuBNEO03Sj0PyfPnWarqhJH/nrO9e8m7QWxu08ZSduQMCesWgGjiWh16jJ+jODSkCxy1EkTdx1voE73uoo4s3xGA5TWbOHmqgr8TtYbNql7L8Sp0ueexw/PYUVtnd4yKJ4ezRfa/WrqVmx/am/LQ4w/vK6jylSIcj/1Lq7DCOw72cpZyAK8DpmqaxMuFdCtp15O2VLalhPrthU5pT//Y+eOZiZmmu5wdLv+TQsaN/kvupvwq2l44wwaFIV/AaDf7i0= - - - - ArangoDB PHP client: result set cursor - - - - - - - - \Iterator - Cursor - \ArangoDBClient\Cursor - - Provides access to the results of an AQL query or another statement - The cursor might not contain all results in the beginning.<br> - -If the result set is too big to be transferred in one go, the -cursor might issue additional HTTP requests to fetch the -remaining results from the server. - - - - - ENTRY_ID - \ArangoDBClient\Cursor::ENTRY_ID - 'id' - - result entry for cursor id - - - - - ENTRY_HASMORE - \ArangoDBClient\Cursor::ENTRY_HASMORE - 'hasMore' - - result entry for "hasMore" flag - - - - - ENTRY_RESULT - \ArangoDBClient\Cursor::ENTRY_RESULT - 'result' - - result entry for result documents - - - - - ENTRY_EXTRA - \ArangoDBClient\Cursor::ENTRY_EXTRA - 'extra' - - result entry for extra data - - - - - ENTRY_STATS - \ArangoDBClient\Cursor::ENTRY_STATS - 'stats' - - result entry for stats - - - - - FULL_COUNT - \ArangoDBClient\Cursor::FULL_COUNT - 'fullCount' - - result entry for the full count (ignoring the outermost LIMIT) - - - - - ENTRY_CACHE - \ArangoDBClient\Cursor::ENTRY_CACHE - 'cache' - - cache option entry - - - - - ENTRY_CACHED - \ArangoDBClient\Cursor::ENTRY_CACHED - 'cached' - - cached result attribute - whether or not the result was served from the AQL query cache - - - - - ENTRY_SANITIZE - \ArangoDBClient\Cursor::ENTRY_SANITIZE - '_sanitize' - - sanitize option entry - - - - - ENTRY_FLAT - \ArangoDBClient\Cursor::ENTRY_FLAT - '_flat' - - "flat" option entry (will treat the results as a simple array, not documents) - - - - - ENTRY_TYPE - \ArangoDBClient\Cursor::ENTRY_TYPE - 'objectType' - - "objectType" option entry. - - - - - ENTRY_BASEURL - \ArangoDBClient\Cursor::ENTRY_BASEURL - 'baseurl' - - "baseurl" option entry. - - - - - $_connection - \ArangoDBClient\Cursor::_connection - - - The connection object - - - \ArangoDBClient\Connection + + figures + \ArangoDBClient\CollectionHandler::figures() + + Get figures for a collection + This will throw if the collection cannot be fetched from the server + + \ArangoDBClient\Exception - - - - $_options - \ArangoDBClient\Cursor::_options - - - Cursor options - - + + mixed + + array - - - $data - \ArangoDBClient\Cursor::data - - - Result Data - - + + $collection + + mixed + + + + getChecksum + \ArangoDBClient\CollectionHandler::getChecksum() + + Calculate a checksum of the collection. + Will calculate a checksum of the meta-data (keys and optionally revision ids) +and optionally the document data in the collection. + + \ArangoDBClient\Exception + + + mixed + + + boolean + + + boolean + + array - - - $_result - \ArangoDBClient\Cursor::_result - - - The result set - - + + $collection + + mixed + + + $withRevisions + false + boolean + + + $withData + false + boolean + + + + getRevision + \ArangoDBClient\CollectionHandler::getRevision() + + Returns the Collections revision ID + The revision id is a server-generated string that clients can use to check whether data in a collection has +changed since the last revision check. + + \ArangoDBClient\Exception + + + mixed + + array - - - $_hasMore - \ArangoDBClient\Cursor::_hasMore - - - "has more" indicator - if true, the server has more results + + $collection + + mixed + + + + rename + \ArangoDBClient\CollectionHandler::rename() + + Rename a collection - - boolean + + \ArangoDBClient\Exception - - - - $_id - \ArangoDBClient\Cursor::_id - - - cursor id - might be NULL if cursor does not have an id - - + mixed - - - - $_position - \ArangoDBClient\Cursor::_position - - - current position in result set iteration (zero-based) - - - integer + + string - - - - $_length - \ArangoDBClient\Cursor::_length - - - total length of result set (in number of documents) - - - integer + + boolean - - - $_fullCount - \ArangoDBClient\Cursor::_fullCount - - - full count of the result set (ignoring the outermost LIMIT) - - - integer + + $collection + + mixed + + + $name + + string + + + + load + \ArangoDBClient\CollectionHandler::load() + + Load a collection into the server's memory + This will load the given collection into the server's memory. + + \ArangoDBClient\Exception - - - - $_extra - \ArangoDBClient\Cursor::_extra - - - extra data (statistics) returned from the statement - - - array + + mixed - - - - $_fetches - \ArangoDBClient\Cursor::_fetches - 1 - - number of HTTP calls that were made to build the cursor result - - - - - $_cached - \ArangoDBClient\Cursor::_cached - - - whether or not the query result was served from the AQL query result cache - - - - - $_count - \ArangoDBClient\Cursor::_count - - - precalculated number of documents in the cursor, as returned by the server - - - integer + + \ArangoDBClient\HttpResponse - - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - - - - string + + $collection + + mixed + + + + unload + \ArangoDBClient\CollectionHandler::unload() + + Unload a collection from the server's memory + This will unload the given collection from the server's memory. + + \ArangoDBClient\Exception + + + mixed + + + \ArangoDBClient\HttpResponse - - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - - - - string + + $collection + + mixed + + + + truncate + \ArangoDBClient\CollectionHandler::truncate() + + Truncate a collection + This will remove all documents from the collection but will leave the metadata and indexes intact. + + \ArangoDBClient\Exception + + + mixed + + + boolean - - - __construct - \ArangoDBClient\Cursor::__construct() - - Initialise the cursor with the first results and some metadata + + $collection + + mixed + + + + drop + \ArangoDBClient\CollectionHandler::drop() + + Drop a collection - - \ArangoDBClient\Connection + + \ArangoDBClient\Exception - - array + + mixed - + array - - \ArangoDBClient\ClientException + + boolean - $connection - - \ArangoDBClient\Connection - - - $data + $collection - array + mixed $options - + array() array - - delete - \ArangoDBClient\Cursor::delete() - - Explicitly delete the cursor - This might issue an HTTP DELETE request to inform the server about -the deletion. - - \ArangoDBClient\Exception - - + + isValidCollectionId + \ArangoDBClient\CollectionHandler::isValidCollectionId() + + Checks if the collectionId given, is valid. Returns true if it is, or false if it is not. + + + boolean + + $collectionId + + + - - getCount - \ArangoDBClient\Cursor::getCount() - - Get the total number of results in the cursor - This might issue additional HTTP requests to fetch any outstanding -results from the server - + + getAllCollections + \ArangoDBClient\CollectionHandler::getAllCollections() + + Get list of all available collections per default with the collection names as index. + Returns empty array if none are available. + + array + + + array + + \ArangoDBClient\Exception - - integer + + \ArangoDBClient\ClientException + + $options + array() + array + - - getFullCount - \ArangoDBClient\Cursor::getFullCount() - - Get the full count of the cursor (ignoring the outermost LIMIT) + + getCollectionId + \ArangoDBClient\CollectionHandler::getCollectionId() + + Gets the collectionId from the given collectionObject or string/integer - - integer + + mixed + + + mixed + + $collection + + mixed + - - getCached - \ArangoDBClient\Cursor::getCached() - - Get the cached attribute for the result set + + getCollectionName + \ArangoDBClient\CollectionHandler::getCollectionName() + + Gets the collectionId from the given collectionObject or string/integer - - boolean + + mixed + + + mixed + + $collection + + mixed + - - getAll - \ArangoDBClient\Cursor::getAll() - - Get all results as an array - This might issue additional HTTP requests to fetch any outstanding -results from the server - + + importFromFile + \ArangoDBClient\CollectionHandler::importFromFile() + + Import documents from a file + This will throw on all errors except insertion errors + \ArangoDBClient\Exception - - array + + mixed - - - - rewind - \ArangoDBClient\Cursor::rewind() - - Rewind the cursor, necessary for Iterator - - - void + + mixed - - - - current - \ArangoDBClient\Cursor::current() - - Return the current result row, necessary for Iterator - - + array - - - - key - \ArangoDBClient\Cursor::key() - - Return the index of the current result row, necessary for Iterator - - - integer - - - - - next - \ArangoDBClient\Cursor::next() - - Advance the cursor, necessary for Iterator - - - void + + array + + $collection + + + + + $importFileName + + mixed + + + $options + array() + array + - - valid - \ArangoDBClient\Cursor::valid() - - Check if cursor can be advanced further, necessary for Iterator - This might issue additional HTTP requests to fetch any outstanding -results from the server - - \ArangoDBClient\Exception + + import + \ArangoDBClient\CollectionHandler::import() + + Import documents into a collection + This will throw on all errors except insertion errors + + + string + array - - boolean + + array - - - - add - \ArangoDBClient\Cursor::add() - - Create an array of results from the input array - - + + array - - void + + \ArangoDBClient\Exception - + \ArangoDBClient\ClientException - $data + $collection - array + - - - addFlatFromArray - \ArangoDBClient\Cursor::addFlatFromArray() - - Create an array of results from the input array - - - array - - - void - - - $data + $importData + string|array + + + $options + array() array - - addDocumentsFromArray - \ArangoDBClient\Cursor::addDocumentsFromArray() - - Create an array of documents from the input array + + createHashIndex + \ArangoDBClient\CollectionHandler::createHashIndex() + + Create a hash index - + + mixed + + array - - void + + boolean - - \ArangoDBClient\ClientException + + boolean + + + boolean + + + + array + + + \ArangoDBClient\Exception - $data + $collection + + mixed + + + $fields array + + $unique + null + boolean + + + $sparse + null + boolean + + + $inBackground + false + boolean + - - addPathsFromArray - \ArangoDBClient\Cursor::addPathsFromArray() - - Create an array of paths from the input array + + createFulltextIndex + \ArangoDBClient\CollectionHandler::createFulltextIndex() + + Create a fulltext index - + + mixed + + array - - void + + integer - - \ArangoDBClient\ClientException + + boolean + + + + array + + + \ArangoDBClient\Exception - $data + $collection + + mixed + + + $fields array + + $minLength + null + integer + + + $inBackground + false + boolean + - - addShortestPathFromArray - \ArangoDBClient\Cursor::addShortestPathFromArray() - - Create an array of shortest paths from the input array + + createSkipListIndex + \ArangoDBClient\CollectionHandler::createSkipListIndex() + + Create a skip-list index - + + mixed + + array - - void + + boolean - - \ArangoDBClient\ClientException + + boolean - - - $data - - array - - - - addDistanceToFromArray - \ArangoDBClient\Cursor::addDistanceToFromArray() - - Create an array of distances from the input array - - + + boolean + + + array - - void + + \ArangoDBClient\Exception - $data + $collection - array + mixed - - - addCommonNeighborsFromArray - \ArangoDBClient\Cursor::addCommonNeighborsFromArray() - - Create an array of common neighbors from the input array - - - array - - - void - - - \ArangoDBClient\ClientException - - - $data + $fields array + + $unique + null + boolean + + + $sparse + null + boolean + + + $inBackground + false + boolean + - - addCommonPropertiesFromArray - \ArangoDBClient\Cursor::addCommonPropertiesFromArray() - - Create an array of common properties from the input array + + createPersistentIndex + \ArangoDBClient\CollectionHandler::createPersistentIndex() + + Create a persistent index - + + mixed + + array - - void + + boolean + + + boolean + + + boolean + + + + array + + + \ArangoDBClient\Exception - $data + $collection + + mixed + + + $fields array + + $unique + null + boolean + + + $sparse + null + boolean + + + $inBackground + false + boolean + - - addFigureFromArray - \ArangoDBClient\Cursor::addFigureFromArray() - - Create an array of figuresfrom the input array + + createTtlIndex + \ArangoDBClient\CollectionHandler::createTtlIndex() + + Create a TTL index - + + mixed + + array - - void + + \ArangoDBClient\number + + + boolean + + + + array + + + \ArangoDBClient\Exception - $data + $collection + + mixed + + + $fields array + + $expireAfter + + \ArangoDBClient\number + + + $inBackground + false + boolean + - - addEdgesFromArray - \ArangoDBClient\Cursor::addEdgesFromArray() - - Create an array of Edges from the input array + + createGeoIndex + \ArangoDBClient\CollectionHandler::createGeoIndex() + + Create a geo index - + + mixed + + array - - void + + boolean - - \ArangoDBClient\ClientException + + boolean + + + + array + + + \ArangoDBClient\Exception - $data + $collection + + mixed + + + $fields array + + $geoJson + null + boolean + + + $inBackground + false + boolean + - - addVerticesFromArray - \ArangoDBClient\Cursor::addVerticesFromArray() - - Create an array of Vertex from the input array - - + + index + \ArangoDBClient\CollectionHandler::index() + + Creates an index on a collection on the server + This will create an index on the collection on the server and return its id + +This will throw if the index cannot be created + + \ArangoDBClient\Exception + + + mixed + + + string + + array - - void + + boolean - - \ArangoDBClient\ClientException + + array + + + + array - $data + $collection + + mixed + + + $type + string + + + $attributes + array() + array + + + $unique + false + boolean + + + $indexOptions + array() array - - sanitize - \ArangoDBClient\Cursor::sanitize() - - Sanitize the result set rows - This will remove the _id and _rev attributes from the results if the -"sanitize" option is set - + + createIndex + \ArangoDBClient\CollectionHandler::createIndex() + + Creates an index on a collection on the server + This will create an index on the collection on the server and return its id + +This will throw if the index cannot be created + + \ArangoDBClient\Exception + + + mixed + + array - + array + - $rows + $collection + + mixed + + + $indexOptions array - - fetchOutstanding - \ArangoDBClient\Cursor::fetchOutstanding() - - Fetch outstanding results from the server + + getIndex + \ArangoDBClient\CollectionHandler::getIndex() + + Get the information about an index in a collection - - \ArangoDBClient\Exception + + string - - void + + string - - - - updateLength - \ArangoDBClient\Cursor::updateLength() - - Set the length of the (fetched) result set - - - void + + array - - - - url - \ArangoDBClient\Cursor::url() - - Return the base URL for the cursor - - - string - - - - - getStatValue - \ArangoDBClient\Cursor::getStatValue() - - Get a statistical figure value from the query result - - - string - - - integer + + \ArangoDBClient\Exception + + + \ArangoDBClient\ClientException - $name + $collection + + string + + + $indexId string - - getMetadata - \ArangoDBClient\Cursor::getMetadata() - - Get MetaData of the current cursor - - - array + + getIndexes + \ArangoDBClient\CollectionHandler::getIndexes() + + Get indexes of a collection + This will throw if the collection cannot be fetched from the server + + \ArangoDBClient\Exception - - - - getExtra - \ArangoDBClient\Cursor::getExtra() - - Return the extra data of the query (statistics etc.). Contents of the result array -depend on the type of query executed - - - array + + mixed - - - - getWarnings - \ArangoDBClient\Cursor::getWarnings() - - Return the warnings issued during query execution - - + array + + $collection + + mixed + - - getWritesExecuted - \ArangoDBClient\Cursor::getWritesExecuted() - - Return the number of writes executed by the query + + dropIndex + \ArangoDBClient\CollectionHandler::dropIndex() + + Drop an index - - integer + + \ArangoDBClient\Exception - - - - getWritesIgnored - \ArangoDBClient\Cursor::getWritesIgnored() - - Return the number of ignored write operations from the query - - - integer + + mixed - - - - getScannedFull - \ArangoDBClient\Cursor::getScannedFull() - - Return the number of documents iterated over in full scans - - - integer + + mixed - - - - getScannedIndex - \ArangoDBClient\Cursor::getScannedIndex() - - Return the number of documents iterated over in index scans - - - integer + + boolean + + $collection + + mixed + + + $indexHandle + null + mixed + - - getFiltered - \ArangoDBClient\Cursor::getFiltered() - - Return the number of documents filtered by the query + + getResponsibleShard + \ArangoDBClient\CollectionHandler::getResponsibleShard() + + Get the responsible shard for a document - - integer + + \ArangoDBClient\Exception - - - - getFetches - \ArangoDBClient\Cursor::getFetches() - - Return the number of HTTP calls that were made to build the cursor result - - - integer + + mixed - - - - getId - \ArangoDBClient\Cursor::getId() - - Return the cursor id, if any - - + + mixed + + string + + + $collection + + mixed + + + $document + + mixed + - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use + + getShards + \ArangoDBClient\CollectionHandler::getShards() + + Get the shards of a collection - - string + + \ArangoDBClient\Exception - - \ArangoDBClient\DocumentClassable + + mixed + + + array + - $class + $collection - string + mixed - \ArangoDBClient\DocumentClassable - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use - - - string + + any + \ArangoDBClient\CollectionHandler::any() + + Get a random document from the collection. + This will throw if the document cannot be fetched from the server + + \ArangoDBClient\Exception - - \ArangoDBClient\DocumentClassable + + mixed + + + \ArangoDBClient\Document + - $class + $collection - string + mixed - \ArangoDBClient\DocumentClassable - - eJzdXFt32zYSfvevQH1yKrlV7LSPTp2t15Yb9ziJ11ay23V0fCASkrimSC0JSna3+e87gwsJguBFttLkVA+JJQKDbwaDuQHgT39bzpc7OwfffbdDviPHCY1m8enfyeXrS+KFAYv4IUlYmoWcpIwTL0vSOIGW2PjnJfXu6IwRkvc7EV3EQ5rxeZzAM/Irjcg1Z2xBo0g88uLlQxLM5pyc5H/9+OKHHweEJwEQjFLyy2LyegCPw3gWsQH5hSXQ+wF6H+zsRHTBUhibWcO+zNm4TOJV4LOUUM9jaUp4TPicKUZSEk8JQDr+xwX5b8aSBwIwaRRDi4SknHK2kDwgpRF0k0yThcAJ7YgXR5wGEaFhmNOErzjEhM2CKAqi2f5Pk+SVInI+NYYXcgwQU0wmwQyxTRgwTqN0ypKE+UgqjhiZxQPshgRKCII0zRihvh/wII5oSF6PRpdAHHhJueB1yrg3130TkHuAiHKo0yReCEApS1Ys2e80nWkQefiIkBf7P4p58EIKoj2R0ILFMhRyS8nHc84SykFN/reD7cWc4AcEsVjGCSfPbv3Yy7D1iaAxzSJP8hLwB9X2QPyfpYycmm3pJGQwzxZdMUtxFDFBhsST/8Bf6qFu8/OKJqBQulFpmGUSrGDeAVhB5aU9iOI0XuLT1EWdJgl9qCGsulWxX0mtOKWcbkjThy5uWRSatilM2bNKdXdOU7KIE7YL6ukHHs4veU4C0OwkYwNDnYhuqfXNBWESx2ENAuj+BnpXIahFEPgwrlwJsG7evr+4QBTqoR/DosclOqcrhos88F3DL4J75teMH/jOoRPQQLKMU7HocImaq1koPP7e/50l8fMJTZm/5xo4iHjNsJp0dXAec1jkIYtmfI6myxi4DziibDEBqcMDvajSDYeWpKsDTzOwb16cAeNxxYL1g1kUJ2hW8EGcgQgWccrJxfmb89GGAHCgExynioHdg2UkqOmkj7Y5SHngpXuAhGdJBMayMGaF5d5M5cUQ1ZELuQr76oGxB+M6p5ysGSj3gvpM2O4sCH0BQKmglFEdp2iZQUWPyA/VEddzJnwQEEEVRprSPymxr2FhiTVmcF04MdXIox7afefo4pkvDZs9+DJhwKKXhdDUdymV9nCSzQEBMPkkTB4MA7DZ3HvueVfcwMDA2hQkkq/+Eh0w16Bzw7ejq99uz09BrL3A73WgtquszC6ZhnRWS/L18fWbd1dDpKs6dCGufsglV0v+anj9/mKE1GWXLsSLBVFLdviv0dUxUhVtuxDFtVMP83p0PLpGeqJZF3qoDIb16GQrzHHPwKrfnrx7/1YIJzcPjqGFSiufLAHUsnFyfPJaTKXoU0fL19xQDsHoBLCCu3GszE5rsroYK4BOc0QuxU1pBF7h944cXh+/PR+d/1sweau7OqjugtLz3RJN0l8HMF88YZSXYmXgj5JUhHfSig6ECCq+porm7OJYTN8tjuZCIcO00cOSlbHs15Ic/XYpmCt6uuii+82SsCvRvx9fD99fXSBd1dNB9ByFCfEpxKOGrV8HfC6VPUiAXi6zyCdpvAAnwTj1HYHdkiZ0YQSj5JkRvT43Q1mZHUAY7FudxVyIn2QgKP/EkEwiza0QPmuz1S6iKmCVRL3G2JfPk3gNgX85bfgo/xvee2xZjbizSRh4eeRPbm/FlCSZx/tuuQwUOsFt/kUhkloo8w2Bns+D9PkrI5yH6X1mB/dGS0OE2FKG1jY1CD2LNhFYpWoTafAam0gLrprcjB00pB2SDaY0THUwjB+IdfuQATLeFyBvUhZODw+1Bxzv7RlSsLArvuwuBYBP+V+1w13rKEsTEFa6flgpDz1yTW8TQSdGhYerH1RK2MWu7GiI0xrJJFDqKHzgWP1UuKcqBhNH7rgQy8akX5boftpURtK7NMyM1DKXlFRX57QcHBiecZGlIgtD58jyJpCms4TXAlNBFSCrqr6KsgBVH1PEPQc43d29JpQ9uOmVSwy9WjlAr1KBoYmEUyBG+yB9y9a9cbFqbfYMm3qUd6w2U6ZbNnNYCOr7/b4wgC4ByahyXJVutoS27EJke/09Q37qecLWkNv3VUdg0XaCw/slGO2Ahw/EZyHjpi+0fMIIKJbrVZHMo06HF8PRUJer0L8FEYSMZkGK0AnEiJoS/i5GA1ntW6Noz2P7GPKzdHeizgDuC2sUolZhjOHdRfE6ZP6M+aUxNLSBnEQi6oJrcPyN/kvKo2/7IdTMwgLbKohxV731KLwVuCdJXk9kEvb3yD7pHfTg34L+AJRlzzJu+FHCQClYRgUiVCwV9nMBkmfMRum0PIqkoecOffmFyVhSVjCKnNKqmXZUoNaCJ40eMLmALCXyIdkoZyeVsuemqgQpLGqSm5VG3ZgxLrxAo3ZIR/nNkYwa7DlQGEqNndZoPQ8gUO9b9rTG9gmxvSsk1ndbOGtwXS4yWjnmvFo8UjHkZoWjbQj/TLvhygRYnBl1qBaNVs6z8IQ6662vvJYt0tNqPY4ij0PnBMY2ns2aUA3D5jYHpoNRqZz21S5YmSE8z/GKbZ+ClTbxHYdhRXZ/wurSBfia+bgSPrpUiAMnwdKUqtJLvvniVr9VbFXQbM51EFCTUOUV8CPyogGk9DcSpKicK7WGGdsQsJ5FNzGtj2kae64ir8WcItC2JiT9G5vncReGQXjs3jB5T+Ne2T0372KoRn7v2EMbr8W+Qw1vx/6K4tbf51O5CHKiCszvv++M8GTOvDtjE8gDjZig/RHAwYBmCdrajrC/OjvmiGHbGJWRayER4IhifbZ5HlY0DKor3wxS8tX/05EVDgDAH2w7CKnimsmdOHM/EDdRysah2FZLXVFPOW610t9v7NTxjz/IN/Uht8Tkx1GPV5ENCPhyU8AgN3Y/p5Dl6vpbGZmV5pXT5IhhZpHrSKFFjXpBGv2HvYq7zkz92sGCLyv5yAq8IFqCWFw+v1Q2lGVILEB68aI4b9BuFR5XQFQ7SLn2YlJsALHVGFY8o5jq6LxflcdlgWIPHckzAGHri1CxIL0VlPuyBWiYVS/SJQAzDcfy93iPfPutnf07WjUUkYCts5DyM5iM4wKDncYxXO9VGgq9C6pZQ3cDKIPQRZK0EUkjGvyk64Abs1ADp6YzfjwKtHuYtvfIYW2rMvYhtG7HbX4moCx39U0kCFiznN13h/EB2gfe50CypHzeHccltP4MINJ5DPJI+eVGYK6NXtvH5AdoPT02irsjOs37bB8PWMZFHL1lEF5M4iTtDuqk3PFzIbtM4iVqKdsYWtFz+9imwSxLNljvZ6L9NnH4bEox7O6sQ52tZUcQn6pmdsf97dOf6OpzQpbPr+wQ1qYCDi9uuTuXM7cStXF5y64b78XBlu1xv6uJ7sqHHeSwteDHoXIN4ZB9BLOIGku/VzcJSjIvNz489ISYrckb2AFQEY22zxJ6tq3OkCD4BabHcrrbmJqiA4ZDduP8N3MO5VmPI3JTMh4iksHIpIffjl6Rm/Gg3ACJyac1DdI4SzzWyxt0U40b3W9cVRJrAB9ihCASpyx7mwxg9mscxdhmK3IFSSMXz1ikCatKwU+I1WzXcXms6taGXB91eORstIBRjRSSXBsej8JlAMRYGyxnHSP+dda1O379MsvbTPdsza2keFIm7i1t3Q2/6AMCBi0DG4TKCf8gEiFsqdvcvDAbGWuw1EhsD/Xz73tYqhh3MFdirrdrjQw+2k2RShC0tdSWRv9so3mE6Sp6tJisQlYolCbL3mzWxVMn4Y2NIQKp2sLV0w2bJLx9u6YMptQqRRi/tAQ/ZdvXJeJUCvIl7V5D/OhIe5vMmFybxaeiepVFqDx+sdKqK+WpK6tQUaTu8u3b8GIyVyaRzsb/Cn6stsCw3SQiZFNu+BT8WvIn8jJg/lx87dlnvaySpt6uQ2L1591KraxzVZ86k7+RCDsOo1tXhqu1gLlOKSuov280XMfoM6dtC2KTRbDM6z5fpVWrL0416fUdsT9HEsvtHXtIVU3iZXP7Z3flIMiasDtbKSxNwAaoAF5l5uVJXg/PG/o965RoFgnN1Q+telMVww1QE8riPUoHZGEu/Ron3q4BNk13+dilXUtqF4PYX9im+mNU8wV8gLVP0mj5O5ccXGWjpqitpWTUYTpUOrLF+ZABxReYkeqW0Vdf07Mn6FpfYbIukKJ8LEmKoxfiHlLCFvFKdsGbC3ihBkCuigN3xnLLT5NO5ZV3SWtXb/Dm14CC1HUsr6QBYs4MDRDf5RUcTa5yn9g6p5S3MxmsmeB8D9oY/umTWr3O4Np41nfF2reojZZlT1R4LCEn9FbgHkUcvqJhJs7FlToU6PR+umoHCBRi8cNNRQnr77foj/J8iOQGYYybiDg2rbeL9Gr4YQtQBRUXVvc3x6FCHKN2ZZ6JgynGwaVtnVhqd9DVsy2W2h8ciLdsBFFGixEIJggsXYKGMmMhmAflwdK3n5Lv9dRJeU21OGymLmibNlK4haNi5OevZoz/msaR6w7FZjdYrM54hKXpPkc5S2k5hWqcvpJMqVOjMV7l5CVTjOYVz5IJxZQu0ydRvHYGjyL8LN9s+1QRg33VpEYDr9VwxcsN8Ftf4d1rP03drmllJDWRnxr/iKiKZMkt1sM3jn3izVGCt0j1QXDnpQYNO+VJcU6wDnhSPX/czbSrC611Jd9GY6/71h1qw67i7TV4xJ+G4YR6d7bVeZ+EYMKAyu3J+6vrd1dNVwUoyd/qQEOVTxBhWgsjZB6Md7tvKU/IlukCr2uL//L0BB24RFYzG3UvJzBPg+PNxQ8Iqy8GaZ+Y2nt+on/r3LR0bzpJ/qJJ3m8Yp/iqGfuEcqO6th+sBgm9UXedWw4cN6VWxnoy3vuhkEotMF4CQsBK7O/t4zVqLvbxyy8pMUETny0ZGLlYEucPS6EfkiS7Z17GmwO7NuaHCLftqLV60Ugr72ua4PuaUnn+2Cd+JrTbRFs43UfB/acaoYOBkYrY05hqN5JIbYcmXb0Zd5BHceFnnQQY+usZ03fZhWS6Lm6HNATVoSLaMoslW9Bbl7r2ak82OLkRF6GAC0GEYIWKyuuhZcv3VMbO5TCP4Ev13JAt440x4oQ9cBjjjcsgkpfCUgg16nLoDkxdQ/eI+XipayOW0qLf9hiStz22w9E50noMS6Ljo3maBiFwtbXFdKbIbcSIxrAhE094MdNjOJOpQeslQp1BtDKSv9JogHZXvN7Qic0VLVbhnbde9Qvya34AS7y975aGAU378s12h4fiN0iPPurXMOry1eSjbILz8392+EmX - - - - ArangoDB PHP client: single database - - - - - - - - Database - \ArangoDBClient\Database - - A class for managing ArangoDB Databases - This class provides functions to manage Databases through ArangoDB's Database API<br> - - - - - - ENTRY_DATABASE_NAME - \ArangoDBClient\Database::ENTRY_DATABASE_NAME - 'name' - - Databases index - - - - - ENTRY_DATABASE_USERS - \ArangoDBClient\Database::ENTRY_DATABASE_USERS - 'users' - - Users index + + all + \ArangoDBClient\CollectionHandler::all() + + Returns all documents of a collection - - - - create - \ArangoDBClient\Database::create() - - creates a database - This creates a new database<br> - - \ArangoDBClient\Connection - - - string + + mixed - - + array - + + \ArangoDBClient\Cursor + + \ArangoDBClient\Exception - + \ArangoDBClient\ClientException - $connection + $collection - \ArangoDBClient\Connection + mixed - $name - - string + $options + array() + array - - delete - \ArangoDBClient\Database::delete() - - Deletes a database - This will delete an existing database. - - \ArangoDBClient\Connection + + getAllIds + \ArangoDBClient\CollectionHandler::getAllIds() + + Get the list of all documents' ids from a collection + This will throw if the list cannot be fetched from the server + + \ArangoDBClient\Exception - - string + + mixed - - + array - + + + $collection + + mixed + + + + byExample + \ArangoDBClient\CollectionHandler::byExample() + + Get document(s) by specifying an example + This will throw if the list cannot be fetched from the server + \ArangoDBClient\Exception - - \ArangoDBClient\ClientException + + mixed + + + mixed + + + array + + + \ArangoDBClient\cursor - $connection + $collection - \ArangoDBClient\Connection + mixed - $name + $document - string + mixed + + + $options + array() + array - - listDatabases - \ArangoDBClient\Database::listDatabases() - - List databases - This will list the databases that exist on the server - - \ArangoDBClient\Connection + + firstExample + \ArangoDBClient\CollectionHandler::firstExample() + + Get the first document matching a given example. + This will throw if the document cannot be fetched from the server + + \ArangoDBClient\Exception - - - array + + mixed - - \ArangoDBClient\Exception + + mixed - - \ArangoDBClient\ClientException + + array + + + \ArangoDBClient\Document + - $connection + $collection - \ArangoDBClient\Connection + mixed + + + $document + + mixed + + + $options + array() + array - - databases - \ArangoDBClient\Database::databases() - - List databases - This will list the databases that exist on the server - - \ArangoDBClient\Connection + + fulltext + \ArangoDBClient\CollectionHandler::fulltext() + + Get document(s) by a fulltext query + This will find all documents from the collection that match the fulltext query specified in query. +In order to use the fulltext operator, a fulltext index must be defined for the collection and the specified attribute. + + \ArangoDBClient\Exception - - - array + + mixed - - \ArangoDBClient\Exception + + mixed - - \ArangoDBClient\ClientException + + mixed + + + array + + + + \ArangoDBClient\cursor - $connection + $collection - \ArangoDBClient\Connection + mixed + + + $attribute + + mixed + + + $query + + mixed + + + $options + array() + array - - listUserDatabases - \ArangoDBClient\Database::listUserDatabases() - - List user databases - Retrieves the list of all databases the current user can access without -specifying a different username or password. - - \ArangoDBClient\Connection + + updateByExample + \ArangoDBClient\CollectionHandler::updateByExample() + + Update document(s) matching a given example + This will update the document(s) on the server + +This will throw if the document cannot be updated + + \ArangoDBClient\Exception - - - array + + mixed - - \ArangoDBClient\Exception + + mixed - - \ArangoDBClient\ClientException + + mixed + + + mixed + + + + boolean + - $connection + $collection - \ArangoDBClient\Connection + mixed + + + $example + + mixed + + + $newValue + + mixed + + + $options + array() + mixed - - getInfo - \ArangoDBClient\Database::getInfo() - - Retrieves information about the current database - This will get information about the currently used database from the server - - \ArangoDBClient\Connection + + replaceByExample + \ArangoDBClient\CollectionHandler::replaceByExample() + + Replace document(s) matching a given example + This will replace the document(s) on the server + +This will throw if the document cannot be replaced + + \ArangoDBClient\Exception - - - array + + mixed - - \ArangoDBClient\Exception + + mixed - - \ArangoDBClient\ClientException + + mixed + + + mixed + + + + boolean + - $connection + $collection - \ArangoDBClient\Connection + mixed + + + $example + + mixed + + + $newValue + + mixed + + + $options + array() + mixed - - eJztmN1vGjkQwN/3r5iHSEC0gfbunvaatNvClVRtggLodGoi5PUOsFfvh2xvCDr1f+/Y+8FHyIWk6UPV7AusPR/2zM8zhlevs3nmOJ3DQwcOwZcsmaXdtzDoD4CLCBPtgYqSmUAImWYBU0hyRvRNxvgXNkOAWuudVbCTLNfzVNIc/EWTX+ATW6K0MzzNljKazTW8q7/99uLl7y5oGZG9RMH7OOi7NC3SWYIuvEcZs2RJ2h3HSViMilzjltc/V3ughTOlYEr+SY/NaPmrjXXLXahyG6N5pEqFTKbXUYikmSdcRymtRKeFCVzpgZ7LNJ/Na5MNVU+CPzh9FciTKkQioq3bZ651prxOJ0y5ajOrGQZtnsad/mg06FQGOlES4k17rmOxV5gpNRytg5ftP2yAiq1U9pz/HDNpI2Oew7V9WFflcMd+ctqyht7Z6OKfSdcf+W/9YW9y5n/qwTE0TOAbFOUte2OFcm9b42HvYmiM5UZrhzUukWlaG1ujzc5UAkW6aqkEF7VkEfgNaQqeZDGRlCRoMwoHfPX9iFKJsDZA2Q4QaG3hlgFFaBJE5jkwcShyWhqo/IPKkEfTiDNjzLX84Q2LMzo7jXhZBb6xvUYLyWP42DQjUecyASYlW8KBpENCGUDfvh5R3BCqsUKmXWsaoBcKLjf5uuzdcMzMVu4TLD62xQsMsjwQEacAUlB4fbDKDDZ3J8YtgtyyBgqAbeQzthQpC4mfz/WgeRSKqeftwhaOTwpb7v0KJZsnW8bNc3vEPBZieyqsm9X6j05mqM9tLNZ2WAwozzsfjE7Pzyb+eNS3TlvubvMZHeRF2AB4vPmBPxz+3W3dsn/l7H67Kk+kDXeNy/Gm9yxVujmWgnyNLz7WAXQ3pf5VaTLBhKchThaSZRnKZpXBVmvNT8lt7c5u7wNpN0nKCHx1bpWJLgq8v0wsIiEgtKLAEjqLkdLmGFc67edq8XNUiyKHD6wWuRRELnHaR0HweV6QRyKk953sfrZGrlr7HIByOcbD94L8kZCskVB3QiyM2Do95hbCdIE0GBZpjqrRtbljPSnTvzR3Juz1fekO/La5KzdYtJg6Xc11jZqGZxh+IhjCB4JwZ/mgqrCjBD20kuxix1xI7gToAqkt4bWlBQuI0ikw0yLXOCIAcikpNoUxTn2TcY7KsEe/6HJdmSva19I0OurC0XSKtZbtedTO7AUmleFT99lfGkOTOPOba9+69OiGaK+3jf06okH6KdrhitEooQtRbO9GwALiboPNe2995Or/TYilJWp1HZvKNH6unD8EWUrGKeVi37r5UE7LjP5YVAlW+8/KhImIqWaVIs+zoy40Lqt/r6qABZf1HZ6sfAOoGev2 - - - - ArangoDB PHP client: failover exception - - - - - - - \ArangoDBClient\Exception - FailoverException - \ArangoDBClient\FailoverException - - Failover-Exception - This exception type will be thrown internally when a failover happens - - - - - - $_leader - \ArangoDBClient\FailoverException::_leader - - - New leader endpoint - - - string + + removeByExample + \ArangoDBClient\CollectionHandler::removeByExample() + + Remove document(s) by specifying an example + This will throw on any error + + \ArangoDBClient\Exception - - - - $enableLogging - \ArangoDBClient\Exception::enableLogging - false - - - - - - - __toString - \ArangoDBClient\FailoverException::__toString() - - Return a string representation of the exception - - - string + + mixed - - - - setLeader - \ArangoDBClient\FailoverException::setLeader() - - Set the new leader endpoint - - - string + + mixed - - void + + array + + integer + + - $leader + $collection - + mixed + + + $document + + mixed + + + $options + array() + array - - getLeader - \ArangoDBClient\FailoverException::getLeader() - - Return the new leader endpoint - - - string + + removeByKeys + \ArangoDBClient\CollectionHandler::removeByKeys() + + Remove document(s) by specifying an array of keys + This will throw on any error + + \ArangoDBClient\Exception - - - - __construct - \ArangoDBClient\Exception::__construct() - - Exception constructor. - - - string + + mixed - - integer + + array - - \Exception + + array + + + array + - $message - '' - string + $collection + + mixed - $code - 0 - integer + $keys + + array - $previous - null - \Exception + $options + array() + array - \ArangoDBClient\Exception - - - enableLogging - \ArangoDBClient\Exception::enableLogging() - - Turn on exception logging - - - \ArangoDBClient\Exception - - - disableLogging - \ArangoDBClient\Exception::disableLogging() - - Turn off exception logging - - - \ArangoDBClient\Exception - - eJyVk99v2jAQx9/zV9wDEhRBWduXie5XR7dWVTVVyx6RoiMciTVztmwDRRX/ex0nDZCm05oXR7773n2+d/KnrzrXUTTq9yPow5VBztT1d3i4fYBUCmI3hgUKqdZkgB5T0k4o9qlF9jeN6V/MCKAWToImBHHlcmV8DO6QIXZES2QOoVTprRFZ7mBS/51/OPs42APcLGe3Ax+WKmMawA0Zr9569SiKGJdkfW9qtL2sffyskIc/Gsh/cmH3PsBtNcFGSAkzApcbtWEQ7MgwSrmFTU4MuB9AjloT26b9FvNWcFrM5eL0IjCnEq2tsWoqj+KI5xb2nE9RMbLgo/j68Is2IAnnxQJ4rpUoWoTQS4YHMbgE64zgrLochVMbsUZH0EnKCpfhttnhN7mVKYyWFcCQNmS9FQyMauFHQ4fbP+5uSnklHrZXOcZazaRIYbHiNHRIEqfioOqdhIRyCMVXFU+Syf1VHCcJnEJ3DF1/dJzf5fBLRu4+eOudlO52rR5jcsEFv2+a3s5/qirQtRLzf3q1NW+nrNh0XPmqNgafoXO4u130xvbeh1m7e1vSjn8w7vZNHeO/QHvs8AQSlAJt79VDGI9DeADdqSfzj4rttHpWs+mr7K5f9TMcvmlo - - - - ArangoDB PHP client: batch - - - - - - - - Batch - \ArangoDBClient\Batch - - Provides batching functionality - - - - - - $_batchResponse - \ArangoDBClient\Batch::_batchResponse - - - Batch Response Object - - - \ArangoDBClient\HttpResponse + + lookupByKeys + \ArangoDBClient\CollectionHandler::lookupByKeys() + + Bulk lookup documents by specifying an array of keys + This will throw on any error + + \ArangoDBClient\Exception - - - - $_processed - \ArangoDBClient\Batch::_processed - false - - Flag that signals if this batch was processed or not. Processed => true ,or not processed => false - - - boolean + + mixed - - - - $_batchParts - \ArangoDBClient\Batch::_batchParts - array() - - The array of BatchPart objects - - + + array + + array + + array + + - - - $_nextBatchPartId - \ArangoDBClient\Batch::_nextBatchPartId - - - The next batch part id - - - integer + + $collection + + mixed + + + $keys + + array + + + $options + array() + array + + + + range + \ArangoDBClient\CollectionHandler::range() + + Get document(s) by specifying range + This will throw if the list cannot be fetched from the server + + \ArangoDBClient\Exception + + + mixed + + string - - - - $_batchPartCursorOptions - \ArangoDBClient\Batch::_batchPartCursorOptions - array() - - An array of BatchPartCursor options - - + + mixed + + + mixed + + array + + + \ArangoDBClient\Cursor + - - - $_connection - \ArangoDBClient\Batch::_connection - - - The connection object - - - \ArangoDBClient\Connection + + $collection + + mixed + + + $attribute + + string + + + $left + + mixed + + + $right + + mixed + + + $options + array() + array + + + + near + \ArangoDBClient\CollectionHandler::near() + + Get document(s) by specifying near + This will throw if the list cannot be fetched from the server + + \ArangoDBClient\Exception - - - - $_sanitize - \ArangoDBClient\Batch::_sanitize - false - - The sanitize default value - - - boolean + + mixed - - - - $_nextId - \ArangoDBClient\Batch::_nextId - 0 - - The Batch NextId - - - integer - string + + double - - - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - - - - string + + double - - - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - - - - string + + array + + + + \ArangoDBClient\Cursor - - - __construct - \ArangoDBClient\Batch::__construct() - - Constructor for Batch instance. Batch instance by default starts capturing request after initiated. - To disable this, pass startCapture=>false inside the options array parameter - - \ArangoDBClient\Connection + + $collection + + mixed + + + $latitude + + double + + + $longitude + + double + + + $options + array() + array + + + + within + \ArangoDBClient\CollectionHandler::within() + + Get document(s) by specifying within + This will throw if the list cannot be fetched from the server + + \ArangoDBClient\Exception - + + mixed + + + double + + + double + + + integer + + array + + + \ArangoDBClient\Cursor + - $connection + $collection - \ArangoDBClient\Connection + mixed + + + $latitude + + double + + + $longitude + + double + + + $radius + + integer $options @@ -9413,946 +9442,1245 @@ specifying a different username or password. array - - setConnection - \ArangoDBClient\Batch::setConnection() - - Sets the connection for he current batch. (mostly internal function) + + lazyCreateCollection + \ArangoDBClient\CollectionHandler::lazyCreateCollection() + + - + + + + + $collection + + + + + $options + + + + + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler + + \ArangoDBClient\Connection - - \ArangoDBClient\Batch - $connection \ArangoDBClient\Connection + \ArangoDBClient\Handler - - startCapture - \ArangoDBClient\Batch::startCapture() - - Start capturing requests. To stop capturing, use stopCapture() - see ArangoDBClient\Batch::stopCapture() - - \ArangoDBClient\Batch + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + \ArangoDBClient\Handler - - stopCapture - \ArangoDBClient\Batch::stopCapture() - - Stop capturing requests. If the batch has not been processed yet, more requests can be appended by calling startCapture() again. - see Batch::startCapture() - - \ArangoDBClient\ClientException + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + + mixed - - \ArangoDBClient\Batch + + \ArangoDBClient\ClientException + + $optionName + + + + \ArangoDBClient\Handler - - isActive - \ArangoDBClient\Batch::isActive() - - Returns true, if this batch is active in its associated connection. - - - boolean - - - - - isCapturing - \ArangoDBClient\Batch::isCapturing() - - Returns true, if this batch is capturing requests. - - - boolean + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + + string + + + \ArangoDBClient\ClientException + + $body + + array + + \ArangoDBClient\Handler - - activate - \ArangoDBClient\Batch::activate() - - Activates the batch. This sets the batch active in its associated connection and also starts capturing. - - - \ArangoDBClient\Batch + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array - - - - setActive - \ArangoDBClient\Batch::setActive() - - Sets the batch active in its associated connection. - - - \ArangoDBClient\Batch + + array - - - - setCapture - \ArangoDBClient\Batch::setCapture() - - Sets the batch's associated connection into capture mode. - - - boolean + + array - - \ArangoDBClient\Batch + + array - $state + $options - boolean + array - - - getActive - \ArangoDBClient\Batch::getActive() - - Gets active batch in given connection. - - - \ArangoDBClient\Connection - - - \ArangoDBClient\Batch - - - - $connection + $body - \ArangoDBClient\Connection + array + + + $includeArray + array() + array + \ArangoDBClient\Handler - - getConnectionCaptureMode - \ArangoDBClient\Batch::getConnectionCaptureMode() - - Returns true, if given connection is in batch-capture mode. + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name - - \ArangoDBClient\Connection + + \ArangoDBClient\ClientException - - boolean + + mixed + + + string - $connection + $value - \ArangoDBClient\Connection + mixed + \ArangoDBClient\Handler - - setBatchRequest - \ArangoDBClient\Batch::setBatchRequest() - - Sets connection into Batch-Request mode. This is necessary to distinguish between normal and the batch request. + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation - - boolean + + array - - \ArangoDBClient\Batch + + mixed - + + $headers + + array + - $state + $collection - boolean + mixed + \ArangoDBClient\Handler - - nextBatchPartId - \ArangoDBClient\Batch::nextBatchPartId() - - Sets the id of the next batch-part. The id can later be used to retrieve the batch-part. + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use - - mixed + + string - - \ArangoDBClient\Batch + + \ArangoDBClient\DocumentClassable - $batchPartId + $class - mixed + string + \ArangoDBClient\DocumentClassable - - nextBatchPartCursorOptions - \ArangoDBClient\Batch::nextBatchPartCursorOptions() - - Set client side cursor options (for example: sanitize) for the next batch part. + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use - - mixed + + string - - \ArangoDBClient\Batch + + \ArangoDBClient\DocumentClassable - $batchPartCursorOptions + $class - mixed + string + \ArangoDBClient\DocumentClassable - - append - \ArangoDBClient\Batch::append() - - Append the request to the batch-part + + + Name of argument $collection does not match with the DocBlock's name $collectionId in importFromFile() + Parameter $collectionId could not be found in importFromFile() + No summary for method lazyCreateCollection() + + eJztXW1z2ziS/p5fgUm5TvKWbM/L3n3IjLOr2EqsiWJ7JXlmchmXixZhm2uK1JKUHe/O/PfrbgAkAL6IlOWX5KSamiQk0WgAjcbTjUbjp7/NrmYvXuz85S8v2F9YN3KCy3D/DTs+OGYT3+NB8opNQt/nk8QLA3blBK7PI/gUv/77zJlcO5ecsbTgHpWhl848uQojeMd+dgI2SjifOkFArybh7C7yLq8Stpf+7ftvv/u+w5LIA4JBzN5Nzw868NoPLwPeYe94BKXvoPTOixeBM+Ux1M2tan9M23EchTeey2MGhYDeFF6y8EJrSSybML7iBe1jFzyZXEFx7ZXrJA67iMIpS6BMzKMb+A4+RyqTiDuJ8XnMoEj24XatHou9YIKvGPt2+3tq6sR34hh7QZI9kPzxzwkP3JjJf7/4z4sXWIxaj7+/MDeczLHZMXOiyLljXuDyz/LlDv05AS4T1jscDz+e7R/tnXyAv47YLmulRVs/5shqHTJzIhiHBKUhR/XoeNw/OjzbOxoMenv4V6SblS0gzD8705nP61Dt/db9cDzoIUlZ6n70Dnu/nv3SHZwQxYDf/uL483uS3Bv2uuOe3X6Skr2qXnASmADn86RWJd3xeNh/czImvtOSBVSv+V1ch+D73kcSAPy+gEycQAOmdQiNxtD+D0hKlCkg5vOLpA6pQe/tGAnh9wVkhO6oQWfYf3dAhKhEkWT7YczdWoM7OBr19mlEqUxR65zES+ZurWEcdMf98ck+jaIqV0QyDC7r0zw6fJcRVSULqLpenDiodWoQ3e+Pxt3DPaKpyhUNieN681ryNuzu909I4kSZIpm79ma1JO59/5jkDb4vIEParw6d/uF+7zckRCWKhsGbevUEt/+hLyQXSxRQuvC478blBN72e4N96h3xZQGJeeD9a87LSZwc9v8h1Jr4soBEcjerIDD+eEzF8aui0fH+zVk4Q2VWMTT9/yUa+HEBjUseyuFZROhd7ygbHyhWTOznGNamGqR+HgmtLIsUELty4quarB10RwcZb1iwaMDnvp/Ayl2T5tuTwWDc+22c0VUECmhPvWDAg8vkaiHZD31UqofvxgdIMi1XMvd8mOc1+cUpOAAVkfGrCBTQnvEohjeIy+pRP+4NR0AcMEpGPyMCNWCJnHAnfk3y4/EgowvFSgjyzzMv4t0LmPkLSfZ+O+4Pe2fdt+PeUGCVtGwJdS94A/DwMgrngbuQPAzjm+7e+3fDo5PDfaGxstJFowk6K+Z1x/K4OxyJWUvFCpHgHEH1AkJ7wN1YgL95UCQIoJWiu4VkQIsNPyIZ+ryImys+uY7n08UMHfT23o9OCJyoQkWLGL/xYq+GJhn2fumPJMBThUqGNwKjBYp654Ah4ysnWjzGw97o+Ohw1H8z6J2NDrrDfVFLSmaEVEpqoxrixSONZGmVEQWK5moUwkxLPL6Y2vHwCCbquN8jilnBwuXvch7VIPm2/+5k2JPrIBUpBEfO4t4cHHX3BR5yiibInjTiHAY2gG7oGJac/FoVGl95Mbv1fJ85rkuflRVEWxFEIJlHAfPALPPcjAZMS5d5aK16gX8nvwIwegH28zlM6lsaykk4nQE+PPd8L7nrMAD77C6cw0CHc99lc5jcVv1oJxMNsJyB6AWPOEK9JLQ+3C5uUXIVhbfMu7DJTsCMDxN2zqXd61p98ncqGLPe5wnXhyR9T+gJlqzP0MQNjfCW0Xnn/4S/IbNZRVaPYsvQKvGCS+AY1j58h422ahIW8IaQjxhfbUGXyMfhhRSceFsVK/39NHt9JIk4EWevfjqPXi8u5HuvBYDKvdpi37Ot1ywIo6nja43vsB/wOXcv+Vb29KcdoFSvulvHS96G0egumGi1buFgxpw6NYnmvIMdBv0AYx3xaXgDPOCEdUQLSQa8AHF+AkIJoxADORjawENDCWiAEXDNdlgfJQSEBv5DuYhnfOIBZHUleVN6WjFz+YUz9xMiB2SvnBsPRpKqg0qcGWAG7m43aO0/Q5gujj9CgKm3VnvObtCob0LUi0d3gC2m5qhtsQvHj/nWa5hukdastmzUZod6dut1TIV1gW5W+S8h2oK+ITRp5Rp6qmDhRpJgbS/YmsIAR3ebyzJ0ze+k5JsMwXM1fVAioFeaUEUrUngtaCWLB941NHhLKC6YmLCAJCFOHZ1tVGieC233JiCwtGqBAmhSbTCfnvPo6EJUqhoE1dJzrFgunliVpSobVBNxkOQJzaa3ziQJo5ZdjfyCuu6a8xlTY/iKfbfZpCqA8cN8bVtoFnhTQEXFVeKUnk8mPI7BsmC3OFlvIy9BdbosI9Rx79F/pL/aynStAD4oNqnHKm5cAXA4SkBP8cu7lqxAPcf1gF5IcQQNxib+HCZL1KiaqRMlP4de0E39aqIdqYMuXVzpU9A1oCphpl0IHahaWbvzdmbqo3TxkmBBrJNbCBEMF7a1+grAM5ufw/CCqRno37Q39LXFWg532afTTSr8nxeKHWhG24vPxNqql97c1L7C3wb1g/jt6qv5j+ZnGt+7BLAyP2h7s/Rb0KM8OYQa2lSP9SH0PncmV6ydtgXkegNla/c12yCNb7Obo/+fFtTQYttsPrnwojhpY/nNP9uyuFnhny/yf8OuMihe8uTXbPltb7LdXWgxmO65rrPaqZfawBWVaO2FQSA+Egq4bT+IX72SAPfXbn98Nvp4uLep8f3ni0pWf87WyAas6qWWYvXno5PhYXdAzqEG3PblotyA1bTIUnz2R9Cho3HvQyMm1eLdiM200LKM/nKEruRBWX9u0EJqzVKqZgwvgNW/vdIm5atX8GJfLALifUZ0g2A1aQ6jTXppsa902P3QS1/jpLRqpqm92VlAhbyQOhVsyaJC6WQoqdqYo4uI6eJaRMyYRYuIpTJVwlkm5DUoqUEvoZRJ4iJa73sfz4QsjQppvU8RoE7r9MdMwHZ2yLjgn2EFVmuutspXzpn9AiQIIvlN2ewREvgp3wzcpBC7YtK1cTbov++dFkh9cZW1Z/mhASKX4vXw5MOb3vDs6K1ktYhLu5ofC5agSj5zuHApVoe940F/rys8Mt298dGwiNmCuhrz+6EAyi7FMjq667FdXGVjzkcWNF2Ka5KE/uE73EPtjnvvPhYxnK+pVGwBxRHeK+YWkXp7Mw/qqtmjjeJSvgTN5r2XQ9zL9d+H7nAM+rqv7Y8XslpQXfGyKf2tHIkUrMztTbDHQwCOJ5EPy/HJcKBt+3dUkX/GYXDGg0no8rPbyJmBBd+WjcDlWtehWKcfClnEOlX9VO9AvjjgjssNIRUlsWe/SYvr3SbeM+nVIwROkSepl67d2gcTA62XCy9wWcrCFVWFdpR0uymGWrnas6HewAYPtZ4zWoEbbgaggIqz365Z+lPLc1un2sc2cnLbUF7vRGk4wVNR6s+CjdNaHuOTQ+UzFgWK9k8jMLVgEi7eYRqeHIImEtupslDhxoNwfizcGSBoRdsBWAAp2aT4Z1iEXXTbWa6oik3n3m97g5P9ngIotG1FVKQzrKCaPdxFQcFzdOOUf4blVVWU9y1P0OkYc/+CcCbMdC8AtAAQyr8jR7nYmpHO5yh16N6CgecgcSmzQpoDdnvlgR0Y8RmImQh6Cthfv/0rPPnXnMfJtsVHzkPNfiVHaHDHQqyP8Sgi1w96iYlQOJnMI7s50r28yJMNwo1sK081EBbumBJ7/zwMfe6YY2+b9VdObFjllvluWttSBU2day34yCiuzZ0kurN0LUxtbTtgRDog6zgYIehwKDShXQi5MQBNiTx+o5wTiq1UfZbVrs1e9GFqChkkJkFT365/I2fiI7+c/PP88wyrgD4Xg5iEzOxj4U81StPSxKWOd5UFB6WLPAmSGlGxPQU2T/8EPIwFsBeNd6JfN7i9Yv6Zn2rv0HePexypOy8L8/MCYwKWzrzFuzoi+NG1gx0XzaHiybHauQFaAspXdIHZqGrXGO5IV84isfLRhhE6ybQlSAiy47rjyAliZ6ItyapUh5XIePPJmZacR776+y4DvHHAfQASr16dzz3fhX+XYJBPhvtPaF19f/5UryOFO6wC8NAUBm46aScZLaRY2cWrvggh2BXffyrgK7+mt0ECNmXJH6umiRdc4K4a9bJzHs6T/wezY08nYzWgmu3iGWIr6tWtMpkkLyvHxTK7WGLzclomprbo6baGcKu/hb7sCuMKKW1WCqQeRXGxFsZlhPE47cLVimVeKlemX7OAmOWV7JOJrArRoRCSr15gxbaYkFW95Q0ghSz2xUinjK16CtEsWPMVN6Uyuef4k7mPxrajBfzZ0mYbe79Ke7O06JQnzhYx36aTEk4afUnmaBoK6LnxpiJqfYNkFA4VJ4VyWHShDVol46bcZD9D3kHYM1EX4VMWMWX2bGC01FC2K86IqRalH95ecbKHce6EFDfkBcKpkLZW7x5VXa2f6iE1GmqItL4q5HufwKXRCcvwfR66d/pQNeK9iukyvSL+nIRB4ngBjhIJ20tF6iXJ1EvVnS8XLYZ7spy5t2+N7K6wTTtaz8lHOb20JCJbqMBsg0PG354WajajbvSSBu4xOUmRBWFwfGoZTWzRXpXxqMNaqrXZW/zXKjCjUl+llk3e2TikIjFJe9ZJcTZz+vu5FZXr8woj6xy5Um5d8gBD9EApyMmeXDmJPKsZ40orIkFDIaPpTFCSbjjprpx0yk6unOASidIZRGTVd2JtdhO1e+mw0nW6XG+VTSVtEjkUS6TYXDRplIxUrtCPNBNU5PiTSSU5mitwXbMVaonhVRTkaz2UaIt2KNIYq3IeNYce6lj/1gGlKoJbc5A04jSTAuHerZQV4VW3dCuFINnSksVClIQ/oAbCknn/UX4faZ6004/w97Dyh+ydWoEBNfar0u8LJDDz2uYlboBbLob+8QIZiy50WytmIky11MCgXRsscOnd8KAOqadWWQdJMkv3wbbYwXh8nG6gmSWLBRFbXKmtgBgGU1dsTj6mUOF+mS1SrVaVxMgGlAnNidipM8TGMh4Xi43c7isUnDJiX7rgiDZ/QaIjNlvvJzy29IzV7mwt9wUdguB0HiLbVEjlQxtFPHoj9BF3bnhqRBLGQhRPh+w4bkgkzmTx7uM9vBu2b4MZi2W1hK16zVS72nX3VHK7KmiSCbiff7fEjosqa0WbyDMtEw7m/4jSE0APalQzac1FnWQMfmolWYm+2yoKMRlHn/tuWVSJYc439Z4/xHQtdRKpwIUmSCHrKLuQHKvaGMKe0ftROFsZaF3h5Gp41iz1LLrYnvTU1SPNVKy08ZmADWGPe58xKqRlTq8sykxS2GT/9V/AToy2inz0KTtSdZqPONOJ/019uIuB+ZoQg8S/ga4YyWMJRYRLQp+LJ4zLfQ76aqWr2ukm8Jw2p6l47+lxL5qw9V2BXDo4xjeO77nbmV8BCGIJL4GXHRRS8vCkj9AFlluDhLRu6DVUCF+lNHnxL8jQnkaqbRC2JUkS/sb4iP3xB/um+NAJUMC38O4CME1S/MoL7Belpi/ubVBiA9yIw6O7N47nO3gsW4uRwhQF6VHF9HSpNv0pCxWqCVrtU5elGhU+nSV3KvkSngoKRFBKWlnJkOQViPppfs4lz6+q31LnWNPCeD7KjAoDfhj7FfvIEQctybVOaorivHIBaOlpT0lH2xBSGLfmwSmDK0pchMzYvLzU6n5J51JVIoQLVSkMM/mTxIDFqPJ5hEcMO7V5yNVKIlKnPhyFIvFq2gnlp8ioHnuR/N1MQva7vWiWfmiFjlaqB9C6Xd/XHJ/tOotN9pK+PoPBuOTtT7bg7b5WHm45+PCgJXq3ddpJyRQcXrEAJoHEdEExazmlGDCU57I4ZAMwmTGUiAytWLaMl3qO75LIYumOae49LFrvpHP9dLOMXmUoj8AAtNqr7z5lvUkjc1qw6KcGqD4S+MtO9pWTo8N+k1KwrlWgg9tPLQqXPbUAe2X0XpGxaX1mO2Cr9tXj/Nqeaj/bPXEksiDgMVNaFncwTvYyv4ddgmpLlAF9t2jSlq3nRWdFS8yrClPKaH7edhKGU+Eo6CUX2VY27QIPQp7cVzJqh5YD+1HGTRzoe0Yj15/Owiix/TkOu/B8bvWzHccSitQYZE7FMuYcewlDkEJpZuVCwpc0P/u4x99w20QS8aiFb6E92PlAZEwBLL7Y36HdwavQd4X8erI7nMSxN9mLgedqQOfSgFMmTtkicaUDrCrLCKf55SWtWKU0abWEqe77AnEJ99AWpfNkIhqUTTEKG3DnTCSIdVUUguwX7Lbt2sz9NKv5HWC4kldZQhYt7aqWOAUZasW04YlBC8T+FfocMYVQJtS+B9bF+R39uc16uHTSIwWz6XTFDCYOlzFRqmgDgFmvFSQfreoGyM43omZiwZcyy/SgbsBgjquQs3OOLlqjvQ2aUHdkP4ToTQkuQlQCV6ALdBmR2tbBNEzsNoyu41fsJ4ddRfyC7b68SpJZ/Gpn5xKMgfn59iSc7sA07r7rHY52FIreufWuvR308Av19PL1MqV+2nFqNnunrqDWlvxGUpPPfAsTuq8sRPHSNn+E88INuZjudJxom8kD6ZS9RDg5GnCywDgCniJpu6d6LrX7082hFBKb+aClbMC4TSknNNEvcZcIfQ0l39Jpf2OL2VTmlX45fdWkyUXhPlDyDNbhM/WsbZHM+8VV2V0VGWQt+RUHBvvBbC6UJnuJrjp7LdpmrZfmwaALzE643Sp206mFXZgugpbVP4rdnGlXZ+mnPeIGgaxLAABrTTV+ps9/6Y1CM2riDykhordkbJzAACShGPpGr7ZF8zBACLNsKeoIDUQUkSzgTCahyKQjN9Rp1QXtK8iQf1HHAWn3FsIJ1XQDVazOkXU/TxYpp/pfP2ssonqjWeNLXn1BqKRBU541NBHtaDTaXxdIER1QF6nY3dWkisai9Tzwi+Q+B2IW/45ELHSWI8vl8STyzoXK6R732b6UadqEzK1lMedMjT1If7zt0GC7QgR+2P5uB6NTdt7M/Wsx6PFOFdCybeVH8UIXools0ay3A9r47EZWNJnO9qSiqdo+zTjKeUszn6i21qMPVCmkIg8owCH29xsnyr5Kx1r1lP7T2dzezQptvU5C4fMFTPfy9+j34GVZZjQio3G4qxM1C80D8hhnr+1EcKnLl1beU/tykqxyozfb9r5zbvqe0vZ09Qd//GHyUu5PX5ibS9wGknd/C5K+8++7PYsBS07zuxi60yyNQNV3Soya7LO12a0kRp6n005h96cPdYHGjhb1XfO7M5HtoS3GSWPYbnIMBpWesE+NbJHoThxQj9p4v8p9obXebCEmDCuVFv13Dv1+nX8lqhZ4YZlqRcnaVf5ZOKy4N1RzW6j/4fhoONa3hDIyddPXyOPcmgJqGF9um19CpgE4ZfcoVDlDbfsod2gUVJ1IjVJiDymDY0NclyE5Nw0M484N/XSR6HG6JCMtqI5OIB+0p5tmGBB7uTLxNgBZWVCcNiqjLhPwF1G36YlPywgZ1wRsZeEfkogjwLVKmQ0sn6ef2wPgYsaUCX2Hp0YyBSQvllLHRvtEW+LdBU4UK0tQekAv5ScThNoQoCq56QGIF/FXGNEkRryTDu6uNMrUcKT/Nnq17JAUMX+UQQRTudm6gFEiPXEdSKf8U3XRy2vFbfrpqaVwZSNyC4nO1icrqBZvgEGl1Eb52VT9ULQbTTWIbmlQg7gqQq9BkCitQe/oBvUY913o1en0ariVNIG20aBWd2nsUKrVzNtcKjWbrdgauXmkWmus1TBVCvZodjMMU0pVZYX25Y0xF2ggurE4JqnPTkPxrPWOqXfeSgGooXuyMXgEdZPeErQalZPy3mCuZncMUZhFSuJr1wl44dFWdmXS81MKaipXIB0xnb24DqhZFaZZqxZTtYxAjgYgRs8a1qS3e62hDfu61Jh9Odtaj6312FJ67DgVpGetybR7BNe6jH2Rugz/X6rPxuPBs1FkrB3iFW8OJtq49GEKBnTgNLzl7qZFUx4629AvnTRvKeKTEG8Bd+iVUDLi8IF4IrLiZvuVgtBaddVRXePEr6GztKF5MA0lfqin8F7SxQoq/V6xWV7CvKL0NWu7IXQGqBW9YbqaS6cZ/r5ANVGqItJbiCtVxEp0xD0c1Op6Y1kwhSnipqv08uNKN/R6nhvz/B0Pa8xz1bWPAEbwYusmKKT4Lhaam5LrBtNS3outT0hJ5CvBCcUKgCI+5QE9K0VWWOvyVxkDolNZ6i7YPGUjpaYgvtL7V++n0lTmJnm1lPhtST7x4Sva/eukd4l3UEt18GLuTupBp5DCDIOXIKvsIiFmK03tlUiGJmIcXX7h4S26vnfNxcftltPapABG9a8Oa51vT1o29CqxL1FZ7oi4HUywphYP+VWR71xxb6gCwX0chxPPSbwbXp4dQHSk3gB1XT1qABF/pK7oTs9Cbtrj/cR6uiQgp2DK0r1eSvlqo4rBOLqFKI98qtBXS83m43bmkX+cnfqsCoZYfLy/OF9JTe1ecHNZmXbPml+h4WWPlF6ToyUsaWxvlrRTDzLR3uQVrtH94m91wxkO93u/dbRha3jGVY9nqJekxGAXQ93w7ofcqdcD+UI/+ZpGtKhS9hhQLMlfv/1rPo6kIrA+Ez7hwboOwtugZYVH4a8gmkRW+G2jCuWaIlWartCYOydtl5mRNx5dKgd6X3wX8DiuwVvFadmCcBL8f4VVv16x7+moWNmCJILiQWOJhb4lUCk92d7errM83ccCEOlKf9j+7xpQvxznG5rrYRePZ68Vjb5Y68XnphcLk9mImZm78ETptuqrgSwobxxIIsLpAYccCbssVUdHmXNlC50rTx4VjpkGykzHfN6i+pmB5Vz9VEj2sRL+FkmKykz4ZV5B0jRTtLiSYCsTQB7L1DtbeCio4fUjfUFhUe7ozCJYmaGR3fyw0rXi4ZNMi2x9QfHsf2CRsNMkIAvC4E09FFfin20r7RLbUYrTLQMrD5GRr1QTSa6ljWeJnHTCaZ+VGYNXigz/PPNxuW7ttMpyZv7JOHo5yih8qiHAFvenhSseci8vYhPEN9lr9r3JeuUBZMqFZwxnyeHie+UAVPNJ8rggqx/+v9B2UWu1nEEeppyL8c5cecWOwhJPO1PSk0K4ipexJJstKW7JZqRmUV1kTjn5086g+4OtGZCebiqQ++zcVPpVTurVrTTqi0Uybn9PItP1/fan1pm8RKQv7yqNUy8cK0s82fjEWFpy9bf9DHuj46PDUf/NQN6N3hSIYH7ZxQYE3SulU3bVhS3N7gZqkUj107t/a8wrKrEI3DwNFFH3v1BGCTVZ4uazRd4DbyQ+s0HIcxI6ebP98pB3NWIUZ1JUJDwOAxvCBTSY6r6CtN92ws4SlJySeO4YOT0IumXyXc2tktXvtr+vlFUnuKtEymeqvj3fieNMFsznBfeLVTjam2LsYs96XVWYzYXu4ccH04mE74Qkq57Jn5dUEm92XsmlfwahKj8EoshSa1LluTWz5S9QvWUSLH5LuTLzmXK19CLLZha5R1oRShhwFjuBl3j/5i2Nq3EkPEbymoEzTDIeuOws4jf6FiZNO5kZM+3YgtQBjZJLCK6uPNflQTetC/MYjHhibKaKbwyGMO259L5mDNXvyZpfkjpFe2mSzNNL9WK6o4jSqpBnLc/dHAPp8P2B1bj2ptgayJKK1B9ESp/jXVyACYe6DtNq084yTMa7cN6KuJwi4gYqOViUBkbLDyIyv0j0uElN86Eb3Tu8Nc7nbgN+UE6QWL75t3p2JdA2YCG5KnNP9lmTthekmCDpOccL2Eck01u0xa7df4hnYGNZMacFMd04gUe+N/Xsi8tFn5E0Q2G6TAF6OxIhRxgUSdUZIk5cYCCBnFRbjB1JFjo0YkV3ggN9LKJO7v5rzqO77TxZYrFVTHbqfPamqEymdF+1TV5IwjaTrOEwy2E455izgeoVXQCNhhERYMLkwfxHaaKyvXkUw2zcKsi69JhuUxjz5tcH0IWLj7F8y4pUGjFhs0l13g/ewFszO4Ji28p+gGTMRybrOfYH/Q/9MXJOMWLV347e949Z8ben6b+0xdlsnRXaPR72ulqe6fsAmcFg8Z75ZhFfBFNozh47UZKDNW/Um3bOQlfYJS1cbEmXJQQ3IU9LkxzzjZkNPAd10LtEk6td3FOdQpxWJw2dMk71GweyvBRoBaqctE398UTxKe9Wbnizsidscz2BVvG+UlUi+b5b7YGfaRcIrU7V6JrmXtPr7H3v46h6js0KYlIq71bW5+A3MvkNAX0h0eo2wmFvdDIY59OwV/hX34VyG1G4WVMTkSTPvjmtzAUm1qzd5edYg0mu21ieiLE2s8tnWZQEX6l7b5NyKfnhxBFOFTuS1Y0/nZpOESioTOi+izbWQBZuZ2Qqt3mBZpVTQrWsHW9iQrl4xifexR1BzoDxz850tjCF9T0Uxb31hfzd2wed0kFOZbMzSaTUfKknI0wTrzv2tnK1zagZjR02i7yQgOvNd9vfbn/LEupVqkldMH2jEjkyZel15NW5sgwlg7xPbsv7ZLZ8njbo0xmhTRJjPrgZ2ijL46MYoo04ekxTtFE+yOai+OQWbS0uDYt3FQZvrVoNg/jR7eGFLJabyBNlIqcOSvVIuzU8u4OpEnGe3/XEelOyJ1nP8G3s6a69tamWvd06nt+U5+p0ggQis8/1a0H2yzipsUOfW7gFnPEETirDjg/pM8iR6v3W/XA8oCOXSMreAO7G4loX2gi+DECSbVWfbgefGvbCk3gmyrNRvumO9w5G/f/taR1mAHGZzzJHsibZXLnNBb4Q4TfJ/Zo4UuoVNjwr9zDjpKDU85Q8uocEr8M85LeULpVA2o9fohcF/yhwolx4UZxBUliKoEcE9hF3MEk188Bbtf+PbaO1SVPA1tqkWZs0T2/SlGPih430IJ28BspPCpQfMjYmR2oBUL4HQG4Mxd72h6NxPUBmx+A8NDDL1dMg6CfDcmflYG7poJ+6u1aWA1rLeUtehVKMdeGBQjXjggrC6YTWJwQnoJ1BXIm9cJ8IL4aqqY85Ttws8YlROoTBdpIw6uRy9KYX7qjEAOpQow7C5FKQ1Z6qeQtTPggGrNxWs0iljLGM1Fhfl2QyBOH1ENc/YmdkEMOkJ7pd/8mrJI1xqXdrJFs71NfoU/7W6LP695Wgz7VDvbrWZ+5QRxZplVQs9i+ES6UjD/ICN7ggRupAr1oWtmSyH1qK7+/Ft3LVdP8xoB73eLwgMc0q/f6qbZY1k865jlwtnz7wLUeqOx4P+29Oxj1mZpGpKPKPk97wo3iORUTLivH52oFd1IGP5sDOFaZziTULr8r7/fZkMBj3fhs3dH/XMmm+HP+0bS+dzFzMEKGbTGXO6VK7aS5o6C4apFMvoc0ix7Ygfq/MM3UTz1RZLcq9Qb/V+K0lZRhccb2qoDwjwzKlqZK+yaS4hlWkQS4EY/KuJwE7zG6zqiy51baTM1JYG+9QPOd+eEv557DWvOWzMQthGbpjbcLm4RSa4J17dINnZkFhnjzo8O+2vxMrMYz/lCdXYZY+uOJn20B1iiAyuOZ8dggapSUaKhPsKTyHC3M0hzFSIeWUF4XOVYuLL2kSZJ2s7k1V4B96w4u0bkfdZdpGdMa2jVwY+BhvcpW3u9KJ97rog9p063jJ2zAa3QWTVr5NMARgHsTwEiZI4MUisUpoTS85Y4XPgXwa0HAvvmYc57sXiKQzZGBgOa1KduE7YPY4COLgUyjknPuaTwLhVqS7Jhq1TQOb9njFdNxRwEV5b+zUCe5MyCnbhf6ZEO8tBTAoSoC0Za4RGAV84POYEi8GFn6viPPtMEFrHihfjJiWVv/G6VXBchrWxpcrhZbLJ3uo60IXzXtTEm4iFWQn03GP4k+X1ebd6Uph1/GmKyKlLvSsPtW4fIWpaq9TY0rm+YWUyM5YKqKkopbD3q9nv3QHJxLzqw742gJXfu32x2ejj4d7q8X9Kdk6uN9cCYt/KjPr6oyGVUH3k+P97rh39ubjkiEsaY001WqeXTbKfGqRekTwvyvOKz3WFpmdvUiyIxcWLT2AjeyHfOY7k3tC+0gSeRhsL6k/Crivikz50sC91W9rdM/W6F4TVTVpvzp4rxr2fPC9molfK8CX7Vsj/DXCXyP8NcJ/MIQ/7B0PuntriK+zo9aWSoxP0RsrOHErMl8Za8QK4Dj9vrhoceualscO2Kn7rY0VUaYl7hRQIEEk6pAVB2IC7UoBoRx6EfqZiCiHDFUKrImAsVGMRl8Cf/gP7bsUj0lGTKTVijGczaEoFcSd5/zKuUFrQiErGStQv9eX3MFf/K2GXJ8gx46N+TwKhy4M+EA8f4t4T1g5OdRYF/KhTilDfOvI6PURwjVOuwdOewZQ68PRL2ukpbMj9WV5rtU6OCvFC9f8TqU3e/5oS2px5NmUwa2sQWkXay1bw6k1nNI+Lj3ClWaRVn/VohodLWqYtQTucFsi1XSZyy4HcsTRTkW9JZanYirYjbIWEuUdOxuhhZS+3/6fWkjpPdAqzCuIlTzDWEtM5SWfI6lsVrP1og2/TePJ6pfdxZnUni5bYcO1XVI1hzObyThgOaeGeHdqCkQ2bwvKqHenupRKzu2V+s3cv2Z+GF7PZ5rWeK6L9eqW6/sv2CtJQM3ut14/2xNLT3lmafn11TzKSHd+q408kqAUU5TyAksmTw8aicteROAAlKf1NDOWZQ20hUazJ93kR0Y5HgiK1LTKoHQL0U2wRRuydLJJbKqFUZJx1XBZFrN/Jcty82T/z3Mhb7xaDY6O3p8cN1utll5FNuR0Lct4aVtraRLaU8p9mXqJbCeRIEvpL1fnJNJMSCDe5ByytgJhRMJzy4GZX5+WvFTdPuC7ZcazYBDMFeuIy1jFVebO9jn8AS3b3i4+5Ms2fH6hbQWoM75+CKYAO0e9U1Yw8i6vklzBOYpucUF106y9Qq6vZyjjan09Q21e1tczaOpnUQkUrokfxmgWMHm2U7hiMEzGw9vM0A0j7FLsM1ISdOM1TvoOCzH85daLcdeQbFf1giKEhDlLhWqL3ZdwWviB7puoU+sTX0exiMVG364wTit//UUWiavvaX/6FhbA4LTa6YTQoeKAL4pzRy57tUAu+RSy1Rld8q3WEg75jEQdTzzWCqM4C+O2zn5rG6r+ZleesLS52NkB2j5IQFYX3ntqoj6tKdmNodstvZuew5bbEgeeB723arMIi9BIl3897L87GGdfk0A8uZvP7M3B0ai3X/PIsNwqa3Q4+WH30bqH7xrvnX2x54Sr7ZmAOzVPATz83R/3tmPccI4X3G74oL8SRAhMkSGTQz1NL5cPIwAfTpZoKUcnDC51Qsp0UU8XElpbJGuL5KESCz27vEJfgE3ieiIuqJXPN5OBD3SQKlMgThSAVUW3WVvN3TonZNKq17ZHaa1r28Ms8QC2By7zlumhlsOOts49wy3vQXfcH5/sY4QbQWfFdUWJo8N3sgiVUI17XhB6vz8adw/3es1AdOMcPw8KpA973eEaRxOOxqAV7wFv0VsDaiLkiWMFG5HjenPjBmZ9sZBv27AsTXnCo3hzDczXwPxr2ipY4/I1Ll/j8i8flwvYUAuZyzXvq4boVU7x7n7/RMTMkFOcOmMN6dMOWBGk/7U/PugffrWgHv/QML1Eg5qc228kBXMSR94NJqvL4tacf9/tEcopnjwaJ/ZEzT460uazecOyvGA5TWc6saoa3814K3/LMm0PLigkNg25ewnL3x9/5ASwVvEfjGI2F9TjOwyryF27rdeU64hPrUTWwX740fj+T8YBwxbXk+UqWrKu7626XmR/S/+aRHf5/U0AKnw6o1MnorOsgx6mchFyLD60RCXHnb7pCRAFExG1U/uPbRRttmpW3hQWiyvnRqbOwfslBJLUGib+Dw2c4GQ8c3zPidvZWB8AgvTx/ml63WGt32HBdi55EP8uM/Sc/577GneP/w9WKlPL + + + + ArangoDB PHP client: single database + + + + + + + + Database + \ArangoDBClient\Database + + A class for managing ArangoDB Databases + This class provides functions to manage Databases through ArangoDB's Database API<br> + + + + + + ENTRY_DATABASE_NAME + \ArangoDBClient\Database::ENTRY_DATABASE_NAME + 'name' + + Databases index - - mixed + + + + ENTRY_DATABASE_USERS + \ArangoDBClient\Database::ENTRY_DATABASE_USERS + 'users' + + Users index + + + + + create + \ArangoDBClient\Database::create() + + creates a database + This creates a new database<br> + + \ArangoDBClient\Connection - - mixed + + string - - \ArangoDBClient\HttpResponse + + + array - + + \ArangoDBClient\Exception + + \ArangoDBClient\ClientException - $method + $connection - mixed + \ArangoDBClient\Connection - $request + $name - mixed + string - - splitWithContentIdKey - \ArangoDBClient\Batch::splitWithContentIdKey() - - Split batch request and use ContentId as array key - - - mixed + + delete + \ArangoDBClient\Database::delete() + + Deletes a database + This will delete an existing database. + + \ArangoDBClient\Connection - - mixed + + string - + + array - + + \ArangoDBClient\Exception + + \ArangoDBClient\ClientException - $pattern + $connection - mixed + \ArangoDBClient\Connection - $string + $name - mixed + string - - process - \ArangoDBClient\Batch::process() - - Processes this batch. This sends the captured requests to the server as one batch. - - - \ArangoDBClient\HttpResponse - \ArangoDBClient\Batch + + listDatabases + \ArangoDBClient\Database::listDatabases() + + List databases + This will list the databases that exist on the server + + \ArangoDBClient\Connection - - \ArangoDBClient\ClientException + + + array - + \ArangoDBClient\Exception - - - - countParts - \ArangoDBClient\Batch::countParts() - - Get the total count of the batch parts - - - integer + + \ArangoDBClient\ClientException + + $connection + + \ArangoDBClient\Connection + - - getPart - \ArangoDBClient\Batch::getPart() - - Get the batch part identified by the array key (0. - ..n) or its id (if it was set with nextBatchPartId($id) ) - - mixed + + databases + \ArangoDBClient\Database::databases() + + List databases + This will list the databases that exist on the server + + \ArangoDBClient\Connection - - mixed + + + array - + + \ArangoDBClient\Exception + + \ArangoDBClient\ClientException - $partId + $connection - mixed + \ArangoDBClient\Connection - - getPartResponse - \ArangoDBClient\Batch::getPartResponse() - - Get the batch part identified by the array key (0. - ..n) or its id (if it was set with nextBatchPartId($id) ) - - mixed + + listUserDatabases + \ArangoDBClient\Database::listUserDatabases() + + List user databases + Retrieves the list of all databases the current user can access without +specifying a different username or password. + + \ArangoDBClient\Connection - - mixed + + + array - + + \ArangoDBClient\Exception + + \ArangoDBClient\ClientException - $partId + $connection - mixed + \ArangoDBClient\Connection - - getProcessedPartResponse - \ArangoDBClient\Batch::getProcessedPartResponse() - - Get the batch part identified by the array key (0. - ..n) or its id (if it was set with nextBatchPartId($id) ) - - mixed + + getInfo + \ArangoDBClient\Database::getInfo() + + Retrieves information about the current database + This will get information about the currently used database from the server + + \ArangoDBClient\Connection - - mixed + + + array - + + \ArangoDBClient\Exception + + \ArangoDBClient\ClientException - $partId + $connection - mixed + \ArangoDBClient\Connection - - getBatchParts - \ArangoDBClient\Batch::getBatchParts() - - Returns the array of batch-parts + + eJztmN1vGjkQwN/3r5iHSEC0gfbunvaatNvClVRtggLodGoi5PUOsFfvh2xvCDr1f+/Y+8FHyIWk6UPV7AusPR/2zM8zhlevs3nmOJ3DQwcOwZcsmaXdtzDoD4CLCBPtgYqSmUAImWYBU0hyRvRNxvgXNkOAWuudVbCTLNfzVNIc/EWTX+ATW6K0MzzNljKazTW8q7/99uLl7y5oGZG9RMH7OOi7NC3SWYIuvEcZs2RJ2h3HSViMilzjltc/V3ughTOlYEr+SY/NaPmrjXXLXahyG6N5pEqFTKbXUYikmSdcRymtRKeFCVzpgZ7LNJ/Na5MNVU+CPzh9FciTKkQioq3bZ651prxOJ0y5ajOrGQZtnsad/mg06FQGOlES4k17rmOxV5gpNRytg5ftP2yAiq1U9pz/HDNpI2Oew7V9WFflcMd+ctqyht7Z6OKfSdcf+W/9YW9y5n/qwTE0TOAbFOUte2OFcm9b42HvYmiM5UZrhzUukWlaG1ujzc5UAkW6aqkEF7VkEfgNaQqeZDGRlCRoMwoHfPX9iFKJsDZA2Q4QaG3hlgFFaBJE5jkwcShyWhqo/IPKkEfTiDNjzLX84Q2LMzo7jXhZBb6xvUYLyWP42DQjUecyASYlW8KBpENCGUDfvh5R3BCqsUKmXWsaoBcKLjf5uuzdcMzMVu4TLD62xQsMsjwQEacAUlB4fbDKDDZ3J8YtgtyyBgqAbeQzthQpC4mfz/WgeRSKqeftwhaOTwpb7v0KJZsnW8bNc3vEPBZieyqsm9X6j05mqM9tLNZ2WAwozzsfjE7Pzyb+eNS3TlvubvMZHeRF2AB4vPmBPxz+3W3dsn/l7H67Kk+kDXeNy/Gm9yxVujmWgnyNLz7WAXQ3pf5VaTLBhKchThaSZRnKZpXBVmvNT8lt7c5u7wNpN0nKCHx1bpWJLgq8v0wsIiEgtKLAEjqLkdLmGFc67edq8XNUiyKHD6wWuRRELnHaR0HweV6QRyKk953sfrZGrlr7HIByOcbD94L8kZCskVB3QiyM2Do95hbCdIE0GBZpjqrRtbljPSnTvzR3Juz1fekO/La5KzdYtJg6Xc11jZqGZxh+IhjCB4JwZ/mgqrCjBD20kuxix1xI7gToAqkt4bWlBQuI0ikw0yLXOCIAcikpNoUxTn2TcY7KsEe/6HJdmSva19I0OurC0XSKtZbtedTO7AUmleFT99lfGkOTOPOba9+69OiGaK+3jf06okH6KdrhitEooQtRbO9GwALiboPNe2995Or/TYilJWp1HZvKNH6unD8EWUrGKeVi37r5UE7LjP5YVAlW+8/KhImIqWaVIs+zoy40Lqt/r6qABZf1HZ6sfAOoGev2 + + + + ArangoDB PHP client: streaming transaction handler + + + + + + + \ArangoDBClient\Handler + StreamingTransactionHandler + \ArangoDBClient\StreamingTransactionHandler + + Provides management of streaming transactions + + + + + + + $_pendingTransactions + \ArangoDBClient\StreamingTransactionHandler::_pendingTransactions + array() + + - - array - - - - getCursorOptions - \ArangoDBClient\Batch::getCursorOptions() - - Return an array of cursor options + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object - - array + + \ArangoDBClient\Connection - - - getConnection - \ArangoDBClient\Batch::getConnection() - - Return this batch's connection + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + - - \ArangoDBClient\Connection + + string - - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - + string - - \ArangoDBClient\DocumentClassable + + + + __construct + \ArangoDBClient\StreamingTransactionHandler::__construct() + + Construct a new streaming transaction handler + + + \ArangoDBClient\Connection + - $class + $connection - string + \ArangoDBClient\Connection - \ArangoDBClient\DocumentClassable - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use + + create + \ArangoDBClient\StreamingTransactionHandler::create() + + Creates a streaming transaction from scratch (no collections) or from an +existing transaction object (necessary when collections need to be passed +into the transaction or when an existing transaction is resumed) - - string + + \ArangoDBClient\ServerException - - \ArangoDBClient\DocumentClassable + + \ArangoDBClient\StreamingTransaction - $class + $trx + null + \ArangoDBClient\StreamingTransaction + + + + closePendingTransactions + \ArangoDBClient\StreamingTransactionHandler::closePendingTransactions() + + Closes all pending transactions created by the handler + + + + + stealTransaction + \ArangoDBClient\StreamingTransactionHandler::stealTransaction() + + Steal the transaction from the handler, so that it is not responsible anymore +for auto-aborting it on shutdown + + + string + + + + $id string - \ArangoDBClient\DocumentClassable - - eJztW+tz2zYS/+6/AvU4JynVw+lMZ26UyK3jOI2nTeKx3Wt7SUYDkZDEhiJ1BOXHtfnfb3fxIECCspzmPt1p2olEAovd3y72BfjZd+vlem9v9PjxHnvMjgueLfIXz9n5q3MWpYnIyjGb8TJawlsc8P2aRx/5QtiRJzSIXvFNucwLxl7Cq4/sNb8TBT2XSRYJxtiT4RNFZbS3l/GVkECrTuipZeW8yK+TWEi1fJIt2HyTRWWSZzxNyrs6PyzEkVnZrD3ai1IuJXtOEv2xh29oOfw8ZmerdV6U7GAa59FmBUROaHRtXRo7on83UrAX7lg+SwWIUKNLy7ELEDjPYMbb2e8iKvVLM+b7a16wV2W5tsMOpiS5+e0tvN7M0iSqD4GV60u/TPmClUteMpksQALJkjn8TjSs7IZLti7ySEgpYgbay/JyiNjrJ5MjVhYbwfrqlTMW3syBngjJMcvzVPAM+LPjffaL5JqXwn3PJopcQIarpWC8KPgdy+cKy3MOasoJRhlaX43W6OBg2bJ8NQDWf/ehZfFM3JYarzWunMShRZOsFAtR/CnLAq31YIrTLLtnbQjURgVYOM4C4p9sCgk6yddomV8IBEXzrSK5DZAozzJBe0JrIbT+STXoYFrNaGGiGtDcP7ik5FlSJv8WLBZzvklLds3TTavxAUEzoWU9S6+yu8Cqaue+ARWd7a7zrao+Q0s/DOAKcAGVTVSCVufwv1o6gYccnNiw9pvN7iwS8AQNOOLrckNsFOJfGyFLxuelQB5BUGAgHlrJchYn5KvIFfTBqsHNEZkTIiImRwQKLgc+GEYJY2narGAfgAcv0cP7qNALT/eOsZAjcryP8sY3SZqyVQ5satE1/+CrwL6KGGQocz0DOFkNXfKWEQZUVzyLOVC5G9b4UUzT58AIAh93Z5nHFfaR0Qg8H7JLAaCLNL+hEXr0uCb+s/XRW4uTYGP7PE2OOtbmOmzArtCrgliFWOXXgk2TmAHzbFqIa8ZLMKfZpoTgNy/yFYyRqGcTlSQ8ACVl4DTpdQXokL1QNiGRNKlw+GwEa3t8uIpGVi7xt9GINaJktRIx2k16pw1p5lggWhTB4i6IkSKwHs271HLD+CQDwTibJ7cggcJf4k5EXJd5GuPqaHGVx5VD2o1J3JGoqtpLYBrsJAM+Z8LsSGktoPn5ZSkyBZrSIlpOTGzFfYf2SkRLUJhcKQPFWA/rXK7Tl8j4MfGNYAgeG6ayvFjxlJInkmsbF2cZ2Dxs0ohLIfuKH1pIaxtsH7KXQnAMjmtRzJE27nxYi8/yTcm+fYSgP/n2UR/YX4uMgANxFPsEKZoU7Ahe08pofeS7KJVOmESHTafW9rvhrdw34SV3okWPiKm0iraaa2kwAu3jqfPWuGD8WDdsX1uzUa8PnVfOFsZXxMp0JYqF6Jp3fXaAkA6OFsKPa91er6IEDrngIGQ16/TXq4vp2cvp6a9nl1eXzlBNzg0cVoLGqIr3iSOIjjH4gSys2xh7xA57Dnzuql6ikokb9t4zxAYth/FPe3XuJEBiNdl1tNpzOByNGIyzQSby8g1whwYGMFt4V4Bfgg1IgQJ3YppHsBHyTAwbALanG+rBeHz65urit+nl8Zuzq7N/nmKm2cWg3mvo4EMdUd/gJsrkWjB1x3Y9vDRq9Qh9KdDN+ekP+SxhEDBeuIs7O70jZ1RA1m13Vu8h4bI+Vnl9Xbyoh+Ht267f+gbVeDoCTVwOHHj14jTjaStCFEkaiQi67xzyi3xdveuTQ8VnVgU1eaWoF4fvSfTxeNusEErbwfLMIAwQuAjK4bq9hyPiCu0AcuaGsSVUYVhdzQREpqokuhNlH4IEmLLNiDDUQZTja/T3MATSQNhoKdL2BWF8wZNsGMDUgtiQ20GxXBb5jWQK99PbSKwdi3yIKTZUVYELHiZaiuhjrSRN1CYjzAW5kOGQApmFEdBbQKgVfZx5IzqFIPSq98PK6ziONpHHRBPA+dvfmH14YqZBZGjxFMICRUHKtYKwJWhrMF8JTXLbNUC7nROeIe/+5oBEoFx6ed1zAw0OVtCAlJ1eq+FdEE+SHGC/ibBGF5MMsCrIwvOIagTHt9VtxygdXfFWnVc413eTWlXJMnECtB7fdEeh/eYRmUzu2YD34BDYmp8vtmNJNcldC1EpiRVRW9brPG4BoEWwY+2TZOVHMEsGmaSJU0rKHVRN2wssO2/Ukm1oKPiJ362gVJ4z7FmlVX4z1XK2HYXxB/veB+PwV6V1pLk30jqyE3ml/L8oZKdNwZCJ5FqrAkJKLBqiqkzEdu7AEMpGe+XhcBgFKno7oqInaVjUzIfi8gPiolVuCle2gF/ZNn1/Rjp2PwyOg9uSirkYLHzLeLDwDadXFxxdX6IrxcEOZvEgRO71lO3+rx0fI7cLUyLPMkLIpdHuMWmr1PcEzR9c6I4ZQaC8KMZagYkYL+6wzo4TWYJD3CRyCRlYeYOpmq730XtWfkYHkr+ywQI2pZuI7t56rnr/tNrDNlhoZrPSdXvzqnT/TNeUVA0S20kfYOvGtHUorU05NZkEFgaxao2VRSKuRYWtmhQGdkXtpANbXTYbtjsnrbWWfNcl2oZwbY6t+21X/6HQ6eM3Rg1Yv/pmXSw7xS1frVMxtq3xHlWjZfPAYkfEvHr8y4Dnd15almqDtLVR0ELnoSAfUxFFgJmOOTYxPWPbitxKlMs8ZtjNhUn6l7Z0Q7H7w+lVn52/vbyCfL0XpmPGKjqWF2yWU0cQ/GVV8bkstijJPUasD9GF3ftaZR0u9FpyOmKlq8XvW/7relwXYjFdUQTrPBpN+ToZyQRNdtT97vyZ+nr0/uZx70/1Ep/GSQF+ip4+Sm47FXH6tvDyIyztvkrAQYEPw3fvOmp250OzkPPfgw11OvWOjzK9uzX17Grjv5rgDPZd48XYPFHidBodKW0VWKh0wBQ6qvSkVSaNdZr1p2KnAxbQYUP1O1hh4lrZBmzFVkRNn1SnjnMSOeXdxoaT/Vp/cTymo5oGrsQkLvNmsxIFGIm/ODq+xnDv/ddf+yM+MYHnTveuEuWbrAww3quR8+Gc+Q7aIemAGuLAm+l8WrF+WtNjW5BAnYVbtSIHZdJWfiXStcC26NufHOs60OcEYB2vrq7OR0+GT9g3h99AXYh7WMRkL0DkaWPGEKZgfxY385iNpvFsNJV3shQrtQ/NOdPocHS4nQqkFSUMHKBZjtEvgJ8gsqPfZZ49ZdGSF7A9J5tyPvj7dlKi5Isx2z/cv3dFnciM2UmaS2GGb531x74oirzYH1P7pr8/TeL98T6It9/fV1/hCx697Y8P+/tLLl/nhdgfP+mzfUVlf/zuj08f4Kc9g1NPPjWW99ZXFzl0x971yl3NnZt1WRPT462hKDPve0bYV76g5h8V8T5751lfJ3KjZIdhQ317jO378/37MB13vvemmvbB9dPNXfrOFeWDF9FDCFY5q4LDDg4VRoW9DKN3VCO3Aist/VydMnjsR58og4atyc1J90dh7vyEg/eal9jkD79U9wJawrQ+QVP/DNixOYmuso9GFvYFordE8X9JyqWV9Udx1zVi9A3Pzd6dOUJX90Lsc3G7TvOYigT9NUCsGg8pquCAfLeaCFAfAMpkVnSrIxC9t20lNafmcSOryYlrSBBIXwkei6Lb0fIPzuJOvaFroynG/YpUMPoRLu+qQWTOxNKukU1TAAha54YihO2H4vRWazdXuaTXTtZ9wizWB1qqfo6rcwadZUpRXENRBhrKM9Nk3CHp/FN1iAambT03hxp0Qu2efOD9M7mJ8N18kzJdv3j34NQNI2xX4FE5HX+zOU9SYHjIjt3ZehH2+wZLeaiypblxwvVNgRtRiOqAZchOubnThUcwSYn3C24yZu0NcrfNYknuQcLXNMb6lA4t8Lac6iTChAYm9xyftGzj3TawZr/RYvROOnY41HBPZsK5sOnCeu0C3Yq1o/B6gf7uZ9WVm5Zes986ctmtZ/M6q3PSOcpnG6fi289T3nfsPUUmVuvyThtup+VQPMpXM7z88QIkUc4BJRkMMLa7+dfrs9en0+dvf37z4vjit9o7ys22UcQ0xHicq0a6dDvgZAoD4hQNsr64n/zBBlcX0A5w7D/QYzg3I7Xh4Kdyt4420OHaeaGqoPJ93rCm6yLlDychiZuZfwtl5aLtT7KRs7hpt41FHQ8+ZohXV0cbn7iP4+Xp+fHF8dXbiyZ/rR7aW7VV6wHTakwOcEjyms3V22ZWinhgmQqR+402MMSBpCJJaYysyVEL/ZsibQI1YT8XqSGtWgXnRAsed+F/OR7/fPHT9Pnx1cmrvlkn0H30bjY7hZbbylzn2L8ENvoKg7o/CdJSSQDIf0LtYrLGbw4bPsY/sqtftA5pYZbHdxaE9qWfwzDvtMubB/ax6tKj/q7qDBYRjs8NZ3wPd3B9xaoL8lb38qPO6VpdjZPXBT6hVK8iVUv3HAxDlPwMsK6Bz+NFY+GzYVAww6DU0VB8cNkItgeAM1Xf6Bk9Cr7OgluIh0PbridllHSVeclT1VgJXLJsyfr0dUsMAJvMdEvDeQuN0HG/lrpoYvc0dbbw7l3OBxNP5om6HFPavx3ACqN7OBwOsx6mmZi5JTHrgpuAapDSUFGqexeN9n8CmX/LzS1bBFI/p8EKZJhAES8nY2qZ6fYVsgIscH0sh38L05ZV13v0D0o0W0/fKjNrHmi4XdVA4a4mNTusW1Iyc7jmIBPnQl1lEbeJLNsys5AL9tn4nzeMdfCk6wu0CbSV+K63aS2Niy2eaencRpP4/zb+r2rLVLVfSG2W3g76s/cN3L/U2tLG8htgrX+h1BTSrR23iuTQvIdrvNRveY62/lWVx/aA1f90xGe+fmDfvIe+owC1M87twlRNno5716FFkpP6gB3ua9zHt3t7WPMK/9Hx0ZSnCZddfQGVHkGS+x5SXr4QmTQbYKbu+WJQ+A9cdS4W - - - - ArangoDB PHP client: connection - - - - - - - - - TraceRequest - \ArangoDBClient\TraceRequest - - Class TraceRequest - - - - - - - $_headers - \ArangoDBClient\TraceRequest::_headers - array() - - Stores each header as an array (key => value) element + + getStatus + \ArangoDBClient\StreamingTransactionHandler::getStatus() + + Retrieves the status of a transaction - + + \ArangoDBClient\ServerException + + + mixed + + array - - - $_method - \ArangoDBClient\TraceRequest::_method - - - Stores the http method + + $trx + + mixed + + + + commit + \ArangoDBClient\StreamingTransactionHandler::commit() + + Commits a transaction - - string + + \ArangoDBClient\ServerException + + + mixed + + + boolean - - - $_requestUrl - \ArangoDBClient\TraceRequest::_requestUrl - - - Stores the request url + + $trx + + mixed + + + + abort + \ArangoDBClient\StreamingTransactionHandler::abort() + + Aborts a transaction - - string + + \ArangoDBClient\ServerException + + + mixed + + + boolean - - - $_body - \ArangoDBClient\TraceRequest::_body - - - Store the string of the body + + $trx + + mixed + + + + getRunning + \ArangoDBClient\StreamingTransactionHandler::getRunning() + + Return all currently running transactions - - string + + \ArangoDBClient\ServerException + + + array - - - $_type - \ArangoDBClient\TraceRequest::_type - 'request' - - The http message type + + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler - - string + + \ArangoDBClient\Connection - - - __construct - \ArangoDBClient\TraceRequest::__construct() + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\Handler + + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + + + \ArangoDBClient\Handler + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() - Set up the request trace + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection - - array + + + mixed - - string + + \ArangoDBClient\ClientException - - string + + + $optionName + + + + \ArangoDBClient\Handler + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array - + string + + \ArangoDBClient\ClientException + - $headers + $body array + \ArangoDBClient\Handler + + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array + + + array + + + array + + + array + + - $method + $options - string + array - $requestUrl + $body - string + array - $body - - string + $includeArray + array() + array + \ArangoDBClient\Handler - - getHeaders - \ArangoDBClient\TraceRequest::getHeaders() - - Get an array of the request headers + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name - - array + + \ArangoDBClient\ClientException - - - - getMethod - \ArangoDBClient\TraceRequest::getMethod() - - Get the request method - - + + mixed + + string + + $value + + mixed + + \ArangoDBClient\Handler - - getRequestUrl - \ArangoDBClient\TraceRequest::getRequestUrl() - - Get the request url + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation - - string + + array + + + mixed + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler - - getBody - \ArangoDBClient\TraceRequest::getBody() - - Get the body of the request + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use - + string + + \ArangoDBClient\DocumentClassable + + + $class + + string + + \ArangoDBClient\DocumentClassable - - getType - \ArangoDBClient\TraceRequest::getType() - - Get the http message type + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use - + string + + \ArangoDBClient\DocumentClassable + + + $class + + string + + \ArangoDBClient\DocumentClassable - eJylVk1vm0AQvfMr5mDJHyJ1k97skqZxVVuVKkWpe6ora40nBgUWurtYsqr+987uAsaATa1y8cfMm/fmzbDw/kMapM54NHJgBB8F47vk0yM8LZ7Aj0LkagJ+wjn6Kkw4peish5T5r2yHACVgZnJNkGUqSATF4Avj8E0hxozzWugz4fxQwizIqIAJ+kl6EOEuUDArv929vb1zQYmQ2LiEebxZuBSOkh1HF+YoqPSB0GPH4SxGScKwpmnqFM3NIiYlLAXlPOOvDKUq+rmo62KzMuS+DgHcvnlnhPhNlt+OTjAq9DUiUxKBEpD5AQTItiiASSC3mBDsAINXPIB3D3sWZTgEjDA2fAZc1HjYM2Hz83/G5jMV4Z4phN7aFpbgwY+fZEK7BBUgBEqlECNZsG3jkGS/tqKVxMIulhfWBchEdHX5HPtdRGcoDIMtAcmL+bVJtoeriTSoSbE8uiOl3gF1SPHq2hpEU+jnzfRbWkGyJz1xS+kFqlOlTLA4XxLoFQOm68ZgbYBsMJrzcA2ce9Wzg4MjuCA+WYQ66jiPGuo43DpEOwtQITpOy8isjCs3LttEoQ8vGTdnDqzXdAARKPPVoOjZLRpwq5pcyzY0ZexNp6+eCkJ5c7+u+OWV7k0baRVnvIKmmVVxwqtqaGZWDPCsQJvzp7EGc1qD8hDIt7kw+HSapdcCVSZ42zlQc3GHamFLDOr+5DVqNl0SeXZf6rra7oumsK+mRJeu6iS6ZbWcNldpei4n2qWrPvvz2swmnM71vzQ+Ur0udV37pv7liLtK1ZIKdKnSJIUq0mWemWsWhUwOqk/OycREXOivineAVf4Q3qyqif3h1PkLRzV67g== + + No summary for property $_pendingTransactions + + eJzlWEtv4zYQvvtXzMGA5MBe94Ee6m3Spmmx2UWxDZLsKQkMSppY3EikQFKxjW7+e4fUw3rZTdO9BM3BkUTOcObjN99Q+unnLM5Go/nR0QiO4FQxsZK//QoX5xcQJhyFWYA2ClnKxQoMDWsWGi4FxExECSqysoa/ZCx8YCsEqH2cOXM3yHITS0Vj8IEJuDKIKRPCDYUy2yq+ig2c1VffffPtj9NdLO/S4HxKw4lcCZzCO1RkvSXr+WgkWIqa1sbOsm/rlC6UfOQRaiAjCjClQZD3w0npZ2WjuQjtEMD3b35wYYQJ05ryKl1e7zyeFygBbgyKSEN5P/prZO0zxR+ZQRgvMxptW2o4hps7ysNOdLnYvyPCQVDseWiAgcD1P+2OM6psKS/FUutCYDFvHO6uZ9C4MRIChFxj1PYxLwLPg4SHcJ+LYvZyGVZh+cPeJ86uSNt5YMqSa9G0bE5/W89UuOLaoFrqODeRXItltazPlGJbf2xirqfghYnUeNEH0puU3p76YBJ2hrjB9sB4r2QKOlTMhDH4QhJCSVJEqCdAlHYTiNOVQ9xQrF0vMvhMNmSPIWrN1BbWMYqmL9pJjErMM+JSjTpwQU9NjG2HqvBACw8uyDWhpvMUo0mXASZWck1cRfWI6vdNiJm1GObJEKFhbNSGqDK07kGKhA5qf7/PYxB5kkygQxR+D34xflzN2A3av8qYamHIeUGP2ckKzY6Z/qRBsKf6qr4YE3wZ7QuS42H72UkmtfFbkXxSiV4sPl3+sby+PP14dXp2/f7Pj/AGvHlAHBbetBP3sN/PWoolilBGuFwrlmWoHACzE2aM4kFOhJ3Unhp57KK3Li4bGVTZuNU+aLvOzmzMo0ZUx23rG88SKTHe3Y3HI++uYeZC0mjeRz65mJRK1chsSNRuaOodLUIFj80SN7kqaLC3Um1xU6EmCZRuW8Jd0iuCYOuqpa1/exi5Ry/8rlbN50AdTKbM8JAC2AILpDIullxQgZKQkZ0beaB6mkmKsBXdFLSENUIkhWeabhNkD6BdLdqKlbkihbA5CGlcfL08a+t7SRlbVTqANjDttvf4BMa0NnZLx5AUtZ80ts8lWW5tc/gJwkIOb2v5gHHPdZkgXwmK00GFSkmlIUaFbX8DhXgop6Itlizp0oTOFizp6aVT6QYt3H6YmBngxoqlRbusER4kFK7YprIK88hC7Qgwc5DYLSEzcls1pGH1pI5ip1r8Z211jg7SUtsUWgLGoy4jcypNc2jnXZ1N9sJ0iRQcPhLXLCraMJNreypiA3L+otaR8g0VY9krhntr2RUJ2zY4lrQFdl3XpUy4rk9ui1ttu2DxaM1NDDuRBKtYNBqBV2ToHcSdpPHKTXNqu78PcTquMDoBElxD/abXnmz9lWq5cmrZbD2ACUn0kIVfYDBpqGK5mfW8ZzQpeuBTWzrHhNrIYhHkPIno3h9sVVMoaNNsDs9qJbvpJZUOdJFyKxqdxCFbGVKT91yZIe3dly/QGghlmnJjh/qHAJf/YO0Mgle1nOEwq8Kxv/0DuA1Cv45aCaRMnPzkaHEuAASdhyEdOKkvlXG6g2Ql5pI0Qa25xoPlUrh6NbXyLH7sPerlL6gieiPxmrVR7sju5NM/5Jxa4r9OZhVHoq9BrPLc8X/gVYQJ0jvRSwT6EK3s70DHd72TDmJhruy7N51WVS5E/xPIS/jWac3Ff9qdw2tNwR1hO6+uX6+fXxZr+j0i/YvW2d+F//7KNdx8msh0WhAxzn1jWrKEM+2f1V8Oyu9Ji4UbJsm5JbTYCoW+Lb9cBbcHvktZgfobsOoKXQ== - + - ArangoDB PHP client: connect exception + ArangoDB PHP client: batchpart - - + + - - \ArangoDBClient\Exception - ConnectException - \ArangoDBClient\ConnectException - - Connect-Exception - This exception type will be thrown by the client when there is an error -during connecting to the server.<br> -<br> - - - + + + BatchPart + \ArangoDBClient\BatchPart + + Provides batch part functionality + + + - - $enableLogging - \ArangoDBClient\Exception::enableLogging - false + + $_cursorOptions + \ArangoDBClient\BatchPart::_cursorOptions + array() + + An array of BatchPartCursor options + + + array + + + + + $_id + \ArangoDBClient\BatchPart::_id + + + An array of BatchPartCursor options + + + array + + + + + $_type + \ArangoDBClient\BatchPart::_type + + + An array of BatchPartCursor options + + + array + + + + + $_request + \ArangoDBClient\BatchPart::_request + array() + An array of BatchPartCursor options + + + array + + + + + $_response + \ArangoDBClient\BatchPart::_response + array() + + An array of BatchPartCursor options + + + \ArangoDBClient\HttpResponse + + + + + $_batch + \ArangoDBClient\BatchPart::_batch + + + The batch that this instance is part of + + + \ArangoDBClient\Batch + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + string + - - __toString - \ArangoDBClient\ConnectException::__toString() - - Return a string representation of the exception + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - + string - - + + __construct - \ArangoDBClient\Exception::__construct() - - Exception constructor. + \ArangoDBClient\BatchPart::__construct() + + Constructor - - string + + \ArangoDBClient\Batch - - integer + + mixed - - \Exception + + mixed + + + mixed + + + mixed + + + mixed - $message - '' - string + $batch + + \ArangoDBClient\Batch - $code - 0 - integer + $id + + mixed - $previous - null - \Exception + $type + + mixed + + + $request + + mixed + + + $response + + mixed + + + $options + + mixed - \ArangoDBClient\Exception - - enableLogging - \ArangoDBClient\Exception::enableLogging() - - Turn on exception logging + + setBatch + \ArangoDBClient\BatchPart::setBatch() + + Sets the id for the current batch part. + + \ArangoDBClient\Batch + + + \ArangoDBClient\BatchPart + - \ArangoDBClient\Exception + + $batch + + \ArangoDBClient\Batch + - - disableLogging - \ArangoDBClient\Exception::disableLogging() - - Turn off exception logging + + setId + \ArangoDBClient\BatchPart::setId() + + Sets the id for the current batch part. + + mixed + + + \ArangoDBClient\BatchPart + - \ArangoDBClient\Exception + + $id + + mixed + - - eJyFkk1rAjEQhu/7K+ZQ8AO/6lHFam1RSgul9igs2Tjuhq6TZZKtleJ/bxJXLVJoLpNl5nln3smO7oqsiKJusxlBE6YsKNUP9/C6eAWZKyQ7AKmJUFrAL4mFVZpcpS+eFEJ+iBQBztwsICEpSptpdjl4EgRLi7gVRCEldbFnlWYWZudbv3fbb4Fl5QTJwHybLFouneuUsAVzZEfvHd2NIhJbNK43XrUdnm3MjhO3H68mfs+UudgAuy8QdirPIUGwGesdQbJ3N6y8wy5D8t+M4EjnA5k1e6l1yYrS02781epAGuRP5M4o4bGvq+L/+zKKpE8B9Dr9YFTmwpiTl7MVN79FWhu4mPuOPBa8+9OEN7QlEwgwNkzJWDAa10kEBb0Jk/56z4Cd6Akf8Qpu/61SVXdDLMokVxI2JcnQIY6tXgaq3ggFxxH9qcTjePY8XS7jGDpQG0DNhRvrnqc9TtG+oDFuUfXGMGCH6BAdtxGLXAlTv97JYBCyLaitTn/QqlpxsrourjnVH36V7/s= - - - - ArangoDB PHP client: value validator - - - - - - - - ValueValidator - \ArangoDBClient\ValueValidator - - A simple validator for values to be stored in the database - - - - - - validate - \ArangoDBClient\ValueValidator::validate() - - Validate the value of a variable - Allowed value types are string, integer, double and boolean. Arrays are also allowed if they contain only one of the former types. - - \ArangoDBClient\ClientException + + getId + \ArangoDBClient\BatchPart::getId() + + Gets the id for the current batch part. + + + mixed - + + + + setType + \ArangoDBClient\BatchPart::setType() + + Sets the type for the current batch part. + + mixed - - void + + \ArangoDBClient\BatchPart - $value + $type mixed - - eJyFVE1v2zAMvftX8FAgWeAlXY/JgqXrhnY7FRiQU4CAtmlbqCwZktw0WPvfR8kfSYwAExDbEJ/4Hh+pfP1Wl3UULWazCGZwb1AV+sd3eH56hlQKUm4Jrygb8k+RodOGcR66qTF9wYIAhlMP4UAIYuNKbTgGv1HBH0dUoVIhlOr6aERROngYvu5uv9zF4IzghMrCY5U8xRyWulAUwyMZPn3k04soUliRZW4a0a5ORYAVVS3PJEPOv1CGBachIbC8SxkIBa4kYBAmaGlc2pXCrFCpr/l2fhf0pBKtha3PvR0c+hv5yoMcv2bQhSiwtX7qHJA/ueREUofr4fdS6gPLa5HuWLNuNF61EaqIWbajgkwMmW74NKDKINFaEqo5izZ4bPEoreZHm0zknv0IqVYOuXCt5JEfQYmXxR5VZFq2+UjQxpVGHyy0Rvx8S6l2QqsxqkaDFVTijeluWvGf+yJ0345xsRtDrjEKXrXIGH4QUkKg84p5eIQKB8/MAGGhZtsp63IswrtmL0TKJqHjV96o1GscaKetok8B23bILyaZCrtvre0x8P7OJHv2ebSTS43jPe/8+ZZquIL1eg393oksjMViKKJrzUW4dWM17H1EY6noG9wTXsleNdZBWlL64gmAJFXcNNs3fsTHbSdMS+gSAlq4sU2yvSbdL0syXy5Ppg7Y1QX0TPZ/qjrzo2v1EGrHQNFhPHjTya9uKhLBsx/mjhx1l3zSafmImCZc0D1j0U4vr+lyGWIxTHb9P8+uu/HJ7hLqM/4Dz/eQjg== - - - - ArangoDB PHP client: autoloader - - - - - - - - Autoloader - \ArangoDBClient\Autoloader - - Handles automatic loading of missing class files. - The autoloader can be nested with other autoloaders. It will only -process classes from its own namespace and ignore all others.<br> -<br> - - - - - EXTENSION - \ArangoDBClient\Autoloader::EXTENSION - '.php' - - Class file extension + + getType + \ArangoDBClient\BatchPart::getType() + + Gets the type for the current batch part. + + mixed + - - - $libDir - \ArangoDBClient\Autoloader::libDir - - - Directory with library files + + + setRequest + \ArangoDBClient\BatchPart::setRequest() + + Sets the request for the current batch part. - - string + + mixed + + + \ArangoDBClient\BatchPart - - - init - \ArangoDBClient\Autoloader::init() - - Initialise the autoloader + + $request + + mixed + + + + getRequest + \ArangoDBClient\BatchPart::getRequest() + + Gets the request for the current batch part. - - \ArangoDBClient\Exception - - - void + + array - - load - \ArangoDBClient\Autoloader::load() - - Handle loading of an unknown class - This will only handle class from its own namespace and ignore all others. - -This allows multiple autoloaders to be used in a nested fashion. - - string + + setResponse + \ArangoDBClient\BatchPart::setResponse() + + Sets the response for the current batch part. + + + mixed - - void + + \ArangoDBClient\BatchPart - $className + $response - string + mixed - - checkEnvironment - \ArangoDBClient\Autoloader::checkEnvironment() - - Check the runtime environment - This will check whether the runtime environment is compatible with the -Arango PHP client. - + + getResponse + \ArangoDBClient\BatchPart::getResponse() + + Gets the response for the current batch part. + + + \ArangoDBClient\HttpResponse + + + + + getHttpCode + \ArangoDBClient\BatchPart::getHttpCode() + + Gets the HttpCode for the current batch part. + + + integer + + + + + getProcessedResponse + \ArangoDBClient\BatchPart::getProcessedResponse() + + Get the batch part identified by the array key (0. + ..n) or its id (if it was set with nextBatchPartId($id) ) + \ArangoDBClient\ClientException - - void + + mixed - - eJyVVttu2zgQffdXTIGglgOvnAZIH9x4N15HaFygaZAERRcIIFAyLXFDkVqSshO0/fcOKcmi5QaL6MGiNbczM2dGOv+rzMvBYHJ8PIBjmCsiMnn5N9xc3UDKGRVmCqQykkuyogpVrNZFSdJHklGAncHC6TohqudSoQw+EQF3htKCCOFEqSyfFctyA4vd6fTk3ekYjGLoUGj4WCRXYxRzmQk6ho9UofUzWk8GA0EKqjE27YX9sMN/RcSKU+0gF8SwFCxwJjKQayiY1vaYcqI1rBkqhk1G9zn10oQUgScUBNWGrmDLTA7S5CjodHQIS4MizkEKbgFCqWRK0bPzjyDWShbAjAa5FdBhR4jAMiEVHq21dazD80T9aZ009/8vM6aSWhHASXjq6lPnNe+69X1gxa409jqGS6ZoaqR6rnPiLFEE/7hSNDqt6sWGKNDYFpE1jybuXiq2IYaiyJX3CH2gV+xAL9RiV2SgTwY7y6TYc5RKoQ1E3+6j67vll2uYwTBEKg4PXS0FM4xwpimYvT71IZtcya2G6CmlpeniwYWiplICNpKt9pOpEo5JNLmsK5FaM2AYMBg5jbqE9tKUr6fTNKfpYyQ2TElRYCuCUYO3U2lKggnF8eXyNo4hBLxHi/svt//Ed9HN/HaOR9+u5HGbVaxoxpB2Kojj6/nn6O5mvoicj+FD19rp1N6HGNza/zwoWT0HPvmR0ZV4FJaKjie92t3nTHdshry2byblNTz+nV8U274UFTes5H4HNRhpJ63SOGdMAGlnbk10jq3ou8ORUKRoeAlHDt81IoI/HDCbaI25duuCrPo+XskG6yToQvV5cdRVxHa837OH4YdOlVOR4dzhNbM54N+gM/eZNJm0J7aGQFcJansYxnAybr2N4M1s5qEYedis8YmTo30p9Z4Lz8S3sVddoQ74zz1k9XhgO3F+c7KhWGmKrMIuY+MSukZG7NTtJlQm2J8MC0hUnPsZK/pfhdupN0Mh/Cb3XeJho71bIi+Nw8JOrVseqhKGIVFoN8IvToKbddjm1K3+F6wBtVNZlMiZBKnt9iqqtt7qxe29Tg8Y3SyterO/YnXt7+EdWw8XVI+vuEdNcFSQf6XCUhYMB3iEdKRPJZcrGgzD4djCjb9Gt7akfo8snQImzAhqeziHM/jxo/dwht09g7dvoX1qQ6Dq+wOaudRx4rf97IPhUnhFtdXzSh7ihi/xPWZXgBWdhe8BI+T4OUFVuxNrItS/SAhHnxhfIkQH/hp1z8c4p+0HyEPzqk28bWt9/gJGybR/ - - - - ArangoDB PHP client: client exception - - - - - - - \ArangoDBClient\Exception - ClientException - \ArangoDBClient\ClientException - - Client-Exception - This exception type will be thrown by the client when there is an error -on the client side, i.e. something the server is not involved in.<br> -<br> - - - - - - $enableLogging - \ArangoDBClient\Exception::enableLogging - false - - - - - - - __toString - \ArangoDBClient\ClientException::__toString() - - Return a string representation of the exception + + getCursorOptions + \ArangoDBClient\BatchPart::getCursorOptions() + + Return an array of cursor options - - - string + + array - - __construct - \ArangoDBClient\Exception::__construct() - - Exception constructor. + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use - + string - - integer - - - \Exception + + \ArangoDBClient\DocumentClassable - $message - '' + $class + string - - $code - 0 - integer - - - $previous - null - \Exception - - \ArangoDBClient\Exception - - - enableLogging - \ArangoDBClient\Exception::enableLogging() - - Turn on exception logging - - - \ArangoDBClient\Exception + \ArangoDBClient\DocumentClassable - - disableLogging - \ArangoDBClient\Exception::disableLogging() - - Turn off exception logging + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + string + + + \ArangoDBClient\DocumentClassable + - \ArangoDBClient\Exception + + $class + + string + + \ArangoDBClient\DocumentClassable - eJyFUsFu4jAQvecr5rASFEHocoSqpUurVqtWqsoekSLHDIm1yTgaGyiq+u87NoFW0Ur1ZWy/ec/zXnJ105RNkowHgwQGcMuKCnv3C14eX0BXBslP2wr4prHxxpI0ht55o/RfVSDAmbaInRFUW19aFgx+K4KlR6wVUYS0bQ5sitLD4rybXP6cDMGzEUFy8FDnj0OBK1sQDuEBWdgHYY+ThFSNTt7GzrOzs4vjeXTfGfhPadynC/CHBmFvqgpyBF+y3RPkB9nhyfG+RApnRhCm2EBmy0HK0tc+Z9YypEkxBWdr9KWhIuIOeYccyGQ9GNrZaodr2aRXOV8HobZ+n6czpAMEcJlOYhC6Us61Xs9WxZ9HWjv4NP+eBFaMJqwBvKLfMoECJ3nLpIwNoxMVFRXsJs7+5XNH2ok9r1VhdPeSj5qt4uj/0m33ONZmm1dGw2ZLOj6bZd4uI6t/ERuOc4fVimfZ4ul2ucwySKE3hZ6UH5K1G10X6J/ROQmvfzGLtI/kIzkmlKnKKNfv5DSdRnAIvdXpp1u1qeerTm9PNP8BNt79Cg== + eJzdWltzGjcUfudXqDPMsHgIbl6dksbBJHFnknpsHtIShhG7AhQvu1TS2qGN/3uPLiu0dwNpnck+JFntuXznfOfoRn75dbPatFqnJyctdILOGY6W8cVrdPXuCvkhJZE4Q3Ms/NUGMwESUujVBvu3eEms9FAJqk84EauYIfQGPt2i93hLmBrnNPIJQuh5/7m2ctpqRXhNONjKG3ph4Vyx+I4GhGsISGJAiyTyBY0jHFKxzSNCZZhS36l3cN3yQ8w5ei3NXsnI/mnJ78qtfE7Q5XoTg7f2LIj9ZA2mhkoj513Jnqq/E07QhSuL5yGBUPKGzyOEGcNbFC92/ocJ45C2eCNtcyOaary6w8zotGfzVIVnvG8YvcOCgICvTP2uLaEBmkyfAAQNnsCp2G6eIuGM/JUQLr5xqt8JsbmG9oDP2on+ZyUGI1kBYrwipofECgv4g3JEIy6w7Az4t+qseFEGRGFO81DhXn0rcTsETIIlvohZ3jR4xOvUuIYGj7A44/ln4oueg1dhnJMwjpYciThnaU2/kAC1aYD0IyOGF0j6zqa00Efj9wmXhlASUWAO4ShA9zSUIxtoW7AiYqXECbsjDPKk3vw4EtDaz8DoiuCAsHIAsggtAPViIJgyAf8q+TIEFFAuaLRMKF8pmYAuFoSBl1RaWwAEMQOPUoURkbAI0DAG+YFXnoSC98vBpFYUmPQFGAGfVQqmjrSCeanTMCWMTC3jsJdWNQrpLejiiAr6NzFM+jgqJtogO7UOV8BJSFg/WzSnur42yTykvp2J0Wzmp2Xm6UrqyTroaS56Ngu9XXg9i7urTOrZXz7tFC900gKHHCYU+8mGOtAdPVsTtiReOi4dArXPXi6J6W8zCXvd7ouWNUMXyKMQvbCKk052kelMu10HkvKtLYNWZompM7ED/rBzTr4Ihn3hYB59HF/PLt/MRh8vb8Y3jtbOpWpSk9pSgcvAg4SXfhoDBZ4iovTztabGSzmqENKseZa/olh22Zvo/J+djT6Mr/+Y3Zx/uBxf/jmaAnOWYG3ioThp3RDBVVlCpy9gklbNnzDVls480jyh5SVM6+42HWlZl1V1Pu/5OjVha0AD49EpM+NMyf03odoZ99g4TflURAjQBtLLvrG9PSw2Y1sFVwt8qYDnUbvQFPjm3Ksp/tDsS+Vj8+/0aAUHCuJAezuYh33j3IcJFUIDFxp8ExvpKnkoIUb/WE4KE2MFM7vNZyp5MD8HRG4cqNWwiaI0ogaWbBTNRJnNwuFMZbbUR1BVWJ4qybK7dCt7BF37x288uGeLZtpMdI28pfE0AZfeh3FwCHAa1bMBeFPrDXgzkanXnWJdCLnTBCwugJwuKBTUfKs+6sPeLdki7+d+vx91Ye+OKMQO65AHmz8q0D3msnDg1CFWKII9ma01sxSibj4BYsXie470rcboi0/URqd0rkTtjbLUlKkrFvtEbsMrKc5ffgws25lxZzM2I8GS5IXtmFPrbbcXSijZ2eSQJci2507j+e2xj8FQZ0EZF52zzBfl6zOHiN3H6T/l9zcQcH2mj9yr/2Q269LIpEMYixnsrtHXryg7hAYDc2TIo7M47AHCBVJ1ZiiicW3Ahp/yD+Re+s0fVDLyNs+uzyx/Z2c+I3CQf8Pi9bms3jTYVKozdQ5MRT8PiID/qqDLAFQAfiiMzAHY7YsSriFfFt1jGH805ceStA9BR5BTS0hl1hpT9kSNYW9tBka3kAR9kLu8mDaVuTkr5AX2Ky05Y/1wZWWn4W9aUrWp+l7KaQQgn6KG+A9WRJOS1MEujmC1QNtUv9PXd2nGRxdvRzdTBJuedoAFrqQt9TiZNtartFO/Ju3FlR+HIVEbo1rCHs2TU0lDa7qi7fZptkfg/F5azo37f2w8fQ2Yy47+hMOwdHy+LUtmodUO7LRCo9W4yt4rF+500eBl+Qa8fnvmpjci90iD9zI3iDqqOIo0ZV63V1pGhy0RjKzju/r19JDOmpQWk/EW6GzpMk6Hpr1yFbqMYBLLqKRD04JGSRGXRC6fzEBAFjgJRTEJ6mSnicke7rzOME7CAEWxAG1B2JpGzrFfToHqTq3faSbjoXjL0HhgvzaXO87vl37tz5bubRB6ttPKimd/O3QPpLmuqr9vyNz32xgezC/7MxxSzD17roa5Vw73UOeTYBQvScQ/mf8pMP9kpWQi/wUUOgYo @@ -10553,23 +10881,23 @@ This is a convenience function that calls json_encode_wrapper on the connection< \ArangoDBClient\Handler - + includeOptionsInBody \ArangoDBClient\Handler::includeOptionsInBody() - + Helper function that runs through the options given and includes them into the parameters array given. Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - + array - + array - + array - + array @@ -10590,19 +10918,19 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\Handler - + makeCollection \ArangoDBClient\Handler::makeCollection() - + Turn a value into a collection name - + \ArangoDBClient\ClientException - + mixed - + string @@ -10613,6 +10941,31 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\Handler + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler + setDocumentClass \ArangoDBClient\DocumentClassable::setDocumentClass() @@ -10656,2888 +11009,2978 @@ This is only for options that are to be sent to the ArangoDB server in a json bo eJzlVlFP20gQfs+vmFapbCMnob3qHgLh4KCUnqCNoNFVByja2OtkW2d3tbsuoVX++82sjUkMSDnUt9uXON6Zb775dma8u3/omW61eltbLdiCA8PkVB39CcOTISS54NL1IVOLBRQ6VyxFGzLb1yz5xqYcoPY49MZ+kxVupgzuwWc1h3M+ldzALr6bM9s1/u9+NukYbjkzyayb8j3vlyh9a8R05uCwfnqz/fr3GJwRGE1aeD+fnMS4nStEieE9N3Mmb9G712pJNucWifEGp5377DAlZi0mZKp8hJzCMaXHtM5FwpxQEn4IbcEpYJAyxybM8o3StkImtAXwW/e1p1RGI/wTJtMcVeALx2Vqofrf+tkie0+P1haMPC3AbRDSOpbnSCOrGHYrqzvjfTcz6sZCSeLdIuGaEmhaaWbYHCyKiNm2c5Ww/B+hca8DbsZBMzejdOnZb/p4HYxHSnToiMR3ThalZr2K2BP4c1VIN1RCugrfv+ho/4aUp3cIHsO8sA4mfCok3AjkwCDoBQ1UZgy7BWgrn5kFz5pQssIVhkNh8TyaCRuOe7LyLUlYbr6j/lhzGmEeeFwUWuOe/ZsZiVnYEOv/7Kg7koXl6bHCKsuHxIc7bqLKq+d/dTHBwkE6MvHFU4lDh44ih7Xc8aoyccWtTmsAl9clblkRtEQG4YtM5HzMF8I6e48VRStmtHwdgOQ3zVIIXxKRDh33z9p9CaniFqRy4JEhJD0xEAgLhTScpWyS86j7Mtqpwyxb9aMzt434ba0QhtbAA42n3I0TJbHY13jvrHvdnQZ6td1M2M4e+h0qKbnXMow6ewQcjkxu+/3R+el4NDz9dHAUlwERbg2PBKsxPdaJc/pQpTyMYBfebm83dduYRbFK4vjTly/jDx8vPh+cnsbw1So55jKhMJcBFvYHmakABnuwzuUvS1iXAelDoyq4jiHwJVEa31fHddQQ6vnJ0aq64TE2D8MsWw9ePV1cQV1cd7MqY5hdGjSAG6CbAJaj5hG8JeCUTmYQXviOrn2hzTfvinYpwhl2PI6PMFqr8xXGK4P5nM8VTkFWD8dfMoz/58PSeFHp0A80zsr/OCAfmUPP6+XRxye6ebP2fF5rbtyWG3eP1VhULiu7CAf5elNCSIz68CqNghie4hs9r9W8BI2mgsFgAAH5CrwX0dcmQw2xmR8RY4OkzugAoOyMV+XXi6oQjbvB2se1eTzLXzcU8Cj8nW7McsFsuHKz6/f9Bo70q7vL6lV1R5xcrdjRKPsXC/JtTg== - + - ArangoDB PHP client: single user document + ArangoDB PHP client: connection - - + + - - \ArangoDBClient\Document - User - \ArangoDBClient\User - - Value object representing a single User document - <br> - - - + + + Connection + \ArangoDBClient\Connection + + Provides access to the ArangoDB server + As all access is done using HTTP, we do not need to establish a +persistent connection and keep its state.<br> +Instead, connections are established on the fly for each request +and are destroyed afterwards.<br> + + - - ENTRY_ID - \ArangoDBClient\Document::ENTRY_ID - '_id' - - Document id index - - - - - ENTRY_KEY - \ArangoDBClient\Document::ENTRY_KEY - '_key' - - Document key index + + $_options + \ArangoDBClient\Connection::_options + + + Connection options + + array + - - - ENTRY_REV - \ArangoDBClient\Document::ENTRY_REV - '_rev' - - Revision id index + + + $_httpHeader + \ArangoDBClient\Connection::_httpHeader + '' + + Pre-assembled HTTP headers string for connection +This is pre-calculated when connection options are set/changed, to avoid +calculation of the same HTTP header values in each request done via the +connection + + string + - - - ENTRY_ISNEW - \ArangoDBClient\Document::ENTRY_ISNEW - '_isNew' - - isNew id index + + + $_baseUrl + \ArangoDBClient\Connection::_baseUrl + '' + + Pre-assembled base URL for the current database +This is pre-calculated when connection options are set/changed, to avoid +calculation of the same base URL in each request done via the +connection + + string + - - - ENTRY_HIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES - '_hiddenAttributes' - - hidden attribute index + + + $_handle + \ArangoDBClient\Connection::_handle + + + Connection handle, used in case of keep-alive + + resource + - - - ENTRY_IGNOREHIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES - '_ignoreHiddenAttributes' - - hidden attribute index + + + $_useKeepAlive + \ArangoDBClient\Connection::_useKeepAlive + + + Flag if keep-alive connections are used - - - - OPTION_WAIT_FOR_SYNC - \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC - 'waitForSync' - - waitForSync option index - - - - - OPTION_POLICY - \ArangoDBClient\Document::OPTION_POLICY - 'policy' - - policy option index - - - - - OPTION_KEEPNULL - \ArangoDBClient\Document::OPTION_KEEPNULL - 'keepNull' - - keepNull option index - - - - - $_id - \ArangoDBClient\Document::_id - - - The document id (might be NULL for new documents) - - - string - - - - - $_key - \ArangoDBClient\Document::_key - - - The document key (might be NULL for new documents) - - - string - - - - - $_rev - \ArangoDBClient\Document::_rev - - - The document revision (might be NULL for new documents) - - - mixed - + + boolean + - - $_values - \ArangoDBClient\Document::_values + + $_batches + \ArangoDBClient\Connection::_batches array() - - The document attributes (names/values) + + Batches Array - + array - - $_changed - \ArangoDBClient\Document::_changed - false - - Flag to indicate whether document was changed locally + + $_activeBatch + \ArangoDBClient\Connection::_activeBatch + + + $_activeBatch object - - boolean + + \ArangoDBClient\Batch - - $_isNew - \ArangoDBClient\Document::_isNew - true - - Flag to indicate whether document is a new document (never been saved to the server) + + $_captureBatch + \ArangoDBClient\Connection::_captureBatch + false + + $_captureBatch boolean - + boolean - - $_doValidate - \ArangoDBClient\Document::_doValidate + + $_batchRequest + \ArangoDBClient\Connection::_batchRequest false - - Flag to indicate whether validation of document values should be performed -This can be turned on, but has a performance penalty + + $_batchRequest boolean - + boolean - - $_hiddenAttributes - \ArangoDBClient\Document::_hiddenAttributes - array() - - An array, that defines which attributes should be treated as hidden. - - - array - - - - - $_ignoreHiddenAttributes - \ArangoDBClient\Document::_ignoreHiddenAttributes - false - - Flag to indicate whether hidden attributes should be ignored or included in returned data-sets + + $_database + \ArangoDBClient\Connection::_database + '' + + $_database string - - boolean + + string - + __construct - \ArangoDBClient\Document::__construct() - - Constructs an empty document + \ArangoDBClient\Connection::__construct() + + Set up the connection object, validate the options provided - + + \ArangoDBClient\Exception + + array $options - null + array - \ArangoDBClient\Document - - createFromArray - \ArangoDBClient\Document::createFromArray() - - Factory method to construct a new document using the values passed to populate it + + __destruct + \ArangoDBClient\Connection::__destruct() + + Close existing connection handle if a keep-alive connection was used - - \ArangoDBClient\ClientException + + void - - array + + + + setOption + \ArangoDBClient\Connection::setOption() + + Set an option set for the connection + + + \ArangoDBClient\ClientException - - array + + string - - \ArangoDBClient\Document - \ArangoDBClient\Edge - \ArangoDBClient\Graph + + string - $values + $name - array + string - $options - array() - array + $value + + string - \ArangoDBClient\Document - - - __clone - \ArangoDBClient\Document::__clone() - - Clone a document - Returns the clone - - - void - - - \ArangoDBClient\Document - - __toString - \ArangoDBClient\Document::__toString() - - Get a string representation of the document. - It will not output hidden attributes. - -Returns the document as JSON-encoded string - - - string + + getOptions + \ArangoDBClient\Connection::getOptions() + + Get the options set for the connection + + + \ArangoDBClient\ConnectionOptions - \ArangoDBClient\Document - - toJson - \ArangoDBClient\Document::toJson() - - Returns the document as JSON-encoded string + + getOption + \ArangoDBClient\Connection::getOption() + + Get an option set for the connection - - array + + \ArangoDBClient\ClientException - + string + + mixed + - $options - array() - array + $name + + string - \ArangoDBClient\Document - - toSerialized - \ArangoDBClient\Document::toSerialized() - - Returns the document as a serialized string + + get + \ArangoDBClient\Connection::get() + + Issue an HTTP GET request - - array + + \ArangoDBClient\Exception - + string + + array + + + \ArangoDBClient\HttpResponse + - $options + $url + + string + + + $customHeaders array() array - \ArangoDBClient\Document - - filterHiddenAttributes - \ArangoDBClient\Document::filterHiddenAttributes() - - Returns the attributes with the hidden ones removed + + post + \ArangoDBClient\Connection::post() + + Issue an HTTP POST request with the data provided - - array + + \ArangoDBClient\Exception - - array + + string - + + string + + array + + \ArangoDBClient\HttpResponse + - $attributes + $url - array + string - $_hiddenAttributes + $data + + string + + + $customHeaders array() array - \ArangoDBClient\Document - - set - \ArangoDBClient\Document::set() - - Set a document attribute - The key (attribute name) must be a string. -This will validate the value of the attribute and might throw an -exception if the value is invalid. - - \ArangoDBClient\ClientException + + put + \ArangoDBClient\Connection::put() + + Issue an HTTP PUT request with the data provided + + + \ArangoDBClient\Exception - + string - - mixed + + string - - void + + array + + + \ArangoDBClient\HttpResponse - $key + $url string - $value + $data - mixed + string + + + $customHeaders + array() + array - \ArangoDBClient\Document - - __set - \ArangoDBClient\Document::__set() - - Set a document attribute, magic method - This is a magic method that allows the object to be used without -declaring all document attributes first. -This function is mapped to set() internally. - - \ArangoDBClient\ClientException + + head + \ArangoDBClient\Connection::head() + + Issue an HTTP Head request with the data provided + + + \ArangoDBClient\Exception - - + string - - mixed + + array - - void + + \ArangoDBClient\HttpResponse - $key + $url string - $value - - mixed + $customHeaders + array() + array - \ArangoDBClient\Document - - get - \ArangoDBClient\Document::get() - - Get a document attribute + + patch + \ArangoDBClient\Connection::patch() + + Issue an HTTP PATCH request with the data provided - + + \ArangoDBClient\Exception + + string - - mixed + + string + + + array + + + \ArangoDBClient\HttpResponse - $key + $url string - \ArangoDBClient\Document - - - __get - \ArangoDBClient\Document::__get() - - Get a document attribute, magic method - This function is mapped to get() internally. - - - string - - - mixed - - - $key + $data string - \ArangoDBClient\Document + + $customHeaders + array() + array + - - __isset - \ArangoDBClient\Document::__isset() - - Is triggered by calling isset() or empty() on inaccessible properties. + + delete + \ArangoDBClient\Connection::delete() + + Issue an HTTP DELETE request with the data provided - + + \ArangoDBClient\Exception + + string - - boolean + + array + + + string + + + \ArangoDBClient\HttpResponse - $key + $url string - \ArangoDBClient\Document - - - __unset - \ArangoDBClient\Document::__unset() - - Magic method to unset an attribute. - Caution!!! This works only on the first array level. -The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. - - - - $key - - + $customHeaders + array() + array + + + $data + '' + string - \ArangoDBClient\Document - - getAll - \ArangoDBClient\Document::getAll() - - Get all document attributes + + handleFailover + \ArangoDBClient\Connection::handleFailover() + + Execute the specified callback, and try again if it fails because +the target server is not available. In this case, try again with failing +over to an alternative server (the new leader) until the maximum number +of failover attempts have been made - + + \ArangoDBClient\Exception + + mixed - - array + + \ArangoDBClient\HttpResponse - $options - array() + $cb + mixed - \ArangoDBClient\Document - - getAllForInsertUpdate - \ArangoDBClient\Document::getAllForInsertUpdate() - - Get all document attributes for insertion/update + + updateHttpHeader + \ArangoDBClient\Connection::updateHttpHeader() + + Recalculate the static HTTP header string used for all HTTP requests in this connection - - mixed - - \ArangoDBClient\Document - - getAllAsObject - \ArangoDBClient\Document::getAllAsObject() - - Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class - - - mixed - - - mixed + + getHandle + \ArangoDBClient\Connection::getHandle() + + Get a connection handle + If keep-alive connections are used, the handle will be stored and re-used + + \ArangoDBClient\ClientException + + + \ArangoDBClient\ConnectException + + + resource - - $options - array() - mixed - - \ArangoDBClient\Document - - setHiddenAttributes - \ArangoDBClient\Document::setHiddenAttributes() - - Set the hidden attributes -$cursor + + closeHandle + \ArangoDBClient\Connection::closeHandle() + + Close an existing connection handle - + + void + + + + + executeRequest + \ArangoDBClient\Connection::executeRequest() + + Execute an HTTP request and return the results + This function will throw if no connection to the server can be established or if +there is a problem during data exchange with the server. + +will restore it. + + \ArangoDBClient\Exception + + + string + + + string + + + string + + array - - void + + \ArangoDBClient\HttpResponse - $attributes + $method + + string + + + $url + + string + + + $data + string + + + $customHeaders + array() array - \ArangoDBClient\Document - - getHiddenAttributes - \ArangoDBClient\Document::getHiddenAttributes() - - Get the hidden attributes + + parseResponse + \ArangoDBClient\Connection::parseResponse() + + Parse the response return the body values as an assoc array - - array + + \ArangoDBClient\Exception + + + \ArangoDBClient\HttpResponse + + + \ArangoDBClient\HttpResponse - \ArangoDBClient\Document + + $response + + \ArangoDBClient\HttpResponse + - - isIgnoreHiddenAttributes - \ArangoDBClient\Document::isIgnoreHiddenAttributes() - - + + stopCaptureBatch + \ArangoDBClient\Connection::stopCaptureBatch() + + Stop capturing commands - - boolean + + \ArangoDBClient\Batch - \ArangoDBClient\Document - - setIgnoreHiddenAttributes - \ArangoDBClient\Document::setIgnoreHiddenAttributes() - - + + setActiveBatch + \ArangoDBClient\Connection::setActiveBatch() + + Sets the active Batch for this connection - - boolean + + \ArangoDBClient\Batch + + + \ArangoDBClient\Batch - $ignoreHiddenAttributes + $batch - boolean + \ArangoDBClient\Batch - \ArangoDBClient\Document - - setChanged - \ArangoDBClient\Document::setChanged() - - Set the changed flag + + getActiveBatch + \ArangoDBClient\Connection::getActiveBatch() + + returns the active batch - - boolean + + \ArangoDBClient\Batch - + + + + setCaptureBatch + \ArangoDBClient\Connection::setCaptureBatch() + + Sets the batch capture state (true, if capturing) + + boolean - $value + $state boolean - \ArangoDBClient\Document - - - getChanged - \ArangoDBClient\Document::getChanged() - - Get the changed flag - - - boolean - - - \ArangoDBClient\Document - - setIsNew - \ArangoDBClient\Document::setIsNew() - - Set the isNew flag + + setBatchRequest + \ArangoDBClient\Connection::setBatchRequest() + + Sets connection into Batch-request mode. This is needed for some operations to act differently when in this mode. - + boolean - - void - - $isNew + $state boolean - \ArangoDBClient\Document - - getIsNew - \ArangoDBClient\Document::getIsNew() - - Get the isNew flag + + isInBatchCaptureMode + \ArangoDBClient\Connection::isInBatchCaptureMode() + + Returns true if this connection is in Batch-Capture mode - + boolean - \ArangoDBClient\Document - - setInternalId - \ArangoDBClient\Document::setInternalId() - - Set the internal document id - This will throw if the id of an existing document gets updated to some other id - - \ArangoDBClient\ClientException + + getBatches + \ArangoDBClient\Connection::getBatches() + + returns the active batch + + + + + doBatch + \ArangoDBClient\Connection::doBatch() + + This is a helper function to executeRequest that captures requests if we're in batch mode + + + mixed - + string - - void + + mixed + + + \ArangoDBClient\ClientException - $id + $method + + mixed + + + $request string - \ArangoDBClient\Document - - setInternalKey - \ArangoDBClient\Document::setInternalKey() - - Set the internal document key - This will throw if the key of an existing document gets updated to some other key - - \ArangoDBClient\ClientException - - - string + + detect_utf + \ArangoDBClient\Connection::detect_utf() + + This function checks that the encoding of a string is utf. + It only checks for printable characters. + + array - - void + + boolean - $key + $string - string + array - \ArangoDBClient\Document - - - getInternalId - \ArangoDBClient\Document::getInternalId() - - Get the internal document id (if already known) - Document ids are generated on the server only. Document ids consist of collection id and -document id, in the format collectionId/documentId - - string - - - \ArangoDBClient\Document - - getInternalKey - \ArangoDBClient\Document::getInternalKey() - - Get the internal document key (if already known) - - - string - - - \ArangoDBClient\Document - - - getHandle - \ArangoDBClient\Document::getHandle() - - Convenience function to get the document handle (if already known) - is an alias to getInternalId() - Document handles are generated on the server only. Document handles consist of collection id and -document id, in the format collectionId/documentId - - string + + check_encoding + \ArangoDBClient\Connection::check_encoding() + + This function checks that the encoding of the keys and +values of the array are utf-8, recursively. + It will raise an exception if it encounters wrong encoded strings. + + array - - \ArangoDBClient\Document - - - getId - \ArangoDBClient\Document::getId() - - Get the document id (or document handle) if already known. - It is a string and consists of the collection's name and the document key (_key attribute) separated by /. -Example: (collectionname/documentId) - -The document handle is stored in a document's _id attribute. - - mixed + + \ArangoDBClient\ClientException - \ArangoDBClient\Document + + $data + + array + - - getKey - \ArangoDBClient\Document::getKey() - - Get the document key (if already known). - Alias function for getInternalKey() - + + json_encode_wrapper + \ArangoDBClient\Connection::json_encode_wrapper() + + This is a json_encode() wrapper that also checks if the data is utf-8 conform. + internally it calls the check_encoding() method. If that method does not throw +an Exception, this method will happily return the json_encoded data. + mixed - - \ArangoDBClient\Document - - - getCollectionId - \ArangoDBClient\Document::getCollectionId() - - Get the collection id (if already known) - Collection ids are generated on the server only. Collection ids are numeric but might be -bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used - + mixed - - \ArangoDBClient\Document - - - setRevision - \ArangoDBClient\Document::setRevision() - - Set the document revision - Revision ids are generated on the server only. - -Document ids are strings, even if they look "numeric" -To reliably store a document id elsewhere, a PHP string must be used - - mixed + + string - - void + + \ArangoDBClient\ClientException - $rev + $data mixed - \ArangoDBClient\Document - - - getRevision - \ArangoDBClient\Document::getRevision() - - Get the document revision (if already known) - - - mixed - - - \ArangoDBClient\Document - - - jsonSerialize - \ArangoDBClient\Document::jsonSerialize() - - Get all document attributes -Alias function for getAll() - it's necessary for implementing JsonSerializable interface - - - mixed - - - array - - $options - array() + 0 mixed - \ArangoDBClient\Document - - - - - user - - - string - - - + + setDatabase + \ArangoDBClient\Connection::setDatabase() + + Set the database to use with this connection + Sets the database to use with this connection, for example: 'my_database'<br> +Further calls to the database will be addressed to the given database. + string - - - - - - passwd - - - mixed|null - - - - mixed - null + + $database + + string + + + + getDatabase + \ArangoDBClient\Connection::getDatabase() + + Get the database to use with this connection, for example: 'my_database' + + + string - - - - - - active - - - mixed|null - - - - mixed - null + + + test + \ArangoDBClient\Connection::test() + + Test if a connection can be made using the specified connection options, +i.e. endpoint (host/port), username, password + + + boolean - - - - - - extra - - - array|null + + + getCurrentEndpoint + \ArangoDBClient\Connection::getCurrentEndpoint() + + Returns the current endpoint we are currently connected to +(or, if no connection has been established yet, the next endpoint +that we will connect to) + + + string - - - array - null + + + + notify + \ArangoDBClient\Connection::notify() + + Calls the notification callback function to inform to make the +client application aware of some failure so it can do something +appropriate (e.g. logging) + + + void - + + $message + + + + - eJyFkM1OwzAQhO9+ir0VIkQFxxSJvwpxQeoFTpHQ1lmloY5trW1oBLw764RWKgXh436zszO+uPQrr9S0KBQUcM1oGze/gcX9ArRpycYSQmsbQ5ACMdROp06mIs76K496jQ0B7FZvh60BYoorx8LgTuAaHrAnHohY6rwEcHZ6LpOpUhY7CmJHP5xmu3BPaBKBW76QjsDkmYJwCQe4zfj4a0Z2njj2ECJndX65zD7s2g3VHzYZAx5DeKv/xKhj+0r7GJmxHzFtIuP/n3P4BdrI3bGCeJCtA8y3Vd6V+lSj4hlNi+Eo68pymJzApJJqcsqG6vvUssqCyfFMfQHFdZsR + + Argument $message is missing from the Docblock of notify + + eJztPWtzG7eu3/MrmHN9Kjkjy25uT6fXqXOr2ErsNrE9frS3k2Y0qxVlbbPa1d2HHZ3T/PcDgI/lcsmV5Dz6mKPJTCwtCYAgAAIgyP32fxezxYMHu48ePWCP2CALkpv06Bk7Pz5nYRzxpNhnYZokPCyiNIEm2Oq7RRC+DW44Y7rDIbWlh0FZzNIMnrHvg4RdFpzPgyShR2G6WGbRzaxgh/qvx3tfPu6xIosAYJKzF/PxcQ8ex+lNwnvsBc+g9xJ67z54kARzngNubqF9ouk/z9LbaMJzFoQhz3NWpKyYVc1ZzrNbnslhDKBZHKumUc4macJZmUfJDTu+ujrvsTsOv7EkLVjC+QSh8bwIxnGUz1iAIBY8y6O8ABoMLrEgmbC3nC9YVOQMOhS8/+04e4odThJoHUx6RnOgIuMVYMADIJDqabxkU+AkD8IZy/j/l9AGYSB47ALjLLJ0CR2CacGzuyCb5ArR6mmCYYb4iLG9/mPibxgHwIfDarb/9QAfE2vx88h4xtIF0S6fqAbf3QYZ0JYFS/nLLv2/yKJb4ALbGsluMGMW6POM7wB6Ph/HMCBkP5sBo4C/wMEMpwRZYYqi6Hc1i2juFtA/DOKwjAHRhN3NeGJOicRLfMt5sRvOgCEc5gHmNLhNo4mCp2BQpynNQw5iZ1LEboMY5oJFSW1qhPjcRgF20uBsgmucEiPzsGpWFItjgfCAdTpP6HE728ZBztn1xUviFZIellmGwjkJQLrg4efmmiboE/MK8VxnsWRUi9jCACYx2JUyh+ECUSESCBSjuu4EcXTLXbgznqdlFnLfTBHQJt7ncXDDIhN4Q+2RDhfGcZrGHmzQ5QcAOEB4TZzPgiKcgXAODCVcWzvHsvMBe/2mCXprFADlt5xQsHT8KwzEhYGeezAYEFwIwmBRlJnEgDzggVMY6o9sJDUoB2waxLmDU3K4F1Ii742tBqUFm9LBuiSvL+O6v1vIL3nByoXQekODaZZ6aLKiCcLB50qtF2K1bAhgMcvSu5wN34V84VLHRZAFcyFIbEsB2wF1ioooiB0GpA5ADqyE5S5k0zIRTUcj6AcMKMOiWwe9Te3FYoSfrQKs185TtZaIHw9gib4zNP1MPOxqIE8a/U1Fgv5dC+7rBrD9/bPzq5Oz09Hh2enp8BD/fMMODmA+EM4OAeo0EYHlPJJztwGOo8HV4NngcvhmW861AbFc4Fwe6wWiK5G+b5q+OAWJ4e/AScE1NLQtIZqnwG2g2F2QO+1TxkG7EmbYf9+MkoeCE2pPIWDtOqfhiy9gWRope6vbCGK3tw0Q+PluGuL47GbVDLz3sAWVJVDiiUtbtWJ6FyGpFcKFWqEb0mXZQo+VgWrQ/7DMpGYfuzG5FdBY/G+3dvMYSBeC0yVcPQnFyW8iAsXVL3TD06Pzs5PTK/bbbzVGr9P3+OzyXv3Ozy7u1e/H4cXJ859Hh8P7dT88OT8eXlzep+vg5cuzn0aXw5fPR5cnL06HRxqCLaAkM8Iy1cWm23lVwnKBoQVKnxTEDusrMejDF3LrTY0Ejy3MOLpq/U5Nyn228TUNB4yUBGuYkt1dli94iAab1Ea52DmHCAl+rJnuDUTo6uTV8Oz6yuYEooOBoooV0ZynpRr0PlvQOk0+YwGjm6Pog3I6jFYNIhK0ga3Aj4A/AkJGkgirl9afJ7W+7ytWMw7L+9rMqBYKDz8MyzsFb7Euip51CkZRQHx8B3ZfUisWoQpWTTg2o1gtOx5664FEndDaOmezsSmj6y9iL6TgqAV/PXstl6nGUFvt6Y2yp3ljzZLwLA1ro/mzrTCeBcZmxTx6x9uX7Jv6cmKzACPNrECtE+hlK9NDcXNJ2iHNLJtbJ3kONg/4RWH2i+FVle9wsmhN5pQQEu4QOIhBne4r2wrBDqdzIYKNdIYcDQrpBc8XMBK+in9dxNpT3nENOsVV7WIlzNDzIIpTMMNdBbi7jZ4Yk7DrUG1N3cokpWj1BVT+jodlwWWQ0hU6Fy94tr//anh1fHY0Ah71mIDe6TQwGPPbJBnYmXPFna7Gbuq+V7Pr836OHoTKENxFhVgU0OR8YKhiygMIBOFpSoRqRQh3IOqbLDHRsUi1GH5S2UE8aoKRhE8sQwLFJxAl5K6SJTeWzyVO159Hmq7/iMJU/jVk6fqPIUqI7pPLkk+UPomAYCr7z7lUHQ8HR3+AtWpwdXj8WcwLIVppYBYyZTpZfg7pIWybGRj2B7UwyN4/hI05Gr4cXg0/g5WRiDYzNB6xm/CYF9yUu3vLlAC1yibJSaIk+Ee3TxL4RxEsweXfSbKGgjyRVMEszzTiE9yli8dB+LZHW8hFtmTBTRAlmBuIID4FTuVszMOgrDYKKV8TZBDXyL1zzEFh1iq4hebBOOZ9doLb1ZiagsC/Z4AlCUao1Z4Gw6mg3cOEBXHBsyTA/SAFu4voMFsWE4NgppIiiomIefAumpdzlpTzMe7gS3BTQkBQg6Lg80WRs1kAEMecQ8ALUFZpDAgxB0IRgMoVVM9S/FWJUP1nncV1faqmoLiTMsS92aWI/uUcaLl3ayyF6iAuYyDP2Y2KEcQsb6x4ckup8gXqmgJYt5mlWls5SAFub82jMEsxedYtslqCBxNMD62wH5Xwlr8q4yJaxHyYTBZplBR5t5Gc290VohrNoR0J0j77FROkuE2sijaMz90sgnaCBEeeD2Ww+St+lIqF466V48PPe0CNy2i3OeVbTkRq4BZXYNIkw54eNFIh/tzb88HJy7Mfhxcqh/rGh1KxTCZSM9xax235Ow5KhyUt4zTD5PKdt7ckCjQ5mi67HcFiodkEDTVb5p8llo6DX5rflObe4u4W752/Av1hCuqdlFwZHaSflBfJWHI9MDNr7IRV5jHni+7jPRD/L/f29lxT+8D9zchLAkVgBogKVe6DghQVlSVLTUHcgqUQmonNcv0j0H6hOVh/1iK1W3zBGqKy8xTs7qEo4VDKY4st4MvmQRz9kyhRrfb39c/HEHFi8q0LKOwFR6TQc0xamWS/NoC+cSbSLfFJUjZPM6WpebU4KB6qnCd4DkXqkiRjo8SywR8KvSl9tR/cpgJEYR5kb0nwuOQpC3B1JCQ47w6e4M813sGM4GQ3h+s3Q9oENdYitwUiNSrjCemMZEQfVd9eiAM2iaZTTuVAaimfYj4ij4CVDbjmDu0mluviZHj5hj1le+yLL5y6CtQmuO2CzNqGhvdG4jOOlmwKJS1SEKIgWTaYQGVcSrV9Ns5v35rSpUTHFJsy0Ua1KTZezdPS48QB9DLhBiT8XaHRNeG7LQt28tkUSdZGdsXq7pQnaWqaeuK0MarXn31tBfOlRM1eWrXv+pdcYzd1poDaG4wsNFs+hh0DoFoT8xlZShq+LGVEt1zPAvjq4KmXmUNJN1iem7L/QWs0fv5jjI3PJsb4r2B1QoyV/2N01jM6Lv23/HnEmfEwnc/BMMDPItcgTEyje5ms8I7bnE3AHWMZAKwaKWUYuLaAxXLBc8bzMFhAIJ6lcwo9HtThNPM6F1xXa8uCmaCIwlpxukzQUYEzlhwgdnouE4ukYyJfYxcieNIDzUINOzmgamjMinUzJTY8e2kWMWqDvHHEg5pZ2U9oewV87GqA2+zhgWlgr34+H46uT0/+rxFuNSnuH7Achp4U024H7fE++3v+97zTYzV8x7RJq/H17GG6K15MM7Su6RhcXx2PcACY8tys1/Xl8KJp3UAag8mEieM50T8DvQ1k5Va2ai1+pGq0A6rk//qrEU/CdMK7voBwIwqxxm2/w/ofCux8cHn509GbGhh7FW2f8AYFnYHJAxQFKQ0fSquY0CaUJs+bjSxRs8er/vxAuTNqm30iZFYRO+SnXbcqzFrD7kXcBqqn4FcV9Ae0feAxCsZhkt3RZLw7ypd5weedRk3det2xqLPMYqk5Ni1rFCtTKVmzdNtK+56sPGfSoyVD1n1TLDPGFSTN8ARZgvvbO65y79aqNJ1tVmWY4Cj5KNWgfqkfR/vFTnW0L0dohQnsRlXl9TrPDevMQe4N3iKvFBcDXZELCy38obbBlEzIdgcWfss6ocs04+FbHEG93DcvcJ7o9EYjc/dwytNpd6ul3lW4YgqcDxZ+VEJKkWc+e98klk4VmJOrxitGSc/VJDlyjvY+QYvGXwylzjtdZ6AF4KE3R/1VuaUsq+4JPwf+yTxeW9rRrs++FLHlDGcYhzOxj9bI+e77E4713DK45IYQgWcGP0jxqDKa6BzTppMeU+U2aVkyDZ+Qvop/tqU32b/2qQuPSFk6dNAUF2PELokSrLHtmzij4q74dts68wgKq1kL+a1hNGoSKRuZgzNZcy8TscZhlHp40GBmUsaxbOzf0FXFAqpKQNhtYoaIa/IyLuzyDjrtqVlBll8IPowahNDgtjwvLfMqGHmOraPJmG1RcAvaLgHYVJ8A4jtnk5KiD9qih2iHkixVKYOA27fII4KAclyJWFTYjzescZhz8KQmiss7dXaJh56eVHDDrJ4rCm+M5vRdlvhhjLVuLQ50xVyIeIaRM8ShiEDGcxzYCpZp85IdWwWskgXJKKtAYe1aMFkK7nD2HgrnytgSg1VykC+TsDodaaodKBlh7drVPaSA5LzWHrw2zd/g8ufTQyoJc4U8Jub6RoxhqExw6pjkK+KN4pE5lpI8O9vX69OD+ukaYZmrE8/AX6clrp8fPZA8wqE01k3VpX7A9UAMrmWfrgqv0+kUOHoJTPUvuc+wJOp8cHHVY9Yevwab6eOuJvfGZRRPtHzVUfcccUGPuYWwUSXzsYclOGxvvDl8+t97sO8/hgyQgJ2L8g3Ze5I+ExV8miQ5SAezESmuTaTYFTBfJlOt+7rhBnvx7WGV95i13XRzsXBK+u858R8yFFu61XkbATcLQv68JJO4vhd+dTE4HL55YtkvBcoRLmG9EqMGGa1AXjFejXt4ejw4PRweSSJccgfOCUzFTBaN1aeLyujwh1c8z4MbqqSjudPT0TDymlkzvQA2IYpHGqvLSCn+dDHAuMJvWmwk5NeP37jFY3tt61Rh6eQQ4nS8uvzeKRAwV+mCC+8xT8O3nKoHCr4vYqc53dGjvUUrBAIHEUOtuo/oCFjkZBuRux2VyKZoYtDWOE8fgqtLPhb6vDe0iSCrMrEwzmUoffKpxp3ES/QwShj5MieJhX5qtyBybKXTDtBVhIco/YVwksO1jsIvt+QI6EvyKRbc6cOnlWhqofwc48JhXAVvQQwa49IbXzjs9kHiZkSJyiLkaARzNBK/6YjySXM0osXrDqKcjHA/yhfpg7R1dI0LetoyTFGbTHjxjNhL6jv3gXAzWadZ1I5UMJlEKMtBrDfMitRA4lwO71vmaA6mGgbVb6it7ISMmbPXlrzN56XaYrlHuZiGBSbJD8cuDnGCECeKNRjw1s2v5CzUCPZyQ3HEd1WFt5M727SitevYsb9PtWMnLhhp1DJ0//aCahbUzq2o8bsLokIdqK8C306ubdbfeuyrvW/aqNWY6WC1YKHB4DU2bRWAdTdv3zf50JIfW3/Yvxjj7rjG7fByH7ryVB67MMdCYSE9rvPVxkdlaJzWyGGzVdE/MsAMtLvSoFsuRK8KOC3YmxvxVgeqgvIRnSgadOVNeMXLcGYkN7xNa3wU6790m7Z79gNg7yFukDSePEsnS/i1HYlewbzNtp1PnEXgHldLIKrcrYyHHC9b6Kn1fY2y49pXFSqp4TrTEy0q+NMsTRe5zHLL4qaEi6z1Apw6lYRpphPP0YVVGUMh5UYWkQ6rykvugpzOauSwpteuDtswO2dqj6FaO3UaAFleLhZxVJ2XMIv/P+S8mnmWxk1Mo6phJkUSV0iPrDbcWNXlW/Z4b4/99psB5ekBmL49h2eLBTkQyTO6J6Jx1GGLZsMmQSiFw52i1g+d+5sSnekCYYZ3GqFjzQs6/hMl9RmpkpgmSar1Afs1T5PRhIutTWysI2kXaunlNyrpzRFU6UCJxUwEyp9ed3iWpdlpOe+0V3G5OlCy5Muv/ucf2+ahRAe12AaGKOqD8lm0wKLBOOaY0gaFS5ObVJ9scnzW8B2+s+iTIWoHgkLjETK3Y1camZ91F/x7senrNdj0NY6Q/IG4WQ9gNTfbVQWe4AaTHFaHv/x8jbXfWlMJ4Rcpt7V+p4x34Oqgmd8zlWSLYMGoWFxBZZ1SR82nxu2nkGDYvjkELNo1Xw+E92HrStccxMY15BrP/cj788YEH0mvPTHAykn/iAHAhhZZD7Qt9F3ynApbsdhbdnf7WjajxZZ8xWY/l9dkssXgI9GpGmd7AbKfvb4EN34amVK1HOdVwYGwa1icKkrek6UsIP3H3n9XazNaUrGiTrBA+LZeilH3R9CYQ2df2T1PeAb+EpIQhZyVSVWRkNX8q7bpaepBxwEQ3GUkxHcEzMfWZhFKkmqvZZqWCZU3katMFraqtX3QROIUptpickEOPQUjiofu+jK3D++4cbJIwX+gPRthyeZzmDrfrq7Y1dlhF/RV1K+Iq3PZuHn7rudqSMB4aGwSect2W67LNUcoW9du8JVjbQyWFzWaBWiRFXAVHlvBgmgudpCACRraDcBKJAMwLiHgrRw0edbOLF4MqoF1BW4fw8xrkNWW2GYMs/iVeab544ztpj62FffabTS/Yi6kAImr7sX51h6Vsilx33bPs7xXWWSOOQUOVIGC5NDuggArkMxBBeXelm4UFSydTldNbE0JBK41VUE0bmeDWa+XAGHUd0cXnADVfX3dOibgZVl+nuKFfQueBaJIE+9ECIvKv4yX4jZ2VaxPgNZiY64mp1b6RwxOJS/1NsMc+qE5AkaiXop0LaCeYGQD7m6teX8Vo58ZW7QrGG3t5q5gtDaDKCG0DRXlVqFkJNViR842McyjP83L1a2xRPlJQtAksFcU7LfrjSk63oGsUHSv/spb3VfRIO9v96JXchiwGe1BuW6TUJNSzIJCqWBuHB7BvEEHC7USQzHdgikusahKsnaAAC5rsNRrApSidOkGQrw7rt/ve+yFqrxSfQQ89Q1Lr/AAX+4sfyM3y0e+UUZHxWxxEPJZGmPYIy9QV7DEWzOME0VyBoQ6U1vBOUDJ3y3ga/3qj6r6rSIF/bg6ORG+IIGr6xgIAfiAMMnJDd3d4pFrwW+SlQWWe2CNaSl2/2o4KjfEmDt/dbaz8NtTZOYvLLENgVmVYpQ+sjWrXOre4CN5gb70GURzVRJaw1jbja4ti3YxSa1shr5A8I1p1Ulr2YzhG/4Xvj1GYJWSaeaLPIUyTe+gXr4pBZmETJQ1Q4iDc4m3JisVgQ5lMdWidlKITWHZF9cfOo5BDn44A+UCOc1ya32xtE+WBkoM+mYq3C1FsC22FhcnZborAq+vnu98o1Z0IaIuMyiPuBnXRBWgVSMYXlfS4joGsMj4zWhOE9vZ3S0xRy8b2yGQynv7ygPlc6Nw0WdY15oi/P6WL3NDjVWqXT4VfKZDG8UUOZSBXc5yENR4ac6oKJsNIlU7rYIxcZsT4iwTnFV2l6WAW5w/mcgJsOfammQxs6umuPVkSOskEriR4ktXlLw4pvGhkXugqhjn5DnnDYSc3jgjemK8sAV8ZwdP1RXfFigLnWizKoVON1Phvv94CVYwjsZZkC1NPwKMLow9juURGyxT0BXOFnLVa0TprrzbmY9HUtgVozqtFQVEFCUM5mNFi7OxTOqoO5yBLZTRaeKjZz3WIVXtyNR+vUbVBR8/LdtWZ2iKCKQWSqERMV5qPumznyqBJVuR4HMpuPviknyked20lmPIUgI8g6ann2PYao/NP3DxMoDa0F0X1PsH35rjpc0nebEYuU/KaAph8u1ueOQn5/F0f9+0z/TkLyUuzTEaN/D/CaWj9otXVsSobaO94k0Jq4MQ2jyU5yK3YZlC7yoTyyZwMjV8dr0UCccGmATRH1j4eeVNJ3SbYBzThV3oassguE70tgw/+nhekjDJcET72zRHCiosrHqO5D67bE+rL26zR4DR2Ds3xiTKFT0LrbzgTx0iMdda0dvdXr0CwXwdgqq2qbMTWeDxyQwXThYmStfDgPBBUYEVwBpgR3KWu6oIWg3igO21Hedc42jw8fDwhxFo0Dd4Svj52cWrN96yeLc8k4fxxBJgRQheLenzQsxSIXMS7DH+xr6/xEtBzi4Oh6OzZ98PD6+aL+q4F+gNc9OORJaWQDogDVJI13aIg1ttKVudClynb0+8z/JdgNc8gsGaL/U56I54caUA+rzMaLtDqnFaR6COLgeTCYwslzd76PywaudRPPP4lqC3SXyrNNdec6KPcdvh7dpyq9/zhWGmAvekAUhTuManBsiGtPlrVz50Zlut0KrMl2b1itRXnXOV7jZWH0wV0UvP6nXsKFB4Xax8/6t1cW7jjXY6IRT1eb+6Yao7S/Nid5FmeDUI8CoTL+VaBHl+l2a+vA3GyFgKpbOb9dxtGYacT/LVoXKVzcMEbOMO1+ZVh1UmpHudxSCT1xcvR4OjVyf0dq1LfG2RaZ/Wv5mwGTTXIFh7b5sDsFaf9QHY4lOF/Z57Il1ZaOPFqnrm7ziF7FUKXc4gWScFoZtmveah2xldLAmWyzxouxTH17nrdr9HwnNRN9JVpeSNvGl9wd9xk66AEf1Nqr2q2Sg1twXO/S6gtjL1NSpFzIPj2suja6+iMJDa7LgrOSJ3Ef+aB2/J6Cso4jXXLMC6QwkhuENegFNEaV1VnwceKbmWmOWkJ5SQ1a7iYpGliyyiLTDev+mzOL25cW1+ed+faCdT5WVeW3NR2LB9r/Xl9OyKXpM3ePny2eDwhzcVOMVysPz06udREEdBbpwvAxcJf4dI+Bf1fm7lBo5/qZphmem/AdBMboQ= - + - ArangoDB PHP client: bind variables + ArangoDB PHP client: connection + - + - BindVars - \ArangoDBClient\BindVars - - A simple container for bind variables - This container also handles validation of the bind values.<br> -<br> - - + TraceResponse + \ArangoDBClient\TraceResponse + + Class TraceResponse + + + + - - $_values - \ArangoDBClient\BindVars::_values + + $_headers + \ArangoDBClient\TraceResponse::_headers array() - - Current bind values + + Stores each header as an array (key => value) element - + array - - getAll - \ArangoDBClient\BindVars::getAll() - - Get all registered bind variables + + $_httpCode + \ArangoDBClient\TraceResponse::_httpCode + + + The http status code - - array + + integer - - - getCount - \ArangoDBClient\BindVars::getCount() - - Get the number of bind variables registered + + + $_body + \ArangoDBClient\TraceResponse::_body + + + The raw body of the response - - integer + + string - - - set - \ArangoDBClient\BindVars::set() - - Set the value of a single bind variable or set all bind variables at once - This will also validate the bind values. - -Allowed value types for bind parameters are string, int, -double, bool and array. Arrays must not contain any other -than these types. - - \ArangoDBClient\ClientException - - + + + $_type + \ArangoDBClient\TraceResponse::_type + 'response' + + The type of http message + + string - integer + + + + + $_timeTaken + \ArangoDBClient\TraceResponse::_timeTaken + + + The time taken to send and receive a response in seconds + + + float + + + + + $_httpCodeDefinitions + \ArangoDBClient\TraceResponse::_httpCodeDefinitions + array(100 => 'Continue', 101 => 'Switching Protocols', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Requested Range Not Satisfiable', 417 => 'Expectation Failed', 418 => 'I\'m a teapot', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported') + + Used to look up the definition for an http code + + array - - string + + + + __construct + \ArangoDBClient\TraceResponse::__construct() + + Set up the response trace + + + array - - void + + integer + + + string + - $name + $headers - string|integer|array + array - $value - null + $httpCode + + integer + + + $body + string + + $timeTaken + + + - - get - \ArangoDBClient\BindVars::get() - - Get the value of a bind variable with a specific name + + getHeaders + \ArangoDBClient\TraceResponse::getHeaders() + + Get an array of the response headers - + + array + + + + + getHttpCode + \ArangoDBClient\TraceResponse::getHttpCode() + + Get the http response code + + + integer + + + + + getHttpCodeDefinition + \ArangoDBClient\TraceResponse::getHttpCodeDefinition() + + Get the http code definition + + + \ArangoDBClient\ClientException + + string - - mixed + + + + getBody + \ArangoDBClient\TraceResponse::getBody() + + Get the response body + + + string - - $name - - string - + + + getType + \ArangoDBClient\TraceResponse::getType() + + Get the http message type + + + string + + + + + getTimeTaken + \ArangoDBClient\TraceResponse::getTimeTaken() + + Get the time taken for this request + + - eJylVlFP2zAQfs+vuEmVaKsWGI8tMKCbQHsZGhMvgCo3vSYWrh3ZDqVa+993dhzapA1sml8CuTvf9919d+nplyzNouio242gC5eayUR9vYLbm1uIBUdpBzDhcgovTHM2EWjIzXleZCx+ZgkCvAWNvL83stymSpMNvjMJdxZxzqT0plhlS82T1MLo7a+T488nPbCUIUFp4Ho+uemRWahEYg+uUVP0kqKPokiyORrKjbW0ww0HMHyeCYRYScu4RA0zwrKXxa+Umy0/JoyClMkpeZCv4FNmuZKgZmBTLK8QOZrD04k+dzeE58clMVzGzgRwfHjiucSCGQNXdOk90yb6HTmjJ+FOF0a51hS9nTaYSo8L4gNMa7YMb478M9P8hVmE1riIgjN4eKIC1e6/RkuMBWhMuLGocbpTpGo2jTbXskgI/fCk2vzNJQFZPhE8hlkuY1/YBO2lEO2ONxYFcCckallqT/88sBh683ovDdcdmc8n1EPCUwWwBa2BEKci9/8hvpHLSOXSNrGJvbHKqdNE6i6Q8m6+xqRqmQisggMStgltrKFmFhQprkbZC37Byd1rPWgcd+RdC6MmqQUGK9hlRgnehipjmoaSCkRJNYKhOZZJz1W1V8ZPFRWLRnmiFGWmGK+dQ5oTehiY58aCVLYcRXIhYREmXV5gaSodSBOy1wFe2FSrhYFi4L69xpi5ptS9PNSAcEUAV4WGW26rgNOAe9YVAD9+EqAg9wW36Z5y780Am9MqKtcPFdxZSA3KfFH8fdFR89sefa9McUZCFqKuQT6DNjdjz6EI6HS2zO4QJmRxCoUZmAk31v3cuXeG+0I8Sg8GpY7aIWRYiVhX/qtOAOH1+TYRa0BBba4mDfi5DHQ7sFoBvSgK3cBoN9tDuwjoFEmfXHZvGf4vxX2g3fG6BImLujTbB1cVkfmim1TlgjZoOUVuvonzQWNB1x8sxa39UdV0oWMwGcZ8Ropy6d+bljAjDSPSIN85f6Wl0d+g2BfUuE1DV/co+ZPX8fgZl2N8pd1s3magul3rggiw3IBs6S16/7vzUEil3NTk7j/cY9IDM+3y8z0Y+Lc9OHgsf8c8hl8Bk8fSyfXxDz43w2I= + eJylV9ty2zYQfddXbGc8I9kjJ5FvbZ0mjaM4ttu40dhKX+KMByZXEsYUwACgHDXTf+/iQoqgaGva8sEX7sHu2YMFdvnLr/ks7zzf2enADpwoJqby3VsYnY8gyTgKcwyJFAITw6UgiEW9yVlyz6YIUC0YOqwzssLMpCIb/MYEXBvEOROiYXpP6xKuYTgryIEzJjJfKj6dGRhWf+29GOz1wShO0YSGs/ndeZ/MmZwK7MMZKnK9pNXPOx3B5qiJGDY4veyUyQ0zpjWMFWGuCCqFxjKhJ4k9ma3mIrEmgMGzfcckaQnzvWMRjod9dkgWqVADsmQGM2QpKmAaSC+mFFtC7x6X8Oo1LFhW4DZghnMX0C0ufbxZMOXx4c1z9ztXfMEMwtatd6zhFXz+QjI0KIxnCDNjctCGmULTNqfYFoFXgdf80+ohrWr3rdgD3Ml0CXICxv5fab4eQ9MWW7Vbw1gn7SHMMkfr3qVB269pm/61e+fkFXRLft1HYvE5/WD3KMBI0ChS2q6UskqQLxBYlR8JRmY6NKlu4zLJJHtMUBtjbEOsU/ikMbWBMynvocidoilOuOD2YMKEqpeqxwnx2EY+WSphK99VLl3ZeLQt7hcvbD12h1IYLgrs9mumgTNdP3CTzEhnGClpZCIzXUPtBQcff49e+qVDhUQjjSx7znKSJJg3TfvO9IcUuyfu3HIqYLsHF4JkmDPLPsIfBDxY9nSOIuOhM9JJRdNqP3L2EVOGs6wFsR8Suywyw/MM6eaQPEEdQXyal3JBmzhytxY5yZYRxif8XhYijd77bK8R4SNtuopsZWYGLmXKJxzjpT43Kh27Jd/icD862xjnuVRMLeEKU07FXE/tIKT2lqVk/lqgjq0+q0/C3578ryj6QUhoxJb27nIOKEAM2Q85qzuepigi2yq3piYHIbFLpLgpWMhJlsmHhvOjyoGvInaXYQTwEjhpwFYS0eSJK592tj+FUnFKwJgOqyxiRX4uD8kk47GUAy/lmRQRh4HX8AOKqZm1Rh0EGZW7Uvxpf8941kDtR9xOKROzhLGU8IGpaRzyoA7d/XR14XFSTCNYKB6hi5xKhM4gXFKJMBjTfRkBj+r+CHZFTRLdrlyTmHrCm8IPvPCn33KqN/ZYRl7ti5vunC5XgyyXdUEPQ21e0HlUgk7mNaoFddFTpaSKcIOqDC7muW+kUaTDUKi2ys/oGnpgy8hanj+1oGMNVO0L4tpI6TBUa1jfUhuHoWbPx+MR/Eld2WbtNCrlDeCWTn1NV1O48qsmY+x80bzlc6bYPIwQsFW2f9h1S/3rslsGY2Mp9Xr7/1bZDsLSZlsp4b6vwpZr8/bx8PC6DGWtjYXh2aoaXtyWijs6PjAphJs64faWSp+cFonplVn1VyT7nkC/5m7b+fneWQWacb37upqIgJpb6enlOqrM3qGqIacJq7K2MD+kNCEVIQupdXeL+Xttn89on6sRsDE1NTas0lOhKZRo6+0NEadozr2LXlOd4KMh0lMsq6Ko6LUNHcHv2gDZwiyIvJFatBkbuFlKtRmpyc7MlHygQd/N8qffbIdYoSrybaPj4/xX49NaJnwCvR+4pjGj18ymNnR9DrZIky/b2zVH9nHcQeBDk36PLkT6aOBpTYJcyQVPMX3W3V5VaNDuCY03stq0CVVt1C6A/ybvW3KwqTRWB3BDWYTvBPfx8L9Y2Ua4iZUNsolV7cvCjvF2Jblx3XQjhfJK2cijefcQHfehekvFwnQv+lw9PnamPnRvyk/vm/Dpe3cTIW1F/QNKpHLw - + - ArangoDB PHP client: collection handler + ArangoDB PHP client: autoloader - - \ArangoDBClient\Handler - CollectionHandler - \ArangoDBClient\CollectionHandler - - Provides management of collections - The collection handler fetches collection data from the server and -creates collections on the server. - - - + + + Autoloader + \ArangoDBClient\Autoloader + + Handles automatic loading of missing class files. + The autoloader can be nested with other autoloaders. It will only +process classes from its own namespace and ignore all others.<br> +<br> + + - - ENTRY_DOCUMENTS - \ArangoDBClient\CollectionHandler::ENTRY_DOCUMENTS - 'documents' - - documents array index + + EXTENSION + \ArangoDBClient\Autoloader::EXTENSION + '.php' + + Class file extension - - OPTION_COLLECTION - \ArangoDBClient\CollectionHandler::OPTION_COLLECTION - 'collection' - - collection parameter + + $libDir + \ArangoDBClient\Autoloader::libDir + + + Directory with library files + + string + - - - OPTION_EXAMPLE - \ArangoDBClient\CollectionHandler::OPTION_EXAMPLE - 'example' - - example parameter - - - - - OPTION_NEW_VALUE - \ArangoDBClient\CollectionHandler::OPTION_NEW_VALUE - 'newValue' + + + init + \ArangoDBClient\Autoloader::init() - example parameter + Initialise the autoloader + + \ArangoDBClient\Exception + + + void + - - - OPTION_CREATE_COLLECTION - \ArangoDBClient\CollectionHandler::OPTION_CREATE_COLLECTION - 'createCollection' - - example parameter - + + + load + \ArangoDBClient\Autoloader::load() + + Handle loading of an unknown class + This will only handle class from its own namespace and ignore all others. + +This allows multiple autoloaders to be used in a nested fashion. + + string + + + void + - - - OPTION_ATTRIBUTE - \ArangoDBClient\CollectionHandler::OPTION_ATTRIBUTE - 'attribute' - - attribute parameter - + + $className + + string + + + + checkEnvironment + \ArangoDBClient\Autoloader::checkEnvironment() + + Check the runtime environment + This will check whether the runtime environment is compatible with the +Arango PHP client. + + \ArangoDBClient\ClientException + + + void + - - - OPTION_KEYS - \ArangoDBClient\CollectionHandler::OPTION_KEYS - 'keys' - - keys parameter + + + eJyVVttu2zgQffdXTIGglgOvnAZIH9x4N15HaFygaZAERRcIIFAyLXFDkVqSshO0/fcOKcmi5QaL6MGiNbczM2dGOv+rzMvBYHJ8PIBjmCsiMnn5N9xc3UDKGRVmCqQykkuyogpVrNZFSdJHklGAncHC6TohqudSoQw+EQF3htKCCOFEqSyfFctyA4vd6fTk3ekYjGLoUGj4WCRXYxRzmQk6ho9UofUzWk8GA0EKqjE27YX9sMN/RcSKU+0gF8SwFCxwJjKQayiY1vaYcqI1rBkqhk1G9zn10oQUgScUBNWGrmDLTA7S5CjodHQIS4MizkEKbgFCqWRK0bPzjyDWShbAjAa5FdBhR4jAMiEVHq21dazD80T9aZ009/8vM6aSWhHASXjq6lPnNe+69X1gxa409jqGS6ZoaqR6rnPiLFEE/7hSNDqt6sWGKNDYFpE1jybuXiq2IYaiyJX3CH2gV+xAL9RiV2SgTwY7y6TYc5RKoQ1E3+6j67vll2uYwTBEKg4PXS0FM4xwpimYvT71IZtcya2G6CmlpeniwYWiplICNpKt9pOpEo5JNLmsK5FaM2AYMBg5jbqE9tKUr6fTNKfpYyQ2TElRYCuCUYO3U2lKggnF8eXyNo4hBLxHi/svt//Ed9HN/HaOR9+u5HGbVaxoxpB2Kojj6/nn6O5mvoicj+FD19rp1N6HGNza/zwoWT0HPvmR0ZV4FJaKjie92t3nTHdshry2byblNTz+nV8U274UFTes5H4HNRhpJ63SOGdMAGlnbk10jq3ou8ORUKRoeAlHDt81IoI/HDCbaI25duuCrPo+XskG6yToQvV5cdRVxHa837OH4YdOlVOR4dzhNbM54N+gM/eZNJm0J7aGQFcJansYxnAybr2N4M1s5qEYedis8YmTo30p9Z4Lz8S3sVddoQ74zz1k9XhgO3F+c7KhWGmKrMIuY+MSukZG7NTtJlQm2J8MC0hUnPsZK/pfhdupN0Mh/Cb3XeJho71bIi+Nw8JOrVseqhKGIVFoN8IvToKbddjm1K3+F6wBtVNZlMiZBKnt9iqqtt7qxe29Tg8Y3SyterO/YnXt7+EdWw8XVI+vuEdNcFSQf6XCUhYMB3iEdKRPJZcrGgzD4djCjb9Gt7akfo8snQImzAhqeziHM/jxo/dwht09g7dvoX1qQ6Dq+wOaudRx4rf97IPhUnhFtdXzSh7ihi/xPWZXgBWdhe8BI+T4OUFVuxNrItS/SAhHnxhfIkQH/hp1z8c4p+0HyEPzqk28bWt9/gJGybR/ + + + + ArangoDB PHP client: server exception + + + + + + + \ArangoDBClient\Exception + ServerException + \ArangoDBClient\ServerException + + Server-Exception + This exception type will be thrown by the client when the server returns an +error in response to a client request. + +The exception code is the HTTP status code as returned by +the server. +In case the server provides additional details +about the error, these details can be queried using the +getDetails() function.<br> +<br> + + + + + + ENTRY_CODE + \ArangoDBClient\ServerException::ENTRY_CODE + 'errorNum' + + Error number index - - OPTION_LEFT - \ArangoDBClient\CollectionHandler::OPTION_LEFT - 'left' - - left parameter + + ENTRY_MESSAGE + \ArangoDBClient\ServerException::ENTRY_MESSAGE + 'errorMessage' + + Error message index - - OPTION_RIGHT - \ArangoDBClient\CollectionHandler::OPTION_RIGHT - 'right' - - right parameter + + $_details + \ArangoDBClient\ServerException::_details + array() + + Optional details for the exception + + array + - - - OPTION_CLOSED - \ArangoDBClient\CollectionHandler::OPTION_CLOSED - 'closed' - - closed parameter + + + $enableLogging + \ArangoDBClient\Exception::enableLogging + false + + - - - OPTION_LATITUDE - \ArangoDBClient\CollectionHandler::OPTION_LATITUDE - 'latitude' - - latitude parameter + + + __toString + \ArangoDBClient\ServerException::__toString() + + Return a string representation of the exception + + string + - - - OPTION_LONGITUDE - \ArangoDBClient\CollectionHandler::OPTION_LONGITUDE - 'longitude' - - longitude parameter - + + + setDetails + \ArangoDBClient\ServerException::setDetails() + + Set exception details + If the server provides additional details about the error +that occurred, they will be put here. + + array + + + void + - - - OPTION_DISTANCE - \ArangoDBClient\CollectionHandler::OPTION_DISTANCE - 'distance' - - distance parameter - + + $details + + array + + + + getDetails + \ArangoDBClient\ServerException::getDetails() + + Get exception details + If the server has provided additional details about the error +that occurred, they can be queries using the method + + array + - - - OPTION_RADIUS - \ArangoDBClient\CollectionHandler::OPTION_RADIUS - 'radius' - - radius parameter - + + + getServerCode + \ArangoDBClient\ServerException::getServerCode() + + Get server error code + If the server has provided additional details about the error +that occurred, this will return the server error code + + integer + - - - OPTION_SKIP - \ArangoDBClient\CollectionHandler::OPTION_SKIP - 'skip' - - skip parameter - + + + getServerMessage + \ArangoDBClient\ServerException::getServerMessage() + + Get server error message + If the server has provided additional details about the error +that occurred, this will return the server error string + + string + - - - OPTION_INDEX - \ArangoDBClient\CollectionHandler::OPTION_INDEX - 'index' - - index parameter - - - - - OPTION_LIMIT - \ArangoDBClient\CollectionHandler::OPTION_LIMIT - 'limit' - - limit parameter - - - - - OPTION_FIELDS - \ArangoDBClient\CollectionHandler::OPTION_FIELDS - 'fields' - - fields + + + __construct + \ArangoDBClient\Exception::__construct() + + Exception constructor. + + string + + + integer + + + \Exception + - - - OPTION_UNIQUE - \ArangoDBClient\CollectionHandler::OPTION_UNIQUE - 'unique' - - unique + + $message + '' + string + + + $code + 0 + integer + + + $previous + null + \Exception + + \ArangoDBClient\Exception + + + enableLogging + \ArangoDBClient\Exception::enableLogging() + + Turn on exception logging - - - OPTION_TYPE - \ArangoDBClient\CollectionHandler::OPTION_TYPE - 'type' - - type + \ArangoDBClient\Exception + + + disableLogging + \ArangoDBClient\Exception::disableLogging() + + Turn off exception logging - - - OPTION_SIZE - \ArangoDBClient\CollectionHandler::OPTION_SIZE - 'size' - - size option + \ArangoDBClient\Exception + + + eJzNVk1v2kAQvfMr5hAJiICkOZI0bUoQadV8KOZSJZG12ANe1azd3TUJqvrfO7teG+MASVOpKhcb78yb2ffejn3yIY3SRuNgf78B+3AmmZgl55/g5uIGgpij0H1QKBcoAZ8CTDVPBAWa2I8pC76zGQKUaQObYRdZpqNE0hp8YQI8jThnQtilIEmXks8iDYPy7ujw3VEHtOQEKBSM5pOLDi3HyUxgB0YoKXtJ2QeNhmBzVFQba2WPy114tuHusNbwOOJqtQvQyxThkccxTBB0JJNHAZMl3aHbOTxGKOx/x4BEnUnqjtl9oJS0QS7osUoToQgkAVbkSvyRodK9sjZWSgdJiEDNGOyL8fgGlGY6U/lzplwhDKkfk7xqwcDBZwJgptyqs1QmCx4itRaG3JRgMYSoGY+VyWCTJNM23jbdMbcE4CIITRgOqGHJqWimuJiZEJM6Q32eh7XaMM1EYNB7JxN5albddc0OG8xAgIHxyWHvyGoYxEwpJ1OpEvGjUYQKVrr9bBgDWVXNbx+u0/XNwZQk0FVuXWSRQF1JNgcmJVu6Zwf2mkq+YBphzy+g3sPdA3moVnFoVRbZfIJG7BCf1mACEl7D8Gp8+80fXJ8PCaVpOb7K5s1taORfZZjaDXc59Lyz0QrxMs/agHpr7ULeU3SASDqJKXmSyGeW12S6m6LcbUVydzPKOnnZJOZBaQfwfZ14NqvVtgG5cObnwH1/8PXM83wfetDsQ5Mue5rOY/eUDJYbYUDmJ4/Rem3ZbbzVPraov57t30NdOVyl79d2+Xn6yvNSPywFgI6YhiQIMikxtCdoWU6PlBIilNjb4T7YKwp03QPS5aWuC20WCQ93KqBWx3S9Wl0PR2vF9UXkNnZHf8xuRCPMMRz+JcNro0mtRhOdIXq/hFvoyimo8Lze9WYKq5Nus4lr3O0irHhn2vNuxvo/IYxeKdaSrt9Kha2NFJRxemd1t0ZvZax6dGuk8Sm0uCJjtmq83SmMp/3+amg+tNuVvO2EP088LrOcDM+Tqcm8vVfL5cbzf6FYPotfnNjb239BuXK2vkk894p6k35F7i4JRRbHhWy0aj8bfBZzplq1j4d+3y52oHlffETeuw+RyX0ttklW+A1ZRFRS + + + + ArangoDB PHP client: user document handler + + + + + + + \ArangoDBClient\Handler + UserHandler + \ArangoDBClient\UserHandler + + A handler that manages users + . +A user-document handler that fetches vertices from the server and +persists them on the server. It does so by issuing the +appropriate HTTP requests to the server. + + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + \ArangoDBClient\Connection + - - - OPTION_GEO_INDEX - \ArangoDBClient\CollectionHandler::OPTION_GEO_INDEX - 'geo' - - geo index option + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + string + - - - OPTION_GEOJSON - \ArangoDBClient\CollectionHandler::OPTION_GEOJSON - 'geoJson' - - geoJson option + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + string + - - - OPTION_HASH_INDEX - \ArangoDBClient\CollectionHandler::OPTION_HASH_INDEX - 'hash' - - hash index option - + + + addUser + \ArangoDBClient\UserHandler::addUser() + + save a user to the user-collection + This will save the user to the users collection. It will additionally grant the user permissions +for the current database + +This will throw if the user cannot be saved + + \ArangoDBClient\Exception + + + string + + + mixed + + + mixed + + + array + + + boolean + + - - - OPTION_FULLTEXT_INDEX - \ArangoDBClient\CollectionHandler::OPTION_FULLTEXT_INDEX - 'fulltext' - - fulltext index option - + + $username + + string + + + $passwd + null + mixed + + + $active + null + mixed + + + $extra + null + array + + + + replaceUser + \ArangoDBClient\UserHandler::replaceUser() + + Replace an existing user, identified by its username + This will replace the user-document on the server + +This will throw if the document cannot be replaced + + \ArangoDBClient\Exception + + + string + + + mixed + + + mixed + + + array + + + boolean + - - - OPTION_MIN_LENGTH - \ArangoDBClient\CollectionHandler::OPTION_MIN_LENGTH - 'minLength' - - minLength option - - - - - OPTION_SKIPLIST_INDEX - \ArangoDBClient\CollectionHandler::OPTION_SKIPLIST_INDEX - 'skiplist' - - skiplist index option - - - - - OPTION_PERSISTENT_INDEX - \ArangoDBClient\CollectionHandler::OPTION_PERSISTENT_INDEX - 'persistent' - - persistent index option - - - - - OPTION_SPARSE - \ArangoDBClient\CollectionHandler::OPTION_SPARSE - 'sparse' - - sparse index option - - - - - OPTION_COUNT - \ArangoDBClient\CollectionHandler::OPTION_COUNT - 'count' - - count option - - - - - OPTION_QUERY - \ArangoDBClient\CollectionHandler::OPTION_QUERY - 'query' - - query option - - - - - OPTION_CHECKSUM - \ArangoDBClient\CollectionHandler::OPTION_CHECKSUM - 'checksum' - - checksum option - - - - - OPTION_REVISION - \ArangoDBClient\CollectionHandler::OPTION_REVISION - 'revision' - - revision option - - - - - OPTION_PROPERTIES - \ArangoDBClient\CollectionHandler::OPTION_PROPERTIES - 'properties' - - properties option - - - - - OPTION_FIGURES - \ArangoDBClient\CollectionHandler::OPTION_FIGURES - 'figures' - - figures option - - - - - OPTION_LOAD - \ArangoDBClient\CollectionHandler::OPTION_LOAD - 'load' - - load option - - - - - OPTION_UNLOAD - \ArangoDBClient\CollectionHandler::OPTION_UNLOAD - 'unload' - - unload option - - - - - OPTION_TRUNCATE - \ArangoDBClient\CollectionHandler::OPTION_TRUNCATE - 'truncate' - - truncate option - - - - - OPTION_RENAME - \ArangoDBClient\CollectionHandler::OPTION_RENAME - 'rename' - - rename option - - - - - OPTION_EXCLUDE_SYSTEM - \ArangoDBClient\CollectionHandler::OPTION_EXCLUDE_SYSTEM - 'excludeSystem' - - exclude system collections - - - - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object - - - \ArangoDBClient\Connection - - - - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - - - - string + + $username + + string + + + $passwd + null + mixed + + + $active + null + mixed + + + $extra + null + array + + + + updateUser + \ArangoDBClient\UserHandler::updateUser() + + Update an existing user, identified by the username + This will update the user-document on the server + +This will throw if the document cannot be updated + + \ArangoDBClient\Exception - - - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - - - + string - - - - create - \ArangoDBClient\CollectionHandler::create() - - Creates a new collection on the server - This will add the collection on the server and return its id -The id is mainly returned for backwards compatibility, but you should use the collection name for any reference to the collection. * -This will throw if the collection cannot be created - - \ArangoDBClient\Exception + + mixed - + mixed - + array - - mixed + + boolean - $collection + $username + string + + + $passwd + null mixed - $options - array() + $active + null + mixed + + + $extra + null array - - has - \ArangoDBClient\CollectionHandler::has() - - Check if a collection exists - This will call self::get() internally and checks if there -was an exception thrown which represents an 404 request. - + + get + \ArangoDBClient\UserHandler::get() + + Get a single user-document, identified by the username + This will throw if the document cannot be fetched from the server + \ArangoDBClient\Exception - - mixed + + string - - boolean + + \ArangoDBClient\User - $collection + $username - mixed + string - - count - \ArangoDBClient\CollectionHandler::count() - - Get the number of documents in a collection - This will throw if the collection cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed - - - integer - - - - $collection - - mixed - - - - get - \ArangoDBClient\CollectionHandler::get() - - Get information about a collection - This will throw if the collection cannot be fetched from the server - + + removeUser + \ArangoDBClient\UserHandler::removeUser() + + Remove a user, identified by the username + + \ArangoDBClient\Exception - - mixed + + string - - \ArangoDBClient\Collection + + boolean - $collection + $username - mixed + string - - getProperties - \ArangoDBClient\CollectionHandler::getProperties() - - Get properties of a collection - This will throw if the collection cannot be fetched from the server - + + grantPermissions + \ArangoDBClient\UserHandler::grantPermissions() + + Grant R/W permissions to a user, for a specific database + + \ArangoDBClient\Exception - - mixed + + string - - \ArangoDBClient\Collection + + string + + + boolean + - $collection + $username - mixed + string - - - figures - \ArangoDBClient\CollectionHandler::figures() - - Get figures for a collection - This will throw if the collection cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed - - - array - - - $collection + $databaseName - mixed + string - - getChecksum - \ArangoDBClient\CollectionHandler::getChecksum() - - Calculate a checksum of the collection. - Will calculate a checksum of the meta-data (keys and optionally revision ids) -and optionally the document data in the collection. - - \ArangoDBClient\Exception + + grantDatabasePermissions + \ArangoDBClient\UserHandler::grantDatabasePermissions() + + Grant R/W permissions to a user, for a specific database + + + string - - mixed + + string - - boolean + + string - + boolean - - array - - $collectionId + $username - mixed + string - $withRevisions - false - boolean + $databaseName + + string - $withData - false - boolean + $permissions + 'rw' + string - - getRevision - \ArangoDBClient\CollectionHandler::getRevision() - - Returns the Collections revision ID - The revision id is a server-generated string that clients can use to check whether data in a collection has -changed since the last revision check. - + + revokePermissions + \ArangoDBClient\UserHandler::revokePermissions() + + Revoke R/W permissions for a user, for a specific database + + \ArangoDBClient\Exception - - mixed + + string - - array + + string + + + boolean + - $collectionId + $username - mixed + string + + + $databaseName + + string - - rename - \ArangoDBClient\CollectionHandler::rename() - - Rename a collection + + revokeDatabasePermissions + \ArangoDBClient\UserHandler::revokeDatabasePermissions() + + Revoke R/W permissions for a user, for a specific database - + \ArangoDBClient\Exception - - mixed + + string - + string - + boolean - $collection + $username - mixed + string - $name + $databaseName string - - load - \ArangoDBClient\CollectionHandler::load() - - Load a collection into the server's memory - This will load the given collection into the server's memory. - - \ArangoDBClient\Exception + + grantCollectionPermissions + \ArangoDBClient\UserHandler::grantCollectionPermissions() + + Grant R/W permissions to a user, for a specific collection + + + string - - mixed + + string - - \ArangoDBClient\HttpResponse + + string + + + string + + + boolean - $collection + $username - mixed + string - - - unload - \ArangoDBClient\CollectionHandler::unload() - - Unload a collection from the server's memory - This will unload the given collection from the server's memory. - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\HttpResponse - - - $collection + $databaseName - mixed + string + + + $collectionName + + string + + + $permissions + 'rw' + string - - truncate - \ArangoDBClient\CollectionHandler::truncate() - - Truncate a collection - This will remove all documents from the collection but will leave the metadata and indexes intact. - + + revokeCollectionPermissions + \ArangoDBClient\UserHandler::revokeCollectionPermissions() + + Revoke R/W permissions for a user, for a specific database + + \ArangoDBClient\Exception - - mixed + + string + + + string + + + string - + boolean - $collection + $username - mixed + string + + + $databaseName + + string + + + $collectionName + + string - - drop - \ArangoDBClient\CollectionHandler::drop() - - Drop a collection + + getDatabases + \ArangoDBClient\UserHandler::getDatabases() + + Gets the list of databases a user has access to - + \ArangoDBClient\Exception - - mixed + + string - + array - - boolean - - $collection + $username - mixed - - - $options - array() - array + string - - isValidCollectionId - \ArangoDBClient\CollectionHandler::isValidCollectionId() - - Checks if the collectionId given, is valid. Returns true if it is, or false if it is not. + + getDatabasePermissionLevel + \ArangoDBClient\UserHandler::getDatabasePermissionLevel() + + Gets the list of collections a user has access to - - - boolean + + string + + + string + + + string - $collectionId + $username - + string + + + $databaseName + + string - - getAllCollections - \ArangoDBClient\CollectionHandler::getAllCollections() - - Get list of all available collections per default with the collection names as index. - Returns empty array if none are available. - - array + + getCollectionPermissionLevel + \ArangoDBClient\UserHandler::getCollectionPermissionLevel() + + Gets the list of collections a user has access to + + + string - - array + + string - - \ArangoDBClient\Exception + + string - - \ArangoDBClient\ClientException + + string - $options - array() - array + $username + + string + + + $databaseName + + string + + + $collectionName + + string - - getCollectionId - \ArangoDBClient\CollectionHandler::getCollectionId() - - Gets the collectionId from the given collectionObject or string/integer + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler - - mixed - - - mixed + + \ArangoDBClient\Connection - $collection + $connection - mixed + \ArangoDBClient\Connection + \ArangoDBClient\Handler - - getCollectionName - \ArangoDBClient\CollectionHandler::getCollectionName() - - Gets the collectionId from the given collectionObject or string/integer + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object - - mixed + + \ArangoDBClient\Connection - + + \ArangoDBClient\Handler + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + mixed + + \ArangoDBClient\ClientException + - $collection + $optionName - mixed + + \ArangoDBClient\Handler - - importFromFile - \ArangoDBClient\CollectionHandler::importFromFile() - - Import documents from a file - This will throw on all errors except insertion errors - - \ArangoDBClient\Exception - - - mixed - - - mixed - - + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + array - - array + + string + + + \ArangoDBClient\ClientException - $collectionId - - mixed - - - $importFileName + $body - mixed - - - $options - array() array + \ArangoDBClient\Handler - - import - \ArangoDBClient\CollectionHandler::import() - - Import documents into a collection - This will throw on all errors except insertion errors - - - string + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + array - + array - - + array - - \ArangoDBClient\Exception - - - \ArangoDBClient\ClientException + + array - $collection + $options - + array - $importData + $body - string|array + array - $options + $includeArray array() array + \ArangoDBClient\Handler - - createHashIndex - \ArangoDBClient\CollectionHandler::createHashIndex() - - Create a hash index + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name - - string - - - array - - - boolean - - - boolean + + \ArangoDBClient\ClientException - - - array + + mixed - - \ArangoDBClient\Exception + + string - $collectionId + $value - string + mixed - - $fields + \ArangoDBClient\Handler + + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers array - $unique - null - boolean - - - $sparse - null - boolean + $collection + + mixed + \ArangoDBClient\Handler - - createFulltextIndex - \ArangoDBClient\CollectionHandler::createFulltextIndex() - - Create a fulltext index + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use - + string - - array - - - integer - - - - array - - - \ArangoDBClient\Exception + + \ArangoDBClient\DocumentClassable - $collectionId + $class string - - $fields - - array - - - $minLength - null - integer - + \ArangoDBClient\DocumentClassable - - createSkipListIndex - \ArangoDBClient\CollectionHandler::createSkipListIndex() - - Create a skip-list index + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use - + string - - array - - - boolean - - - boolean - - - - array - - - \ArangoDBClient\Exception + + \ArangoDBClient\DocumentClassable - $collectionId + $class string - - $fields - - array - - - $unique - null - boolean - - - $sparse - null - boolean - + \ArangoDBClient\DocumentClassable - - createPersistentIndex - \ArangoDBClient\CollectionHandler::createPersistentIndex() - - Create a persistent index + + eJztWm1v2zYQ/u5fcQMK2A6cBNtHd+7apS/p0BVB1mAfkiKlJdrmSosaScUxivz3HUlRr5bfErfuGqFALfHueLx7+Bx10a+/xZO41To+OGjBAbyQJBqLl7/D2ekZBJzRSPchUVRCKIJkircwIVHIqURpo/A8JsFnMqYAme6JVbODJNETIXEMXuPgZ/iTzK0mPFcsCowSwM9Hv+CT41YrIlOq0BytWHqae+cnBz0hGqYkwpmV9U+Z8SMnZO4Pq/46lRHVwQRVbqjULMAfIymmOEQBdfAhoLAxEqNFprQyQ1MQUUHkCN5qjAbqKgHDOTClEhaNjYTRJHEsRSwZ0RROP3w4A0n/Tag1JYpW1opfPUoBJ0rBBRo5TddFbzWNQgXpfetLq2UUbMjMdQCK3FAgLo2pEzZEgeCcBpqJKJX0Ch8mTMGMce5UvUJRWUGubSNixUkYMvOEcD6HMa5H58oY0inGCkeVn2ckpB0PEilNqkKiyZAo2uiOnkgxAzbKrQYkioSGIbWuhhXN51ZBwavbgMYLForRl2QKSkuTwSfGokEhHOKcFOxPUZiMKAyjEz5yXuE/RCH6LeT8qGJ1ym5pCPAkxozN8Edq1QXDPBMyLJt8O4JI5GNoXMU0YCNGw571gk5jPffu2ogMrcGwaW6CCbqhdm4SgYhdcmDEydhtCD8BBnhCcQqZrxand+qpY7rsjc9JSEck4dqCQya06gmRkszRE4SpJFDzxA3PmJ7gzyFDGTkHJ2vQAGQokhxER9X8SaoTGcFQCE7R7KF1oWcQ4tAhEh5WweG3ld1S9smx/T9OhpwFMEoii2oDZrPPOhkselkuBxAlnPey+Gb3znN327VWv7g58LJ2Xnpa8hfK0pnd0J3u08Wyh8/sYoxs5kujaOZh6mujYOZ6uohGwTRzg3R1BTmboeo1qOqPqX7BuVldrmngY0dORBQ5Ful00XmhdOdCctXvX5y/u77469V5zwv/o0R0TaNAhPR6JpFmTWqMB92iZY3wyUNuruPjMi0pqmuEBCxaSESqZMl7bXjtLFcuAaRhYfjgZWqz0y3k+Q4JDCsSdK4yisIwdwtLuMvXloLdQNxZuKtR/TmNuamguBfoLRYwwxPGO9wSIS7Mbl5btLQrm8brRraVqbGsYGQ1tVQQ12PrTDdn7NT+1yPtHpKcaKt0MQa86OpY2Ootih49svu+sbsxzGdkrlKGrwFMUrskxL2UQi4l9jTL+0Lu+8zY+QSS1/RQEbn6lHJk0n5/mDAe4n2Nvy+zGH8sWmwqAYnumNk25P1F3Fglx4s4NKfyVdzo4biUGxNna1fU6MzvETOmDj0S4/+ZGF2S94UXm+kOF9Yxk8FPg4w1u5Vj39oke9dg1k26wmyzj01mbbBWWPUBrdJ34SxoCXkn/GvOo2sw8OKKsTEnv8HTODIBbmxeYdKtaHkVr7r+T1ht+zwYz2Y/CwTXsHkN+s0La62CLPdx8c7F+Odbtr4HffG+F2AkVTG+7li0N7/mWOiU3vUsoQ1yfSv2hzIaRTHHjQolL9vXTL2nszYMnsGIcEU/FgWvfaRObC8s86b8/GkVhhW9fj+QFNnuNUb5hWFjd6joZY50GzF7Tqci66htANOHhVWvVMttVWMqrdYh5XTB8WFn52kTj3LZqGIQ38LtLo0RBQbOpn84Ra5hQ8YZFnffChQ8hFig+TnYaOAyfPkDe6jAZxYjJUjcmwxrBgzLReGZnc7YSQnRzb8GjboM1DbDWpRo+6bnx3+XOhSYWA84EyviTyVBU9d0W7SZaymRVTX9/O8dVv0x0z9egwq3B2RmKaSIrMAcUY3rxQZ5v28bNr79clbq+ihNSbgU3Eu7PcWlVxHvaafQNFrgQ7O5HeNjD2BQtVBcDloo3qYin+Tsk10eUnd4OJMMX8E66Um828NhURgWEZ8vAdzqrG+Srl7Z/QG05axdK8RpKbwsHf7adjJb7J7U/kiC172Zrgdt72q74vY3fiM/pzfiM61h2QH4key2ITtpQ7ot2znt+9Ndoxdb8N0jSB7iiLZxPjblrnYkItr+EVhr0wLc9Hf2dXB3H+TBdmU4d7eC33xg02K+F+X8JHN/zYJeDsR3WuFr63gs+d/Rrvo6deGeO2OfS8W+wf8NdR+VAWdKFyGk/BdaE4OCIKDKlJSddpAaMOb+NlFEt/0yL2vR5B5n3adFPjc2Kv0pRO2iY1mEwlfsXvrTr5G+bKMsVrD2x/VRkGN0PRzs+KRaTHMDSkpmV+Y655V39Iby9U+dDwKEZcfHHwYXD1XzFmBj7Vpnv7Fq+up0M2QtqlnLsbW6bu0CbMsL0DdFH/6znxNfE86I6pTaCHYAl3WFySBjGqmr9PPk4VVBro2z/Qcr0Cf/ + + + + ArangoDB PHP client: AQL query result cache handling + + + + + + + \ArangoDBClient\Handler + QueryCacheHandler + \ArangoDBClient\QueryCacheHandler + + A base class for REST-based handlers + + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + - + string - - array + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string - - boolean + + + + enable + \ArangoDBClient\QueryCacheHandler::enable() + + Globally turns on the AQL query result cache + + + \ArangoDBClient\Exception - - boolean + + + + disable + \ArangoDBClient\QueryCacheHandler::disable() + + Globally turns off the AQL query result cache + + + \ArangoDBClient\Exception - - - array + + + + enableDemandMode + \ArangoDBClient\QueryCacheHandler::enableDemandMode() + + Globally sets the AQL query result cache to demand mode + + + \ArangoDBClient\Exception - + + + + clear + \ArangoDBClient\QueryCacheHandler::clear() + + Clears the AQL query result cache for the current database + + \ArangoDBClient\Exception - - $collectionId - - string - - - $fields - - array - - - $unique - null - boolean - - - $sparse - null - boolean - - - createGeoIndex - \ArangoDBClient\CollectionHandler::createGeoIndex() - - Create a geo index + + getEntries + \ArangoDBClient\QueryCacheHandler::getEntries() + + Returns the entries from the query cache in current database - - string + + \ArangoDBClient\Exception - + array - - boolean + + + + setProperties + \ArangoDBClient\QueryCacheHandler::setProperties() + + Adjusts the global AQL query result cache properties + + + \ArangoDBClient\Exception - - + array - - \ArangoDBClient\Exception + + array - $collectionId - - string - - - $fields + $properties array - - $geoJson - null - boolean - - - index - \ArangoDBClient\CollectionHandler::index() - - Creates an index on a collection on the server - This will create an index on the collection on the server and return its id - -This will throw if the index cannot be created - + + getProperties + \ArangoDBClient\QueryCacheHandler::getProperties() + + Returns the AQL query result cache properties + + \ArangoDBClient\Exception - - mixed - - - string - - - array - - - boolean - - - array - - + array - - $collectionId - - mixed - - - $type - - string - - - $attributes - array() - array - - - $unique - false - boolean - - - $indexOptions - array() - array - - - getIndex - \ArangoDBClient\CollectionHandler::getIndex() - - Get the information about an index in a collection + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler - - string - - - string - - - array - - - \ArangoDBClient\Exception - - - \ArangoDBClient\ClientException + + \ArangoDBClient\Connection - $collection - - string - - - $indexId + $connection - string + \ArangoDBClient\Connection + \ArangoDBClient\Handler - - getIndexes - \ArangoDBClient\CollectionHandler::getIndexes() - - Get indexes of a collection - This will throw if the collection cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed - - - array + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection - - $collectionId - - mixed - + \ArangoDBClient\Handler - - dropIndex - \ArangoDBClient\CollectionHandler::dropIndex() - - Drop an index + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection - - \ArangoDBClient\Exception - - + + mixed - - boolean + + \ArangoDBClient\ClientException - $indexHandle + $optionName - mixed + + \ArangoDBClient\Handler - - any - \ArangoDBClient\CollectionHandler::any() - - Get a random document from the collection. - This will throw if the document cannot be fetched from the server - - \ArangoDBClient\Exception + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array - - mixed + + string - - \ArangoDBClient\Document + + \ArangoDBClient\ClientException - - $collectionId + $body - mixed + array + \ArangoDBClient\Handler - - all - \ArangoDBClient\CollectionHandler::all() - - Returns all documents of a collection - - - mixed - - + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + array - - \ArangoDBClient\Cursor + + array - - \ArangoDBClient\Exception + + array - - \ArangoDBClient\ClientException + + array - $collectionId + $options - mixed + array - $options + $body + + array + + + $includeArray array() array + \ArangoDBClient\Handler - - getAllIds - \ArangoDBClient\CollectionHandler::getAllIds() - - Get the list of all documents' ids from a collection - This will throw if the list cannot be fetched from the server - - \ArangoDBClient\Exception + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name + + + \ArangoDBClient\ClientException - + mixed - - array + + string - $collection + $value mixed + \ArangoDBClient\Handler - - byExample - \ArangoDBClient\CollectionHandler::byExample() - - Get document(s) by specifying an example - This will throw if the list cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed - - - mixed - - + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + array - - \ArangoDBClient\cursor + + mixed - - $collectionId + + $headers - mixed + array - $document + $collection mixed - - $options - array() - array - + \ArangoDBClient\Handler - - firstExample - \ArangoDBClient\CollectionHandler::firstExample() - - Get the first document matching a given example. - This will throw if the document cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string - - mixed + + \ArangoDBClient\DocumentClassable - - array + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string - - \ArangoDBClient\Document + + \ArangoDBClient\DocumentClassable - - $collectionId + $class - mixed - - - $document - - mixed + string + \ArangoDBClient\DocumentClassable + + + + No summary for class \ArangoDBClient\QueryCacheHandler + + eJzVV9tO20AQffdXjBBSEpRAW6kvplDSEBFVVAqpeKigitb2ODFd77q760KE+PfObpz7BdOGByzFt9k5M3M8Z+x8+pwNM887Ojjw4ACaiomBPP8C3U4XQp6gMD40ry7hd45qBAp1zg2ELBwiDJmIeCIG5GddzzIW/mIDBJiitByAM7LcDKUiG3xlAr4bxJQJ4UyhzEYqGQwNtKZnH969/1gHoxICFBou0qBTJzOXA4F1uEBF3iPyPvI8wVLUFBuXwh57XsiZ1nBlU2/ZlDs2Y1SADwZFpKG49h49z2bmOLDbAVxwGTDOR2ByRfGlAEMVryei8Jm4npmhkvca2g8hZiaRojAcuWOWBzwJIc5FaG2AggUcqzVnfBwvpW0/VxxO4FrxDvIMle8HecIjuq7ST/v+de+yf3Xd7v3ot5qtTrsON5VMSVppEtSVn7XjGZQZJrpxOkDTkkKgC1utNU6z3FRtmPpkxZ2Woo8ilBH27xXLCKx6U0npsgInp1CRgnAL4CfvWcri+LU4ixL9dkiL43KsaTR6C2FgJERWMxFY8B303LlD+0Zgb4LIcfELXC5R2eLI1FYOY5pA1hzmStGEgIgZFjD9f2yGNuwuKCxDW4QcDTrmpjzY/TIXPRyr0FZLlSp6LBArmbobY2bGlCTiX9mY2pWLBUwpNoLGNBwhzwVaoHAtj1Rre+y6k34s0lhsxqIbTjbySzcm5E69ivoKZ7fmq7bLNzViM7rLdaHmgdP3poaciealpGdMsRQK0vdnOM7emHvMG+IdTpC2b8aphnN5Ty/6OXfCExAg5BojvxxUA1L20HPZaN+eJ2megsjTgN7IMi4S1WXzYmZTkfcJ5zCUPCoHRRUtt/7zldBY8mEmsTVZUEdLW1dcLwdKi90rIDFLo/4QulLrhCY2/GE8J+6ZKpnonhR7ddrHMR0owN4Ydu9wm4S3DjtKsTttgupK960IN5DRqGtbVVvRzRbOycuJ220vUPiSqDMpNG6Rdam3zVyytQ36d3FKTID58btz6Zd+WIOFh7V2qL4y78+M0010PhWf7n3GE6arKx/wvu/MdajcTv4i3BYf/8HtyuoK4f4FYBu70Q== + + + + ArangoDB PHP client: http helper methods + + + + + + + + HttpHelper + \ArangoDBClient\HttpHelper + + Helper methods for HTTP request/response handling + + + + + + METHOD_POST + \ArangoDBClient\HttpHelper::METHOD_POST + 'POST' + + HTTP POST string constant + + + + + METHOD_PUT + \ArangoDBClient\HttpHelper::METHOD_PUT + 'PUT' + + HTTP PUT string constant + + + + + METHOD_DELETE + \ArangoDBClient\HttpHelper::METHOD_DELETE + 'DELETE' + + HTTP DELETE string constant + + + + + METHOD_GET + \ArangoDBClient\HttpHelper::METHOD_GET + 'GET' + + HTTP GET string constant + + + + + METHOD_HEAD + \ArangoDBClient\HttpHelper::METHOD_HEAD + 'HEAD' + + HTTP HEAD string constant + + + + + METHOD_PATCH + \ArangoDBClient\HttpHelper::METHOD_PATCH + 'PATCH' + + HTTP PATCH string constant + + + + + CHUNK_SIZE + \ArangoDBClient\HttpHelper::CHUNK_SIZE + 8192 + + Chunk size (number of bytes processed in one batch) + + + + + EOL + \ArangoDBClient\HttpHelper::EOL + "\r\n" + + End of line mark used in HTTP + + + + + SEPARATOR + \ArangoDBClient\HttpHelper::SEPARATOR + "\r\n\r\n" + + Separator between header and body + + + + + PROTOCOL + \ArangoDBClient\HttpHelper::PROTOCOL + 'HTTP/1.1' + + HTTP protocol version used, hard-coded to version 1.1 + + + + + MIME_BOUNDARY + \ArangoDBClient\HttpHelper::MIME_BOUNDARY + 'XXXsubpartXXX' + + Boundary string for batch request parts + + + + + ASYNC_HEADER + \ArangoDBClient\HttpHelper::ASYNC_HEADER + 'X-Arango-Async' + + HTTP Header for making an operation asynchronous + + + + + createConnection + \ArangoDBClient\HttpHelper::createConnection() + + Create a one-time HTTP connection by opening a socket to the server + It is the caller's responsibility to close the socket + + \ArangoDBClient\ConnectException + + + \ArangoDBClient\ConnectionOptions + + + resource + + $options - array() - array + + \ArangoDBClient\ConnectionOptions - - fulltext - \ArangoDBClient\CollectionHandler::fulltext() - - Get document(s) by a fulltext query - This will find all documents from the collection that match the fulltext query specified in query. -In order to use the fulltext operator, a fulltext index must be defined for the collection and the specified attribute. - - \ArangoDBClient\Exception + + buildRequest + \ArangoDBClient\HttpHelper::buildRequest() + + Create a request string (header and body) + + + \ArangoDBClient\ConnectionOptions - - mixed + + string - - mixed + + string - - mixed + + string - + + string + + array - - \ArangoDBClient\cursor + + string + + + \ArangoDBClient\ClientException - $collection + $options - mixed + \ArangoDBClient\ConnectionOptions - $attribute + $connectionHeader - mixed + string - $query + $method - mixed + string - $options + $url + + string + + + $body + + string + + + $customHeaders array() array - - updateByExample - \ArangoDBClient\CollectionHandler::updateByExample() - - Update document(s) matching a given example - This will update the document(s) on the server - -This will throw if the document cannot be updated - - \ArangoDBClient\Exception + + validateMethod + \ArangoDBClient\HttpHelper::validateMethod() + + Validate an HTTP request method name + + + \ArangoDBClient\ClientException - - mixed + + string - - mixed + + boolean - - mixed + + + $method + + string + + + + transfer + \ArangoDBClient\HttpHelper::transfer() + + Execute an HTTP request on an opened socket + It is the caller's responsibility to close the socket + + resource - - mixed + + string - - boolean + + string + + + \ArangoDBClient\ClientException + + + string - - $collectionId + $socket - mixed + resource - $example + $request - mixed + string - $newValue + $method - mixed - - - $options - array() - mixed + string - - replaceByExample - \ArangoDBClient\CollectionHandler::replaceByExample() - - Replace document(s) matching a given example - This will replace the document(s) on the server - -This will throw if the document cannot be replaced - - \ArangoDBClient\Exception - - - mixed + + parseHttpMessage + \ArangoDBClient\HttpHelper::parseHttpMessage() + + Splits an http message into its header and body. + + + string - - mixed + + string - - mixed + + string - - mixed + + \ArangoDBClient\ClientException - - boolean + + array - - $collectionId + $httpMessage - mixed + string - $example - - mixed + $originUrl + null + string - $newValue - - mixed + $originMethod + null + string + + + parseHeaders + \ArangoDBClient\HttpHelper::parseHeaders() + + Process a string of HTTP headers into an array of header => values. + + + string + + + array + + - $options - array() - mixed + $headers + + string - - removeByExample - \ArangoDBClient\CollectionHandler::removeByExample() - - Remove document(s) by specifying an example - This will throw on any error - - \ArangoDBClient\Exception + + eJytWvt32sgV/t1/xcTHXUQC+HH27La4pCZYid21wQdwumnscgYxgGohUc3INtvkf++989BbGO/WJyeANPPNfc2931zpr39bL9d7e4dv3+6Rt6QbUn8RnH8gNxc3xPFc5os2WQqxJkvmrVlIVkwsgxmHsTj8bE2dB7pghMQze3KSvEkjGBvCPfJ36pORYGxFfV/ecoL1JnQXS0F68beTo+OTBhGhC4A+J59W04sG3PaChc8a5BMLYfYGZh/u7fl0xTiszXLLnsaKXGTEJXOQ42I8viEh+0/EuDgMYX7gc0aW1J95rr/Ia1SiD3d9B1U9ap1IMRyPck4uwDpqtb3/7qGyUgL8e6uWvBmMxoSDXv6COLCmoIgnBxzKT3mRXNvji8H5RI7ukBp+1kCfUsTb1wDeKrzbSrhz+8oe27sj6vEAqr5V4X6yXyEmDgZE+KiCu7C757vjydEAiJ+VduyOexevsKQcjrbELyWgvWXkPxDu/saI5UerKQRgMCfTjWCcrMPAYZyzGXF9EviMTKlwlvWS1XoXt/1fJqPLf6KJ/3z8l5PiQrY/Q2SIW0ZWNHwgkQZGtUog7cEVYO3fhXf+fhFtxNY0pAK2yJSJJ8Z82Ox0BsLD1iDTYLYpQRzZN91hdzwYGtwKbGln0F0ETuCRRxZyN/CluA3YeuGs6QQzEF0E8b3j1nHJejfDwXjQk2rUEPMQhpV5IGRUMELRwk3hrpgSADB85giEn25IsGY+epwSHjgPTODqYskIZyEIoaEM4qUgLpe3Hep5LKxxonOHO3U9V2xwtuMFkEokhkTMYZyJZRg8cUhmUgz72WFrFCY/DN2wMqPg/kCO4uQg0F+aaU30xTxIyEQU+ihkEIWQr5pGyydXLLWOKZgGXPc8IiUkT0twvh+kV3EgdU8ZgZxJp57Ll2yW8c46gqsO7CEq4GMe+XqW9EOiiVWtlNoCKnXi3wHzZ+vA9QW42oxpvl8w0YvCEFKxrW9b9dNkDggs2DNOgd3M6GqiL0yUIDg2HuzOiWVA2m0AHm/WzIqXrZNOp0OSAeMvN/ZkNLqqp2SUUXcIxhSgcgh+DwmMMB6R1QaDwUBm5uUEBIyJmmcZLRqkxrlXgw9wlTvfTNYM4q4RW+NrwZjt9uBmfDnoTz7bw8uPXyY9ezi+T9kH/85+58ITLLavXn3S717beRFeIwFstuAJhnjzCXeBAcx2E6F7dTX4x2RkX32EDPqpb5/nZcj8wFBw+URVAOtsB/xed/Lx8go0y4fDa/Vz6Nz1drRrvGhWle97BWV2Abu8ubCHo3vyBsLcjzyvTBMIbgxox11DbPM/pqjC2FFTLVxB0xKdD+Zr2O8mrFWSmyjOamVmJ3vZD4BEelCfU9u9kRl7wMKwH+SuAdnkwAlzV1/WZnx5bQ9ux/fZiaPx0O5eT3pXl3Z/POkN+n27N85hayvGF/P56w0on/ebSuE+eyrUGavgQAg/3w+ESfRYw+K0e1erkVZhRpKWW6R2V2sTGJRYRtstMyvlw5TXjLvAV1ifg0hYoMtOwWHMmTaGrnYAoVb7XqAEH4LIn9FwY3geJmfJvcxZgEDZFaaMZmgfrDf5MLjtn3eHX5B4/Prrrzya4nD4VklTFXfCZVb0QfIMrNUMGBZWRso3vgOe8oOobM3u6Eu/J8mrPZRLNtVBpNnFedsYj9FGq2nlOJxhmruTjfhvC+swMHrRdLwkc7RFmsADWROOTGw19YDzaQFTbkmmvAyvTnapK01lfnX95flR6GXi28y/HV69PBkNmpus7EI9aWzcT+uAixwSDUOanXfgRFwEK2UhrpDglKtHYhagruSq2ljMYyvIb1WkT4sKGLGV06defb9AS2XOrGClW2neNHK92VCBb6F4jWI0NIwHG9IVDWXThlY8Z5YO+Xqfp4kyCya1W04vFOVUSszqaNUu/UeoBDMC/0dMJQVAaBH7eY1yghUVcoMsIE9isgOmKCRTVEuVZrcDj/kLoNmSh8J3PTiXvXfIdR/wiHkvqagII5ZXTBUIX1JXTBM99bOJv9tkFXnCxTR1CHqtmjMq6Cmop/JgB3VBXtVuZxOcuQqHxZRuEHJwtNm+eu20hIloS7wnR+SHH3ZJ71JlOFWOldpzCgtXcBNYQG4zOJlBIYEjDBy8lkHkzSQlp0TL10R/6a1TLGhbTUjXawh4mbIP/80Dv1ZuHuX+skBIR7C2kbkHTmEU6o+VC3MKO0YJ+wvbkM578+szhmgxAtILtDrpqVChdX1OAVT4NxEZ7Dp3IYN5mzh9yFOMTh6JaiabQJCvYYuIuVX7EyfyX62wr9Wa5vhezzGLYpVoKUmAnIAXxBI8jM0SSDxQo9URFsopqLDNGNXBmr0Vi298fyVjtq0VURFcTxsu+z27DkZkCTPR1qqiJ58xC8kK7mdztS5wePqqaidsy9u56mXqZXMbrhZ5GgQe1hDviW64TD+ZJgFsPpDV1fkzBSe3Y4QbZ7cmwaNW/VpCWFrEskRvpMe8oFNXqlv67VuerlcMvt19rO5x7jocu5e7jpWdyZ1lxqSYHANySUA7DF1UuqV3qH+5cJPkPxZHUv1avSp27WfmRCWhizRXcl44tpd3xP4vXTUV4HGj60D3ubJ8VV+0VpAhsJGFUtXL90gqtSHEau0xwbKaQYqmeRaVxzDMNENIVYfWYq1Fi+xjBOwXCPnWXV2keFou/RhDX6ay0fzoYk91uil2NbfuRwEnDT5noaUt2YjtEWf1KhZmnGCm/h4mpj2FhqqVsyssS6FIdWyMfPU0wzqbP4WuYEUtUqBn87kX8WUs7mm6cqtioGoBXlFtklS3kUmOyGbxkMIIEQjqDaEcmSsdcpRvV5olbgKubqcrLAcKl6MNB3M3hBAkHb3f4xtPSxdKtaXvf/tG3sxZMK90BaCDXB2wAX5JzKTyTvL0IdeDkXlYTTXsDNdKLkGiKGFrU7j/sLVvlTLWu4Q3I2y9jFdKLctWSqwmJ58WB8QGlNLnhCojumnYViluWQ8uG0Cd7W02Z8mcB5xnOKvmzfrA5+KGZhwfQZbNPj4BbVZwRFxFKxLM50h/LbfFWsaO++ZhCXl+ft6vk2YZCp0Lhh1rKpBJO5pIM7Kflam9XzTOWgYvbkf4ZmlbYdcvO5MAnzo+yfszthiivNnG+eVaJRvTkg17Hk1BgmR1ifeOHP8Eix7VT6WhfkrOZHm1iMnFWxdU29RA/6xQf4ZLAA0XJE2duQu3xFGxnqkqrx5MVumqHRM/tpacQacxOE4neV0RM1UGZtugJHXGeVAf8Ml4lvKqY3ADDvRCIm5D6g/GMfEAPHlsrhyf3wzpNJj++164+v2V+8y0s+VpM5eht+1BydtHeL5QEZKJ4+TRZqMYDvWiKlKuBPDlmE7GQu77UQbVj6lIjZeviNC8nhnAnMRFaV82cQ4/Y+Mkbb/v5CXZuRKULJ4cnNAHVdxzBMcMOBECz5Svp+hGNBxLgDjijVz7s7X9dIQY1xqCjCGqM6BqVKtibhDCrvdvVT8R56oL1MNeoj5Ba5YG2Rx4pWx3hsFqK546FEm8NI1USRponuST8nktFIcZTsQ2j3mUrTBSzcxXskzZhtuFM4LonF0k1rPSpmykjaMip5HTT+/LHK3UUkBMecGMWYqZxK8cNEh2kZPKA8qNeuki5uz40oS05lK3XGS4UK0v3tVh03mvMiJ/KW40TlNa3fzKHBD+oGkVpGVWKjwtR0v0wEglJFQTF1JyK3kbBXurqbIc96aM7ZPXm2TToxHrXJf9KnwFpa9edcGGFf7M733VDUyNgyRyVMGGFEOT77WAM7QC2FaA5OLSYllCbOBHi8kKn+hY+4f/QvfeHd7N3t218D/+zoKP+iHmb4TFkwwOZbz0CW7WpIZfmClfj+9fSqJpw3fUkjvyTNA+kG8S4Bxuev/kgW3aMhSbnvsQh1jZbIzAeYCPzTE0XYx68Bp2gCm+t4YN2JX7m3oKBVG/AKoYuvgeURWYeArwdbwVJxYcMSAoaMhwTzI4pT8ydD+M2uirshMAaI866eKXOil1mCmyyh/Yqqy/XCk9lwvrAKwBHnxUDdFOnCBqkmBqwJOSulxp9R2gX0Au4cRmc30FTUUADsEzNeDX7zEm5BK718GvcTw2SIrhmjXuTe6DmfKFxAkcpinP7Ft5HSx9Z16uvNNvN07vkmF45v4fBozSrQ== + + + + ArangoDB PHP client: view handler + + + + + + + + \ArangoDBClient\Handler + ViewHandler + \ArangoDBClient\ViewHandler + + A handler that manages views. + + + + + + + OPTION_RENAME + \ArangoDBClient\ViewHandler::OPTION_RENAME + 'rename' + + rename option + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection - - mixed + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string - - mixed + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string - - array + + + + create + \ArangoDBClient\ViewHandler::create() + + Create a view + This will create a view using the given view object and return an array of the created view object's attributes.<br><br> + + \ArangoDBClient\Exception - - integer + + \ArangoDBClient\View + + + array - + - $collectionId + $view - mixed + \ArangoDBClient\View + + + get + \ArangoDBClient\ViewHandler::get() + + Get a view + This will get a view.<br><br> + + String + + + \ArangoDBClient\View + false + + + \ArangoDBClient\ClientException + + + - $document + $view - mixed - - - $options - array() - array + String - - removeByKeys - \ArangoDBClient\CollectionHandler::removeByKeys() - - Remove document(s) by specifying an array of keys - This will throw on any error - + + properties + \ArangoDBClient\ViewHandler::properties() + + Get a view's properties<br><br> + + \ArangoDBClient\Exception - + mixed - - array - - - array - - + array - + - $collectionId + $view mixed - - $keys - - array - - - $options - array() - array - - - lookupByKeys - \ArangoDBClient\CollectionHandler::lookupByKeys() - - Bulk lookup documents by specifying an array of keys - This will throw on any error - + + setProperties + \ArangoDBClient\ViewHandler::setProperties() + + Set a view's properties<br><br> + + \ArangoDBClient\Exception - + mixed - - array - - + array - + array - + - $collectionId + $view mixed - $keys + $properties array - - $options - array() - array - - - range - \ArangoDBClient\CollectionHandler::range() - - Get document(s) by specifying range - This will throw if the list cannot be fetched from the server - + + drop + \ArangoDBClient\ViewHandler::drop() + + Drop a view<br><br> + + \ArangoDBClient\Exception - - mixed - - - string - - + mixed - - mixed - - - array - - - \ArangoDBClient\Cursor - - - - $collectionId - - mixed - - - $attribute - - string - - - $left - - mixed - - - $right - - mixed - - - $options - array() - array - - - - near - \ArangoDBClient\CollectionHandler::near() - - Get document(s) by specifying near - This will throw if the list cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed - - - double - - - double - - - array - - - \ArangoDBClient\Cursor + + boolean + - $collectionId + $view mixed - - $latitude - - double - - - $longitude - - double - - - $options - array() - array - - - within - \ArangoDBClient\CollectionHandler::within() - - Get document(s) by specifying within - This will throw if the list cannot be fetched from the server - + + rename + \ArangoDBClient\ViewHandler::rename() + + Rename a view + + \ArangoDBClient\Exception - + mixed - - double - - - double - - - integer - - - array + + string - - \ArangoDBClient\Cursor + + boolean - $collectionId + $view mixed - $latitude - - double - - - $longitude - - double - - - $radius - - integer - - - $options - array() - array - - - - createCollectionIfOptions - \ArangoDBClient\CollectionHandler::createCollectionIfOptions() - - - - - - - - $collection - - - - - $options + $name - + string @@ -13614,23 +14057,23 @@ This is a convenience function that calls json_encode_wrapper on the connection< \ArangoDBClient\Handler - + includeOptionsInBody \ArangoDBClient\Handler::includeOptionsInBody() - + Helper function that runs through the options given and includes them into the parameters array given. Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - + array - + array - + array - + array @@ -13651,19 +14094,19 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\Handler - + makeCollection \ArangoDBClient\Handler::makeCollection() - + Turn a value into a collection name - + \ArangoDBClient\ClientException - + mixed - + string @@ -13674,6 +14117,31 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\Handler + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler + setDocumentClass \ArangoDBClient\DocumentClassable::setDocumentClass() @@ -13715,1385 +14183,1433 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\DocumentClassable - - No summary for method createCollectionIfOptions() - - eJztPWtz20aS3/0rJi7VktqiJCe7dR+cyLu0RFtMZEknUnG8jkoFEaCIFQjwAFCybpP/ft09D8wMHgQo6mEfWanYBjA9PTP9np6en/4xm8xevNj5619fsL+ybuyEV9H+W3ZycMJGge+F6Ws2ioLAG6V+FLKJE7qBF8On+PU/Z87o2rnyGFMN96gNvXTm6SSK4R372QnZIPW8qROG9GoUze5i/2qSsj31tx9eff9Dh6WxDwDDhL2fXh504HUQXYVeh733Ymh9B613XrwInamXQN+e1e2PahwncXTju17CoBHAm8JLFo21kSRiCMOJVzA+NvbS0QSaa69cJ3XYOI6mLIU2iRffwHfwOUIZxZ6TGp8nDJpkH27XmrHED0f4irFX2z/QUEeBkyQ4CwLsgcDP+5J6oZsw8e8X/3nxApvR6PH3V+ZGozkOO2FOHDt3zA9d74t4uUN/jgDLlPWOhqefLvaP984+wF8HbJe1VNPWjzmw2oTMnBjWIUVqyEE9Phn2j48u9o4PD3t7+FeEm7UtAOx9caazwKsDtfdb98PJYQ9Bilb3g3fU+3jxa/fwjCCG3u2vTjC/J8i901532LPHT1SyVzULTgoMcDlPa3XSHQ5P+2/PhoS3alkA9dq7S+oA/KX3iQgAvy8AE3jjtA6Yw967IYLB7wvAcHavAee0//6AAFGLImIMosRza63H4fGgt0+LQG2KRuekfjp3a838YXfYH57t08TLdkUgo/CqPszjo/cZUNmyAKrrJ6mDgqIG0P3+YNg92iOYsl3RkjiuP69FIqfd/f4ZEQlvUwAsufZndUANfumfICD8vgAMCaw6cPpH+73fEBC1KFoGf+rXI9z+hz6nXGxRAGnse4GblAN41+8d7tPs8C8LQMxD/3/mXjmIs6P+f3NJxL8sAJHezSoADD+dUHP8qmh1/P/1WDRD+VOxNP1/EQz8uADGlReJ5VkE6H3vOFsfaFYM7OcE1EkNUD8PuCAVTQqATZxkUhO1g+7gIMMNGxYt+DwIUlC2NWG+Ozs8HPZ+G2ZwJYAC2FM/PPTCq3SyEOyHPgrVo/fDAwSp2pXwXgB8XhNfZMFDEBEZvhJAAeyZFyfwBk2petBPeqcDAA5mRQY/A1KEPfBo4tXF/aR7OuBUSs0KjZU52n0LAO0dnx0NuX0yL0QLuDC+WwgGuPb0E4Khz4uwmXij62Q+XYzQQW/vl8HZB8JJNCoS2t6Nn/g1OOe092t/IGwQ2ahofeMIVif1wY5duLKnx7C4w36PZF3WsFBkXs3jGiDf9d+fnfaE7KQmhQrVcRdCOjzu7nMd6hTp+T1hqzsMTD3dnjUMdvG1bDSc+Am79YOAOa5Ln5U1RJcAliadxyHzwfr23QwGkLbLfHRK/DC4E1+BATMGN+kSHINbJ3bRiZjOwKa49AM/veswsOnYXTRnySSaBy6bA4NY/aM7RDDAQQKgYy/20DxII+vD7eIRpZM4umX+2AY7Am8tStmlJ9wb15qTf1LDhPW+jDx9SdR70rgg5r7AEDc0wFvG5F3+G/6GyGYdWTOKI2MJmLfhFWAM8hLf4aCtnrijs8HpI8FXWzAl4jF4f+LFtmxW+vtp9uZYAHFij73+6TJ+s7hR4L/hStd8vsV+YFtvWBiBAxtoI++wv+Fzz73ytrKnP+0AmHp93Tp++i6KB3fhqKX6gmVMPJrONJ6D3wxTBTMAqxx70+gGEEBWdfjYaPX9EK3CFMgR5j8BWLCooY9mNcAAk/Ga7bA+0gaQC/yHFJHMvJEPBo4rwJt000qY642deZASOAA7cW58WEPqDjpxZqBhPHe7wVD/HQGjOMEAzRE1VO0hu0GXrQlEPxncgRqaaou1xcZOkHhbb4DFYm1AbTGczQ7N6dabhFrqRNys518j9BmCjFBUz5qKrej/RrRnbT/cmsK6xneby2IDrp4gdQ0beCiZBakA5qMJyHA+vfTi4/FgguKsxUHyh8iFCT0meWWJpwZ9EJBf0E1Vz7cyRqe3NArlFSdNoMceUOiIuOSdM0qjuGWMQLymubn2vBmTK/Safb/ZeBQg1QYpsKR3ddfCUciHKPHoqVgC4FRweOdAHXHdPnZmb2yZLDQTF8pbqI+MsJgl6rl2nc0vYbxgC4f6N+0NXZZZsneXfT7fpMb/eSHRAdHU9pMLLsj11pub2lf42yCNxn+7uur40fxMw3uXtHkWW2lvln4LDOylR9BDm/qxPgS69JzRhLXVWGChN5CWdt+wDZIzNro5+P9pQQ8tts3mo7EfJ2kb22/+2RbNzQ7/fJH/G06VAfHKSz9m4r69yXZ3YcTgW+Smzhqn3moDhTjB2ovCkH/Emb9tP0hevxbW1Mduf3gx+HS0t6nh/eeLSlR/ziRzA1T1Vkuh+vPx2elR95C81wbY9oUqaICqarIUnv0BTCj4RR8aISm1RiM0VaNlEf31GGNdh2XzuYEGD7O4lLoZwgtA9R+vNaZ8/Rpe7HNZyd9nQDfIhiPJYYxJb81j1UfdDz31GpnS6plYe7OzAAqFSXQoOJJFjRQzlHRt8OgiYDq5FgEzuGgRMEVTJZhlRF4Dklz0EkgZJS6C9Uvv0wWnpUEhrF+U9aHDOv8xI7CdHbJnvS+gDKX607R6Jc8cGYYIEON3ZXzDae9zAa2dfXjbO704fncxOOie7g/OCyjd7ubHAoFeieepbW4shepp7+Swv9flznR3b3h8WoRsQV+N8R1YZstS6NJ89o/eXwyGp91h7/2nImzzPZUKTLAsyAYpxhZNxfZm3tCoRo82RErx4jCLxWLsJTOgag/bFkje9ibY+hEYBmdxAOL27PRQ2yrqyCb/TqLwAlz5yPUubmNwm7y4LTBGcazzCPYZRHxdsU/ZP/V7KF4ceI7rGQvOW+L0faea63PE3zMRIiALi3Yrlcvfbu2DCYlO4dgPXaZQmFBXaLIKH14i1Mr1nhHdBg74VJs5YxQY8TUUBnSc/XbN1p9bvts61z62NaPbhvb6JArDGJ7yVn8WRO5rhZ/OjmQAijcoCuDHYEoDQS+ENTw9OwKW5vF80agwEkgG8+I4IKlOigJiA4Rkg/K+gJB1MRJg+bgVux693/YOz/Z7UgHRtixBES52QTd7GNZEwnN058P7As6v7CgfqBphHCPxgjHZESB1/BC0AajI4I6ibjxWKiJZsYoO3YIB7yBwQbOcmkN2O/HBzgdnDsiMb5SH7O+v/g5P/mfuJem2hUcu3MU+UmwlBJcT+2NeHJNPiyEnAhSNRvPYHo6IVS0KiwFxI9oy7AWAuf9Z4s9dRlHgOeba227bxEkMr8tyz0xvSoigqXOtbVgbzTXeSeM7S7ACa2uxxQHJgGziYIVgwqHRiEKaIsoIQ4l970Y6nxItJT7Lete4F+MjmkAGiknRlbP738i5cIivR8E+78sMu4A554sIzrc5xzxWY7QmJekJGe9KCx1aF3mKAhpBsT1BG6d/g72DDXAWjXd8Xjc8W3f/mWe19xgOxICpil9kqSF+aDBgKectDhHzhBnXTpBZxEPFzLFa3gApAe0rpsAcVHXoA7eIVstFquU8DuTfdxkYBgdeABr/9evLuR+48O8SY+GzEYfh4lHf2TrX+1B2CauwTIjXABudyTYo/WmxUuZbbrv8+88F2ORVbhsWaFO0/LGKiv1wjEF0mlvnMpqn/w+Id08HYw2gGu1iArbl6OqUQEa/y1JvMaUuQ6dlZGqTnm7386jmO5jLLvcjENJmJUHqO6bjNTEuQ4wnagq/GqmabX6vUrQ+EsnK7XjaLv7mCZbvSnBa1UfeQOOLZl8NdYo8iqcgzQKdL7Eppck9JxjNA/SFHS1BxqY22xf7KNzB0qZTL3W2CPk2Jb+ie8jdY/IWVeqM7yabEqj1DYKRZiJP/s6ZigtdxCoaN+imn8UymtC7hChdkw1MjzgVg0syiHJY6sPbiUc+KwKMKF3AD7njr4asz5HsrtZPTpNcErlO2oQV4r1PFqb2Ww7vy8i909erEe5VSJcJF/7nKApTxw9xlYjiXkpQL4mwXsrpfLlII+6Jdm2DPDr22u5yD7KjzZ14JMXTCi0z7N+05UWK2nmhMDO6wbhl6J5Q2BJ7w88AessYTot2B4xHHdaSI8ve4r9WYSZKiVXqzOTDf6fUJCHazgR7kvFJfz+nRD2dizB9xhHKcevKCzEPB+SAYO104qTixE2CypUnekWcIhXdS7o2wmYTRzHoaOKEVwiUTpIgqoGTaLxM0O4ltkyhtQrlrHGOQ0kbEttFnCJJxeSUxyB/mVH5ZKRI8d4K+62ZJlpgbtnriX/LZfBZkEUbPZNjizYQVLJiOe5avA3Fa3DrgDzl6Ww5kzT2iK1CHn2tpBge9DbTVngGSLk9ByRurmb2oswPpmAgb+EnvzqB75a1Alq1A4QVGy173OB2AtoB1RcABaMdDYGl07da9L2pbKO9ZG8dhS3Oi75/UraJNU/bxgBWxmCIybm1wVxjX0x9X8BiWXQ4z1KHuLVjTmAoEmi5xG4ljKfalXpKtDuEDa78Gy+sA2pVgvi+TGtz3kGaztQ+3BY7GA5P1Aae2bKY03AmajpM3yKDwVRh9mvF1u8DcQ1uPNo802pVsYTAtYwrzviWpzFuy81fzBdi37SQM8qAfaucwedizRuPzxt8W/5+3GGzx1Du49eKpFEGvkfJ+Nn2k2IAbfbwxAfXKJ5z46l4Btn+6EvS+SgPt65SZ7R4n/qJWGXV5pvMf/h/zDyPzDIy+6QZ0xhWls0x+3E0W5nf8gBuS80jRCqI7OJ41JGaR+IE7LRx9r32PSbIljDHkeUhLcceCOVJGITHmvwvmIPU+tHAPMsPFLO0yf7yF5jyBF1y8ehzdizoPJ8rqAP/h/xwF9P8NX6D2XwLyz0QhxyKADfibdcLPJB5y3E0rsP5JiCocG/Kr3t6ShUzpCvZch0k2hukhe0sQAYAsYWfwssOch2FJdUjjNzmlBZnP0MaVXBTJXsslt0WawjA35na448/2HfF51UAAr6Fd2Ow5tLiV35ovygN5+C+HB3axk1kPGJ64/iBcxnoE57g8Wt1sE6dgtS4gorioNwj80BF2uWqeNNZeidrwYxhDUKe76Q6K1mSvESUPy08v+Q5S/lb6rylaownqcyEQ8CHsY84Rw4/GUjbQiR3KYUwl9uoziYKONpmprTua565MrCiOiqIjI3LS63vl3SKUh56H8tOYZkpIsoXLEEd5sX+yAk6tXHI9UokUqc/XIUi8mo6CeUH0KgfW+v/btZE+t22Ako/tDRKpXgAEdsNAi2C366jPbOX9PUFLMaV1/5sE97uG7ktIxYfHrT47LbOOwpMwbkX6tZUWZn2MHs5p/RCpOeyfHbDjDPTczGd3UqTzHCpt4NTkrQuInDNI+JFyk3sEp1vlsGrTEPjCp9Uu/zuczabtDLnBRpeOaf6SuAvOxRYDo7OCWqWU9EhQd6BrqI/tygT+9w6ZVCZGFrknVqf2ZsKVTkhSV63K+lnB2yO+Wl90OlcLe5gCvZVfounxEwvEQb03SKmLfXgLFa1TqyIA+4jD0TdXunq5BzH7N/80JNrJDzoU6y3LDbtymEXhBzy4L6RVcu5Fo+xbvws4DNauf50FsWpHQBy2NgPPGue7RysiBdyIP8wEccZcJYwfS4SfmPutMHyW7uFmSgL8lAEHJ8G+Q6GRK7mFu2E4whp8492uidR4HIS9sWMOKljp4cU256rsTuXtjlFjY8tolg6/irLYnjEYn7aSmQNjlaLT1UQcKOLn8DaogKDjCczsynm+IPpOeMlK12ZPyPmBadtuzZyP81qfgdmXMmrrIKIVghSq/SBCLUS2rXHdBtCf4JxSqx2k9F14IODcXlHf26zHmpPeiQtbTq7MwPe8UTWgGzawMasNwqij1b1AMTkG0lfCcdLemb6kQEwwxxXGs/OJYZ1jfE2GELdlf0QYYQoHEcoByYgDnQaEQLXwYpB7DaKr5PX7CeHTWJvzHZfTtJ0lrze2bkCf2B+uT2KpjvAxt33vaPBjjSkd279a38Htze4hHr5ZplWP+04NYe9U5dQa1N+I6rJ1+IEhu5LJ5G/tD0gHr9wI4+zOx1W22biODsVA+FxjgaYLPCPAKdYuO9KzinXX+2YKavYrFAraAPWbUpVagl+ScSEy2toiTI7iyWbweHssSnfsxcFjhS9y6fkCOajNDYAcwGq+kI+a1vwLbtea7srM97qhxr74WzOhSp7iaE7W1dts9ZL81jaOJqH7nZJxFHqfhEWJVi5xD2JcM7/q2MfUO5Ag0ztJawES+saP90iq3locYGNwF//IWiFT5lI/eSGApExZnbSq20+QsyIw9pREjraDzxtTjRwRqOI180RuRakmkFEczAUh9SNBTXDhTaHHL1heqwu4HW/iBdJsPpfP2uDRc5Gs8GXvPqKTJcGQ3nW9gsfR6PV/rYsGT4Bdc0Ze7qadNGYtJ6HkSOwz1k6i3/HPNU/K8Plesko9i+5yOme9Nm+oGnafc2ps8TzmFx7oP5k26HFdjkJ/G37+x3M39l5Ow+u+aInO1XWmO1TP0q0WpgURSZZziBDLVrfGCuA2PjIZzqd7QkxVLXjmqGXi7lmkVXNEsBIqhRXRXFUsJfYP2+cOPtKUYKcR/2no7m9mzXaepNGPHIMZt/L3+Pfw5dlpdmsWaaJUkDNRvOQ4s7Za7sSnQock14+t29cyDrX5pkWxWbn/lgWTzJzmjMjM4Ogkn717QsDL/uwdnZzgVG36bxTOBr10M4Y4P1de3cXvLpHmw9bQ9Ne4QRcHL0An5yoIkoYOSCLtOl7nftCG705QiwAVjr5+u8Spv06/4p3zZXzMt3ylrW7/LOQMHDDpuZeTf/DyfHpUN+nycDULVfEd2V0fm54kMF2d3gxZrBSssLtxU6JMPtzx09s9eVa7aQ5v8EL8gtUTfPdqOqfO5rGy/CrhvIkDnZMO6uqhATfURVlmsFMFA35UbUy6KLkeRF0Gx7/1J4esNeuK7Qcabg+TxjcOYBJ3p6k08AGYgUdrJpN6jymqM6sL1NtbVhVShTxIhxt11noML5AHbUWu8JDkbMnao/Zio3wPNb0n53MxMHl9hT0dp+tJFK8nAHZt40ruCkxKtpMpR44gg164FXt9R44iDrRh6IZNIBnVx50skkVU6mjVJqpotjVvBehkmWX5NjGDItlXnBus2sVqB1lz/qhP51PWSCuWxijZ+Em/PhoAf5NeOqdmInnyFcSt1q8lc3bsuykIDSg9+xqC9oBVyBWQu/mdRz3pXm8GmMru1zjWRA9pZaySiXF1YifLNRHCOdR1dFA3DXyHFkHcTsE3NZq6eHVknkLzX3Z1L6mZs2n9+XTEzWjz5FTM+zWvPrwvGrf6XRfblVXiT03t09eS2ZzGL+LQV1apjPpUsz13oueI1cBWrXYSU7Esvwj2jcgb3EPnE7fAshKCFzdWHcvyqYNe5FibVXriGpdMyWi8zqUpW6dykM2Cnpx4Cu96SnHq+Leq1xRJ+QpkWeudJ9xDVSJyhZXDkjO5G3x4WuKInXUJXgdZNOO8lVpCzizDko0e1ZbPicwtFe8Wgvfk3a9sY+3eAX+tcc/brec1iZtOMt/dVgLeL+1WSBtWN4swA2aHb7PghVgpKwUX5m8bmJv8BvHPkmike+k/o1XfoyNz6E+AHnFIkZ/+X6RvGZP5bhvrk5klex9FDErv6dByiFtSVC66Ppd5OHLPANbEBWWiTnJcvHrRcP7rl4kA0tPnRRfY5GLAbOyWyes+mn8QtE3+lCLb0rQzJHycvwZhs2tkpJx6hsK2pu8vDRmmv+tbuhayGO1Qg0PGeix64oSIhnyRnn9DdTkWNc5d+zgQLzQjx6o3QvZyl4D2jf4+6u/5/cMqk5IZmnNvguv8Pq1mDsL12F0G7bsHGf8FewiiM5fNepcqAchh3QpxNw5iagst+DGp8tBQE7z70IvSVrWDlgBbhVHF+psI8ga1wUVgqUCrS51XeoVCluzSH+VtKXueD0/u22hofvkW8x4vMGWtB01jpxJV7ualuDaz4VgH6tyVhGlyPoJX0vN3pXUWeOlPLcyOvQScexvCxONGpbtFd5L9blaTaMuqVCz8qgr1RQPX6GN1zkIizm+ERkQhAMw7wNPGbsT/s+2dTyT7UhZ55bZZg9RikAIDw3RHCEIhHfxdoUAFWZrp9Uxxqav032Owiuhw7v8/AptQvH378/PNwvWtaosGIoLh4FsdYE9VLJJQdEW+/R0ifRQIBrKjocRITUFiMqt2TLHUI05+ycvQvn99g+VJOSEdwvEyIXscS8AbyZjXvN5QdniChO8QgAVm9e17My5fqNT9+hTtb1J1bp1wndlBdyFFZfJ2Kdyyyp9JZ8gI+WWOU8lZcMNQFWGGfoVpepVVhswixxVK9rKM2jLnEIrK1mg5W8vm7p9j7xtysi8SJzQT7VrjCnpPeZWtCgQdYGDDF12EXs3esyB2EwcUVZzW5Cb2Sh7l2M18V3wKrqqL0wUHXipEf3g3xgIYUEd4c1nCNWfyZpfDsXV084onavK3AkVQKW8dfI28tjNE7pEF7w0a3DtTR6Ty7K26y8inU/wx/KKdaxvQqEg4Me7aN6KPcElvJitWCzKs9cSsHlqPa9DgLdYIbvANLp3dMOV5zbAB+kEgeWHf6ufYRFXbsujEfqtyA0IOJ/DS9RziZcs8au5tygmphVRxzQocZd46pEyVBFLeBT4U9++nIjPmYwEpqB6E5jtmOf8YtES6s4gcX6X8rU/E0y1xdixQKFDK1Z07w/AxyYyeQtc1fhuOw+WUGwVg506X3y8092Z0qU3NnhOCdtMoIbLLJbh0sO0V+qXTwEMGlaEGxImDuY/So+L7c3jBLhxq+BYy2O6krDmJRsGlcU1qGT7itW1gKni/lRAQ8jufvgW3prprxJDK70VwZiPTCxzmB72P/SHiCRtGlR/ixvfrPjbc/WvxomaphFyeLg46KUbIaaJQcwGnlSaM0neyjftXAKvtDtU4+IoYllJFdNc4bXfiww+s55KzkzBSBZxReHdx+3NTqGNVeeMnow26TWbsiRivC9BnupvGlwgiE95s0rD0u041HvcpsZVYN+tvl1FpK6zRhJi4TEGXWrci73oktjGd7ZW36yi8+B3opANGemcorMrfwdnh8N8IZuKWO77SMREqWhb5ssR5dnVeEtK1Y24stldnscaMLl54ytZ82Z9nuwECceLOuKWFZ4jKbrWVgL7fG7GlfB2ctF530X/SN6c287AVMasAWZVJEGOrJ1s4lG7ZOaN/PEd2Yp4P6kznS0sAnIPQbGCGAL9li4LoohN/XhAQYw8I0aKbqqoQ6Sq1zh2mLza39Mcvg6bxX5ERufN99uvtl+xlCaWepI5HzfylCuTXlpHXKQh2tBJ2fsc/L3Psd/n6T8+nQPZ5NTwg7uQjY7APooT2Qijx3QjGx2WbU6KT+6N1sLS8FZX4azW6tVwZh/dl12IYrl7O5LurYovykfa5UFZIctKo/Pyrsf1TS6zRI64ntPaOCptnolV51tzholSg7t1QrcK54Lakn+anX+Xfa5XV9svw6SyjAq3H3Oqm9s0PjeWygzIFfn7uVa937ofTg4xtYZaZed8uZjsJrwQHvqY/lUIZGvLdZXudG74B08SVcjsaAFfDfNtd7h3MOj/q6dZzYbhzRu0cyBrgs2121wQx+Axj9yvSRCkXuNVRUUEodSLjDx6RASrhR95t3Q0XFwT/xVGTfCPgqDJ2I+TzP4EvQMzwg0dXrVSSJTnv59Kv6/TF1q7MAVorV2YtQvz9C5MuQ38sFkYJJbXhvETG8YrylvJtVpgGN/DIG5ser3rnw6G9QwwOz/moQ2xXD8NEnIy2+2i3HhbOiGn7q6UFWDW6jRQyKDUphr7ID0XX0xGIp4sNm7KGcAlhfPYCA9RyJ76eFLOzY7PGa359UlR3MnVlVClBuURG3leRcNJyv2sdyXTLRvyvjafXMWlbT6FGMtADXUlJI4V8ZAGr46Nk5HZEyY8Pu36T1TaNtalXlFtto6Wr01N8VubmtW/b8TUXEfLq3t95tFyRJG0pESxP5Z3svFTR+qYmDh9JNXCljgxS6r4WYboJabWiSTFQR2h+x48u6zCpO4Oh6f9t2fDHjNPZ1Y0+e+z3ukn/hyb8CGs48zZ79nEmXON6VhJzcarClLL6lUNo9S1PJGvJ4xsuzlnMxdPoeqeTlkMudTdmXMYehgF4dSrzLAo/syB36uEwrIHdywoMgZBv9WElwVkWF9eEp5DnpFLqGDKwgfsduLDc8Of0YwlNKNEBU1uMJgzZ3VZUom/k3MvWBvrPl96QXRLNRiw17zPsjGLQOXcsTZZ1dEUhuBf+lR1PPN9sFYEzPn3299zHerj9fTpJFLH6/ISIfvZ3kudJvzSSG92BEKlxQcqikxISwzDU/Ec1khmadPxazoZx4t1Ex9kkyxrvUuzHWbDj7VpR/FlejV0fWsbsTAsW6w+LyrSU2WBunYDjenW8dN3UTy4C0et/JhgCcCwT+Al8EjoJ/z8dmRxmGBaddkyDdxPrpmHLO+H/Gw7uQbYTuuSjQMHHBYHzS/4FBrhfadZNAENpVgPKjQam2Ym2uuV0OlBbuiJWvdTJ7wzjUUxLoysRFhrHcw43gKoLQtq4J3w8CDwEio+ElqWd0UGbkfcujsPZRSFs6U1v9kdqIINa1uGFUbh8sdN68atObJvS3M6hMDrZDLrUYLYott8DFsK4DohbAmkNG6d9ScHl+9Qieo6PSowT5q3Ica9VNpGRS9HvY8Xv3YPz4TFLsf6rWWHfOz2hxeDT0d7q7XaFdg6VrupxIp/srDQ6kz+VRneZyf73WHv4u2nJfNEVI/EVTUP8xptPrdIFlbc9PtQW1B2rQOBjtAJrfOKk7+zwBnd0zCPBZCHscwF9LVp3tw0t6ZubZuztW2ukark22/OOJcDez7WueTEr8M8F9iu7fO1fb62z9f2uULpXvb5ae/ksLu3NtB1dKRaqLTQKeFhBYdQedUmQyGswJim39eYUM3udxvsfdNc6n5rW3raHaNc9adoRzrkhgGlwLiUOSdWn+dGpjw3ILMJuaWI5l6jzIa+MNvlbbTSmtIubM1ooYW3P5IhTB0DAhPnBn0BaReJHfb6s77kvvfibzW78wlKxtg2nk8Zw4VpEmiN36J9x32UnF9c18RDsVJu4a2Th9en6tZ2WT277BmYVh+Of11bVjo6QjhqhhX+0dCuUsbBtXcnS3N9FdaVkNmItkmGW9mY1Cxrg1ubT2vzSfu4NAQlK0kpCtCyBR0tt5a1uJ3htgDldFIaYMsZNfy0o4Te4hqqGApOo+iFSHnHLqZnWUY/bP9XLcvoF4BVUhYPu3nUGnm5Vli9SjzHVhkLs7WSZvK2dDUhK1ezi4uHPV2Bvoa6XEA1lzNjW1ywXNCCv7PuFM+YtKCNfHeuU6nA3NbMb+fBNQui6Ho+00TEc1XOK1XP91fQK6mXzO6nn5/tOZ6nPMmzvD41D/hF8zDbZiMKUjZEKS6gIj11/Abbyp19aE/6M3OFRQ+0wUUMpHbhEVEPj8nEkrMy67mF1ky4RduldN6Hb3lFcZph1VANcwGwIjXcvBb9kyvuxtrp8Pj4l7OTZtppaa2xIXizrKij7Y2pOqvnVN5RBXzseA8HSxUeVxfv0VxEAN7kKK6mcTA54LmVeczro+a6SF6AZB9z3TKzSzAlZcI6/LY5fjWes30Jf8DgtreLj7qyjcAba6F9edI1iMDUZ5coZ8oaxv7VJM01nCP1FjeUV+nZGnF9e0AZVuvbA2rjsr49QJNAi1ogcY2CKEFPgIkTjjzUgjUE/DAF6edgWAVdUZwzEhJ0EyoyfYdFmL5y6ye4C0juqnxB+Trcg6VGtcnuazgz+0DXIdTp9YlvS1iEYqNvG9y1kCW66jvOn1+BOgvPq0NEaAvktsz0g65Inh2hxmqZqBQWyLQtRtFbrSVi6BmIOsFz7BVWZRYlbR391jZ0jbeR8htjLSx2dgB2ACua9YX3mJmGnDaU7Pqw7ZY+TY+8IbbE0d/D3ju5lYNNaFHLvz7tvz8YZl/T2j95UM6cuMPjQW+/5uFZsZHV6Jjuw+5ydY/eN97Z+mpPzFZ7I6Hn1Myo/6qcETcCSesBp4HQSlHNi5/wG+RTdalrFIMF4WQ1g3JwovBKByT9D/l0IaC1W7F2Kx6qRs6zK5HzFTgWrs9TdVr50imZxYFRTWnPJ6m0QmXTbdaWvFvn0Inqeu1AlPa6diAaOhCovnP+g1RvHU1vPe0u82F32B+e7WMSGdm/EsGKFsdH70UTaiHH8bzs4P3+YNg92us1s4Qbl6x5UGv4qNc9XRvDZAxjUoj/gHe1rc1hCcjnmfobseP6c+OOXl3Ui7dtUCpTL/XiZHNtVq/N6m8pWr+2qtdW9dqqfm5WNbcDatrVQod9KwZ2VVy6u98/40knFJemca8NcjUBKzLIP/aHB/2jb9Ykxz80i1wYchqh228EBJNjY/8Gy6YpluXGSXbZb38sqM0qIivRsRiTTnLxiQP1dEH5Z0k7A3cAyjfAO2Ill572sEZQxqwa6OJ02+I9qhtx9r+NtRg2s+KdDXo+t87TfMeBNsEim6FjTXiZ9xCLa4hVdVF7wod3M6+Vv4uYtiMXNOKblJ57Bbr7jz9yLFir+d+MZjYWRHM7DLvIXU6t95SbiM+tVPTB/vaj8f2fzAMDvLifrPjQkn39YPVVtGppfJffTwUry5vO6FQKnyzrIIgpXjkn8w8tPslhp2+ygn2FZYXayn9lG0Wbu5qXOgXNOHFuRCEcvKWBm8HawPj/YYAjFEcXTuA7hRxIrzus9TtYG86VFya/i3o7l7/nvsbd6v8D4uhuUg== + eJzVl1tvGjkUgN/5FecBiSGCZC992UmTbTZBSardFBGaqkoQMoNhpmvske0pQdv89x7bcwcWstutspYSwD5X+/OZOa9/jcO40Tg6OGjAAZxJwufi4jfoX/UhYBHl2ofPEV1CSPiUUYlCRu5NTII/yZwC5CrnVtoukkSHQuIavCUcbjWlC8K5XQpEvJLRPNRwnn/76Ycff+kUri8Xk6sOLjMx57QDl1Si9ipzrCIeGLcAPx++wpmjRoOTBVUYEK3FclyklYUPOiQa0B7Grmxi6rCe0oaEMqeZy4ARpeAO1a9Su/RRUz5VkP5u/NUwIVr3ZhyApCZMELGOBE8nj+xnILjS8K4/vH53Mx70bs7+6MEJtJxCC5OoWTqXlGgKxIafTmZrwzBSsIwYg6AsBQlmMMfkKcyjz5S7STH5RAMNGDFGpxPJ8SsQKckKxMwKOyPTsnhLAdFaRpNEU3X4eiJPzV8tjDc6lGKpoPcY0HLC+XpMJFnYDYSmNd7F0GklrGUYBSGEguGumlgiPhNIgrGWhWfFtYBJHmndT5aXSSqfrJxm6SDiZMKiAGYJD6wXZ9MromxbMXe0ZjRtGgq/ncB9PmuG0fH93s1w8HFsD9SNk1NnqHs6p/oGj9drd7bqDT/2N+oNV3FFb3RcBJRIlmrAe8mU778f/D6+u+59KMlIvCyIHEWZpkZerNFzwTm1aXvt7mkslPaMsU4m8kkJPqY8EFM6XkoSx1R6afrtdsm4kUsDyB1ZB2+VMV2SdPkoqq+nnlW7Lyd/fTFqp+ibkZ5jsQlnjGXWntZuyCXVu67HPBfZyrBj9BZZx6vjKMXhQHV3uaBwC3cmoy8zwhSt34yHapV5cB/1+7I/q5iPt5lRg4Sl4YoyPDXfnyQRm+Jvr0pIB+6tgcq+7wOLdY1eyoc7JZpsRaBiPWEaBTlurtksz2re16/PqAPrC+Z+jNrHdWs5U2sKW5hyartZwsoXS4FbqCOq/l3hW0SPWFWzymc/LFEEiysoRxw+QCN8MBBz/kja3XbKXMnuwsD+VJUqXqrV8MGAbwOEyKIrsapacSqlkDXmdhFX7MVm8NCFW8jTSLNol4TsuVmhk7XKWJzsU+Of49yBVhFpawMv+5G9hZq10vZk/9chuv2vIXLj+ShlthwvzSI0tOXmlpEOndli8UVxiLe9X0Oxs57P/5LOnY/pZK+ndLEJz3pSryFvNPIyWUf8Ar2kjL+k2jgRghmW2ZKs8D1SJthRLL8pf1NMPK2A8DIhq2C1BaUpZRTfdbdUO7Nvf1ffBq652fjO9V2OPbOSCjatqhtd+3JhJ7CBwG6LMZf2NydmMx+uj8sKk43sOxWjtDvB3mStHTENhYlktJsMU2QqQTynuinKZr5f6W1HtZZnjwYjl9+BJiZvO/MxYRFRXqk/9327gOX2AQnBLp+r7A188lCSa6GHr/G26dU= - + - ArangoDB PHP client: single document + ArangoDB PHP client: result set cursor - - - + - - \ArangoDBClient\Document - Graph - \ArangoDBClient\Graph - - Value object representing a graph - <br> - - - + + + \Iterator + Cursor + \ArangoDBClient\Cursor + + Provides access to the results of an AQL query or another statement + The cursor might not contain all results in the beginning.<br> + +If the result set is too big to be transferred in one go, the +cursor might issue additional HTTP requests to fetch the +remaining results from the server. + + - - ENTRY_EDGE_DEFINITIONS - \ArangoDBClient\Graph::ENTRY_EDGE_DEFINITIONS - 'edgeDefinitions' - - Graph edge definitions + + ENTRY_ID + \ArangoDBClient\Cursor::ENTRY_ID + 'id' + + result entry for cursor id - - ENTRY_FROM - \ArangoDBClient\Graph::ENTRY_FROM - 'from' - - Graph edge definitions from collections + + ENTRY_HASMORE + \ArangoDBClient\Cursor::ENTRY_HASMORE + 'hasMore' + + result entry for "hasMore" flag - - ENTRY_TO - \ArangoDBClient\Graph::ENTRY_TO - 'to' - - Graph edge definitions to collections + + ENTRY_RESULT + \ArangoDBClient\Cursor::ENTRY_RESULT + 'result' + + result entry for result documents - - ENTRY_COLLECTION - \ArangoDBClient\Graph::ENTRY_COLLECTION - 'collection' - - Graph edge definitions collections + + ENTRY_EXTRA + \ArangoDBClient\Cursor::ENTRY_EXTRA + 'extra' + + result entry for extra data - - ENTRY_ORPHAN_COLLECTIONS - \ArangoDBClient\Graph::ENTRY_ORPHAN_COLLECTIONS - 'orphanCollections' - - Graph orphan collections + + ENTRY_STATS + \ArangoDBClient\Cursor::ENTRY_STATS + 'stats' + + result entry for stats - - ENTRY_ID - \ArangoDBClient\Document::ENTRY_ID - '_id' - - Document id index + + FULL_COUNT + \ArangoDBClient\Cursor::FULL_COUNT + 'fullCount' + + result entry for the full count (ignoring the outermost LIMIT) - - ENTRY_KEY - \ArangoDBClient\Document::ENTRY_KEY - '_key' - - Document key index - - - - - ENTRY_REV - \ArangoDBClient\Document::ENTRY_REV - '_rev' - - Revision id index - - - - - ENTRY_ISNEW - \ArangoDBClient\Document::ENTRY_ISNEW - '_isNew' - - isNew id index + + ENTRY_CACHE + \ArangoDBClient\Cursor::ENTRY_CACHE + 'cache' + + cache option entry - - ENTRY_HIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES - '_hiddenAttributes' - - hidden attribute index + + ENTRY_CACHED + \ArangoDBClient\Cursor::ENTRY_CACHED + 'cached' + + cached result attribute - whether or not the result was served from the AQL query cache - - ENTRY_IGNOREHIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES - '_ignoreHiddenAttributes' - - hidden attribute index + + ENTRY_SANITIZE + \ArangoDBClient\Cursor::ENTRY_SANITIZE + '_sanitize' + + sanitize option entry - - OPTION_WAIT_FOR_SYNC - \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC - 'waitForSync' - - waitForSync option index + + ENTRY_FLAT + \ArangoDBClient\Cursor::ENTRY_FLAT + '_flat' + + "flat" option entry (will treat the results as a simple array, not documents) - - OPTION_POLICY - \ArangoDBClient\Document::OPTION_POLICY - 'policy' - - policy option index + + ENTRY_TYPE + \ArangoDBClient\Cursor::ENTRY_TYPE + 'objectType' + + "objectType" option entry. - - OPTION_KEEPNULL - \ArangoDBClient\Document::OPTION_KEEPNULL - 'keepNull' - - keepNull option index + + ENTRY_BASEURL + \ArangoDBClient\Cursor::ENTRY_BASEURL + 'baseurl' + + "baseurl" option entry. - - $_edgeDefinitions - \ArangoDBClient\Graph::_edgeDefinitions - array() - - The list of edge definitions defining the graph. + + $_connection + \ArangoDBClient\Cursor::_connection + + + The connection object - - array<mixed,\ArangoDBClient\EdgeDefinition> + + \ArangoDBClient\Connection - - $_orphanCollections - \ArangoDBClient\Graph::_orphanCollections - array() - - The list of orphan collections defining the graph. - These collections are not used in any edge definition of the graph. - + + $_options + \ArangoDBClient\Cursor::_options + + + Cursor options + + array - - $_id - \ArangoDBClient\Document::_id + + $data + \ArangoDBClient\Cursor::data - - The document id (might be NULL for new documents) + + Result Data - - string + + array - - $_key - \ArangoDBClient\Document::_key + + $_result + \ArangoDBClient\Cursor::_result - - The document key (might be NULL for new documents) + + The result set - - string + + array - - $_rev - \ArangoDBClient\Document::_rev + + $_hasMore + \ArangoDBClient\Cursor::_hasMore - - The document revision (might be NULL for new documents) + + "has more" indicator - if true, the server has more results - - mixed + + boolean - - $_values - \ArangoDBClient\Document::_values - array() - - The document attributes (names/values) + + $_id + \ArangoDBClient\Cursor::_id + + + cursor id - might be NULL if cursor does not have an id - - array + + mixed - - $_changed - \ArangoDBClient\Document::_changed - false - - Flag to indicate whether document was changed locally + + $_position + \ArangoDBClient\Cursor::_position + + + current position in result set iteration (zero-based) - - boolean + + integer - - $_isNew - \ArangoDBClient\Document::_isNew - true - - Flag to indicate whether document is a new document (never been saved to the server) + + $_length + \ArangoDBClient\Cursor::_length + + + total length of result set (in number of documents) - - boolean + + integer - - $_doValidate - \ArangoDBClient\Document::_doValidate - false - - Flag to indicate whether validation of document values should be performed -This can be turned on, but has a performance penalty + + $_fullCount + \ArangoDBClient\Cursor::_fullCount + + + full count of the result set (ignoring the outermost LIMIT) - - boolean + + integer - - $_hiddenAttributes - \ArangoDBClient\Document::_hiddenAttributes - array() - - An array, that defines which attributes should be treated as hidden. + + $_extra + \ArangoDBClient\Cursor::_extra + + + extra data (statistics) returned from the statement - + array - - $_ignoreHiddenAttributes - \ArangoDBClient\Document::_ignoreHiddenAttributes - false - - Flag to indicate whether hidden attributes should be ignored or included in returned data-sets + + $_fetches + \ArangoDBClient\Cursor::_fetches + 1 + + number of HTTP calls that were made to build the cursor result - - boolean - - + + $_cached + \ArangoDBClient\Cursor::_cached + + + whether or not the query result was served from the AQL query result cache + + + + + $_count + \ArangoDBClient\Cursor::_count + + + precalculated number of documents in the cursor, as returned by the server + + + integer + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string + + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string + + + + __construct - \ArangoDBClient\Graph::__construct() - - Constructs an empty graph + \ArangoDBClient\Cursor::__construct() + + Initialise the cursor with the first results and some metadata - + + \ArangoDBClient\Connection + + array - + array - - + \ArangoDBClient\ClientException - - $name - null + $connection + + \ArangoDBClient\Connection + + + $data + array $options - array() + array - - addEdgeDefinition - \ArangoDBClient\Graph::addEdgeDefinition() - - Adds an edge definition to the graph. - - - \ArangoDBClient\EdgeDefinition + + delete + \ArangoDBClient\Cursor::delete() + + Explicitly delete the cursor + This might issue an HTTP DELETE request to inform the server about +the deletion. + + \ArangoDBClient\Exception - - \ArangoDBClient\Graph + + boolean - - - $edgeDefinition - - \ArangoDBClient\EdgeDefinition - - - getEdgeDefinitions - \ArangoDBClient\Graph::getEdgeDefinitions() - - Get the edge definitions of the graph. - - - array<mixed,\ArangoDBClient\EdgeDefinition> + + getCount + \ArangoDBClient\Cursor::getCount() + + Get the total number of results in the cursor + This might issue additional HTTP requests to fetch any outstanding +results from the server + + \ArangoDBClient\Exception + + + integer - - - addOrphanCollection - \ArangoDBClient\Graph::addOrphanCollection() - - Adds an orphan collection to the graph. + + getFullCount + \ArangoDBClient\Cursor::getFullCount() + + Get the full count of the cursor (ignoring the outermost LIMIT) - - string - - - \ArangoDBClient\Graph + + integer - - - $orphanCollection - - string - - - getOrphanCollections - \ArangoDBClient\Graph::getOrphanCollections() - - Get the orphan collections of the graph. + + getCached + \ArangoDBClient\Cursor::getCached() + + Get the cached attribute for the result set - - array<mixed,string> + + boolean - - - set - \ArangoDBClient\Graph::set() - - Set a graph attribute - The key (attribute name) must be a string. -This will validate the value of the attribute and might throw an -exception if the value is invalid. - - \ArangoDBClient\ClientException - - - string - - - mixed + + getAll + \ArangoDBClient\Cursor::getAll() + + Get all results as an array + This might issue additional HTTP requests to fetch any outstanding +results from the server + + \ArangoDBClient\Exception - - void + + array - - - $key - - string - - - $value - - mixed - - - getSingleUndirectedRelation - \ArangoDBClient\Graph::getSingleUndirectedRelation() - - returns (or creates) the edge definition for single-vertexcollection-undirected graphs, throw an exception for any other type of graph. + + rewind + \ArangoDBClient\Cursor::rewind() + + Rewind the cursor, necessary for Iterator - - \ArangoDBClient\ClientException - - - \ArangoDBClient\EdgeDefinition + + void - - __construct - \ArangoDBClient\Document::__construct() - - Constructs an empty document + + current + \ArangoDBClient\Cursor::current() + + Return the current result row, necessary for Iterator - + array - - $options - null - array - - \ArangoDBClient\Document - - createFromArray - \ArangoDBClient\Document::createFromArray() - - Factory method to construct a new document using the values passed to populate it + + key + \ArangoDBClient\Cursor::key() + + Return the index of the current result row, necessary for Iterator - - \ArangoDBClient\ClientException - - - array - - - array - - - \ArangoDBClient\Document - \ArangoDBClient\Edge - \ArangoDBClient\Graph + + integer - - $values - - array - - - $options - array() - array - - \ArangoDBClient\Document - - __clone - \ArangoDBClient\Document::__clone() - - Clone a document - Returns the clone - - + + next + \ArangoDBClient\Cursor::next() + + Advance the cursor, necessary for Iterator + + void - \ArangoDBClient\Document - - __toString - \ArangoDBClient\Document::__toString() - - Get a string representation of the document. - It will not output hidden attributes. - -Returns the document as JSON-encoded string - - - string + + valid + \ArangoDBClient\Cursor::valid() + + Check if cursor can be advanced further, necessary for Iterator + This might issue additional HTTP requests to fetch any outstanding +results from the server + + \ArangoDBClient\Exception + + + boolean - \ArangoDBClient\Document - - toJson - \ArangoDBClient\Document::toJson() - - Returns the document as JSON-encoded string + + add + \ArangoDBClient\Cursor::add() + + Create an array of results from the input array - + array - - string + + void + + + \ArangoDBClient\ClientException - $options - array() + $data + array - \ArangoDBClient\Document - - toSerialized - \ArangoDBClient\Document::toSerialized() - - Returns the document as a serialized string + + addFlatFromArray + \ArangoDBClient\Cursor::addFlatFromArray() + + Create an array of results from the input array - + array - - string + + void - $options - array() + $data + array - \ArangoDBClient\Document - - filterHiddenAttributes - \ArangoDBClient\Document::filterHiddenAttributes() - - Returns the attributes with the hidden ones removed + + addDocumentsFromArray + \ArangoDBClient\Cursor::addDocumentsFromArray() + + Create an array of documents from the input array - + array - - array + + void - - array + + \ArangoDBClient\ClientException - $attributes + $data array - - $_hiddenAttributes - array() - array - - \ArangoDBClient\Document - - set - \ArangoDBClient\Document::set() - - Set a document attribute - The key (attribute name) must be a string. -This will validate the value of the attribute and might throw an -exception if the value is invalid. - - \ArangoDBClient\ClientException - - - string - - - mixed + + addPathsFromArray + \ArangoDBClient\Cursor::addPathsFromArray() + + Create an array of paths from the input array + + + array - + void + + \ArangoDBClient\ClientException + - $key - - string - - - $value + $data - mixed + array - \ArangoDBClient\Document - - __set - \ArangoDBClient\Document::__set() - - Set a document attribute, magic method - This is a magic method that allows the object to be used without -declaring all document attributes first. -This function is mapped to set() internally. - - \ArangoDBClient\ClientException - - - - string - - - mixed + + addShortestPathFromArray + \ArangoDBClient\Cursor::addShortestPathFromArray() + + Create an array of shortest paths from the input array + + + array - + void + + \ArangoDBClient\ClientException + - $key + $data - string + array + + + addDistanceToFromArray + \ArangoDBClient\Cursor::addDistanceToFromArray() + + Create an array of distances from the input array + + + array + + + void + + - $value + $data - mixed + array - \ArangoDBClient\Document - - get - \ArangoDBClient\Document::get() - - Get a document attribute + + addCommonNeighborsFromArray + \ArangoDBClient\Cursor::addCommonNeighborsFromArray() + + Create an array of common neighbors from the input array - - string + + array - - mixed + + void + + + \ArangoDBClient\ClientException - $key + $data - string + array - \ArangoDBClient\Document - - __get - \ArangoDBClient\Document::__get() - - Get a document attribute, magic method - This function is mapped to get() internally. - - - string + + addCommonPropertiesFromArray + \ArangoDBClient\Cursor::addCommonPropertiesFromArray() + + Create an array of common properties from the input array + + + array - - mixed + + void - $key + $data - string + array - \ArangoDBClient\Document - - __isset - \ArangoDBClient\Document::__isset() - - Is triggered by calling isset() or empty() on inaccessible properties. + + addFigureFromArray + \ArangoDBClient\Cursor::addFigureFromArray() + + Create an array of figuresfrom the input array - - string + + array - - boolean + + void - $key + $data - string + array - \ArangoDBClient\Document - - __unset - \ArangoDBClient\Document::__unset() - - Magic method to unset an attribute. - Caution!!! This works only on the first array level. -The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. - - - - - $key - - - - \ArangoDBClient\Document - - - getAll - \ArangoDBClient\Document::getAll() - - Get all document attributes + + addEdgesFromArray + \ArangoDBClient\Cursor::addEdgesFromArray() + + Create an array of Edges from the input array - - mixed - - + array + + void + + + \ArangoDBClient\ClientException + - $options - array() - mixed + $data + + array - \ArangoDBClient\Document - - getAllForInsertUpdate - \ArangoDBClient\Document::getAllForInsertUpdate() - - Get all document attributes for insertion/update + + addVerticesFromArray + \ArangoDBClient\Cursor::addVerticesFromArray() + + Create an array of Vertex from the input array - - mixed + + array - - \ArangoDBClient\Document - - - getAllAsObject - \ArangoDBClient\Document::getAllAsObject() - - Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class - - - mixed + + void - - mixed + + \ArangoDBClient\ClientException - $options - array() - mixed + $data + + array - \ArangoDBClient\Document - - setHiddenAttributes - \ArangoDBClient\Document::setHiddenAttributes() - - Set the hidden attributes -$cursor - - + + sanitize + \ArangoDBClient\Cursor::sanitize() + + Sanitize the result set rows + This will remove the _id and _rev attributes from the results if the +"sanitize" option is set + array - - void + + array - $attributes + $rows array - \ArangoDBClient\Document - - getHiddenAttributes - \ArangoDBClient\Document::getHiddenAttributes() - - Get the hidden attributes + + fetchOutstanding + \ArangoDBClient\Cursor::fetchOutstanding() + + Fetch outstanding results from the server - - array + + \ArangoDBClient\Exception + + + void - \ArangoDBClient\Document - - isIgnoreHiddenAttributes - \ArangoDBClient\Document::isIgnoreHiddenAttributes() - - + + updateLength + \ArangoDBClient\Cursor::updateLength() + + Set the length of the (fetched) result set - - boolean + + void - \ArangoDBClient\Document - - setIgnoreHiddenAttributes - \ArangoDBClient\Document::setIgnoreHiddenAttributes() - - + + url + \ArangoDBClient\Cursor::url() + + Return the base URL for the cursor - - boolean + + string - - $ignoreHiddenAttributes - - boolean - - \ArangoDBClient\Document - - setChanged - \ArangoDBClient\Document::setChanged() - - Set the changed flag + + getStatValue + \ArangoDBClient\Cursor::getStatValue() + + Get a statistical figure value from the query result - - boolean + + string - - boolean + + integer - $value + $name - boolean + string - \ArangoDBClient\Document - - getChanged - \ArangoDBClient\Document::getChanged() - - Get the changed flag + + getMetadata + \ArangoDBClient\Cursor::getMetadata() + + Get MetaData of the current cursor - - boolean + + array - \ArangoDBClient\Document - - setIsNew - \ArangoDBClient\Document::setIsNew() - - Set the isNew flag + + getExtra + \ArangoDBClient\Cursor::getExtra() + + Return the extra data of the query (statistics etc.). Contents of the result array +depend on the type of query executed - - boolean - - - void + + array - - $isNew - - boolean - - \ArangoDBClient\Document - - getIsNew - \ArangoDBClient\Document::getIsNew() - - Get the isNew flag + + getWarnings + \ArangoDBClient\Cursor::getWarnings() + + Return the warnings issued during query execution - - boolean + + array - \ArangoDBClient\Document - - setInternalId - \ArangoDBClient\Document::setInternalId() - - Set the internal document id - This will throw if the id of an existing document gets updated to some other id - - \ArangoDBClient\ClientException - - - string - - - void + + getWritesExecuted + \ArangoDBClient\Cursor::getWritesExecuted() + + Return the number of writes executed by the query + + + integer - - $id - - string - - \ArangoDBClient\Document - - setInternalKey - \ArangoDBClient\Document::setInternalKey() - - Set the internal document key - This will throw if the key of an existing document gets updated to some other key - - \ArangoDBClient\ClientException - - - string - - - void + + getWritesIgnored + \ArangoDBClient\Cursor::getWritesIgnored() + + Return the number of ignored write operations from the query + + + integer - - $key - - string - - \ArangoDBClient\Document - - getInternalId - \ArangoDBClient\Document::getInternalId() - - Get the internal document id (if already known) - Document ids are generated on the server only. Document ids consist of collection id and -document id, in the format collectionId/documentId - - string + + getScannedFull + \ArangoDBClient\Cursor::getScannedFull() + + Return the number of documents iterated over in full scans + + + integer - \ArangoDBClient\Document - - getInternalKey - \ArangoDBClient\Document::getInternalKey() - - Get the internal document key (if already known) + + getScannedIndex + \ArangoDBClient\Cursor::getScannedIndex() + + Return the number of documents iterated over in index scans - - string - - - \ArangoDBClient\Document - - - getHandle - \ArangoDBClient\Document::getHandle() - - Convenience function to get the document handle (if already known) - is an alias to getInternalId() - Document handles are generated on the server only. Document handles consist of collection id and -document id, in the format collectionId/documentId - - string + + integer - \ArangoDBClient\Document - - getId - \ArangoDBClient\Document::getId() - - Get the document id (or document handle) if already known. - It is a string and consists of the collection's name and the document key (_key attribute) separated by /. -Example: (collectionname/documentId) - -The document handle is stored in a document's _id attribute. - - mixed + + getFiltered + \ArangoDBClient\Cursor::getFiltered() + + Return the number of documents filtered by the query + + + integer - \ArangoDBClient\Document - - getKey - \ArangoDBClient\Document::getKey() - - Get the document key (if already known). - Alias function for getInternalKey() - - mixed + + getFetches + \ArangoDBClient\Cursor::getFetches() + + Return the number of HTTP calls that were made to build the cursor result + + + integer - \ArangoDBClient\Document - - getCollectionId - \ArangoDBClient\Document::getCollectionId() - - Get the collection id (if already known) - Collection ids are generated on the server only. Collection ids are numeric but might be -bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used - - mixed + + getId + \ArangoDBClient\Cursor::getId() + + Return the cursor id, if any + + + string - \ArangoDBClient\Document - - setRevision - \ArangoDBClient\Document::setRevision() - - Set the document revision - Revision ids are generated on the server only. - -Document ids are strings, even if they look "numeric" -To reliably store a document id elsewhere, a PHP string must be used - - mixed + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string - - void + + \ArangoDBClient\DocumentClassable - $rev + $class - mixed + string - \ArangoDBClient\Document - - - getRevision - \ArangoDBClient\Document::getRevision() - - Get the document revision (if already known) - - - mixed - - - \ArangoDBClient\Document + \ArangoDBClient\DocumentClassable - - jsonSerialize - \ArangoDBClient\Document::jsonSerialize() - - Get all document attributes -Alias function for getAll() - it's necessary for implementing JsonSerializable interface + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use - - mixed + + string - - array + + \ArangoDBClient\DocumentClassable - $options - array() - mixed + $class + + string - \ArangoDBClient\Document + \ArangoDBClient\DocumentClassable - eJzFWG1v2zYQ/u5fcQWMWg6cpin2yamztrGTtOjiIskKDElg0BJta5FFgaScGm3++44veqMk1yswzAgQm+TdPXd89Bypt78nq6TTOTo46MABvOckXrLxB/hy+QX8KKSxHIII42VEIWB+usYBXKeWvkuI/0iWFCC3OtMGepKkcsU4zsEnEsONpHRN4tiZOo8YD3H6A+GSRkLP+izZ8nC5knCWf3vz+vi3AUhcu6SxgIv1/HKA0xFbxnQAF5Sj720GC9H6ChTA8as3OHLU6cRkTQXCpQ7SkzzvryRKKbD539SXwGnCqcB5zBsILDlJVtb72zk/3Sv/Ogo/IgKxK2dAv0kaBwLGWUm/d9RSDUZ9DrJ1AfoP6CKMQxmyWNjZI/3fxwEJk6vb679mk/HFZDaenH+8+nj7cXp1AyPoKeNxYdvDbPcKAgvO1ug9irAYO6OeX0//UJGUwf7uJdvL+e1UuZZsf8f7eD2bfv48OVM1Ut4Li9YojCcrpOg+vqfXXy7fX5VC6G0wDs4K+4ZQtysKUYiO2KKelvmOVJS4SpPxlbXLzN9tCIdJZbvvHlodvqokkHAmERgNoDtzGIPo7x52g61XZwdcZSloZTHhFGImIRUIIIwBn2MXrwqzO3PCOdnugNSecG1vspTdnM/UNvPUlwg5BrpO5DbThSqehHCytoi6SnfU+CGwRLkn0QB0ViQCPbdAHSy7ceyNlWi0z+ZcF7knR4Gqk3LF2ZOA+6py3Zt/k28+1d6rdUvnUejDIo11qWA287OieCbTEcRphBAd9Kqkfe3iu6mrru0RbgTdYDSYo44+ER6oB3idEBnOwyjE+s45JY/wtKLIEUWARchxh3WBqKQcQqGH8zg6bB4gXID3IhQzPWoA9uHlS7spL0YGbB++5xbq05WrUByeCiq93uyRbnsDY9A/yZc9V5NQol6BgfKmfiNOlVxeI9wmnAnMJPFlinv4xPhj7swYDIeVulqnNvxznZjvg8BQ0nloLIrmh8aQrCoY0K0+/Ug65UD7LUZrrjiVKY+NVjZQ701OvWYSkSCowvB2o8p45OyXq1yofiPX9KTYNwtaG+eVdQp7QWVRgLIc75Qj69nV4l+ozJLKqhfhucmX06jX4KeUqQnlPqRBYipt77rKaelS8/kfEGbqhPZqYNpYUpN7wxN3+BeZ0tAL9+GKqeivcsQtxk9ZUqtBK09uMC97+gUiEeU8ldRJQp0FUCbByxeAUdp1ilo9R6Wz+ZXOAKjbT2EUwYZEYUCkEfeNOYCbehXOSBzAWt8BdMfC35kfmjUppfSFB3Qextpzrd625zX3uBaaq9xU/66m5yxeh9/wNAFdg+DQIlGNua1s2d5vWBjs3GHViBSIgfXubq7qchrkCBuaoNFiOGy+ELiNThtaSgTsq90Kd5X66KuRXcD4cJhtm2cRnVQsSt1RfRwN/kAEnZpLFvZf+uQIpdc/qZpjDSnxV2BjARHKYxNKt3uN8PbKYtoOwIlUjUaDu3Ix1T3nQQdXN52m8A0QDk9Rq85xfVmptP1Jzfx5fyy3U4NEsn+D45aVUaDtPhhqjpCN1zQixomDq7j1PDQ4t1Srt3u3v7tsyr8BjfDu0Mr3+t3rf2J8E2Ubt6ooSUND+1kdqu6yo2NNLcqn1hLWksgbIRLgoVr5iFxS0W8692g5My+CDjeUS5TfHO9hGgchN3cq3S7EIJfrkk5rQcT7HUP3eBjeJlrvm3vjTq1uOWY5t7xwo3pLuVfeaPh/5mBzLtfOC5jIKNugpoNYUVfFKp+lsfS0MJ3C69qVgpiz6N3rh+qmdudqgugIVZ2oRNBL/WJp+VGuLHxuB3UMP35UHHo1OpbWq2frWN2V6qtKK1uAN4ZrNHUS2WnYnWP59K2t6+O3unb3O82/3N0wvFStx+GW19MnE5ZQTsxrhzjagkiThHG89Rte48FFrkD1lRLl7evR0jmaW2L19tkdXe0aaei4qQxtTGq+AdiXGTmCJulQgdpacQG9dpik4/zYiH/61eYMVZIITx/sh0M9NIDeffbWNnvVML/XK1Rp/gGsVV+5 + eJzdXFt32zYSfvevQH1yKrlV7LSPTp2t15Yb9ziJ11ay23V0fCASkrimSC0JSna3+e87gwsJguBFttLkVA+JJQKDbwaDuQHgT39bzpc7OwfffbdDviPHCY1m8enfyeXrS+KFAYv4IUlYmoWcpIwTL0vSOIGW2PjnJfXu6IwRkvc7EV3EQ5rxeZzAM/Irjcg1Z2xBo0g88uLlQxLM5pyc5H/9+OKHHweEJwEQjFLyy2LyegCPw3gWsQH5hSXQ+wF6H+zsRHTBUhibWcO+zNm4TOJV4LOUUM9jaUp4TPicKUZSEk8JQDr+xwX5b8aSBwIwaRRDi4SknHK2kDwgpRF0k0yThcAJ7YgXR5wGEaFhmNOErzjEhM2CKAqi2f5Pk+SVInI+NYYXcgwQU0wmwQyxTRgwTqN0ypKE+UgqjhiZxQPshgRKCII0zRihvh/wII5oSF6PRpdAHHhJueB1yrg3130TkHuAiHKo0yReCEApS1Ys2e80nWkQefiIkBf7P4p58EIKoj2R0ILFMhRyS8nHc84SykFN/reD7cWc4AcEsVjGCSfPbv3Yy7D1iaAxzSJP8hLwB9X2QPyfpYycmm3pJGQwzxZdMUtxFDFBhsST/8Bf6qFu8/OKJqBQulFpmGUSrGDeAVhB5aU9iOI0XuLT1EWdJgl9qCGsulWxX0mtOKWcbkjThy5uWRSatilM2bNKdXdOU7KIE7YL6ukHHs4veU4C0OwkYwNDnYhuqfXNBWESx2ENAuj+BnpXIahFEPgwrlwJsG7evr+4QBTqoR/DosclOqcrhos88F3DL4J75teMH/jOoRPQQLKMU7HocImaq1koPP7e/50l8fMJTZm/5xo4iHjNsJp0dXAec1jkIYtmfI6myxi4DziibDEBqcMDvajSDYeWpKsDTzOwb16cAeNxxYL1g1kUJ2hW8EGcgQgWccrJxfmb89GGAHCgExynioHdg2UkqOmkj7Y5SHngpXuAhGdJBMayMGaF5d5M5cUQ1ZELuQr76oGxB+M6p5ysGSj3gvpM2O4sCH0BQKmglFEdp2iZQUWPyA/VEddzJnwQEEEVRprSPymxr2FhiTVmcF04MdXIox7afefo4pkvDZs9+DJhwKKXhdDUdymV9nCSzQEBMPkkTB4MA7DZ3HvueVfcwMDA2hQkkq/+Eh0w16Bzw7ejq99uz09BrL3A73WgtquszC6ZhnRWS/L18fWbd1dDpKs6dCGufsglV0v+anj9/mKE1GWXLsSLBVFLdviv0dUxUhVtuxDFtVMP83p0PLpGeqJZF3qoDIb16GQrzHHPwKrfnrx7/1YIJzcPjqGFSiufLAHUsnFyfPJaTKXoU0fL19xQDsHoBLCCu3GszE5rsroYK4BOc0QuxU1pBF7h944cXh+/PR+d/1sweau7OqjugtLz3RJN0l8HMF88YZSXYmXgj5JUhHfSig6ECCq+porm7OJYTN8tjuZCIcO00cOSlbHs15Ic/XYpmCt6uuii+82SsCvRvx9fD99fXSBd1dNB9ByFCfEpxKOGrV8HfC6VPUiAXi6zyCdpvAAnwTj1HYHdkiZ0YQSj5JkRvT43Q1mZHUAY7FudxVyIn2QgKP/EkEwiza0QPmuz1S6iKmCVRL3G2JfPk3gNgX85bfgo/xvee2xZjbizSRh4eeRPbm/FlCSZx/tuuQwUOsFt/kUhkloo8w2Bns+D9PkrI5yH6X1mB/dGS0OE2FKG1jY1CD2LNhFYpWoTafAam0gLrprcjB00pB2SDaY0THUwjB+IdfuQATLeFyBvUhZODw+1Bxzv7RlSsLArvuwuBYBP+V+1w13rKEsTEFa6flgpDz1yTW8TQSdGhYerH1RK2MWu7GiI0xrJJFDqKHzgWP1UuKcqBhNH7rgQy8akX5boftpURtK7NMyM1DKXlFRX57QcHBiecZGlIgtD58jyJpCms4TXAlNBFSCrqr6KsgBVH1PEPQc43d29JpQ9uOmVSwy9WjlAr1KBoYmEUyBG+yB9y9a9cbFqbfYMm3qUd6w2U6ZbNnNYCOr7/b4wgC4ByahyXJVutoS27EJke/09Q37qecLWkNv3VUdg0XaCw/slGO2Ahw/EZyHjpi+0fMIIKJbrVZHMo06HF8PRUJer0L8FEYSMZkGK0AnEiJoS/i5GA1ntW6Noz2P7GPKzdHeizgDuC2sUolZhjOHdRfE6ZP6M+aUxNLSBnEQi6oJrcPyN/kvKo2/7IdTMwgLbKohxV731KLwVuCdJXk9kEvb3yD7pHfTg34L+AJRlzzJu+FHCQClYRgUiVCwV9nMBkmfMRum0PIqkoecOffmFyVhSVjCKnNKqmXZUoNaCJ40eMLmALCXyIdkoZyeVsuemqgQpLGqSm5VG3ZgxLrxAo3ZIR/nNkYwa7DlQGEqNndZoPQ8gUO9b9rTG9gmxvSsk1ndbOGtwXS4yWjnmvFo8UjHkZoWjbQj/TLvhygRYnBl1qBaNVs6z8IQ6662vvJYt0tNqPY4ij0PnBMY2ns2aUA3D5jYHpoNRqZz21S5YmSE8z/GKbZ+ClTbxHYdhRXZ/wurSBfia+bgSPrpUiAMnwdKUqtJLvvniVr9VbFXQbM51EFCTUOUV8CPyogGk9DcSpKicK7WGGdsQsJ5FNzGtj2kae64ir8WcItC2JiT9G5vncReGQXjs3jB5T+Ne2T0372KoRn7v2EMbr8W+Qw1vx/6K4tbf51O5CHKiCszvv++M8GTOvDtjE8gDjZig/RHAwYBmCdrajrC/OjvmiGHbGJWRayER4IhifbZ5HlY0DKor3wxS8tX/05EVDgDAH2w7CKnimsmdOHM/EDdRysah2FZLXVFPOW610t9v7NTxjz/IN/Uht8Tkx1GPV5ENCPhyU8AgN3Y/p5Dl6vpbGZmV5pXT5IhhZpHrSKFFjXpBGv2HvYq7zkz92sGCLyv5yAq8IFqCWFw+v1Q2lGVILEB68aI4b9BuFR5XQFQ7SLn2YlJsALHVGFY8o5jq6LxflcdlgWIPHckzAGHri1CxIL0VlPuyBWiYVS/SJQAzDcfy93iPfPutnf07WjUUkYCts5DyM5iM4wKDncYxXO9VGgq9C6pZQ3cDKIPQRZK0EUkjGvyk64Abs1ADp6YzfjwKtHuYtvfIYW2rMvYhtG7HbX4moCx39U0kCFiznN13h/EB2gfe50CypHzeHccltP4MINJ5DPJI+eVGYK6NXtvH5AdoPT02irsjOs37bB8PWMZFHL1lEF5M4iTtDuqk3PFzIbtM4iVqKdsYWtFz+9imwSxLNljvZ6L9NnH4bEox7O6sQ52tZUcQn6pmdsf97dOf6OpzQpbPr+wQ1qYCDi9uuTuXM7cStXF5y64b78XBlu1xv6uJ7sqHHeSwteDHoXIN4ZB9BLOIGku/VzcJSjIvNz489ISYrckb2AFQEY22zxJ6tq3OkCD4BabHcrrbmJqiA4ZDduP8N3MO5VmPI3JTMh4iksHIpIffjl6Rm/Gg3ACJyac1DdI4SzzWyxt0U40b3W9cVRJrAB9ihCASpyx7mwxg9mscxdhmK3IFSSMXz1ikCatKwU+I1WzXcXms6taGXB91eORstIBRjRSSXBsej8JlAMRYGyxnHSP+dda1O379MsvbTPdsza2keFIm7i1t3Q2/6AMCBi0DG4TKCf8gEiFsqdvcvDAbGWuw1EhsD/Xz73tYqhh3MFdirrdrjQw+2k2RShC0tdSWRv9so3mE6Sp6tJisQlYolCbL3mzWxVMn4Y2NIQKp2sLV0w2bJLx9u6YMptQqRRi/tAQ/ZdvXJeJUCvIl7V5D/OhIe5vMmFybxaeiepVFqDx+sdKqK+WpK6tQUaTu8u3b8GIyVyaRzsb/Cn6stsCw3SQiZFNu+BT8WvIn8jJg/lx87dlnvaySpt6uQ2L1591KraxzVZ86k7+RCDsOo1tXhqu1gLlOKSuov280XMfoM6dtC2KTRbDM6z5fpVWrL0416fUdsT9HEsvtHXtIVU3iZXP7Z3flIMiasDtbKSxNwAaoAF5l5uVJXg/PG/o965RoFgnN1Q+telMVww1QE8riPUoHZGEu/Ron3q4BNk13+dilXUtqF4PYX9im+mNU8wV8gLVP0mj5O5ccXGWjpqitpWTUYTpUOrLF+ZABxReYkeqW0Vdf07Mn6FpfYbIukKJ8LEmKoxfiHlLCFvFKdsGbC3ihBkCuigN3xnLLT5NO5ZV3SWtXb/Dm14CC1HUsr6QBYs4MDRDf5RUcTa5yn9g6p5S3MxmsmeB8D9oY/umTWr3O4Np41nfF2reojZZlT1R4LCEn9FbgHkUcvqJhJs7FlToU6PR+umoHCBRi8cNNRQnr77foj/J8iOQGYYybiDg2rbeL9Gr4YQtQBRUXVvc3x6FCHKN2ZZ6JgynGwaVtnVhqd9DVsy2W2h8ciLdsBFFGixEIJggsXYKGMmMhmAflwdK3n5Lv9dRJeU21OGymLmibNlK4haNi5OevZoz/msaR6w7FZjdYrM54hKXpPkc5S2k5hWqcvpJMqVOjMV7l5CVTjOYVz5IJxZQu0ydRvHYGjyL8LN9s+1QRg33VpEYDr9VwxcsN8Ftf4d1rP03drmllJDWRnxr/iKiKZMkt1sM3jn3izVGCt0j1QXDnpQYNO+VJcU6wDnhSPX/czbSrC611Jd9GY6/71h1qw67i7TV4xJ+G4YR6d7bVeZ+EYMKAyu3J+6vrd1dNVwUoyd/qQEOVTxBhWgsjZB6Md7tvKU/IlukCr2uL//L0BB24RFYzG3UvJzBPg+PNxQ8Iqy8GaZ+Y2nt+on/r3LR0bzpJ/qJJ3m8Yp/iqGfuEcqO6th+sBgm9UXedWw4cN6VWxnoy3vuhkEotMF4CQsBK7O/t4zVqLvbxyy8pMUETny0ZGLlYEucPS6EfkiS7Z17GmwO7NuaHCLftqLV60Ugr72ua4PuaUnn+2Cd+JrTbRFs43UfB/acaoYOBkYrY05hqN5JIbYcmXb0Zd5BHceFnnQQY+usZ03fZhWS6Lm6HNATVoSLaMoslW9Bbl7r2ak82OLkRF6GAC0GEYIWKyuuhZcv3VMbO5TCP4Ev13JAt440x4oQ9cBjjjcsgkpfCUgg16nLoDkxdQ/eI+XipayOW0qLf9hiStz22w9E50noMS6Ljo3maBiFwtbXFdKbIbcSIxrAhE094MdNjOJOpQeslQp1BtDKSv9JogHZXvN7Qic0VLVbhnbde9Qvya34AS7y975aGAU378s12h4fiN0iPPurXMOry1eSjbILz8392+EmX - + - ArangoDB PHP client: single document + ArangoDB PHP client: transaction base - - - + + - + - EdgeDefinition - \ArangoDBClient\EdgeDefinition - - Value object representing an edge Definition. - An edge definition contains a collection called 'relation' to store the edges and -multiple vertices collection defined in 'fromCollections' and 'toCollections'. - -<br> - - + TransactionBase + \ArangoDBClient\TransactionBase + + Transaction base class, used by Transaction and StreamingTransaction + + + - - $_relation - \ArangoDBClient\EdgeDefinition::_relation - - - The name of the edge collection for this relation. + + ENTRY_COLLECTIONS + \ArangoDBClient\TransactionBase::ENTRY_COLLECTIONS + 'collections' + + Collections index - - string - - - - $_fromCollections - \ArangoDBClient\EdgeDefinition::_fromCollections - array() - - An array containing the names of the vertices collections holding the start vertices. + + + ENTRY_WAIT_FOR_SYNC + \ArangoDBClient\TransactionBase::ENTRY_WAIT_FOR_SYNC + 'waitForSync' + + WaitForSync index - - array + + + + ENTRY_LOCK_TIMEOUT + \ArangoDBClient\TransactionBase::ENTRY_LOCK_TIMEOUT + 'lockTimeout' + + Lock timeout index + + + + + ENTRY_READ + \ArangoDBClient\TransactionBase::ENTRY_READ + 'read' + + Read index + + + + + ENTRY_WRITE + \ArangoDBClient\TransactionBase::ENTRY_WRITE + 'write' + + WRITE index + + + + + ENTRY_EXCLUSIVE + \ArangoDBClient\TransactionBase::ENTRY_EXCLUSIVE + 'exclusive' + + EXCLUSIVE index + + + + + $_connection + \ArangoDBClient\TransactionBase::_connection + + + The connection object + + + \ArangoDBClient\Connection - - $_toCollections - \ArangoDBClient\EdgeDefinition::_toCollections + + $attributes + \ArangoDBClient\TransactionBase::attributes array() - - An array containing the names of the vertices collections holding the end vertices. + + The transaction's attributes. - + array - + __construct - \ArangoDBClient\EdgeDefinition::__construct() - - Constructs an new edge definition + \ArangoDBClient\TransactionBase::__construct() + + Initialise the transaction object - - string - - - array - string + + \ArangoDBClient\Connection - - array - string + + \ArangoDBClient\ClientException - - $relation - null - string - - - $fromCollections - array() - array|string - - - $toCollections - array() - array|string + $connection + + \ArangoDBClient\Connection - - setRelation - \ArangoDBClient\EdgeDefinition::setRelation() - - Set the relation of the edge definition + + getConnection + \ArangoDBClient\TransactionBase::getConnection() + + Return the connection object - - string + + \ArangoDBClient\Connection + + + + + setCollections + \ArangoDBClient\TransactionBase::setCollections() + + Set the collections array. + The array should have 2 sub-arrays, namely 'read' and 'write' which should hold the respective collections +for the transaction + + array - - $relation + $value - string + array - - getRelation - \ArangoDBClient\EdgeDefinition::getRelation() - - Get the relation of the edge definition. - - - string + + getCollections + \ArangoDBClient\TransactionBase::getCollections() + + Get collections array + This holds the read and write collections of the transaction + + array - - - getToCollections - \ArangoDBClient\EdgeDefinition::getToCollections() - - Get the 'to' collections of the graph. + + setWaitForSync + \ArangoDBClient\TransactionBase::setWaitForSync() + + set waitForSync value - - array + + boolean + + + \ArangoDBClient\ClientException - + + $value + + boolean + - - getFromCollections - \ArangoDBClient\EdgeDefinition::getFromCollections() - - Get the 'from' collections of the graph. + + getWaitForSync + \ArangoDBClient\TransactionBase::getWaitForSync() + + get waitForSync value - - array + + boolean - - - addToCollection - \ArangoDBClient\EdgeDefinition::addToCollection() - - Add a 'to' collections of the graph. + + setLockTimeout + \ArangoDBClient\TransactionBase::setLockTimeout() + + Set lockTimeout value - - string + + integer + + + \ArangoDBClient\ClientException - - $toCollection + $value - string + integer - - addFromCollection - \ArangoDBClient\EdgeDefinition::addFromCollection() - - Add a 'from' collections of the graph. + + getLockTimeout + \ArangoDBClient\TransactionBase::getLockTimeout() + + Get lockTimeout value - - string + + integer + + + + + setReadCollections + \ArangoDBClient\TransactionBase::setReadCollections() + + Convenience function to directly set read-collections without having to access +them from the collections attribute. + + + array - - $fromCollection + $value - string + array - - clearToCollection - \ArangoDBClient\EdgeDefinition::clearToCollection() - - Resets the 'to' collections of the graph. + + getReadCollections + \ArangoDBClient\TransactionBase::getReadCollections() + + Convenience function to directly get read-collections without having to access +them from the collections attribute. - + + array + - - clearFromCollection - \ArangoDBClient\EdgeDefinition::clearFromCollection() - - Resets the 'from' collections of the graph. + + setWriteCollections + \ArangoDBClient\TransactionBase::setWriteCollections() + + Convenience function to directly set write-collections without having to access +them from the collections attribute. - + + array + + + $value + + array + - - transformToArray - \ArangoDBClient\EdgeDefinition::transformToArray() - - Transforms an edge definition to an array. + + getWriteCollections + \ArangoDBClient\TransactionBase::getWriteCollections() + + Convenience function to directly get write-collections without having to access +them from the collections attribute. - + array - - - createUndirectedRelation - \ArangoDBClient\EdgeDefinition::createUndirectedRelation() - - Constructs an undirected relation. This relation is an edge definition where the edges can start and end -in any vertex from the collection list. + + setExclusiveCollections + \ArangoDBClient\TransactionBase::setExclusiveCollections() + + Convenience function to directly set exclusive-collections without having to access +them from the collections attribute. - - string + + array - + + + $value + + array + + + + getExclusiveCollections + \ArangoDBClient\TransactionBase::getExclusiveCollections() + + Convenience function to directly get exclusive-collections without having to access +them from the collections attribute. + + array - - \ArangoDBClient\EdgeDefinition + + + + set + \ArangoDBClient\TransactionBase::set() + + Sets an attribute + + + + + \ArangoDBClient\ClientException - - $relation + $key - string + - $vertexCollections + $value - array + - - createDirectedRelation - \ArangoDBClient\EdgeDefinition::createDirectedRelation() - - Constructs a directed relation. This relation is an edge definition where the edges can start only in the -vertices defined in 'fromCollections' and end in vertices defined in 'toCollections'. - - - string + + __set + \ArangoDBClient\TransactionBase::__set() + + Set an attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. + + \ArangoDBClient\ClientException - - array + + string - - array - string + + mixed - - \ArangoDBClient\EdgeDefinition + + void - - $relation + $key string - $fromCollections + $value - array|string + mixed + + + get + \ArangoDBClient\TransactionBase::get() + + Get an attribute + + + string + + + mixed + + - $toCollections + $key - array|string + string - - eJztWE1v4zYQvftXzCGAnMBx2qCn7Ec3m+xmj4tt2ksSGLRE22ppSqCobI1t/3uHFEWRlGRL2aS91AgQm0POzJs3M+Lo9c/5Jp9Mzk5OJnACl4LwdXb9Hj5/+gwxSymXF1CkfM0oJFlcbnEB96mt73IS/0HWFMCeutIHtJCUcpMJlMFHlomUcHhPhKSs0NI4y3ciXW8kXNlv5z/8+NMMJO5dU17AzXb5aYZilq05ncENFVvCd7VtdClWlgHO5+e4cjaZcLKlBfpEA3deWXC/EVZSyJa/01iCoLmgBcoRHKB7NEEo13SV8lSmGZ/raJjlxC5DnHFJUvSP4FfGUJNeJfg1gUhQRtRCBDKDQmaCgtxQrQRP8EQp3ZZMpjnG85EKmcYocBRpS6gp5RCtRLa9sqIiUgogkpm7NjcBeb0Ubwfx0g5czEhRwAd0sUE/+TZRW3Tc1OcEbhGGijBkKwvJdXyFZMtNWkAdgrk5WSt490gEhkSocO9RZLaf6f+5yCQuYzyOFrVepDNwDVkiQpBdzY2yII27RW2mI9gFbDKW1LsLiflpt3V6X1nx1PqnhuAIWIU3cPfwUpgoJsxYRO6ZIXi8fOxBc4UiKcpYqiIATr+GZRX6lhNBtnW2VJ+jOgHMbzj10shKp+pXyRMq2E6dDvLreB4Y0SH4y5g6Ctk5xTpnaSGVGTfKGIHHtImzru8gF7AgSA2hJoXUvdSpHIViv1N+iGGUUx6dT3HJehZ0DldosqJcsjSGVckrLYtFXPM+bdh7A7xkbNYOtUqdWQhWLR5r7VVH0pmg+szp24Wj8ijoDnpb28BUx/W4JXrl6A5i7RzyRK4h40/b3j471Zm2udCM2v13q6J+odJPe7ebDqyrhpNT21vCchqUBd30F1R+MVoa+sdx2Y39Zhj2luuCylJwg/4JgNYOoBCH0R3CsRD6MODjPPJq2GBZC5Jv+hDohHwagFs3uQ6hGJSJFonK9X8Vy0e/uA6h6azFNp7LJMGeOI4Xv6zcsHWUFkkSfHA2ur+jxFCVS+jUM91Xah6rdw9hyzkQl5Es+5HxKXjx2PgJMg3M98UnyJMqQv5iX4y+4ECBd5zxhT0cVswoER7pg3g2F7PDbo/kd6TjASPjKnYvhlscdQocQraFHeacqQ2nMWJ6zXM3Ilkbvs0ulYoOPuodNPmQgP9pILW33kUNDVFVpzou3nOo/7Bm8sHaaQ63+ma/DkziB8fXRkfwHHFuQ5ZDV1Pvc9CfDPDanopqsLAXEJw8nakS0k5+v26oN2rHhJvruJqZqRq8K3s4VxO+0zdi+ieoEOlTzt1XXawPtLFwEnneWQRZqNz7vjnEAO+f/wxRweA/uADQivTqW1Ai6a+Wwfbdb9YBrKcDqBHRd2y/mk7Vg5IOnj3jMs52Ks9QVhu0A9jB1zuKMRR2Hmi9+dmTo6ac/5+Z/9uZ+UVq7HpfhQVkhAP10+rtkFJbafinXycuCEtJMfVVXlxo2Qyi+/ot7715Q7m897dGqPIfNEzqrA== - - - - ArangoDB PHP client: single vertex document - + + __get + \ArangoDBClient\TransactionBase::__get() + + Get an attribute, magic method + This function is mapped to get() internally. + + + string + + + mixed + + + + $key + + string + + + + __isset + \ArangoDBClient\TransactionBase::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. + + + string + + + boolean + + + + $key + + string + + + + buildTransactionAttributesFromArray + \ArangoDBClient\TransactionBase::buildTransactionAttributesFromArray() + + Build the object's attributes from a given array + + + + \ArangoDBClient\ClientException + + + + $options + + + + + + eJzNWltv2kgUfs+vmJWQgIq02/Yt3e02pSRFpUmV0O1WSWQNZoDZGBt5xiRo1f++58z4MrbHNrC0WxQFsM+c63cuM+a3P1aL1dHRsydPjsgTchpSfx68e0s+vf9EXI8zX54QCRcFdSUPfDKhggEh0r5ZUfeezhkh6bK+WqFu0kgughDukTO4eU8+0g0L1R03WG1CPl9I0k8/vfj1+cseCOLAzxfkfDl534PbXjD3WY+cs3BJ/Q2sfnZ05NMlEyCaFaS+So0YF/QFQ6gQPRIJNiWTTe4+9afkWoaMLrk/N24UbbRYKLjvovHPn75UmikpJvO36Kt/jtAHSjN8gXYLUCjwfaYVCCZ/w6f4ZkLzZk1DMD8hii8/U++rkK+pZKTlZFzAdosUI25tQagE904iycRTmzQahnSTFxRNPO6SVraQ/E5u7sqyIE6e1kMQ7k/ZY44NaCkkGVyMr746/cvRaNAfDy8vroFX280Wtstsv1Auz4LweuO7DWy/nA7HztnllXP99aKPjB+ypRbGo8C9J5IvWRDJBs6jy/4HZzz8OLj8PEbGHiwd65UWxleMThsYXg1O3yEjQNzUZvPVcDxoslbRoJUhlwyYIEGR0eCv/ujz9fDPJmYZHTBkj64XCb5mFs2GPpecehzSSeaxVQHhFQ3p0gAxaRmo169jxcq4LAMyYSpPi9zkIgweBLnN5+Gtfhs8umxVThSN31nka+aOowwPI1d27Gp11TqdsfhqyQUXx6+NRAMvtcy0SyiLS7KcuRHMm52clPB/h8mULsOXSahh8hrSrVdJE+OgnsiILxKmdHda929HFhDLKPSLkbHHONS0hjdLIc0tTCpYIOEaFOM0NnMmMyadYhxiMeVwVBpxzWSsSFaaVIUr1j6sk+oGEYsg8qZkQdeMvCAimhyr69A3sON4mzhnVceIU488LLi7SFcG8A+FhtCfUOg6Jz+ROIOuWMgge+potVpr6kWsFtgCnZfK6Zjrip7kM6LvO/ds47BHLqToaMN6yZKuQW9AGqRgfTMl6QU3ev1dN0uHbw0Ctfu2kPgFCW0iNYddZGbFbQu5g4TYJjvjVJZvweI5YLGEwxIMuVAAEjGCoJEg0JSZudXBrAk9cbZsDZ95Hj71yQfEnYqK1q3MRnAoMVoyMXUqgH4SBF5e6UO2AERUpkfHniMZCnKW5oaMHumgpt0ESZWmz7cxPXaxst0gboqaacpuUcvZUq08VlFj4qmLG/fldw3bKFNjt7CZExxEDfRsDtr5NnbHHkbDDdqmmJl27BYz05Bq1aGLrpkProWtSSoXxqopDyHBoYthLmJ5OTaLygOHzRoYCs0PtkFIT12XibRnQcVZklkYLMtNNRl0SpuK3ZuYvb1UxHmLCeumOFHhzKU7Q4KB/f04/1F+zJVz5VTRBLKiI+uBtpcnE8fhf+sGZCsgqvb2EyKxYuw4EBTV4H5oLP4YV+4BxpIvD4tG7czUd3tDMR3qfkI41kyjB4Jkuk08NCx/nFv3gKbVr4eFZ+bYuikL7PIz0+yAacFmpnipbuDaccDqIP9ezbbxFy4cARr6c0Va2jwpscRnD0XJnfbQB658SqaBGy3hVmYqAU7t3CaqBskoFvHZgEucWk139siSzsHaJQPQFQ+W1MYL/miOCIyhwMTz0JEIQX2KYZxPJRBO+EyZ61F0Dq6yGCrIjIdCllBbG6yUSulmh4UOiUIHwRO1zLV4bFEgXvJHUD12IBDrdzyRqARfDP91wKe1EHKcJhAJcJm7IBo9BfC4eExfkVDkJEdqYKNw8JEb683XBAa1+1dlgfoUwWDRrpVVNRXsIDDMT2b18irm4R3EMUuBq5dZ12q2F1y516z3b3lrvp/I3Kl9nUTLrnIriVM2o5En61jnU6GRa+3pUXNzMKvAscp8PChqSmpdDpIyYC7okYvPoxHW/ayeQJX0A4m9oqmv6hTfNf23SY7SFrm01Tlw9pcElsfZ75CPJan2SWULVOVaOBcKmPbGWmrolYOPIrcKiZf4kefVHq7s1p5TaMHnJV2tALPQiBFnXTx+YaEPPbd0sr9t0/yf08VxqhKmfBykqCodOxT4AH0+Z6F+zO2CV9BKHfUugS7Pliu5wY94bqVHbj7xGD6RWbFQcsuz4f/iMDzQZBBr/RXVQ7+FZEY9yIYObrvgW+ylboObYvBaHLU3tFGfOhwrPSv9/Tbi8QMfPR3mnrHr3Qslc8hZ33rkn8zwwcp8PFQcDHc6Ni0/V5ugjsZPEk5TBc9Av1NUq5NoUOPWmKJyy1PzJCU3RzTyaSpdNga5AaNOldx8sQWnfZQxR486XXKTRzOj8qAAKqkfnDiws6KiU/jZyclJ/JuX9m3yo5oESZPbAi3uv/4FJWtlpQ== + + + + ArangoDB PHP client: single document + - - + + - + \ArangoDBClient\Document - Vertex - \ArangoDBClient\Vertex - - Value object representing a single vertex document + Graph + \ArangoDBClient\Graph + + Value object representing a graph <br> - - + + + + ENTRY_EDGE_DEFINITIONS + \ArangoDBClient\Graph::ENTRY_EDGE_DEFINITIONS + 'edgeDefinitions' + + Graph edge definitions + + + + + ENTRY_FROM + \ArangoDBClient\Graph::ENTRY_FROM + 'from' + + Graph edge definitions from collections + + + + + ENTRY_TO + \ArangoDBClient\Graph::ENTRY_TO + 'to' + + Graph edge definitions to collections + + + + + ENTRY_COLLECTION + \ArangoDBClient\Graph::ENTRY_COLLECTION + 'collection' + + Graph edge definitions collections + + + + + ENTRY_ORPHAN_COLLECTIONS + \ArangoDBClient\Graph::ENTRY_ORPHAN_COLLECTIONS + 'orphanCollections' + + Graph orphan collections + + + ENTRY_ID \ArangoDBClient\Document::ENTRY_ID @@ -15175,6 +15691,39 @@ vertices defined in 'fromCollections' and end in vertices defined in 'toCollecti + + KEY_REGEX_PART + \ArangoDBClient\Document::KEY_REGEX_PART + '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' + + regular expression used for key validation + + + + + $_edgeDefinitions + \ArangoDBClient\Graph::_edgeDefinitions + array() + + The list of edge definitions defining the graph. + + + array<mixed,\ArangoDBClient\EdgeDefinition> + + + + + $_orphanCollections + \ArangoDBClient\Graph::_orphanCollections + array() + + The list of orphan collections defining the graph. + These collections are not used in any edge definition of the graph. + + array + + + $_id \ArangoDBClient\Document::_id @@ -15284,47 +15833,27 @@ This can be turned on, but has a performance penalty - + __construct - \ArangoDBClient\Document::__construct() - - Constructs an empty document - - - array - - - - $options - null - array - - \ArangoDBClient\Document - - - createFromArray - \ArangoDBClient\Document::createFromArray() - - Factory method to construct a new document using the values passed to populate it + \ArangoDBClient\Graph::__construct() + + Constructs an empty graph - - \ArangoDBClient\ClientException - - + array - + array - - \ArangoDBClient\Document - \ArangoDBClient\Edge - \ArangoDBClient\Graph + + + \ArangoDBClient\ClientException + - $values - + $name + null array @@ -15332,89 +15861,249 @@ This can be turned on, but has a performance penalty array() array - \ArangoDBClient\Document - - - __clone - \ArangoDBClient\Document::__clone() - - Clone a document - Returns the clone - - - void - - - \ArangoDBClient\Document - - - __toString - \ArangoDBClient\Document::__toString() - - Get a string representation of the document. - It will not output hidden attributes. - -Returns the document as JSON-encoded string - - - string - - - \ArangoDBClient\Document - - toJson - \ArangoDBClient\Document::toJson() - - Returns the document as JSON-encoded string + + addEdgeDefinition + \ArangoDBClient\Graph::addEdgeDefinition() + + Adds an edge definition to the graph. - - array + + \ArangoDBClient\EdgeDefinition - - string + + \ArangoDBClient\Graph + - $options - array() - array + $edgeDefinition + + \ArangoDBClient\EdgeDefinition - \ArangoDBClient\Document - - toSerialized - \ArangoDBClient\Document::toSerialized() - - Returns the document as a serialized string + + getEdgeDefinitions + \ArangoDBClient\Graph::getEdgeDefinitions() + + Get the edge definitions of the graph. - - array + + array<mixed,\ArangoDBClient\EdgeDefinition> - + + + + + addOrphanCollection + \ArangoDBClient\Graph::addOrphanCollection() + + Adds an orphan collection to the graph. + + string + + \ArangoDBClient\Graph + + - $options - array() + $orphanCollection + + string + + + + getOrphanCollections + \ArangoDBClient\Graph::getOrphanCollections() + + Get the orphan collections of the graph. + + + array<mixed,string> + + + + + + set + \ArangoDBClient\Graph::set() + + Set a graph attribute + The key (attribute name) must be a string. +This will validate the value of the attribute and might throw an +exception if the value is invalid. + + \ArangoDBClient\ClientException + + + string + + + mixed + + + void + + + + + $key + + string + + + $value + + mixed + + + + getSingleUndirectedRelation + \ArangoDBClient\Graph::getSingleUndirectedRelation() + + returns (or creates) the edge definition for single-vertexcollection-undirected graphs, throw an exception for any other type of graph. + + + \ArangoDBClient\ClientException + + + \ArangoDBClient\EdgeDefinition + + + + + __construct + \ArangoDBClient\Document::__construct() + + Constructs an empty document + + + array + + + + $options + null array \ArangoDBClient\Document - + + createFromArray + \ArangoDBClient\Document::createFromArray() + + Factory method to construct a new document using the values passed to populate it + + + \ArangoDBClient\ClientException + + + array + + + array + + + \ArangoDBClient\Document + \ArangoDBClient\Edge + \ArangoDBClient\Graph + + + + $values + + array + + + $options + array() + array + + \ArangoDBClient\Document + + + __clone + \ArangoDBClient\Document::__clone() + + Clone a document + Returns the clone + + + void + + + \ArangoDBClient\Document + + + __toString + \ArangoDBClient\Document::__toString() + + Get a string representation of the document. + It will not output hidden attributes. + +Returns the document as JSON-encoded string + + + string + + + \ArangoDBClient\Document + + + toJson + \ArangoDBClient\Document::toJson() + + Returns the document as JSON-encoded string + + + array + + + string + + + + $options + array() + array + + \ArangoDBClient\Document + + + toSerialized + \ArangoDBClient\Document::toSerialized() + + Returns the document as a serialized string + + + array + + + string + + + + $options + array() + array + + \ArangoDBClient\Document + + filterHiddenAttributes \ArangoDBClient\Document::filterHiddenAttributes() - + Returns the attributes with the hidden ones removed - + array - + array - + array @@ -15430,24 +16119,24 @@ Returns the document as JSON-encoded string \ArangoDBClient\Document - + set \ArangoDBClient\Document::set() - + Set a document attribute The key (attribute name) must be a string. This will validate the value of the attribute and might throw an exception if the value is invalid. - + \ArangoDBClient\ClientException - + string - + mixed - + void @@ -15463,25 +16152,25 @@ exception if the value is invalid. \ArangoDBClient\Document - + __set \ArangoDBClient\Document::__set() - + Set a document attribute, magic method This is a magic method that allows the object to be used without declaring all document attributes first. This function is mapped to set() internally. - + \ArangoDBClient\ClientException - - + + string - + mixed - + void @@ -15497,16 +16186,16 @@ This function is mapped to set() internally. \ArangoDBClient\Document - + get \ArangoDBClient\Document::get() - + Get a document attribute - + string - + mixed @@ -15517,17 +16206,17 @@ This function is mapped to set() internally. \ArangoDBClient\Document - + __get \ArangoDBClient\Document::__get() - + Get a document attribute, magic method This function is mapped to get() internally. - - + + string - + mixed @@ -15538,16 +16227,16 @@ This function is mapped to set() internally. \ArangoDBClient\Document - + __isset \ArangoDBClient\Document::__isset() - + Is triggered by calling isset() or empty() on inaccessible properties. - + string - + boolean @@ -15558,15 +16247,15 @@ This function is mapped to set() internally. \ArangoDBClient\Document - + __unset \ArangoDBClient\Document::__unset() - + Magic method to unset an attribute. Caution!!! This works only on the first array level. The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. - - + + $key @@ -15575,16 +16264,16 @@ The preferred method to unset attributes in the database, is to set those to nul \ArangoDBClient\Document - + getAll \ArangoDBClient\Document::getAll() - + Get all document attributes - + mixed - + array @@ -15595,28 +16284,28 @@ The preferred method to unset attributes in the database, is to set those to nul \ArangoDBClient\Document - + getAllForInsertUpdate \ArangoDBClient\Document::getAllForInsertUpdate() - + Get all document attributes for insertion/update - + mixed \ArangoDBClient\Document - + getAllAsObject \ArangoDBClient\Document::getAllAsObject() - + Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class - + mixed - + mixed @@ -15627,17 +16316,17 @@ The preferred method to unset attributes in the database, is to set those to nul \ArangoDBClient\Document - + setHiddenAttributes \ArangoDBClient\Document::setHiddenAttributes() - + Set the hidden attributes $cursor - + array - + void @@ -15648,37 +16337,37 @@ $cursor \ArangoDBClient\Document - + getHiddenAttributes \ArangoDBClient\Document::getHiddenAttributes() - + Get the hidden attributes - + array \ArangoDBClient\Document - + isIgnoreHiddenAttributes \ArangoDBClient\Document::isIgnoreHiddenAttributes() - + - + boolean \ArangoDBClient\Document - + setIgnoreHiddenAttributes \ArangoDBClient\Document::setIgnoreHiddenAttributes() - + - + boolean @@ -15689,16 +16378,16 @@ $cursor \ArangoDBClient\Document - + setChanged \ArangoDBClient\Document::setChanged() - + Set the changed flag - + boolean - + boolean @@ -15709,28 +16398,28 @@ $cursor \ArangoDBClient\Document - + getChanged \ArangoDBClient\Document::getChanged() - + Get the changed flag - + boolean \ArangoDBClient\Document - + setIsNew \ArangoDBClient\Document::setIsNew() - + Set the isNew flag - + boolean - + void @@ -15741,31 +16430,31 @@ $cursor \ArangoDBClient\Document - + getIsNew \ArangoDBClient\Document::getIsNew() - + Get the isNew flag - + boolean \ArangoDBClient\Document - + setInternalId \ArangoDBClient\Document::setInternalId() - + Set the internal document id This will throw if the id of an existing document gets updated to some other id - + \ArangoDBClient\ClientException - + string - + void @@ -15776,19 +16465,19 @@ $cursor \ArangoDBClient\Document - + setInternalKey \ArangoDBClient\Document::setInternalKey() - + Set the internal document key This will throw if the key of an existing document gets updated to some other key - + \ArangoDBClient\ClientException - + string - + void @@ -15799,97 +16488,97 @@ $cursor \ArangoDBClient\Document - + getInternalId \ArangoDBClient\Document::getInternalId() - + Get the internal document id (if already known) Document ids are generated on the server only. Document ids consist of collection id and document id, in the format collectionId/documentId - + string \ArangoDBClient\Document - + getInternalKey \ArangoDBClient\Document::getInternalKey() - + Get the internal document key (if already known) - + string \ArangoDBClient\Document - + getHandle \ArangoDBClient\Document::getHandle() - + Convenience function to get the document handle (if already known) - is an alias to getInternalId() Document handles are generated on the server only. Document handles consist of collection id and document id, in the format collectionId/documentId - + string \ArangoDBClient\Document - + getId \ArangoDBClient\Document::getId() - + Get the document id (or document handle) if already known. It is a string and consists of the collection's name and the document key (_key attribute) separated by /. Example: (collectionname/documentId) The document handle is stored in a document's _id attribute. - + mixed \ArangoDBClient\Document - + getKey \ArangoDBClient\Document::getKey() - + Get the document key (if already known). Alias function for getInternalKey() - + mixed \ArangoDBClient\Document - + getCollectionId \ArangoDBClient\Document::getCollectionId() - + Get the collection id (if already known) Collection ids are generated on the server only. Collection ids are numeric but might be bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used - + mixed \ArangoDBClient\Document - + setRevision \ArangoDBClient\Document::setRevision() - + Set the document revision Revision ids are generated on the server only. Document ids are strings, even if they look "numeric" To reliably store a document id elsewhere, a PHP string must be used - + mixed - + void @@ -15900,29 +16589,29 @@ To reliably store a document id elsewhere, a PHP string must be used \ArangoDBClient\Document - + getRevision \ArangoDBClient\Document::getRevision() - + Get the document revision (if already known) - + mixed \ArangoDBClient\Document - + jsonSerialize \ArangoDBClient\Document::jsonSerialize() - + Get all document attributes Alias function for getAll() - it's necessary for implementing JsonSerializable interface - + mixed - + array @@ -15934,404 +16623,262 @@ Alias function for getAll() - it's necessary for implementing JsonSerializable i \ArangoDBClient\Document - eJylUMtKw0AU3c9XnF01BGuzTAUfLbYIQkHoKiA300sSm8yEmYk0iP/ubWK7qEt3w3ndc+buvi1bpaZRpBDh0ZEp7PIJm/UGuq7YhBS+MkXN+GQX+ICd1V0juMiPjoeW9J4KBs7mxeAbSOpCaZ1weCGDt8DckDEX1LP49nilnt3AaNv2rirKgMX5ldzOkhjBVXLKeKyafB0LXdvCcIwVO8ntB7e01cc2wOwmEWSqlKGGvfTki4rz8+4t1R3D5h+sAxy3jr3wshv0n/l/u+iavMd2zOJDYLPzWJ4yv5T6VqPmneqK/NWoTNMBizHJTl+Q/Z7Ls1EyuZ6rH7e+kY0= + eJzFWG1v2zYQ/u5fcQWMWg6cpin2yamztrGTtOjiIskKDElg0BJta5FFgaScGm3++44veqMk1yswzAgQm+TdPXd89Bypt78nq6TTOTo46MABvOckXrLxB/hy+QX8KKSxHIII42VEIWB+usYBXKeWvkuI/0iWFCC3OtMGepKkcsU4zsEnEsONpHRN4tiZOo8YD3H6A+GSRkLP+izZ8nC5knCWf3vz+vi3AUhcu6SxgIv1/HKA0xFbxnQAF5Sj720GC9H6ChTA8as3OHLU6cRkTQXCpQ7SkzzvryRKKbD539SXwGnCqcB5zBsILDlJVtb72zk/3Sv/Ogo/IgKxK2dAv0kaBwLGWUm/d9RSDUZ9DrJ1AfoP6CKMQxmyWNjZI/3fxwEJk6vb679mk/HFZDaenH+8+nj7cXp1AyPoKeNxYdvDbPcKAgvO1ug9irAYO6OeX0//UJGUwf7uJdvL+e1UuZZsf8f7eD2bfv48OVM1Ut4Li9YojCcrpOg+vqfXXy7fX5VC6G0wDs4K+4ZQtysKUYiO2KKelvmOVJS4SpPxlbXLzN9tCIdJZbvvHlodvqokkHAmERgNoDtzGIPo7x52g61XZwdcZSloZTHhFGImIRUIIIwBn2MXrwqzO3PCOdnugNSecG1vspTdnM/UNvPUlwg5BrpO5DbThSqehHCytoi6SnfU+CGwRLkn0QB0ViQCPbdAHSy7ceyNlWi0z+ZcF7knR4Gqk3LF2ZOA+6py3Zt/k28+1d6rdUvnUejDIo11qWA287OieCbTEcRphBAd9Kqkfe3iu6mrru0RbgTdYDSYo44+ER6oB3idEBnOwyjE+s45JY/wtKLIEUWARchxh3WBqKQcQqGH8zg6bB4gXID3IhQzPWoA9uHlS7spL0YGbB++5xbq05WrUByeCiq93uyRbnsDY9A/yZc9V5NQol6BgfKmfiNOlVxeI9wmnAnMJPFlinv4xPhj7swYDIeVulqnNvxznZjvg8BQ0nloLIrmh8aQrCoY0K0+/Ug65UD7LUZrrjiVKY+NVjZQ701OvWYSkSCowvB2o8p45OyXq1yofiPX9KTYNwtaG+eVdQp7QWVRgLIc75Qj69nV4l+ozJLKqhfhucmX06jX4KeUqQnlPqRBYipt77rKaelS8/kfEGbqhPZqYNpYUpN7wxN3+BeZ0tAL9+GKqeivcsQtxk9ZUqtBK09uMC97+gUiEeU8ldRJQp0FUCbByxeAUdp1ilo9R6Wz+ZXOAKjbT2EUwYZEYUCkEfeNOYCbehXOSBzAWt8BdMfC35kfmjUppfSFB3Qextpzrd625zX3uBaaq9xU/66m5yxeh9/wNAFdg+DQIlGNua1s2d5vWBjs3GHViBSIgfXubq7qchrkCBuaoNFiOGy+ELiNThtaSgTsq90Kd5X66KuRXcD4cJhtm2cRnVQsSt1RfRwN/kAEnZpLFvZf+uQIpdc/qZpjDSnxV2BjARHKYxNKt3uN8PbKYtoOwIlUjUaDu3Ix1T3nQQdXN52m8A0QDk9Rq85xfVmptP1Jzfx5fyy3U4NEsn+D45aVUaDtPhhqjpCN1zQixomDq7j1PDQ4t1Srt3u3v7tsyr8BjfDu0Mr3+t3rf2J8E2Ubt6ooSUND+1kdqu6yo2NNLcqn1hLWksgbIRLgoVr5iFxS0W8692g5My+CDjeUS5TfHO9hGgchN3cq3S7EIJfrkk5rQcT7HUP3eBjeJlrvm3vjTq1uOWY5t7xwo3pLuVfeaPh/5mBzLtfOC5jIKNugpoNYUVfFKp+lsfS0MJ3C69qVgpiz6N3rh+qmdudqgugIVZ2oRNBL/WJp+VGuLHxuB3UMP35UHHo1OpbWq2frWN2V6qtKK1uAN4ZrNHUS2WnYnWP59K2t6+O3unb3O82/3N0wvFStx+GW19MnE5ZQTsxrhzjagkiThHG89Rte48FFrkD1lRLl7evR0jmaW2L19tkdXe0aaei4qQxtTGq+AdiXGTmCJulQgdpacQG9dpik4/zYiH/61eYMVZIITx/sh0M9NIDeffbWNnvVML/XK1Rp/gGsVV+5 - + - ArangoDB PHP client: single collection + ArangoDB PHP client: single document + - + - Collection - \ArangoDBClient\Collection - - Value object representing a collection + \JsonSerializable + Document + \ArangoDBClient\Document + + Value object representing a single collection-based document <br> - - + + - + ENTRY_ID - \ArangoDBClient\Collection::ENTRY_ID - 'id' - - Collection id index + \ArangoDBClient\Document::ENTRY_ID + '_id' + + Document id index - - ENTRY_NAME - \ArangoDBClient\Collection::ENTRY_NAME - 'name' - - Collection name index + + ENTRY_KEY + \ArangoDBClient\Document::ENTRY_KEY + '_key' + + Document key index - - ENTRY_TYPE - \ArangoDBClient\Collection::ENTRY_TYPE - 'type' - - Collection type index + + ENTRY_REV + \ArangoDBClient\Document::ENTRY_REV + '_rev' + + Revision id index - - ENTRY_WAIT_SYNC - \ArangoDBClient\Collection::ENTRY_WAIT_SYNC - 'waitForSync' - - Collection 'waitForSync' index + + ENTRY_ISNEW + \ArangoDBClient\Document::ENTRY_ISNEW + '_isNew' + + isNew id index - - ENTRY_JOURNAL_SIZE - \ArangoDBClient\Collection::ENTRY_JOURNAL_SIZE - 'journalSize' - - Collection 'journalSize' index - - - - - ENTRY_STATUS - \ArangoDBClient\Collection::ENTRY_STATUS - 'status' - - Collection 'status' index - - - - - ENTRY_KEY_OPTIONS - \ArangoDBClient\Collection::ENTRY_KEY_OPTIONS - 'keyOptions' - - Collection 'keyOptions' index - - - - - ENTRY_IS_SYSTEM - \ArangoDBClient\Collection::ENTRY_IS_SYSTEM - 'isSystem' - - Collection 'isSystem' index - - - - - ENTRY_IS_VOLATILE - \ArangoDBClient\Collection::ENTRY_IS_VOLATILE - 'isVolatile' - - Collection 'isVolatile' index - - - - - ENTRY_NUMBER_OF_SHARDS - \ArangoDBClient\Collection::ENTRY_NUMBER_OF_SHARDS - 'numberOfShards' - - Collection 'numberOfShards' index - - - - - ENTRY_REPLICATION_FACTOR - \ArangoDBClient\Collection::ENTRY_REPLICATION_FACTOR - 'replicationFactor' - - Collection 'replicationFactor' index - - - - - ENTRY_SHARDING_STRATEGY - \ArangoDBClient\Collection::ENTRY_SHARDING_STRATEGY - 'shardingStrategy' - - Collection 'shardingStrategy' index - - - - - ENTRY_SHARD_KEYS - \ArangoDBClient\Collection::ENTRY_SHARD_KEYS - 'shardKeys' - - Collection 'shardKeys' index - - - - - OPTION_PROPERTIES - \ArangoDBClient\Collection::OPTION_PROPERTIES - 'properties' - - properties option - - - - - TYPE_DOCUMENT - \ArangoDBClient\Collection::TYPE_DOCUMENT - 2 - - document collection type - - - - - TYPE_EDGE - \ArangoDBClient\Collection::TYPE_EDGE - 3 - - edge collection type + + ENTRY_HIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES + '_hiddenAttributes' + + hidden attribute index - - STATUS_NEW_BORN - \ArangoDBClient\Collection::STATUS_NEW_BORN - 1 - - New born collection + + ENTRY_IGNOREHIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES + '_ignoreHiddenAttributes' + + hidden attribute index - - STATUS_UNLOADED - \ArangoDBClient\Collection::STATUS_UNLOADED - 2 - - Unloaded collection + + OPTION_WAIT_FOR_SYNC + \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC + 'waitForSync' + + waitForSync option index - - STATUS_LOADED - \ArangoDBClient\Collection::STATUS_LOADED - 3 - - Loaded collection + + OPTION_POLICY + \ArangoDBClient\Document::OPTION_POLICY + 'policy' + + policy option index - - STATUS_BEING_UNLOADED - \ArangoDBClient\Collection::STATUS_BEING_UNLOADED - 4 - - Collection being unloaded + + OPTION_KEEPNULL + \ArangoDBClient\Document::OPTION_KEEPNULL + 'keepNull' + + keepNull option index - - STATUS_DELETED - \ArangoDBClient\Collection::STATUS_DELETED - 5 - - Deleted collection + + KEY_REGEX_PART + \ArangoDBClient\Document::KEY_REGEX_PART + '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' + + regular expression used for key validation - + $_id - \ArangoDBClient\Collection::_id + \ArangoDBClient\Document::_id - - The collection id (might be NULL for new collections) + + The document id (might be NULL for new documents) - - mixed + + string - - $_name - \ArangoDBClient\Collection::_name + + $_key + \ArangoDBClient\Document::_key - - The collection name (might be NULL for new collections) + + The document key (might be NULL for new documents) - + string - - $_type - \ArangoDBClient\Collection::_type + + $_rev + \ArangoDBClient\Document::_rev - - The collection type (might be NULL for new collections) + + The document revision (might be NULL for new documents) - - integer + + mixed - - $_waitForSync - \ArangoDBClient\Collection::_waitForSync - - - The collection waitForSync value (might be NULL for new collections) + + $_values + \ArangoDBClient\Document::_values + array() + + The document attributes (names/values) - - boolean + + array - - $_journalSize - \ArangoDBClient\Collection::_journalSize - - - The collection journalSize value (might be NULL for new collections) + + $_changed + \ArangoDBClient\Document::_changed + false + + Flag to indicate whether document was changed locally - - integer + + boolean - - $_isSystem - \ArangoDBClient\Collection::_isSystem - - - The collection isSystem value (might be NULL for new collections) + + $_isNew + \ArangoDBClient\Document::_isNew + true + + Flag to indicate whether document is a new document (never been saved to the server) - + boolean - - $_isVolatile - \ArangoDBClient\Collection::_isVolatile - - - The collection isVolatile value (might be NULL for new collections) + + $_doValidate + \ArangoDBClient\Document::_doValidate + false + + Flag to indicate whether validation of document values should be performed +This can be turned on, but has a performance penalty - + boolean - - $_numberOfShards - \ArangoDBClient\Collection::_numberOfShards - - - The collection numberOfShards value (might be NULL for new collections) + + $_hiddenAttributes + \ArangoDBClient\Document::_hiddenAttributes + array() + + An array, that defines which attributes should be treated as hidden. - - mixed - - - - - $_replicationFactor - \ArangoDBClient\Collection::_replicationFactor - - - The replicationFactor value (might be NULL for new collections) - - - mixed - - - - - $_shardingStrategy - \ArangoDBClient\Collection::_shardingStrategy - - - The shardingStrategy value (might be NULL for new collections) - - - mixed - - - - - $_shardKeys - \ArangoDBClient\Collection::_shardKeys - - - The collection shardKeys value (might be NULL for new collections) - - + array - - $_status - \ArangoDBClient\Collection::_status - - - The collection status value - - - integer - - - - - $_keyOptions - \ArangoDBClient\Collection::_keyOptions - - - The collection keyOptions value + + $_ignoreHiddenAttributes + \ArangoDBClient\Document::_ignoreHiddenAttributes + false + + Flag to indicate whether hidden attributes should be ignored or included in returned data-sets - - array + + boolean - + __construct - \ArangoDBClient\Collection::__construct() - - Constructs an empty collection + \ArangoDBClient\Document::__construct() + + Constructs an empty document - - string - - - \ArangoDBClient\ClientException + + array - $name + $options null - string + array - + createFromArray - \ArangoDBClient\Collection::createFromArray() - - Factory method to construct a new collection + \ArangoDBClient\Document::createFromArray() + + Factory method to construct a new document using the values passed to populate it - + \ArangoDBClient\ClientException - + array - - \ArangoDBClient\Collection + + array + + + \ArangoDBClient\Document + \ArangoDBClient\Edge + \ArangoDBClient\Graph @@ -16339,94 +16886,121 @@ Alias function for getAll() - it's necessary for implementing JsonSerializable i array + + $options + array() + array + - - getDefaultType - \ArangoDBClient\Collection::getDefaultType() - - Get the default collection type - - - string - - - - + __clone - \ArangoDBClient\Collection::__clone() - - Clone a collection + \ArangoDBClient\Document::__clone() + + Clone a document Returns the clone - - + + void - + __toString - \ArangoDBClient\Collection::__toString() - - Get a string representation of the collection - Returns the collection as JSON-encoded string - - + \ArangoDBClient\Document::__toString() + + Get a string representation of the document. + It will not output hidden attributes. + +Returns the document as JSON-encoded string + + string - + toJson - \ArangoDBClient\Collection::toJson() - - Returns the collection as JSON-encoded string + \ArangoDBClient\Document::toJson() + + Returns the document as JSON-encoded string - + + array + + string + + $options + array() + array + - + toSerialized - \ArangoDBClient\Collection::toSerialized() - - Returns the collection as a serialized string + \ArangoDBClient\Document::toSerialized() + + Returns the document as a serialized string - + + array + + string + + $options + array() + array + - - getAll - \ArangoDBClient\Collection::getAll() - - Get all collection attributes + + filterHiddenAttributes + \ArangoDBClient\Document::filterHiddenAttributes() + + Returns the attributes with the hidden ones removed - + + array + + + array + + array + + $attributes + + array + + + $_hiddenAttributes + array() + array + - + set - \ArangoDBClient\Collection::set() - - Set a collection attribute + \ArangoDBClient\Document::set() + + Set a document attribute The key (attribute name) must be a string. - This will validate the value of the attribute and might throw an exception if the value is invalid. - + \ArangoDBClient\ClientException - + string - + mixed - + void @@ -16441,277 +17015,232 @@ exception if the value is invalid. mixed - - setId - \ArangoDBClient\Collection::setId() - - Set the collection id - This will throw if the id of an existing collection gets updated to some other id - + + __set + \ArangoDBClient\Document::__set() + + Set a document attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. +This function is mapped to set() internally. + \ArangoDBClient\ClientException - + + + string + + mixed - - boolean + + void - $id + $key + + string + + + $value mixed - - getId - \ArangoDBClient\Collection::getId() - - Get the collection id (if already known) - Collection ids are generated on the server only. - -Collection ids are numeric but might be bigger than PHP_INT_MAX. -To reliably store a collection id elsewhere, a PHP string should be used - - mixed - - - - - setName - \ArangoDBClient\Collection::setName() - - Set the collection name + + get + \ArangoDBClient\Document::get() + + Get a document attribute - - \ArangoDBClient\ClientException - - + string - - void + + mixed - $name + $key string - - getName - \ArangoDBClient\Collection::getName() - - Get the collection name (if already known) - - + + __get + \ArangoDBClient\Document::__get() + + Get a document attribute, magic method + This function is mapped to get() internally. + + string - - - - setType - \ArangoDBClient\Collection::setType() - - Set the collection type. - This is useful before a collection is create() 'ed in order to set a different type than the normal one. -For example this must be set to 3 in order to create an edge-collection. - - \ArangoDBClient\ClientException - - - integer - - - void + + mixed - $type + $key - integer + string - - getType - \ArangoDBClient\Collection::getType() - - Get the collection type (if already known) + + __isset + \ArangoDBClient\Document::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - + string - - - - - setStatus - \ArangoDBClient\Collection::setStatus() - - Set the collection status. - This is useful before a collection is create()'ed in order to set a status. - - \ArangoDBClient\ClientException - - - integer - - - void + + + boolean - $status + $key - integer + string - - getStatus - \ArangoDBClient\Collection::getStatus() - - Get the collection status (if already known) - - - integer - + + __unset + \ArangoDBClient\Document::__unset() + + Magic method to unset an attribute. + Caution!!! This works only on the first array level. +The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. + + + + $key + + + - - setKeyOptions - \ArangoDBClient\Collection::setKeyOptions() - - Set the collection key options. + + getAll + \ArangoDBClient\Document::getAll() + + Get all document attributes - - \ArangoDBClient\ClientException + + mixed - + array - - void - - $keyOptions - - array + $options + array() + mixed - - getKeyOptions - \ArangoDBClient\Collection::getKeyOptions() - - Get the collection key options (if already known) + + getAllForInsertUpdate + \ArangoDBClient\Document::getAllForInsertUpdate() + + Get all document attributes for insertion/update - - array + + mixed - - setWaitForSync - \ArangoDBClient\Collection::setWaitForSync() - - Set the waitForSync value + + getAllAsObject + \ArangoDBClient\Document::getAllAsObject() + + Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class - - boolean + + mixed - - void + + mixed - $value - - boolean + $options + array() + mixed - - getWaitForSync - \ArangoDBClient\Collection::getWaitForSync() - - Get the waitForSync value (if already known) - - - boolean - - - - - setJournalSize - \ArangoDBClient\Collection::setJournalSize() - - Set the journalSize value + + setHiddenAttributes + \ArangoDBClient\Document::setHiddenAttributes() + + Set the hidden attributes +$cursor - - integer + + array - + void - $value + $attributes - integer + array - - getJournalSize - \ArangoDBClient\Collection::getJournalSize() - - Get the journalSize value (if already known) + + getHiddenAttributes + \ArangoDBClient\Document::getHiddenAttributes() + + Get the hidden attributes - - integer + + array - - setIsSystem - \ArangoDBClient\Collection::setIsSystem() - - Set the isSystem value + + isIgnoreHiddenAttributes + \ArangoDBClient\Document::isIgnoreHiddenAttributes() + + - + boolean - - void + + + + setIgnoreHiddenAttributes + \ArangoDBClient\Document::setIgnoreHiddenAttributes() + + + + + boolean - $value + $ignoreHiddenAttributes boolean - - getIsSystem - \ArangoDBClient\Collection::getIsSystem() - - Get the isSystem value (if already known) + + setChanged + \ArangoDBClient\Document::setChanged() + + Set the changed flag - + boolean - - - - setIsVolatile - \ArangoDBClient\Collection::setIsVolatile() - - Set the isVolatile value - - + boolean - - void - $value @@ -16719,1179 +17248,1094 @@ For example this must be set to 3 in order to create an edge-collection.boolean - - getIsVolatile - \ArangoDBClient\Collection::getIsVolatile() - - Get the isVolatile value (if already known) + + getChanged + \ArangoDBClient\Document::getChanged() + + Get the changed flag - + boolean - - setNumberOfShards - \ArangoDBClient\Collection::setNumberOfShards() - - Set the numberOfShards value + + setIsNew + \ArangoDBClient\Document::setIsNew() + + Set the isNew flag - - integer + + boolean - + void - $value + $isNew - integer + boolean - - getNumberOfShards - \ArangoDBClient\Collection::getNumberOfShards() - - Get the numberOfShards value (if already known) + + getIsNew + \ArangoDBClient\Document::getIsNew() + + Get the isNew flag - - mixed + + boolean - - setReplicationFactor - \ArangoDBClient\Collection::setReplicationFactor() - - Set the replicationFactor value - - - integer + + setInternalId + \ArangoDBClient\Document::setInternalId() + + Set the internal document id + This will throw if the id of an existing document gets updated to some other id + + \ArangoDBClient\ClientException + + + string - + void - $value + $id - integer + string - - getReplicationFactor - \ArangoDBClient\Collection::getReplicationFactor() - - Get the replicationFactor value (if already known) - - - mixed + + setInternalKey + \ArangoDBClient\Document::setInternalKey() + + Set the internal document key + This will throw if the key of an existing document gets updated to some other key + + \ArangoDBClient\ClientException - - - - setShardingStrategy - \ArangoDBClient\Collection::setShardingStrategy() - - Set the shardingStragy value - - + string - + void - $value + $key string - - getShardingStrategy - \ArangoDBClient\Collection::getShardingStrategy() - - Get the sharding strategy value (if already known) - - - mixed + + getInternalId + \ArangoDBClient\Document::getInternalId() + + Get the internal document id (if already known) + Document ids are generated on the server only. Document ids consist of collection id and +document id, in the format collectionId/documentId + + string - - setShardKeys - \ArangoDBClient\Collection::setShardKeys() - - Set the shardKeys value + + getInternalKey + \ArangoDBClient\Document::getInternalKey() + + Get the internal document key (if already known) - - array - - - void + + string - - $value - - array - - - getShardKeys - \ArangoDBClient\Collection::getShardKeys() - - Get the shardKeys value (if already known) - - - array + + getHandle + \ArangoDBClient\Document::getHandle() + + Convenience function to get the document handle (if already known) - is an alias to getInternalId() + Document handles are generated on the server only. Document handles consist of collection id and +document id, in the format collectionId/documentId + + string - - eJy1HP1z07jy9/4VYqZzTZkUDrj7pVz7LrShBErSSVJ4vIPJOImSGhw7YzuUvHf8729XsmxZH5bd5DIMLdHuale72i9J/PGv9d364ODp48cH5DHpxF64jC5fkZs3N2QW+DRMT0nih8uAklkUBHSW+lEIkAj859qbffOWlJAc74KhsEFvk95FMYyRt15IRimlKy8M2dAsWm9jf3mXkov8t+e/PnveJmnsA8EwIVer6Zs2DAfRMqRtckVjwN4C9tODg9Bb0QTmpsq0L3MxPnjBhpJo+hX4JTFdxzSBcRCDeLoYf0zj81oSwTrMcIiQX588Z6zMAi9JkEtB8X8HOMy4wM9jMr6TF474c9JaMXmnlPRvr6/JAtYopPcSUHKcIQsaf373YrLyf9A5OSkTyyCesp/r2P/upZQcTvw5LEU1I7iGD2UlAS3BUp6o9Czc4JCTn3S7fjA/fpiWmUFiFmZwyMnMveenr6N4tA1n5DszpQdyNo2iAFjT6FmYk+CcPH6NNnHoBSP/v3Q3HvnqaeQsLEpwThb9ZLRNUrrayxqWidkMPwOqwdqHKPBSP9hx8XLmyuSs7Akw9/7crKY0HixGd148T3ZjUrgOE03bni2BvmSjJo7Btwb+zMO5X3uzFBjaC6cWshZmNWg7vwnKA85rlMaAu9zuh10zVQu3KrDTFBjCO7rd0Qq8OPa2gtmCXBWXCOVmL/XSTZmYwb8YoLQpGYhzvm90O1gzMe1zClktsOrMBZg++0UpePvhnP4oUZkBVkq6/fHw06R3Sc7IkT8/qiTDQm81oX7nfRdJIWg1MRY3q4mNP90wYghaTexICkBHDqofO73xZPSpf4GkZbzqGaT44Zrh7eB22O9cT0a9/zD+ZdTqSbglueiPxp3x7QgpZ/DVRAsjcRF+1/00GdyMe4M+oy4hVs8gopeLfm8ECz8ad98zaxNILtoi9NSg/mFw3Rn3rrucfo5YPUM5ZLhm6d++f9UdTgavJ6M3neElWyiFgtmLy1Nqjt8167B7c9276KBqJq87F+PBEOfVybinVr2409hQyl7/Cqxu2Bl3rz4xu1OJOMxa+ORak6EZjvJZGJpOfh1HaxqnPk1ItOY1kUaTm/LkZji46Q7HvS4jWiAaqM6j2WYFVVNlTs6Jo3OaXA4ubt8D60D4uU6NzpdaqWCj1L28Qqt9oVPpQ4icRnFYqv80ItwnTPrdj5NXg2EfSD3TSd2GQeTNIfLXIXXbvx50LruXZtmu6xPKyRiEk6xkSrE222Qs2sm96qI1Stz9ppO9pAFNa7J32b3ujhmh3038AWS8maUJ8UJCV+t0qxPNI/jai72VqDIPWbg84VETc530jlbgpndxdJ+Qz+Xy/TP/0f0xo7qVrzdT2P5ksQn5Ck4mM8Fui89+BqlzEPCsilf4+PEXJBt/dJZBSKP4OUzv/OTkPKFpH8A48PHLHOTnAf9bXS3uhLZkRdO7aE7SiOQMEU/J9Szym+VVVphnSYcsM0qwign91PcCkn2Bi22fKKYphGO592FYUwys8tLOYgqO7nUcrTo4d6vEgbq+h9KeP2NiJzRYtI4z88IPsEi92R3oIePZS8ghxFtydp5R1VRSEGWKaSF4WwDLusl/zSSVMF9aFHdFU2aec7rwNoHN/alLmLdT9B6KeRWXNL3kM4yBaktdN0EWFuv0tORfbXxfBFFIldZYidUhI5nwvYfAqigrb+nPLPJ9j9RGlb7hkKYmSLZ9JpB3Kx++3V5qkGw31oKUWzLVkHJnpBoyb1E4Z5f6BS6JyjV7BaReM9sgtXK1GpLViiY+zRvAEwad910ZTyRaVLvuko0VGwd29NvRoH9Cw1mEoZITb2J/+f4q0bHENN0202jECNj2WbZWafQ2icLWsW1pdhJvH5IIBs1SfIWxCafYyiQCN9MJgtbxA0QCG6AxhBLYM3VFwgMHCam2UKMcx+4IM4jagjEzDoKSUCkwOt2kNLEIIloO/CcYu4uAWSDBm+oKYSdhRDkjf5XCGXfyefeh+GAAzN1n24rDGg0GHHSkdqyi9i9jSU7Vjlwu689NftaOXJS+ioyZ663EzMvaMqZwxXZc1kExrBIGdTtW1l/QsHi3wY4ntw9kvKKPkKN+kXIhTEfRN7Ns1Bw+tGSIW9VfJYtQCvMvxEZNTWTxU82NFqLqMKTX7DJLlt5vE67UcFiHKa2cl3nSO7wFSyVW/GTC3EVLi7fHtZlgZb42O+/cGqYVQYuTsznAEYvjJu+leD/szWK+3coBWBZ7TFabhLWoRTbwREP0E3LvB6za8OfYh8UwwjvcWapQ0PTCOeFdb1bfwL8FHSpKHFzQggIQ90NGWZ24UYUkalAUkaBzL0mpAPPTgKyUAGD+E6so2+rVzpC1QkUJD2hMj8CaOL8MVLMgvnJYRimit456fKmMCmeVy5G5MmIVMCu3YDuVQ5G9FO7NW3m1VQLhi9FsIoxfrqp7b5PlYc8+48ciAu5xYjlk2ud+WwTQPc6dR9wKjWbBd7+zimhdNa8I3XucGWO9fUpWcO9vMp4i2KcbsVRhjxNKuYV91nd5orHPnarkFRW7tpRl1GZB/OZmRc8o7MwM1fziH+BHSyYqDEJJLfZpi3k24Zgec4vGq/D0KdmE38LoXgotbZ4AQJbgL8MozrrV5mwkVe9RWfMJHueybACCGpZiIeQJfsIugElEoNZKyGaNyQfrsibRCnIPQIt1+o3SBp4JHPq2+1pq/MdbJK74j2HTnxt70EWbTDSiyS+/EOVrRK6fEYzuok0wJ2GUZgvkXE1LilBukiAzZ6TF05Rj5MnVSlXuzvlYV8fUm28JMyb1pkPptD6BYpyClkMaMxVjvwDvgND4O6g4CoOtmhwa0KHmoTHoAgyW5Bcvpv5ySfEoAtbi5s3NpNcfT953/v0kt8YIBA98bxpsIYcE0y5n0yAJDRJ6D5YGm8DjvQ+eaiZ84WGOTUJt9mK8C9gm5XshsFTS+DyiCVPnFhb2zvuOObV2gVDvRfSsXZVCo1VFRKrfOtxHPi6dCe2QUkuHMoqMXgJGkrakjJpBHSvldqntbNp7+QDH33X/MXJNd2CJF3nz8XuZtbcfvzHq2oC1DzVkK2OKcNhZFbcGS8OqxVhzwh/YWYsNxp2FvjOT7IyqdUyOKN73IVE8x60eocUA8NxfLGDbhim/esNcANNNFK+8ALxKPi2BQgD05K3WAcIBaVEUIyUg+KJEns/LdDtf0pOCqZ0qWLx9dcg4PeEMn5Hn5ORcsFvM0hbDL3BYYWGHTcYzZqRtjl1sUtghR+LSwJGefnDGrAdazCiYR1Vpohh16OG1AXu2JHX7jLs8H+Bi7rrLGbmmu7wQ/NGZcak4wwYAlP0BvQJGCmOUck5s4a/wqGCRmT1IkKWlzBaygW/it8f/Ed9UdcQqc93AN/EG8G7eyeyczJSbO4zstqa4tgmpwxl5xtxGdoumLS50Zu5E3DeRvmd+RPv2N/y2fEdFGv0dR+f81skOPkeUzZyuPbgzU8yAbLE9482076UhQWXXvZ+RfMjuf+SHWTe57O1Mxw3lQyT8cIegXH9qV4OJy0MOsFpA5etIDuDsrlEJ6As+HhI3fOFzXPzW3Lllaqjv3hSTyA2igQ/LUGt7MfletcuJZRvC4caqWTY4Mmwj8GuDu/mc7BqQdFv7hHTwIDmJZr6X+litMJBZFKaeH+Ke4PNCCgNYySmLAG08c43ub2F7Y4+iDUsE7hJzijbsqAU4Bo3LBk5F7ooVnNqdS3ayI4HKLkY/1EOjkS+i1zYcSQv1rUe/Ie+yIUl+hx25pRC2ZHsYpdgHe2WTn6s4kRoo1dCvNyuU+X7MKTM2/v4bovEEGRN4hmxG5lRguhRreHtWV6f1XpvpmpUXwaHa0gu1at3aXpSZ8g2hWidOA9UajkOsezVr8lSoUuasrioNT/SaOXfHozxdk7LMDk2WHvJVa9L49K5yiwqMU7LwoCw7OYdIGpeLTYjVJ+cJp7uXQlM9hdrjPs4XoK7m1ZePDXdw1VtHQ49OCO7q1OWPI13qNj5mdCi8GqeRHtVTvb1qMuezvi7Vp6KNtVn1ONSkz3wBnBot3pNW67Ti6WeVP66D1qThajzZa6Jet6NWWK6rZfN727qarv/C1tD8LC+Kqw1quILFT9mKvwz6r35QW2UCNTEbWIH1SHUHQ8Bvs3HW+EugoA4CPy3dXKm6KV3PSqzPnZsaSq0Hzrqt6EvnMBfL9biflcYi319THjMrliLOY4SxVD6Efoit2M67FamtN9vrKlYgokSlh+FNFVvnKbihPlfFdFXqxhuGdvdvfvOtKFN+jGN9J/5gJcq3Bpps9KyMtvr7gs1Gupbf0zetmStf0FuUy8Svo9Xi5ubPA5CB/Q8zEy/wvaRVnE6fnrLv2+Tos/gfc8SLt+nni1Kz6v9tJkgb - - + + getId + \ArangoDBClient\Document::getId() + + Get the document id (or document handle) if already known. + It is a string and consists of the collection's name and the document key (_key attribute) separated by /. +Example: (collectionname/documentId) + +The document handle is stored in a document's _id attribute. + + mixed + + + + + getKey + \ArangoDBClient\Document::getKey() + + Get the document key (if already known). + Alias function for getInternalKey() + + mixed + + + + + getCollectionId + \ArangoDBClient\Document::getCollectionId() + + Get the collection id (if already known) + Collection ids are generated on the server only. Collection ids are numeric but might be +bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used + + mixed + + + + + setRevision + \ArangoDBClient\Document::setRevision() + + Set the document revision + Revision ids are generated on the server only. + +Document ids are strings, even if they look "numeric" +To reliably store a document id elsewhere, a PHP string must be used + + mixed + + + void + + + + $rev + + mixed + + + + getRevision + \ArangoDBClient\Document::getRevision() + + Get the document revision (if already known) + + + mixed + + + + + jsonSerialize + \ArangoDBClient\Document::jsonSerialize() + + Get all document attributes +Alias function for getAll() - it's necessary for implementing JsonSerializable interface + + + mixed + + + array + + + + $options + array() + mixed + + + + + No summary for method isIgnoreHiddenAttributes() + No summary for method setIgnoreHiddenAttributes() + + eJztHGtz2zbyu38F3PFVUk6y00zvZs6O0ri24qhp7Yztps3ZPg1EwRIbitQQlB218X+/XQAkQQIgKduZ3nWiL5ZFYLEvLPYFPv9uMVtsbOw8ebJBnpD9mIbT6PB78vb1W+IFPguTXcL9cBowMom85Rx+gHE49OWCeh/olBGSzToQE8RDukxmUQzPyA80JGcJY3MahqVHr2DeB/ITXbFYPPGixSr2p7OEHGTfnj395lmXJLEPS4WcHM3Hr7vwOIimIeuSIxYD3BXM3tnYCOmcccCKlRDay8h7R4MlI9H4N+YlJGaLmHF4DuQRmlLpRUEAT/0o7I0pZ5My2c/H8YtGHAB4Hj4i5On2M4GgF1DOyaGCR/z5ImD4jZPLH3gUnjEgMvB/p+OAbfyxgTMF2vh5Qs5nuQSIPyHtuWDPmJHjn3/8kVwDR0N2mw3hHTUxnf/yhsaEAx+B2J4OSQ3YEX8XcZQA9UD21sifAOOqsPjAVo+FBoBy4gHPahCJ2Y3PQWL3w2buf2RuLgDsmtVpAuSMlwnjpC1UcOcG1cy+GI1j6iZVTiR9cnFlLvoqoFOSRMQPJ75HE0ZuZyyZsTjH5JZy4s1AEwFYEHk0CFY2HMZRFDhRSOf3yTUNOLsPGj6H7aTzHfjCbmDEmLGQcHoD4AEATCKcxfDAyqlKLH1+DPD7YBeW66AI/PUnFDc3ia5z9BTb+SxaBhPUngWLQXfmmVqAwIEoDywZPEyWcQhIRGGXgNTJjCK5agbFPb9gIQ2S9Vk/id5J/Jib+/uhVCEwiTOakAm79kNA/XbmezNdE3NakphRhA9ozvzJhIXb6+ulnLifg19TQ+V8O37+NIxi5GcM87xgOYHvfgh7WvEZ+EF7nCV8fSURkF+buDt4e6iZVyCBfSxA9qKQJ2RwfH76fjQ8BCgtsJCtCihoHqvBvBm8F3BgpAXQaWrVatE5HbwTcMBWWeDIvVJP09nx4BdJFk6wACpLsQbg6+Hh4eB4//z8dPj9z+eDMwG7rEkPX2Z4dHxyOrAuZlcAy5K31E9eRfHZKvRItBD2wbXoydvz4cnx6Jf94fno1cnp6Oz98QEupoGwLLCIAt9bNYT99uTH4YHQDDnNAu8DY4vjZRA0hPhmMHgrTkSAmU4FqDiuDDlm02UAO4t9RO9I6N8S3SA8S1GjcxNqWQ4UGpTxaPDr6O3+6TmudkF7v+/3/v2096/R7vbLy8teu/P3bn9va/PJZetvV3980332j2/vLAQeILx46YFzBFaXzRfJSvPEioZgQWM6lxaMbEmGcJJ/eopJNOgCn/wEnKx8GJJVgkvqPs8XL07UdBozsitdwoZzA/+FZRcAkmcsQVIlGXA6mTYTcfWUNc9cmu31VnZsCVgfj1I03mCZb83Ft8khu6bLAOQBY4QBfb4DENfgWVFsylwvx6Dh5HoZCpebjEZeKvh2SaB9EoLWSldBesf48a9J2+cjMbadju10tBH42dkROwadTvQ6QnDul7BjYu6JowdcEKHoyOAx+PS3NJ7wnhfNF6DoYz/w08O8sCicSdmKFy1DpFcGFvjZSsCT6L2AuWUZVMPaK0C6q0OHs+B6d9duh++PWDXUB6Bot+F1iA6turzeCg9BGg/MWhzxLK2cvyYGrZGywKxaw4repHW6a2X57c5076iXRPGKzMGpi4QLn23WssO/5OleU771AkJf6fYvogUcMHisG4Y8mcXRLScyiB589NhCO2fs5l6BB/uVmnb1i82w208K2/lQcTxkwKSHmvl7nwaTKft0FNPFzGbieAK2RLN00pC/iqP5vrRdEu9uGTv0tMtGbyvjc1+wXcLOzV8uWMCfUYgMUvAYBWzhMd5/oXhXVqEMtlDfNg7upkP3NBUxkRETDmT42MbTpLOXj1LMygbvOXTsIIhCBtrkYPqpAMOFZnk4tCyUOZ36nkNSN1E522GePgizbfBbbSnwodUxtGc8E0x1PAO/3HgGR9IkgpMoURG7ICmLvq8xkoLIiTnYdITOQppHyRJZWWSbaPmJcrg3TMitD54jLh0tkwWGsMZpX8H2PO/ByQ9nJ8c9FnoRBm0Sm3UEkuWBCnBKoneJKonOxHRDWqmqSeYnEebW2h2Xwj2AtFprkvly6UMRswvuY5IhM4m49pQl+/B7SmC1X1X2QGtGS89PBtfDMGExYFfw+dQzgYivBjzY+fszHM7nO2U/8zGUTelQA8us1voNho/kEm2lh1K+mou6rkJSTJaJBPEXhfxrKSTWWjTZNlTJs2zGGoqZLfMgtdRi0ls/mYnfFL8izEbGbB7dZMlTu3pqMHo6QD0RaZ9pRM8O/srhTuB2vl77AWibGVPkQLpOPOy+mmWUZepmXzoI5Dvb012Si8vATXezMGDwomUIjlsZSIe8IE/L3l7uHxproqdY+vGYzg1/MV1VhSk5ny5ss+0hC36WYbP5e8bsYsikhzHZVwGcFKDXxbKGO5HPdW0RkcGx1IVK+onFI1E6yzOcoWDsfMlF7Sp17LbzGT6XVjoN3vLQKnX3cmA0nBBZBxPxFPyfwmFpSIUSyyEAcD8UkI3SwDoRmbJnIrwg+r4T5JUGi6IbUYEFDJZ/Mdxysa2xF2+ELaUdidpqBsmWlJGF2fKILAwUNWUFJYp3d9NZ7aqgSeAAOF48vSL9PuaqW2UE0iHieSFvcFiTclDn5XBiolBU6nICoNn6bwbvmyHwhq0+Dwang3fVGKSlk8+zvEjcNEr7rLe6BQ/EYTNVVhUc2hRlU5lfNVIG+xeI/VWHfPpEbA/EmWNPAuAHNgAaTT0idRGsFY1lQbaWLgCOZorDjtG2lxE4F9BNkV3X/HaJiEFV2sowxmj90LvWB0m/mAYBGj9ET7WMgOMH9lnUQ9DxgfA5hTNhXkCF/YNZ1t6Aaz/mSdGkZyYLvs/pYiGdbxRkJ/N6g9U9jbI18P7fstSjUZ2tzneULRPlyovUHsEWPvQE7Xia1pElGdLLj19N00SRzb/Wi5dcZFqAgkpWTBWF9vqGc2+XN24x91EYaz2H1Pg8NdWcpfXbyq7e0zr1bqi4f7LARiOXyIoyyEZl/C0zeMixvW06ZViKGq8I9u0glVLsHWyMEPVP/IqVXup5WJgdBwy7HRYsTnwzY/cghmFXBaNpDwaXgTGgIYJe0sZjATurJJc6NWxS2vtoul08YUxdVs0ddmX+qWDkIxUYUC3Ozyz0AV0iBZubm8r/juIPHCQQrFAMeCgIi66iwYDdsECz7igbds1ilKmxXH4o+BIS9rhgt2EXtU8eAfB7xEU6QoSFeFpOIsR0uRDeZScPvWXsvquV9jG9L/iwzubaMprwDFmqIM0iS/XEJsdKw2I/LO0Iyn3cLLGF55Mli9Ul6vdUxfPTbKucj0pXt3++ZLxca7ozXllGJpWWQ/yqgbLuwMTEVYPUF/iaYgOLIkl8A7uuUNnPVCUKJqQsISI0j8F/27lPYgySn75ueuRAVwOa2id/1Feo7zRwZl5IrWsDZwFUjCrquyZMQvNCsmaBCcNT4bM2XNgwEchj2W3EPvo84W0jOmkZ+61rRjCKnsKDDmbhsoq5AeUK83HlXzX2PgBj00TcC2UTTBOcH11oLvVvIjq7zbqfAO2wJEuszwxh3p+S+i1+H5oatLY0p86WyF6PsMcmyUqMgaajHQF8qWyFfikU0qwpqLe+OWHTqCxGq0taajh8rUSrZFMtm74vUyLuvDuiV9+Vka1QzBmSr78mT0UeBxz9RcRVkNwaYToRnm36YWrkZfSsE92VmLkS8oKR1tSL/mmQfJecceygvjo1zTYUFGMmPldZBkd1LarhzroKb1pkvvLGDeviF7Iv+4oUhlZFHmLaPbxdYVF9cKBj3Ak70sGviWUp55Hng+G9YY/oTr2K4qHA42cVZJRcqVQqF1o2oajK2U6r1+lCflU004tMZf4LtrPbtNOL8M6WmWesgo6ixB2h0lh9VW5zJD5Vo/OSiSB3xbR0QAM89P+qd9FdcZNorUSbDgQfRTXX0M2uiDxT/z3txFbpUL/YaSRTPBC8QJyatcX9EuPPMRGX377EdX/JuO4BRkkILtOrs2RyIC5JljTLhdkkYjJbN6O4ZFidv5A6s89PhPY2CR23IGQEPuX7rNwusVfYwKryLid1hJExKu5pxpXdkkuuyG3bj6t070p4VWUPrQHDSKKQLW8Z8yi27z1rN0YmuroWiya1WOPQNpZ0JP2rw1mUSX1J/qiGOfYMRVN2ONXM7NEokVjMEdcF7nbaStnaSpx87miWXwOxygSFBT2pYKlBdniAddrj6vG3Q2uiSQ4yQJ/aiGvHHTVV7z+zUGpjRV5HU22/tuGaYOv4k/Zb28tnpXJQXqZNSa0sqB41oExDNT13fO1mrXYjuavKBxHeCL31OaskbZqT1oyoOvHIW5B1wpGjemKcOIXQTmMBBoNgTIwAZQ+whaotQKzibDJXV5szbcT/60Tkpk4X0DrkOcUiaagRSiXSmUhSd8h8G0E6NO98kr1Myi/wJ8IehwXEJQjAkKsaiaymR3Olcyb0e7U3+RNx2aQW9bX0QmvZ8SdVDUuwetYqiOFM8WecXPI3JN9QziUq260zeQcb/SfJsBretopuSgG/zUXMpqM5TbxZu7XzH+3aZw9vef7z27vLnRbZVumU0j3RbdLa2ml1Bfpr4D+UTWtEXLxPCnd1gIqW47pKzjHYY1KouMvqDYgh8rxeVqOuGNDdQ19N+Pfux7NprAX8PVRWNHk5iru2gFbX2vT3LUsOZm29rWCyQxUseluvoojqI+koxvDVSiovFeVamkX5FSeBxTKRNnY4BDGjkxX5EEa3YfmNG9qrD2TcO2Uhi4VOqmK3fFOHqH9vF4fjJUBgODI/f3kOrkrD7P0ZGjLdtOitWJLPGU520nFDlzXNmuZtdHZJ8f0vuieShYqYzVHhovH2G8tpl1vmuiPPaUHcohFtwHWyaUC6SO6uRbv5xh037bjFa4ivUMyDKLxhIWwLj+nXF3CB4h0X8OMmAbPwA0kWrwGAnUS5mmsIxqLMEuJaCp1O+Usr9WtBZI1MSzyuU+6CudGtnORoh5TFarmXKPowFTMw7aiEwNMe95yrLS6bmXBUYXWxo4TdzKL1DogaT8REtlftZF06g48UX8G1i4mbFDBC1QRWVq1zi8IC1qKPVby2Ju+UAxTRyTAai8rCT5NnDxP5du1mfgQDVmO3Msbui32a36kBdbCakwbM+DyWrd6ilfGtjZELRqLWph/ow5sYKMuEEFgQA2H4EqqUQyn8segnxDbmEK+XjYbH56Of9n/dJucREAriGQcr1X1NS7hjN8ctXj3uwiNxNU1uyPyNTUtu3u0qya8A8jNYsAPNvhqSfBmA0Whv6Ta4A24U+7gI8EJmS/hxmdJ3yTPbdR99dl1oYLyIrsQd7U1ODWRd55pJefAuYXCuqhBjRYIo+kC+UjrxVWavLOLWLbVL2OlVJJuoC0UbvNrey1/A96AoOL+1AfBc6RF5lz53icX7+Rqarfw9gU19rlSfNQI/gzZnhNdY6Bpaq5spHVYZyxnCw8IDK2TYWkxj2RSXvaASNaL8hkrpq1xTz9Fb/6Wo939e1HvMZs3fNOVha1xXrqy63W3ANhBl5ZEIDNqppdzdFb92SesyUe+NvVQvaB1fpoMw8v4vAesctg== + + - ArangoDB PHP client: HTTP response + ArangoDB PHP client: single vertex document + + - - HttpResponse - \ArangoDBClient\HttpResponse + \ArangoDBClient\Document + Vertex + \ArangoDBClient\Vertex - Container class for HTTP responses + Value object representing a single vertex document <br> - + + - - HEADER_LOCATION - \ArangoDBClient\HttpResponse::HEADER_LOCATION - 'location' - - HTTP location header + + ENTRY_ID + \ArangoDBClient\Document::ENTRY_ID + '_id' + + Document id index - - HEADER_LEADER_ENDPOINT - \ArangoDBClient\HttpResponse::HEADER_LEADER_ENDPOINT - 'x-arango-endpoint' - - HTTP leader endpoint header, used in failover + + ENTRY_KEY + \ArangoDBClient\Document::ENTRY_KEY + '_key' + + Document key index - - $_header - \ArangoDBClient\HttpResponse::_header - '' - - The header retrieved + + ENTRY_REV + \ArangoDBClient\Document::ENTRY_REV + '_rev' + + Revision id index - - string - - - - $_body - \ArangoDBClient\HttpResponse::_body - '' - - The body retrieved + + + ENTRY_ISNEW + \ArangoDBClient\Document::ENTRY_ISNEW + '_isNew' + + isNew id index - - string - - - - $_headers - \ArangoDBClient\HttpResponse::_headers - array() - - All headers retrieved as an assoc array + + + ENTRY_HIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES + '_hiddenAttributes' + + hidden attribute index - - array - - - - $_result - \ArangoDBClient\HttpResponse::_result - '' - - The result status-line (first line of HTTP response header) + + + ENTRY_IGNOREHIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES + '_ignoreHiddenAttributes' + + hidden attribute index - + + + + OPTION_WAIT_FOR_SYNC + \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC + 'waitForSync' + + waitForSync option index + + + + + OPTION_POLICY + \ArangoDBClient\Document::OPTION_POLICY + 'policy' + + policy option index + + + + + OPTION_KEEPNULL + \ArangoDBClient\Document::OPTION_KEEPNULL + 'keepNull' + + keepNull option index + + + + + KEY_REGEX_PART + \ArangoDBClient\Document::KEY_REGEX_PART + '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' + + regular expression used for key validation + + + + + $_id + \ArangoDBClient\Document::_id + + + The document id (might be NULL for new documents) + + string - - $_httpCode - \ArangoDBClient\HttpResponse::_httpCode + + $_key + \ArangoDBClient\Document::_key - - The HTTP status code of the response + + The document key (might be NULL for new documents) - - integer + + string - - $_wasAsync - \ArangoDBClient\HttpResponse::_wasAsync - false - - Whether or not the response is for an async request without a response body + + $_rev + \ArangoDBClient\Document::_rev + + + The document revision (might be NULL for new documents) - - boolean + + mixed - - $batchPart - \ArangoDBClient\HttpResponse::batchPart - - - Whether or not the response is for an async request without a response body + + $_values + \ArangoDBClient\Document::_values + array() + + The document attributes (names/values) - - \ArangoDBClient\Batchpart + + array - - __construct - \ArangoDBClient\HttpResponse::__construct() - - Set up the response + + $_changed + \ArangoDBClient\Document::_changed + false + + Flag to indicate whether document was changed locally - - string + + boolean - - string + + + + $_isNew + \ArangoDBClient\Document::_isNew + true + + Flag to indicate whether document is a new document (never been saved to the server) + + + boolean - - string + + + + $_doValidate + \ArangoDBClient\Document::_doValidate + false + + Flag to indicate whether validation of document values should be performed +This can be turned on, but has a performance penalty + + + boolean - + + + + $_hiddenAttributes + \ArangoDBClient\Document::_hiddenAttributes + array() + + An array, that defines which attributes should be treated as hidden. + + + array + + + + + $_ignoreHiddenAttributes + \ArangoDBClient\Document::_ignoreHiddenAttributes + false + + Flag to indicate whether hidden attributes should be ignored or included in returned data-sets + + boolean - - \ArangoDBClient\ClientException + + + + __construct + \ArangoDBClient\Document::__construct() + + Constructs an empty document + + + array - $responseString - - string - - - $originUrl - null - string - - - $originMethod + $options null - string - - - $wasAsync - false - boolean + array + \ArangoDBClient\Document - - getHttpCode - \ArangoDBClient\HttpResponse::getHttpCode() - - Return the HTTP status code of the response + + createFromArray + \ArangoDBClient\Document::createFromArray() + + Factory method to construct a new document using the values passed to populate it - - integer + + \ArangoDBClient\ClientException - - - - getHeader - \ArangoDBClient\HttpResponse::getHeader() - - Return an individual HTTP headers of the response - - - string + + array - - string + + array + + + \ArangoDBClient\Document + \ArangoDBClient\Edge + \ArangoDBClient\Graph - $name + $values - string + array + + $options + array() + array + + \ArangoDBClient\Document - - getHeaders - \ArangoDBClient\HttpResponse::getHeaders() - - Return the HTTP headers of the response - - - array + + __clone + \ArangoDBClient\Document::__clone() + + Clone a document + Returns the clone + + + void + \ArangoDBClient\Document - - getLocationHeader - \ArangoDBClient\HttpResponse::getLocationHeader() - - Return the location HTTP header of the response - - + + __toString + \ArangoDBClient\Document::__toString() + + Get a string representation of the document. + It will not output hidden attributes. + +Returns the document as JSON-encoded string + + string + \ArangoDBClient\Document - - getLeaderEndpointHeader - \ArangoDBClient\HttpResponse::getLeaderEndpointHeader() - - Return the leader location HTTP header of the response + + toJson + \ArangoDBClient\Document::toJson() + + Returns the document as JSON-encoded string - - string + + array - - - - getBody - \ArangoDBClient\HttpResponse::getBody() - - Return the body of the response - - + string + + $options + array() + array + + \ArangoDBClient\Document - - getResult - \ArangoDBClient\HttpResponse::getResult() - - Return the result line (first header line) of the response + + toSerialized + \ArangoDBClient\Document::toSerialized() + + Returns the document as a serialized string - + + array + + string + + $options + array() + array + + \ArangoDBClient\Document - - getJson - \ArangoDBClient\HttpResponse::getJson() - - Return the data from the JSON-encoded body + + filterHiddenAttributes + \ArangoDBClient\Document::filterHiddenAttributes() + + Returns the attributes with the hidden ones removed - - \ArangoDBClient\ClientException - - + array - - - - setBatchPart - \ArangoDBClient\HttpResponse::setBatchPart() - - - - - \ArangoDBClient\Batchpart + + array - - \ArangoDBClient\HttpResponse + + array - $batchPart + $attributes - \ArangoDBClient\Batchpart + array - - - getBatchPart - \ArangoDBClient\HttpResponse::getBatchPart() - - - - - \ArangoDBClient\Batchpart - - - - - - No summary for method setBatchPart() - No summary for method getBatchPart() - - eJzNWFtv2zYUfvevOAGC2g7spMv25NRdkzSoG6RJkKTYQ1sYtETb2mRSI6m4xtD/vsOLZIm6xFmAYmoRyeS5n4+Hh3zze7JMOp2jg4MOHMCpIGzB35/B7eQWgjiiTI1g8vBwC4LKhDNJkUoTvktI8BdZUICc59yQm0mSqiUXOAeXhMG9onRFGDNTAU82IlosFZznX8evfzkegBIRCmQSPqxmkwFOx3zB6AA+UIHcG+Q+6nQYWaEhJKCe2pPchXPOFIkYFWg/kRLmaEjJA+lceDMTb31vanyREQu0m68Pj40JVupEqeQuC8k/He2q0a+fA3hYUlhSEqIRgqJf9JGGbi4jefdIBEicYws3dGTeiYgeiaKwP3UCxtDtonc1GmY83LxAvmGvl34ax85+uVUARAJmE73nARAhyKZOZXGi3iOJSr98q3cJc5TGCu0mKpXDGNMIvXkkpALzzeflVDoj+8/23elpjq1RY82AgIdGtbIGumVQ1RhpxNQ7jmg5RylVXX8sKYoVgCBlXJVUQGTBa2K+YQFO/J1SDMU6wtWVKiBbUp3LOpNmnMcNNq2JPDVixzAnsfz5tp0RFSwTIhqCNtPTtzhdNcwkJ+YBURFnDgMlIQEqVjC5OH1/cTe9ujk/ffh4c62znTFh1jVdvWC77igLE44pdfIHkEpcAxHDaEUxf2zVaF8X1+9vbz5eP2jF34fElJZhJrYGd/dUQZq0wCwPH0aNrBzCYT8jvre/h0ZCwFdJTBX1FgyuYZkmCZa3EGYbQymp2Hrjy+ZYoSP2WcRm2iwNO0Ri+Hx3VQEFqtV8c8FXrRI/IbR46CQaE1d2RC0JogjNNOFeLylDA1moWUOiCChudFop2oT62Gjg4+/9DOU+lVoKvpZg6/zF94AmGhZlJKazOApgnrLA4Gw6NUkWaaB6XswHxUCNgaVxPPA8zUf9dWeLl91C9LOvlpEcvi2uz5znJKeK5tAr6NwbW/nw6pWnN5vpF1TkAjzkjMe6IPqU+jHhAkbXfsR6FVL9dD9gvWB8iwyNhwLYgMyV2Rtt0cCcdmvlHHrOHEIX/x0Wo62HhnDNFR2BjhysyAZmCHRQ0YrqUhRJmdKq/P5JaehHZ/uVf8aRxFy7hGR1IPut61ofs6NbgQmNEypGIwSfpHrgE5USG4o2oHgIKdhTVuv2jq1iu3ltf7tttd4WO+c50T/plJFUcMmgwGGpFKGKRQZbx69/M6Crm/vVzu3l+O3nAn2QHR3BwsOMNmavitmXgF4//wXKuM1F7JHEUfgTIL07Utvd2dXybkG+lf2jsjXdUZUKZpie2xkJy6p30mEts8dYX3wXVE0ctHp+xXQafAietPtiIhNGj1GY4l5mDMv60yc8Ku9n+kSCnpkXMpa6ET8IMtuhXW+PiUlxYV9/vrrS4HajuFpYF5tgbAdwi9s5PIa5Z+zxI4Q9OxWqF8mptcBRFcuA9WOsTVR48lrnorxSgdWU+jVRfjGk3/r+evMzU6Iuos7PpV68T+Qvx+KOWXOSzfkEM2DfyEMKZx3dvdqkyN3CLZ8EoyXbwZe8ny04taNPrbCSL4PVlTPLwavd3S0MJY3no5HXgfezMOi/baGwBv9fI2KYL1wf/6K4lM8J/R1QYnboZ8aghafRyTPkeQrbWu4OJruzdvEw7+Kvh/rP9aZBZHY/UL4RaPTvzkh4ykOrZwcfzdEk31cv72+u8aCnN7iw9vjbevpoLlW2MjXoqTtvN7p/KbFBqJw83I3QFrQWBdtCvf8n8iGFfk1DqhX3DJe+vUsre8UebjjG+J5hrGwPxdYzbxFrWjYXjy/f/EbIbyHlkqdxaNp/F76BOa4D1xcZ6yhDl3ue6p3wLBHPuVjZ6GrEtbZOFRRpp5vA47qI/BKkcOHRsAJKV45t+cV6dpbJ6m3FNhw083mdef/SpeiNJm/0xhE13OnU1JfcwPYlWDDIacb/5gp2ik0tkb1iVEYjMzOA7tfsMvmru9GdfS0S6rz9C8rpmwY= - - - - ArangoDB PHP client: http helper methods - - - - - - - - HttpHelper - \ArangoDBClient\HttpHelper - - Helper methods for HTTP request/response handling - - - - - - METHOD_POST - \ArangoDBClient\HttpHelper::METHOD_POST - 'POST' - - HTTP POST string constant - - - - - METHOD_PUT - \ArangoDBClient\HttpHelper::METHOD_PUT - 'PUT' - - HTTP PUT string constant - - - - - METHOD_DELETE - \ArangoDBClient\HttpHelper::METHOD_DELETE - 'DELETE' - - HTTP DELETE string constant - - - - - METHOD_GET - \ArangoDBClient\HttpHelper::METHOD_GET - 'GET' - - HTTP GET string constant - - - - - METHOD_HEAD - \ArangoDBClient\HttpHelper::METHOD_HEAD - 'HEAD' - - HTTP HEAD string constant - - - - - METHOD_PATCH - \ArangoDBClient\HttpHelper::METHOD_PATCH - 'PATCH' - - HTTP PATCH string constant - - - - - CHUNK_SIZE - \ArangoDBClient\HttpHelper::CHUNK_SIZE - 8192 - - Chunk size (number of bytes processed in one batch) - - - - - EOL - \ArangoDBClient\HttpHelper::EOL - "\r\n" - - End of line mark used in HTTP - - - - - SEPARATOR - \ArangoDBClient\HttpHelper::SEPARATOR - "\r\n\r\n" - - Separator between header and body - - - - - PROTOCOL - \ArangoDBClient\HttpHelper::PROTOCOL - 'HTTP/1.1' - - HTTP protocol version used, hard-coded to version 1.1 - - - - - MIME_BOUNDARY - \ArangoDBClient\HttpHelper::MIME_BOUNDARY - 'XXXsubpartXXX' - - Boundary string for batch request parts - - - - - ASYNC_HEADER - \ArangoDBClient\HttpHelper::ASYNC_HEADER - 'X-Arango-Async' - - HTTP Header for making an operation asynchronous - - - - - createConnection - \ArangoDBClient\HttpHelper::createConnection() - - Create a one-time HTTP connection by opening a socket to the server - It is the caller's responsibility to close the socket - - \ArangoDBClient\ConnectException - - - \ArangoDBClient\ConnectionOptions - - - resource - - - $options - - \ArangoDBClient\ConnectionOptions + $_hiddenAttributes + array() + array + \ArangoDBClient\Document - - buildRequest - \ArangoDBClient\HttpHelper::buildRequest() - - Create a request string (header and body) - - - \ArangoDBClient\ConnectionOptions - - - string - - - string - - - string + + set + \ArangoDBClient\Document::set() + + Set a document attribute + The key (attribute name) must be a string. +This will validate the value of the attribute and might throw an +exception if the value is invalid. + + \ArangoDBClient\ClientException - + string - - array - - - string + + mixed - - \ArangoDBClient\ClientException + + void - $options - - \ArangoDBClient\ConnectionOptions - - - $connectionHeader + $key string - $method + $value - string + mixed + \ArangoDBClient\Document + + + __set + \ArangoDBClient\Document::__set() + + Set a document attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. +This function is mapped to set() internally. + + \ArangoDBClient\ClientException + + + + string + + + mixed + + + void + + - $url + $key string - $body + $value - string - - - $customHeaders - array() - array + mixed + \ArangoDBClient\Document - - validateMethod - \ArangoDBClient\HttpHelper::validateMethod() - - Validate an HTTP request method name + + get + \ArangoDBClient\Document::get() + + Get a document attribute - - \ArangoDBClient\ClientException - - + string - - boolean + + mixed - $method + $key string + \ArangoDBClient\Document - - transfer - \ArangoDBClient\HttpHelper::transfer() - - Execute an HTTP request on an opened socket - It is the caller's responsibility to close the socket - - resource - - - string - - + + __get + \ArangoDBClient\Document::__get() + + Get a document attribute, magic method + This function is mapped to get() internally. + + string - - \ArangoDBClient\ClientException - - - string + + mixed - $socket - - resource - - - $request - - string - - - $method + $key string + \ArangoDBClient\Document - - parseHttpMessage - \ArangoDBClient\HttpHelper::parseHttpMessage() - - Splits an http message into its header and body. + + __isset + \ArangoDBClient\Document::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - - string - - + string - - string - - - \ArangoDBClient\ClientException - - - array + + boolean - $httpMessage + $key string + \ArangoDBClient\Document + + + __unset + \ArangoDBClient\Document::__unset() + + Magic method to unset an attribute. + Caution!!! This works only on the first array level. +The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. + + + - $originUrl - null - string - - - $originMethod - null - string + $key + + + \ArangoDBClient\Document - - parseHeaders - \ArangoDBClient\HttpHelper::parseHeaders() - - Process a string of HTTP headers into an array of header => values. + + getAll + \ArangoDBClient\Document::getAll() + + Get all document attributes - - string + + mixed - + array - $headers - - string + $options + array() + mixed + \ArangoDBClient\Document - - eJytWvtzGskR/l1/xVilHIsN6FFXdwkOjmW0ZykngQqQY8dSqGEZYE/7IDuzkrjY/3u657HvRegSymXQ7sw3/Zrub3r3r39br9Z7e4evX++R1+Q0osEyPPtArs+vieO5LBBdshJiTVbMW7OI+EyswjmHsTj8/Zo693TJCElm9uUkeZPGMDaCe+TvNCBjwZhPg0DecsL1JnKXK0H6ya+To+OTFhGRC4ABJx/92XkLbnvhMmAt8pFFMHsDsw/39gLqMw5rs8KybxNFznPikgXIcT6ZXJOI/TtmXBxGMD8MOCMrGsw9N1gWNarQh7uBg6oedU6kGI5HOSfnYB212t5/9lBZKQF+Xqslr4fjCeGgV7AkDqwpKOLJAYfyW14kV/bkfHg2laN7pIHfDdCnEvHmJYA3Cu+mFu7MvrQn9u6IejyAql91uB/tF4iJgwERvurgzu3Ts93x5GgAxO9aO55O+ucvsKQcjrbEHxWg/VUc3BPu/s6IFcT+DAIwXJDZRjBO1lHoMM7ZnLgBCQNGZlQ4q2bFav3zm8Gv0/HFP9HEfz7+y0l5ITuYIzLELSM+je5JrIFRrQpIe3gJWPu30W2wX0YbszWNqIAtMmPikbEANjudg/CwNcgsnG8qEMf29enodDIcGdwabGln0F2ETuiRBxZxNwykuC3YetG87YRzEF2Eyb3jznHFetej4WTYl2o0EPMQhlV5IGJUMELRwm3h+kwJABgBcwTCzzYkXLMAPU4JD517JnB1sWKEswiE0FAG8UIQl8vbDvU8FjU40bnDnbmeKzY42/FCSCUSQyIWMN6LVRQ+ckhmUgz7yWFrFKY4DN3gm1FwfyhHcXIQ6h/trCb6YhEkYiKOAhQyjCPIV22j5aMrVlrHDEwLrnsekRKSxxU4PwizqziQumeMQM6kM8/lKzbPeWcdw1UH9hAV8LWIAz1L+iHVxKpXSm0BlTrxc8CC+Tp0AwGuNmPa75ZM9OMoglRs69tW8206BwQW7AmnwG5m1J/qC1MlCI5NBrsLYhmQbheAJ5s1s5Jlm6TX65F0wOTLtT0djy+bGRll1B2CMQWoHIHfIwIjjEdktcFgMJC5eQUBAWOq5llGixZpcO414Atc5S420zWDuGsl1vhaMma3O7yeXAwH00/26OKXL9O+PZrcZeyDn/d/cOEpFtsXrz4dnF7ZRRFeIgFstvARhniLKXeBAcx3E+H08nL4j+nYvvwFMujHgX12l3W9cf8OQP2L63N7NL4jryAagtjziv7XMYB+d9w1hAAv3X6JvhpjNy2NcAX7ft9Lf6V7Y7GGbWG8r3LBVFE7Kzc7DfkgBK7lQRnL7IpWbuwBi6JBWLgGnIwDdSpcfV6bycWVPbyZ3OUnjicj+/Rq2r+8sAeTaX84GNj9SQFbWzG5WNzmr0D5ot9UpgvYYykdWyUHNiD7BaEw+RBTfZKdbhsN0inNSLNXhzRuG10Cg1LLaLvlZmV8mPGacRf4CstYGAsLdNkpOIw5s8bQRQEg1GrfS5XzQxgHcxptDB3CHCYpiqHMBKqTMNUmx45gvemH4c3g7HT0Bevz58+feTzD4fCrls0pioHL+PRelmMsaQyICBYQyjeBA54KwrhqzdPxl0Ffcjx7JJdsK77ePsV524iB0UaraRWojiFku9fk5LOlOBsYvWg2XtI52iJtoEusDScL5s88oEZawIxb0inPw6sDUOZKW5lfXX9+fhx5ufg2829Gl89PRoMWJiu7UE8aG/fTOuSigESjiObnHTgxF6GvLMQVEhwG9UjMAtSVlE4bi3nMh/xWx420qICRWDl7ONT3S+xN5swa8raVDc1i15uPFPgWJtQqR0PLeLAlXdFSNm1pxQtm6ZGvd0U2JbOgy6dKJUtOb25JiXkdrcZF8ACVYE7g/5ippAAIHWI/rVFOsKJCbpEl5ElMdkCohCRUaqnK7HbgsWAJbFTSNfitBxey9w657gOexO4kYxNRzIqKqQIRSIaHaaKv/mzj313ix55wMU0dgl5+e04FfQvqqTzYQ12QfnS7+QRnrsKZKqMbhBycALav3qhiItoS78gR+eGHXdK7VBkOXxOl9oLCwjXcBBaQ2wwOMFBIgOnD+WQVxt5cMldKtHxt9JfeOuWCttWEdL2GgJcp+/A3HgaNavMo91cFQjaCtY3MPXAKo1B/rEKYU9gxSthf2Yb03pm/PmGIliMgu0Cnl50KFVrX5wxAjX9TkcGuCxcymLdJ0ock+zp5pKqZbAJBvoYtIhZW40+cyH+N0r5Wa5pTbrPALMpVoqMkAXICXhAr8DD2FCDxQI1WJz0op6DCNmPUB2v+ViK+8f2ljNmuVkRFcDNruPzv/DoYkRXMRFurjp58wiwkK3iQz9W6wOEhpe7UvS1vF6qXqZftbbha5FkYelhDvEe64TL95M7SsPlAVlfnzwyc3I4xbpzdztIPWvUrCWFpEasSvZEe84JOXZmm4rdvRbpeM/hm97G6FbjrcGzy7TpWNvB2lhmTYnoMKCQB7TB0UeWW3qH+FcJNkv9EHEn1G8262LWfmBNXhC7SXMl54XRb3Tj6vzSfVIAn/aAD3Q7K81V90fIhQ2C/B6VqVu+RTGpDCH/tMcHymkGKpkUWVcQwzDRHSFUj02KdZYfsYwTslwj51l1dpnhaLt3t15ep7Mc+uNh6nG3Kzb+t+1HASYMvWGRpS7YSeyRZvY6FGSeYqX+EiWlPoaEa1ewKy1IkrAzr0/I1swzr/eIxcgUra5EBfb9YeDFfJeK+zVZuVQxULcArqk2SacoxyRHZPBlSGiFCQb0RlCNzpUeOil09s8R1yNXtbIXlQOEKtOFg4UYQgqSn93ty43HlQqm29P1v38irBQsXta4AdJCrBzbAH6mZVN5Jm/SFHozMw2qqYWe4VnoJEkUFW5vB/fsiYcrLkxrrTcqbEbaywyW1rFoptZqc/LY8IDGglL4gVBXRzcJ2KnG/V0iYD6De9jabs2LOPc4znFXzZn3gc3FDM45P6qpmH5+ANj4cEf3YJ+FigfTXcjusY+y4b54pkKenp/0maVeh0IVg2NilApm0o4k0I/t5mbr7ZeOsZfDidoRflrYVdv3yMwnwqeOToj8TiyHKq22cX65VsTEt2dfm8QwkSFeXeG/I8U+w6FHzrTTUT+mZrKgWMbl464JqmxronxXqz3AJoOGCpKlzd+lWOCrRM1Pl1fO7Ol21Y5Knu5Iz6DQGx+k0rytipsrAfBuUpM44D+oDPkDOU151DG7BgV5IxG1Ig+EkIR6AJ4/NteOLmyGbBrOf76Wr31+4z0w7W542Cxl62x6UvH2M5wsVIbk4Tp8Atsrh0CyrIuVKAZ+P6XQs5L4fZVD9mInUZPmaCC3qmQMsSFyW9nkTF/BzNk7T9rteUZKdK0HF4unBCX1Qxz3HcMyAEyHwTPkWh25Ew7EEiCPeKLQ/O9tPR4hxpSHIBKI6B6pGdWrmhhHs+uBG9RNxrrpAPewl6hO0ZmmQzYFXynZnFPpb8dShSOJlaaRK0kDzJJ+UjzWhOMxxIrZ5zBNfhZFpZr6QZco23C6cEUTn7Dy1npU1ZStrHBU5rYJ+el8WaKWWAmLKC+fMUswkeTLfIvlFTmoPKNfq3YSEs+O7BdKaK91ykeFCtb54V4dN753KiPy5uNE4bWl181fugPA/mlZBWmal0kNltEQfjFRBQjVxIRW30pc2sLeaKctJb8rYPn0LSDY9WonOTdmvwjc1BuqNEGxY4Z/Fva+6gZlxkESOatiQYmjy9Q9whlYA2wqQXFxaLkuIDfxoOfXxiY61f/gvdO/t4e38zW0H/+NvLPhqHmL+Rlg8yeBQxku8uGxSwy/MlK/Hd88l0azhe2rJHXkmaB/KB+44h5veP7lnm64Mxbbn3ichVjUbI3AR4tNlDE0Xox68hh1giq93YQPWd39XT6Eg6pdAFSMXX7epAxOPIb615nNiwREDgoJGDPckg1P6A0P3w6iNvio7AYD2oJMu/miSSoeZIqv8ga3K5vOV0nO5sA7AGuDBB9UQ7SUJoiEJpgY8qajLtVbfAfoZ5ApObDbXV9BUhOAQPFMDfvMOY0IusXsd/JrEY4tkGK5Z487kPpgp39ubwmGa8ty+ldfB0rfmHcRb/RLg7DYdhmfu/wIci5Km - - - - ArangoDB PHP client: update policies - - - - - - - - UpdatePolicy - \ArangoDBClient\UpdatePolicy - - Document update policies - - - - - - LAST - \ArangoDBClient\UpdatePolicy::LAST - 'last' - - last update will win in case of conflicting versions + + getAllForInsertUpdate + \ArangoDBClient\Document::getAllForInsertUpdate() + + Get all document attributes for insertion/update + + mixed + - - - ERROR - \ArangoDBClient\UpdatePolicy::ERROR - 'error' - - an error will be returned in case of conflicting versions + \ArangoDBClient\Document + + + getAllAsObject + \ArangoDBClient\Document::getAllAsObject() + + Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class + + mixed + + + mixed + - - - validate - \ArangoDBClient\UpdatePolicy::validate() - - Check if the supplied policy value is valid + + $options + array() + mixed + + \ArangoDBClient\Document + + + setHiddenAttributes + \ArangoDBClient\Document::setHiddenAttributes() + + Set the hidden attributes +$cursor - - \ArangoDBClient\ClientException - - - string + + array - + void - $value + $attributes - string + array + \ArangoDBClient\Document - - eJydU2Fr2zAQ/e5fcYNRJyFdunx0G9ouLe3GYCFdvwWKopxtUVsSkpwslP73nSTHpF6hMGFko7v33t07+eJSlzpJJqNRAiO4NkwW6uYbLO4XwCuB0mXQ6A1zCFpVggu0lOdTrzTjz6xAgA41D4AQZI0rlaEY/GASHhxizaQMIa703oiidDDvvqZnX6djcEYQobRwV6/vxxSuVCFxDHdoCL0n9CRJJKvRkjb2ZM+7Jm4Ub2o6+ajwd8q2QnLf0dmXaVDjFbMWHgPPwtPsk5fEdxWk/BoBpXRSO1FVtEmghzOLoHLgSuaEdEIWsEVjhZK2xU7CmxKI4ef1w2+YQerpUmqmp0IuojFkaZBYIxh0jZG4+Q+p2+Xy19JrBcZ3xOYl8mcQObgSwTZak0Ob6OMetqxqEIT1H2LTQg7IK1catbMQPb39w1E7qqKfpZlhNVgaOFX6OTKevplXq9MHxq5hqzrl2Jhu1gQiRubolTeSe9lYInEOosYw5MYJ+kXDReMGwj7FUg5pw9YSv8iF9hg+zWZgscqzLAzr5AT+CQRrh0cSfgVPQOKub8sg/S5DiW9bT0n/gH1N4v6axMv4ROnMDo6vZJaFyBjS1eEPWrV3e706TvS8fwH05C35 - - - - ArangoDB PHP client: exception base class - - - - - - - \Exception - Exception - \ArangoDBClient\Exception - - Exception base class used to throw Arango specific exceptions - <br> - - - - - $enableLogging - \ArangoDBClient\Exception::enableLogging - false - - + + getHiddenAttributes + \ArangoDBClient\Document::getHiddenAttributes() + + Get the hidden attributes + + array + - - - __construct - \ArangoDBClient\Exception::__construct() - - Exception constructor. + \ArangoDBClient\Document + + + isIgnoreHiddenAttributes + \ArangoDBClient\Document::isIgnoreHiddenAttributes() + + - - string - - - integer + + boolean - - \Exception + + \ArangoDBClient\Document + + + setIgnoreHiddenAttributes + \ArangoDBClient\Document::setIgnoreHiddenAttributes() + + + + + boolean - $message - '' - string - - - $code - 0 - integer + $ignoreHiddenAttributes + + boolean + \ArangoDBClient\Document + + + setChanged + \ArangoDBClient\Document::setChanged() + + Set the changed flag + + + boolean + + + boolean + + - $previous - null - \Exception + $value + + boolean + \ArangoDBClient\Document - - enableLogging - \ArangoDBClient\Exception::enableLogging() - - Turn on exception logging + + getChanged + \ArangoDBClient\Document::getChanged() + + Get the changed flag + + boolean + + \ArangoDBClient\Document - - disableLogging - \ArangoDBClient\Exception::disableLogging() - - Turn off exception logging - - - - - - No summary for property $enableLogging - - eJydVF1vmzAUfedX3AckoGJJlkfaZu26qtVUaZXSx0jIOBewRmxkmy7VtP++i8NHgtJpql9sfM+599wPfPWlLmvPm19ceHABt5rJQn37Cs+Pz8ArgdImgHuOtRVKQsYM0jUzhsAt/qZm/CcrEGCg3jmWM7LGlkqTDb4zCWuLuGNSOhNX9ZsWRWnhbjgtF5+XMVgtyKE08LDLHmMyV6qQGMMDamK/EXvueZLt0FBsnIS9HDK5PyMaGoNbsApsqdWvjgqmRi5ywcc8++yuMr36r0SNkLw1ASxmS6fwEG8UgXuLcmtgM1x5v72W4OS261gyJw1WN9wqPeusPYiEaLYDMgtZuDufSmFI2gQhpIVu+Vxtp+ZRCPi1xlehGtNB5m6vm6yiouSN5A6VpoOqsA8J1xAE8cE/nRfxWbdkkU1VRc7tIet2iRxCg1WeJD5KllX4pIqCkoqOMO26Qa2VTmkMwgJt6iob+rYUJoIZBAkEtPWKosv3uMHaUgtpvGhqkmCCy5VGxksIcV9XlExI85/e/3ii3NpAn1YU+aVl3pq1q3wYRcAM+AKuV+BXQuJU9jQ8fTqhDnsa/Y83noYjtan9+5Jzde9KHo817jx2/KOhemm0BDeAfV+qQ5nPNdtYZo97ftKXcNrAc82jXpNU/LeaPP+YnK0wH9CTs8qcCqq1eGUWe//vMQjthi1llWAmHCY7Sdx1DMGmf6w23aOQjfPfjthfI0+USQ== - - - - ArangoDB PHP client: endpoint - - - - - - - - Endpoint - \ArangoDBClient\Endpoint - - Endpoint specification - An endpoint contains the server location the client connects to -the following endpoint types are currently supported (more to be added later): -<ul> -<li> tcp://host:port for tcp connections -<li> unix://socket for UNIX sockets (provided the server supports this) -<li> ssl://host:port for SSL connections (provided the server supports this) -</ul> - -Note: SSL support is added in ArangoDB server 1.1<br> - -<br> - - - - - TYPE_TCP - \ArangoDBClient\Endpoint::TYPE_TCP - 'tcp' - - TCP endpoint type - - - - - TYPE_SSL - \ArangoDBClient\Endpoint::TYPE_SSL - 'ssl' - - SSL endpoint type - - - - - TYPE_UNIX - \ArangoDBClient\Endpoint::TYPE_UNIX - 'unix' - - UNIX socket endpoint type - - - - - REGEXP_TCP - \ArangoDBClient\Endpoint::REGEXP_TCP - '/^(tcp|http):\/\/(.+?):(\d+)\/?$/' - - Regexp for TCP endpoints - - - - - REGEXP_SSL - \ArangoDBClient\Endpoint::REGEXP_SSL - '/^(ssl|https):\/\/(.+?):(\d+)\/?$/' - - Regexp for SSL endpoints - - - - - REGEXP_UNIX - \ArangoDBClient\Endpoint::REGEXP_UNIX - '/^unix:\/\/(.+)$/' - - Regexp for UNIX socket endpoints - - - - - ENTRY_ENDPOINT - \ArangoDBClient\Endpoint::ENTRY_ENDPOINT - 'endpoint' - - Endpoint index - - - - - ENTRY_DATABASES - \ArangoDBClient\Endpoint::ENTRY_DATABASES - 'databases' - - Databases index - - - - - $_value - \ArangoDBClient\Endpoint::_value - - - Current endpoint value - - - string - - - - - __construct - \ArangoDBClient\Endpoint::__construct() - - Create a new endpoint + + setIsNew + \ArangoDBClient\Document::setIsNew() + + Set the isNew flag - - string + + boolean - - \ArangoDBClient\ClientException + + void - $value + $isNew - string + boolean + \ArangoDBClient\Document - - __toString - \ArangoDBClient\Endpoint::__toString() - - Return a string representation of the endpoint + + getIsNew + \ArangoDBClient\Document::getIsNew() + + Get the isNew flag - - - string + + boolean + \ArangoDBClient\Document - - getType - \ArangoDBClient\Endpoint::getType() - - Return the type of an endpoint - - - string + + setInternalId + \ArangoDBClient\Document::setInternalId() + + Set the internal document id + This will throw if the id of an existing document gets updated to some other id + + \ArangoDBClient\ClientException - + string + + void + - $value + $id string + \ArangoDBClient\Document - - normalize - \ArangoDBClient\Endpoint::normalize() - - Return normalize an endpoint string - will convert http: into tcp:, and https: into ssl: - - - string + + setInternalKey + \ArangoDBClient\Document::setInternalKey() + + Set the internal document key + This will throw if the key of an existing document gets updated to some other key + + \ArangoDBClient\ClientException - + string + + void + - $value + $key string + \ArangoDBClient\Document - - getHost - \ArangoDBClient\Endpoint::getHost() - - Return the host name of an endpoint - - - string - - + + getInternalId + \ArangoDBClient\Document::getInternalId() + + Get the internal document id (if already known) + Document ids are generated on the server only. Document ids consist of collection id and +document id, in the format collectionId/documentId + string - - $value - - string - + \ArangoDBClient\Document - - isValid - \ArangoDBClient\Endpoint::isValid() - - check whether an endpoint specification is valid + + getInternalKey + \ArangoDBClient\Document::getInternalKey() + + Get the internal document key (if already known) - + string - - boolean + + \ArangoDBClient\Document + + + getHandle + \ArangoDBClient\Document::getHandle() + + Convenience function to get the document handle (if already known) - is an alias to getInternalId() + Document handles are generated on the server only. Document handles consist of collection id and +document id, in the format collectionId/documentId + + string - - $value - - - + \ArangoDBClient\Document - - listEndpoints - \ArangoDBClient\Endpoint::listEndpoints() - - List endpoints - This will list the endpoints that are configured on the server - - \ArangoDBClient\Connection + + getId + \ArangoDBClient\Document::getId() + + Get the document id (or document handle) if already known. + It is a string and consists of the collection's name and the document key (_key attribute) separated by /. +Example: (collectionname/documentId) + +The document handle is stored in a document's _id attribute. + + mixed - - - array + + \ArangoDBClient\Document + + + getKey + \ArangoDBClient\Document::getKey() + + Get the document key (if already known). + Alias function for getInternalKey() + + mixed - - \ArangoDBClient\Exception + + \ArangoDBClient\Document + + + getCollectionId + \ArangoDBClient\Document::getCollectionId() + + Get the collection id (if already known) + Collection ids are generated on the server only. Collection ids are numeric but might be +bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used + + mixed + + + \ArangoDBClient\Document + + + setRevision + \ArangoDBClient\Document::setRevision() + + Set the document revision + Revision ids are generated on the server only. + +Document ids are strings, even if they look "numeric" +To reliably store a document id elsewhere, a PHP string must be used + + mixed + + + void - $connection + $rev - \ArangoDBClient\Connection + mixed + \ArangoDBClient\Document - - normalizeHostname - \ArangoDBClient\Endpoint::normalizeHostname() - - Replaces "localhost" in hostname with "[::1]" in order to make these values the same -for later comparisons + + getRevision + \ArangoDBClient\Document::getRevision() + + Get the document revision (if already known) - - string + + mixed - - string + + \ArangoDBClient\Document + + + jsonSerialize + \ArangoDBClient\Document::jsonSerialize() + + Get all document attributes +Alias function for getAll() - it's necessary for implementing JsonSerializable interface + + + mixed + + + array - $hostname - - string + $options + array() + mixed + \ArangoDBClient\Document - - Name of argument $value does not match with the DocBlock's name $mixed in isValid() - Parameter $mixed could not be found in isValid() - - eJy9WG1v2zYQ/u5fcTM8RE4dK8mXAWqTNEuNpkWRBYk7tIhTg5Zpm4hMCiSdly397ztSpCzJsut0w4wglsnjcy987njUm5N0ljYa4e5uA3bhVBI+Fe9+h8vzS4gTRrmOgPJxKhjXKGBk3qYkviNTCpCLn1lJO0kWeiYkzsFHwuFaUzonnNupWKRPkk1nGs7yp8P9g8MOaMkQkCt4Px+dd3A6EVNOO/CeSlz9hKvDRoOTOVWom1bUvs6t7zlDQaU0ZhMWE80Ed2af8twRiAXXhKE+PaOgqLynEhKRiduxzHUjx2msUU4YCDMzEUkiHhifLtH0U0oVEInLFlLiuuQJ1CJNhdR0DMFc4IwWMKJAxmMcSYimsh0ZxDeL5Nh+J+wYdJxGYTgTSkdmLaqSZsxbgbapXHbB2SMKKxHf0Uzy88WHL5D9VhCkUtwzo6zgobPJeM1UO4dSKllRe339qah2a7ww88c8XwhNIwvk5IApFwDGl0RzWAfdgzcj6dcWHjezTTEemymA/e6hpUmcEKVyJjT+bphJyw/z2YWzbIuWu3dPkgV1s17o7T1B95CVfOqGQvudSnaPmwetoV2FzKug988uy7woLceIKg39r5e9oRE8gh3c3p1VFBO0rVCMIKLgDtagFAixHZpdgHCGWzV4V3RKH1NLj6Kbqgbuqve+9+XSOxl+C9DP55nWaTsahIMw6L46aUfBYPyqPQhPWuFmZcVobFDmYoHKMBxWmfoZbXVR26DVxyz8ZjPS6WvXasnLE+Nj+liD2bvoX30d9i7eXf7x4aJvYL0FNWjviCYjorDybIZ7d9o//f30undt8MZ+kQFcSQ1JDbkJcPpQKPrlzEiJJHOXG9CyaQB7S35VKm95rZ5J8aAgy9/eY0zTVSmXaItRwmKYLLgtQDAcWpfkItZBprRt5bL0Nh82geAXRZNJFDH1J0nY2Au2C1LmY62wPlYMCRTmN9eToMn4vUFY4xbs/Kp2mh3w+K9z+O+N/LFliuLecVYoMPQtVzEKYiUC6oXkGHoXWElTSRUalykUE1t31+3JnExZXB2UGaQD3HsR8rpN0OLaogTV6DtlJad/4KtRa6qRMYHw/4Rv9bW8Goj1tdA5rExsCn5Pqe6j6AbiYUinwznR8SzIKLgsgEuaVGjozbLy/kyopdImDVj1XqABpV+swVS4F6gw4rU6nChfJIlnhvm//LdKES6w/UvYX7RIkOVGPrAkMaUO+wcNpuBHWAqx0TJ9VAeXjO2gcqOmzXkpuYodwFo+5VaO16zcSK589Rp6OW12dzB3E+x/gxtohtbfEKtQ9qjwGW47gFPGfTNuHLZjDniLfDRNIJg++39Pylzzlgl5jvL/LiHx2wpQtY7VpZg3w2/LkLsQe4Cbw9v6Q2DLzP05U1Rmi93mLWypyb8qE3B9fAcPM4pckOWcK+0oNvL2fNxMizl7xJTYTAsIYlRjbkZ+mbCKiZTkyZAwG1XtNfwZCZGgCmwMqAn2D+ztwIQkCslt/HtgaiuyVbqJGrIxNczMXNdxtHwTcOMfb4tb5J/KvQyi2ih4UHh+xmK34Dnt4ejoCPbXEMY6WssDbHIpiWfgYIAoaNG0CuNN8I6hRFVkvbayWzYC9qQ/cgdFfqAi6uvGil4njN4Zsv6s2u9V5huS5MyvUv8TU6v9vp/sY1eTnTaJESs2TObyS3R2+Rd8wqYLiaR3bxGyu219lpzlt2toLW/ahsszWrh6uxcHC0VXsi1h/M6dcGE4FrHqEntBHo+6sZiH5/3+ZeivHCq0l4TuTM+Tag5ludbCrjDFHpue2p976DQFP5bJdKuN/KB8Ix9UW/qNeWVCmZsX1Iejmm25kaahXortHSOjgs8yUVH0+epTfoMqkst3qB7BrvmosOtvr7QjpcPR1lwFTfN+KDHHVNO8vzAP9qB8YHoGzZsoOri1E0KOsXbirs3JHTWbicbaRHMvm5ZHnL1u2ndBuN9zZAVT9g1PHVt8Tc3V7i0teEF/4te8qDE5d4uCXHsxJcMQ3LlUCpENi42KKTCOmDAWVG3sbJruXUF+hT9xd/gc+vng8LdBd9/+HbSzI3AwOMAUsNrMUbgMU3lrMe3t26EhukVU4MkXRXa0AzsD/x7SE3s08EI7CPUPvDch/w== + eJylUMtKw0AU3c9XnF01BGuzTAUfLbYIQkHoKiA300sSm8yEmYk0iP/ubWK7qEt3w3ndc+buvi1bpaZRpBDh0ZEp7PIJm/UGuq7YhBS+MkXN+GQX+ICd1V0juMiPjoeW9J4KBs7mxeAbSOpCaZ1weCGDt8DckDEX1LP49nilnt3AaNv2rirKgMX5ldzOkhjBVXLKeKyafB0LXdvCcIwVO8ntB7e01cc2wOwmEWSqlKGGvfTki4rz8+4t1R3D5h+sAxy3jr3wshv0n/l/u+iavMd2zOJDYLPzWJ4yv5T6VqPmneqK/NWoTNMBizHJTl+Q/Z7Ls1EyuZ6rH7e+kY0= @@ -18082,23 +18526,23 @@ This is a convenience function that calls json_encode_wrapper on the connection< \ArangoDBClient\Handler - + includeOptionsInBody \ArangoDBClient\Handler::includeOptionsInBody() - + Helper function that runs through the options given and includes them into the parameters array given. Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - + array - + array - + array - + array @@ -18119,19 +18563,19 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\Handler - + makeCollection \ArangoDBClient\Handler::makeCollection() - + Turn a value into a collection name - + \ArangoDBClient\ClientException - + mixed - + string @@ -18142,6 +18586,31 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\Handler + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler + setDocumentClass \ArangoDBClient\DocumentClassable::setDocumentClass() @@ -18188,1622 +18657,2030 @@ This is only for options that are to be sent to the ArangoDB server in a json bo eJzFVN9v2jAQfs9fcQ+VCAjENmkv6dZ1o6io6wOl8DCNqTLJkVg1dnZ2RlHV/31nE7IKrZU6ps1SlDj33a/v7O/dh7Ioo6jf6UTQgY8kdG7OPsF4NIZUSdQuge8V0gYKoTMldc4wjzwtRXorcgRonAYBH4yicoUhtsGF0HDtEFdC62BKTbkhmRcOBs3Xm1ev33bBkeSA2sL5ajHqslmZXGMXzpHYe8Pe/SjSYoWWc+Ne2uMoSpWwFq58tSNfLBLgnUOdWaj30X3kawrN+tWBgUJBFlyBoKR1YJZglVmHniXaGrZDn7qCzNrC8C7F0kmja0M/vMtqoWQKy0qn3sb8cexrjha3g32b3K+jihS8hxmpEaoSKUkWlVQZ72N+bJLMJpc3V7Ph5EsXvrZ8Qa1v7eNf7q6QtneSoxsYrTFki9u9kwwVOox99Br9EO03PEFXkT6448ZOIR4IIrF5lg2u9mkuwjqAEOIzYbRFjvEUOfxjx0zjVxffuAfUhfUOL+EvrYj4CKoNnzdMK8e35F/QOdim/RuM1h38L1I/S6UsCLAlpnLJbQbJ2eNmyiXAmpFg+U4D68poOh3D2fByOB1CalYsEhk4E0ZjkX7w/fc7Vg+phcPt/20GzH6bgkWNxAosKxGP8Ehm0KvVT2Z/OMmFMerZQd5yRzGnOkgj2P/lArE/MUcVNhN6qPX0RigpbPxYVZMkWLrQmu8ke16L8WL+GNjiJD8BgT/eng== - + - ArangoDB PHP client: server exception + ArangoDB PHP client: document handler + - - \ArangoDBClient\Exception - ServerException - \ArangoDBClient\ServerException - - Server-Exception - This exception type will be thrown by the client when the server returns an -error in response to a client request. + + \ArangoDBClient\Handler + DocumentHandler + \ArangoDBClient\DocumentHandler + + A handler that manages documents + A document handler that fetches documents from the server and +persists them on the server. It does so by issuing the +appropriate HTTP requests to the server.<br> -The exception code is the HTTP status code as returned by -the server. -In case the server provides additional details -about the error, these details can be queried using the -getDetails() function.<br> <br> - - - + + + - - ENTRY_CODE - \ArangoDBClient\ServerException::ENTRY_CODE - 'errorNum' - - Error number index + + ENTRY_DOCUMENTS + \ArangoDBClient\DocumentHandler::ENTRY_DOCUMENTS + 'documents' + + documents array index - - ENTRY_MESSAGE - \ArangoDBClient\ServerException::ENTRY_MESSAGE - 'errorMessage' - - Error message index + + OPTION_COLLECTION + \ArangoDBClient\DocumentHandler::OPTION_COLLECTION + 'collection' + + collection parameter - - $_details - \ArangoDBClient\ServerException::_details - array() - - Optional details for the exception + + OPTION_EXAMPLE + \ArangoDBClient\DocumentHandler::OPTION_EXAMPLE + 'example' + + example parameter - - array + + + + OPTION_OVERWRITE + \ArangoDBClient\DocumentHandler::OPTION_OVERWRITE + 'overwrite' + + overwrite option + + + + + OPTION_RETURN_OLD + \ArangoDBClient\DocumentHandler::OPTION_RETURN_OLD + 'returnOld' + + option for returning the old document + + + + + OPTION_RETURN_NEW + \ArangoDBClient\DocumentHandler::OPTION_RETURN_NEW + 'returnNew' + + option for returning the new document + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection - - $enableLogging - \ArangoDBClient\Exception::enableLogging - false - + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + string + - - __toString - \ArangoDBClient\ServerException::__toString() - - Return a string representation of the exception + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - + string - - - setDetails - \ArangoDBClient\ServerException::setDetails() - - Set exception details - If the server provides additional details about the error -that occurred, they will be put here. - + + + get + \ArangoDBClient\DocumentHandler::get() + + Get a single document from a collection + Alias method for getById() + + \ArangoDBClient\Exception + + + string + + + mixed + + array - - void + + \ArangoDBClient\Document - $details + $collection + + string + + + $documentId + mixed + + + $options + array() array - - getDetails - \ArangoDBClient\ServerException::getDetails() - - Get exception details - If the server has provided additional details about the error -that occurred, they can be queries using the method - - array - - - - - getServerCode - \ArangoDBClient\ServerException::getServerCode() - - Get server error code - If the server has provided additional details about the error -that occurred, this will return the server error code - - integer + + has + \ArangoDBClient\DocumentHandler::has() + + Check if a document exists + This will call self::get() internally and checks if there +was an exception thrown which represents an 404 request. + + \ArangoDBClient\Exception - - - - getServerMessage - \ArangoDBClient\ServerException::getServerMessage() - - Get server error message - If the server has provided additional details about the error -that occurred, this will return the server error string - + string + + mixed + + + boolean + + + $collection + + string + + + $documentId + + mixed + - - __construct - \ArangoDBClient\Exception::__construct() - - Exception constructor. - - + + getById + \ArangoDBClient\DocumentHandler::getById() + + Get a single document from a collection + This will throw if the document cannot be fetched from the server. + + \ArangoDBClient\Exception + + string - - integer + + mixed - - \Exception + + array + + + \ArangoDBClient\Document - $message - '' + $collection + string - $code - 0 - integer + $documentId + + mixed - $previous - null - \Exception + $options + array() + array - \ArangoDBClient\Exception - - - enableLogging - \ArangoDBClient\Exception::enableLogging() - - Turn on exception logging - - - \ArangoDBClient\Exception - - - disableLogging - \ArangoDBClient\Exception::disableLogging() - - Turn off exception logging - - - \ArangoDBClient\Exception - - eJzNVk1v2kAQvfMr5hAJiICkOZI0bUoQadV8KOZSJZG12ANe1azd3TUJqvrfO7teG+MASVOpKhcb78yb2ffejn3yIY3SRuNgf78B+3AmmZgl55/g5uIGgpij0H1QKBcoAZ8CTDVPBAWa2I8pC76zGQKUaQObYRdZpqNE0hp8YQI8jThnQtilIEmXks8iDYPy7ujw3VEHtOQEKBSM5pOLDi3HyUxgB0YoKXtJ2QeNhmBzVFQba2WPy114tuHusNbwOOJqtQvQyxThkccxTBB0JJNHAZMl3aHbOTxGKOx/x4BEnUnqjtl9oJS0QS7osUoToQgkAVbkSvyRodK9sjZWSgdJiEDNGOyL8fgGlGY6U/lzplwhDKkfk7xqwcDBZwJgptyqs1QmCx4itRaG3JRgMYSoGY+VyWCTJNM23jbdMbcE4CIITRgOqGHJqWimuJiZEJM6Q32eh7XaMM1EYNB7JxN5albddc0OG8xAgIHxyWHvyGoYxEwpJ1OpEvGjUYQKVrr9bBgDWVXNbx+u0/XNwZQk0FVuXWSRQF1JNgcmJVu6Zwf2mkq+YBphzy+g3sPdA3moVnFoVRbZfIJG7BCf1mACEl7D8Gp8+80fXJ8PCaVpOb7K5s1taORfZZjaDXc59Lyz0QrxMs/agHpr7ULeU3SASDqJKXmSyGeW12S6m6LcbUVydzPKOnnZJOZBaQfwfZ14NqvVtgG5cObnwH1/8PXM83wfetDsQ5Mue5rOY/eUDJYbYUDmJ4/Rem3ZbbzVPraov57t30NdOVyl79d2+Xn6yvNSPywFgI6YhiQIMikxtCdoWU6PlBIilNjb4T7YKwp03QPS5aWuC20WCQ93KqBWx3S9Wl0PR2vF9UXkNnZHf8xuRCPMMRz+JcNro0mtRhOdIXq/hFvoyimo8Lze9WYKq5Nus4lr3O0irHhn2vNuxvo/IYxeKdaSrt9Kha2NFJRxemd1t0ZvZax6dGuk8Sm0uCJjtmq83SmMp/3+amg+tNuVvO2EP088LrOcDM+Tqcm8vVfL5cbzf6FYPotfnNjb239BuXK2vkk894p6k35F7i4JRRbHhWy0aj8bfBZzplq1j4d+3y52oHlffETeuw+RyX0ttklW+A1ZRFRS - - - - ArangoDB PHP client: base handler - - - - - - - - Handler - \ArangoDBClient\Handler - - A base class for REST-based handlers - - - - - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object - - - \ArangoDBClient\Connection + + getHead + \ArangoDBClient\DocumentHandler::getHead() + + Gets information about a single documents from a collection + This will throw if the document cannot be fetched from the server + + \ArangoDBClient\Exception - - - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - - - + string - - - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - - - + + mixed + + + boolean + + string - - - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler - - - \ArangoDBClient\Connection + + array - $connection + $collection - \ArangoDBClient\Connection + string + + + $documentId + + mixed + + + $revision + null + string + + + $ifMatch + null + boolean - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object + + createFromArrayWithContext + \ArangoDBClient\DocumentHandler::createFromArrayWithContext() + + Intermediate function to call the createFromArray function from the right context - - \ArangoDBClient\Connection - - - - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection - - - - mixed + + + + \ArangoDBClient\Document - + \ArangoDBClient\ClientException - $optionName + $data + + + + + $options - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - - array + + store + \ArangoDBClient\DocumentHandler::store() + + Store a document to a collection + This is an alias/shortcut to save() and replace(). Instead of having to determine which of the 3 functions to use, +simply pass the document to store() and it will figure out which one to call. + +This will throw if the document cannot be saved or replaced. + + \ArangoDBClient\Exception - - string + + \ArangoDBClient\Document - - \ArangoDBClient\ClientException + + mixed + + + array + + mixed + + - $body + $document + \ArangoDBClient\Document + + + $collection + null + mixed + + + $options + array() array - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array + + insert + \ArangoDBClient\DocumentHandler::insert() + + insert a document into a collection + This will add the document to the collection and return the document's id + +This will throw if the document cannot be saved + + \ArangoDBClient\Exception - - array + + mixed - + + \ArangoDBClient\Document array - + array + + mixed + + - $options + $collection - array + mixed - $body + $document + \ArangoDBClient\Document|array + + + $options + array() array + + + save + \ArangoDBClient\DocumentHandler::save() + + Insert a document into a collection + This is an alias for insert(). + + + $collection + + + - $includeArray + $document + + + + + $options array() array - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name - - - \ArangoDBClient\ClientException + + update + \ArangoDBClient\DocumentHandler::update() + + Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document. + Attention - The behavior of this method has changed since version 1.1 + +This will update the document on the server + +This will throw if the document cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the document to-be-replaced is the same as the one given. + + \ArangoDBClient\Exception - - mixed + + \ArangoDBClient\Document - - string + + array + + + boolean - $value + $document - mixed + \ArangoDBClient\Document + + + $options + array() + array - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use - - + + updateById + \ArangoDBClient\DocumentHandler::updateById() + + Update an existing document in a collection, identified by collection id and document id +Attention - The behavior of this method has changed since version 1.1 + This will update the document on the server + +This will throw if the document cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the document to-be-updated is the same as the one given. + + \ArangoDBClient\Exception + + string - - \ArangoDBClient\DocumentClassable + + mixed + + + \ArangoDBClient\Document + + + array + + + boolean - $class + $collection string - \ArangoDBClient\DocumentClassable + + $documentId + + mixed + + + $document + + \ArangoDBClient\Document + + + $options + array() + array + - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use - - - string + + replace + \ArangoDBClient\DocumentHandler::replace() + + Replace an existing document in a collection, identified by the document itself + This will replace the document on the server + +This will throw if the document cannot be replaced + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given. + + \ArangoDBClient\Exception - - \ArangoDBClient\DocumentClassable + + \ArangoDBClient\Document + + + array + + + boolean - $class + $document - string + \ArangoDBClient\Document + + + $options + array() + array - \ArangoDBClient\DocumentClassable - - eJztWG1v2zYQ/p5fcQOMxgkcp8tHZ8mSOl2TYUiMxv0wNIVBS7TFmiIFkopjDPnvO75IlmQ5bouuGLAJBiyR9/Lcc6cjqV9+zZJsb+/48HAPDuFSETGXV29gdD2CiDMqzACmRFNIiIg5VShk5S4yEi3InAKUKkMn7SZJbhKpcA5+JwLuDaUpEcJNRTJbKTZPDAzLu5PXP5/0wCiGBoWGd+n0uofTXM4F7cE7qlB7hdrHe3uCpFSjb9pwe7qOwMONONEaZoji/dv78ZEdi4sYdDOIlhA0E5GN7nX/xHkmU20UiUwwfB3Y+GvPRulc2+sQbtJMKgOdSSyjPEVrQw8kF5FhUhDOzCrIHrv/HMFeVWXJlFMMp2F3KIWgzgTI6We8CxPFPMaiSFoRqznJFHskhiKsqBRAHy1OMMocoyQg6HKd85ddQWdtFY6g8mAkTKkNMa7bCKjyKWdRyQ1MLDoPoNtu/cDpedLt1TEJ00fnlajgrCp/6iSfNwJ9T02uEF5Cq2jbiVVedlgN8SXFgnFpcAyLrgxvTs3aSLcZSnCzGVEZw5YgSA1JVsk9jNEW4M+JPFKB1Y1FXQIyCcF6Jpxr+KylmOCsjOlkqUiWUQWySVB7HXS8z1t8M5GZMWr4AZt8VUB8JDyn9nXcwm7KnpAqT6xX39deqZQ0iZJLDQ/1l/XB/719imjWUvYvJ+HOqXQrEbyclUYG3UCLjd0Zs3SDpzsGrHgm5q5X2fCJUmQFGXYCGvd/aCa9585UxquQSXeLefT2gAm8tw62ZDFEcuTjC09y5px7UxbnkugQ3nfObUvoXRfNV2Z1u51GZo+NjOUAuhczxL1IyYqqA4gSGi2AzdDLDBcM6UggMGUGUqkopGRBNWhc6Wi/32+WyDXlNmP1zKocl0XLUT5PKq+IhjnDWgDs0piaiOcxtWI09Ymygi6x1OCaF7LrNMqyuhN8VRpzrggi1NSgBegEm5dOcck4t808DG6WprS2bBFv2POrAEZsIMAqtxmaqkcMF72hZmprJVe8irrL2YLC/pIw85tU9ysR7fdgf0FpdptzjvfUREjjAfRfrOkCk7uqXargxYFNJI91jWDEGwK2GOuMtnuqkeY9VTzEdMYEZmmZsCipQEAhzuUSq9mTVbDcc8ldWlV0zpQ1QHJuQkNluu8op08kzTgd1Ik6O8e1lG55VwNch10jUP+MCaiQb03b/QmzPQsT823vK1xgOVKFex+oMVW6HtcL1RWvJ6iaim0FuLUdBEHfoPWNGDl/RafWvdaMncHHTxu7jIDUzp2Wo0gOJYixNAjY1zoLijbOoePyc1AxYi9sCl3ndIJiE/rEtEE8eN+rozhoKhbK3vzZGTTXMD0Y3I3GN3e3kw+jq8vx28no7o+b4Z9tduz1IYtxOziSuP1aDQaIldnnbkB9uqHzvDESOPloEX2ymy6nuqnpUPtitbgFvrTbQG2YrFLiR3chWz+FPZ+9im7vzf/fwv+xFh72NXalDG2bs5QZ27D1gmX/wmbtNiXFVW3WX9mD/ntrwBd33Te2GtY911H+5a33RzdZB+9bmhq8etXWsOCnXU2v7vA7tzxrfNsZeFw9mbl6t4cLzsNJ0n5paZZNWPbbl/nGq+BPdIGlIyg+h/SqPrC0/CFh13miHdfWGrT9eViqFMtao7QqSWRCG4IHKqz8tVozYwWnTsWdGuxhr1tZLZ932C4+8+y2vEZxE9c9bKS4UqI4iz/3gWqCSzrR3fCZajBwg9iHH4qvbMXWbfoQZPbRzd8TMyQK - - - - ArangoDB PHP client: Traversal - - - - - - - - Traversal - \ArangoDBClient\Traversal - - Provides graph traversal - A Traversal object is used to execute a graph traversal on the server side.<br> -<br> + + replaceById + \ArangoDBClient\DocumentHandler::replaceById() + + Replace an existing document in a collection, identified by collection id and document id + This will update the document on the server -The object requires the connection object, the startVertex, the edgeCollection and the optional parameters.<br> -<br> - - - - - - OPTION_FIELDS - \ArangoDBClient\Traversal::OPTION_FIELDS - 'fields' - - count fields - - - - - ENTRY_STARTVERTEX - \ArangoDBClient\Traversal::ENTRY_STARTVERTEX - 'startVertex' - - Collections index - - - - - ENTRY_EDGECOLLECTION - \ArangoDBClient\Traversal::ENTRY_EDGECOLLECTION - 'edgeCollection' - - Action index - - - - - $_connection - \ArangoDBClient\Traversal::_connection - - - The connection object - - - \ArangoDBClient\Connection - - - - - $attributes - \ArangoDBClient\Traversal::attributes - array() - - The traversal's attributes. - - - array +This will throw if the document cannot be Replaced + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given. + + \ArangoDBClient\Exception - - - - $_action - \ArangoDBClient\Traversal::_action - - - - - - - - - __construct - \ArangoDBClient\Traversal::__construct() - - Initialise the Traversal object - - - \ArangoDBClient\Connection + + mixed - - string + + mixed - - string + + \ArangoDBClient\Document - + array - - \ArangoDBClient\ClientException + + boolean - $connection + $collection - \ArangoDBClient\Connection + mixed - $startVertex + $documentId - string + mixed - $edgeCollection + $document - string + \ArangoDBClient\Document $options - null + array() array - - getResult - \ArangoDBClient\Traversal::getResult() - - Execute and get the traversal result + + remove + \ArangoDBClient\DocumentHandler::remove() + + Remove a document from a collection, identified by the document itself - - array - - + \ArangoDBClient\Exception - - \ArangoDBClient\ClientException + + \ArangoDBClient\Document + + + array + + + boolean + + $document + + \ArangoDBClient\Document + + + $options + array() + array + - - getConnection - \ArangoDBClient\Traversal::getConnection() - - Return the connection object + + removeById + \ArangoDBClient\DocumentHandler::removeById() + + Remove a document from a collection, identified by the collection id and document id - - \ArangoDBClient\Connection + + \ArangoDBClient\Exception - - - - setStartVertex - \ArangoDBClient\Traversal::setStartVertex() - - Set name of the user function. It must have at least one namespace, but also can have sub-namespaces. - correct: -'myNamespace:myFunction' -'myRootNamespace:mySubNamespace:myFunction' - -wrong: -'myFunction' - - string + + mixed - - \ArangoDBClient\ClientException + + mixed + + + mixed + + + array + + + boolean - $value + $collection - string + mixed + + + $documentId + + mixed + + + $revision + null + mixed + + + $options + array() + array - - getStartVertex - \ArangoDBClient\Traversal::getStartVertex() - - Get name value + + getDocumentId + \ArangoDBClient\DocumentHandler::getDocumentId() + + Helper function to get a document id from a document or a document id value - - string + + \ArangoDBClient\ClientException - - - - setEdgeCollection - \ArangoDBClient\Traversal::setEdgeCollection() - - Set user function code - - - string + + mixed - - \ArangoDBClient\ClientException + + mixed - $value + $document - string + mixed - - getEdgeCollection - \ArangoDBClient\Traversal::getEdgeCollection() - - Get user function code + + getRevision + \ArangoDBClient\DocumentHandler::getRevision() + + Helper function to get a document id from a document or a document id value - - string + + \ArangoDBClient\ClientException + + + mixed + + + mixed + + $document + + mixed + - - set - \ArangoDBClient\Traversal::set() - - Set an attribute + + lazyCreateCollection + \ArangoDBClient\DocumentHandler::lazyCreateCollection() + + - - - - \ArangoDBClient\ClientException + + mixed + + + array - $key + $collection - + mixed - $value + $options - + array - - __set - \ArangoDBClient\Traversal::__set() - - Set an attribute, magic method - This is a magic method that allows the object to be used without -declaring all attributes first. - + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection + + + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\Handler + + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + + + \ArangoDBClient\Handler + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + + mixed + + \ArangoDBClient\ClientException - + + + $optionName + + + + \ArangoDBClient\Handler + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + string - - mixed + + \ArangoDBClient\ClientException - - - void + + + $body + + array + + \ArangoDBClient\Handler + + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array + + + array + + + array + + + array - $key + $options - string + array - $value + $body - mixed + array + + + $includeArray + array() + array + \ArangoDBClient\Handler - - get - \ArangoDBClient\Traversal::get() - - Get an attribute + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name - - - string + + \ArangoDBClient\ClientException - + mixed + + string + - $key + $value - string + mixed + \ArangoDBClient\Handler - - __get - \ArangoDBClient\Traversal::__get() - - Get an attribute, magic method - This function is mapped to get() internally. - - - string + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array - + mixed + + $headers + + array + - $key + $collection - string + mixed + \ArangoDBClient\Handler - - __isset - \ArangoDBClient\Traversal::__isset() - - Is triggered by calling isset() or empty() on inaccessible properties. + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use - + string - - boolean + + \ArangoDBClient\DocumentClassable - $key + $class string + \ArangoDBClient\DocumentClassable - - __toString - \ArangoDBClient\Traversal::__toString() - - Returns the action string + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use - - + string + + \ArangoDBClient\DocumentClassable + + + $class + + string + + \ArangoDBClient\DocumentClassable - eJzVWG1v2zYQ/u5fwQEGLAeKvW775HRZvdRNPHhpYLvFhqYQKImW1cikSlJJvGH/fUfqnZLsGuswTB8sSzrey3MPj0e+/Cnexr3e+Oysh87QlGMasNc/o7ubO+RFIaFygtYcPxIucAQSSugVTuSWcQTXG5B/QL/iPeH6i8fiPQ+DrURXxb/vvn3xvY0kD3FAqEDXO/fGhs8RCyix0TXhO0z3MHrc61G8IyLGHikcudI+XBQO3nH2GPpEoIDjeAta665NS2cRcz8RT6JQoEQQH0mGyDPxEkkQNkcjRpHcEiQIhxdIgIXRS5dfKpXZXf1dg0imlZPPScjBDzXMY5TCyxC0pJ/tVJvEXL4nXJLn9AXxAwKBR5kspr5+zWL1CF7EmAMAElxqs/4qCgFrfW2ljMVkPPaZJ0ZYQ+W7I4/txjfr9d24wGAcUp88j7ZyV+QO0H2ARICSOsT6owipR7SFF6MfdEq8CAtRYcCfPfVVJ0NdKSaN+LOPucyrR8wh47lQ9nqs7zEPHzHkpO+UWiDdLVaKbA0EwhL45EIuxajNFuYc7w0zTIJy4EG/HIt+RB8+No15LKESbUIS+aKmBDwUEr29W8/f3jpv5rPF6xWoGKSSg6aiMtcC6Uy0aJvdrpe/O6v1dLl+P1uuZ78pjRXmtKidplAf1jh7fT27ertYzK6Ut0ppnX0tejV0fQen6gWgRAONfPYGMIzBpz1iG83bIiGjLqgzXU1TcxrKEEehIFqTOWnNnOqJUWEQ6lcop65zcx7CbHeJnviGkiwsdfUrMKdKQJ6jTUJzgFMn/8D60ccSH1BmTO7TlWnSpvO7n5YEYeIgt5w9CXRfn7r36W327JG4Ob8SNwq90g/H0SzhiSetdkDtGjC2GZmdOZr7CNSiSRQNtbW0POgQ5DYU55eVWQ2C/eocNyQFkavSrFX1YdgmPKt5ZRleDjPOqSvcICsUjnbbyt0eDivOVjTXqoMe4uwID4jV+G4XEFT8+6uX/jYYP8vXHij6AZH1CQTLiUiiBu05kQmnOd4gE4MxMq0Ut05KmGT4KtwBv5faUWvYM9PtMn9/p3iscGtgddEr01EEUgpWWHJ+GTMhrVpq3vFITCbvlgtnvZxClVxNF3Zb7sC/ktLW8Pzyk2DUIdRjPnGeYMmH8mVVPB0WSqp0yVAv3NR6fxFK40VXdpfpmNZmoCOrlcnXqF61gWZVraajGq6RkTyMBsKdQayAlqoDy+t7rYCN0FyiXQLryxZICwswigiGJ0YJKto2G0G2EY4EQx6mqaRI3PNCoFiuIVrOwZ9J/jzY7W9zqclu/yYzO6h8XzImqzKrxD00JB/5xBkNqnY6BNtre/8RRwn5FwqxWe+0nY4qCrKWINFmMmm0CzayUk+HmavdJL3O89saUsaXLGwld6wWVN0/zL6g2//S3RY21pdQNY3/s1yZy80p6ar3Yidm7DgGp2fOCOa05NWj6XZeJRCKQLEItKeu/0D25qtDaTwxbZbSb6P2dKnG4BvoDFLktGijLdBmESVPpmVrMKegNfTLCBEoGNSaAZMZ5Yr4QVn7qJZA7doXo2ijHQ4gSNgnbplvgLQGI2rDi2tCEANWVTlS+MlyD1v2yOgpBMEkX3GQT2Dfp9kEoyqbLdgUcSEbW66DqemYqhA9Ui13CV6FuLnwLnwG5zKIQDi9bxjvZpUOvGOGPLLQP0gYxzlGGQFIeVuUcsWgioeFOkJoLXNoUhOtUKJ9HbhoiLuc4IeLwwaNTd8hm+317IvM+mSDoQk8pL2O4VGtRdesbkb9O1RCWpPd5Nl50dZ0asoYkhIuJ1p1gI1u3y0WqmSUjIWZRplUZeZYwU350lJ+QqHRaq8OjWJUL8ymeGvhyYaoLVrXSmuifLzElLtaAbLQVuvjNRXnEDa6knAKdWPfqBP/j3Q5TlfCmuuiluqs3XOhjj2DgHDw0t3DfI0iFWWa9CGCOkZ2sdyrv+qEAHvQIYvQjUh+1hK2HHD9E8BcxqBtp1kkyj2FG/QX0LMT6EuACfCUoTQ8AlPG3a/JbOXPIRprP4/swtI1rnaKdcoikQGb7ckS2KVQ2aqtCxbJVmk/cWRHhmu7MQhHn7U60FJgYRUnYpOJfm2jwX1+hJ53su59IaW6jr8BeLzhcA== + + Name of argument $revision does not match with the DocBlock's name $ifMatch in getHead() + The type hint of the argument is incorrect for the type definition of the @param tag with argument $revision in getHead() + Name of argument $ifMatch does not match with the DocBlock's name $revision in getHead() + The type hint of the argument is incorrect for the type definition of the @param tag with argument $ifMatch in getHead() + Argument $collection is missing from the Docblock of save + Argument $document is missing from the Docblock of save + Argument $options is missing from the Docblock of save + No summary for method lazyCreateCollection() + + eJztXW1T40YS/s6vmEtRZ5MykE3uEwl7S8AJzhGgWPb2UoSiZGmMFWTJkWRY7pL/ft09L5oZSbZkDMtucKU2xprpeeu3ebpn9N0/p+Pp2tr2l1+usS/ZXurF18nB9+z08JT5UcjjfIcFiT+bwDc29uIg4ikUxLJvpp5/411zxnS1fapBD71ZPk5SeMZ+8mL2Nud84sWx8+gHqHfDfvbuiSh74yfT+zS8HudsX3/7+qtXX/dYnobQVJyxHyfDwx48jpLrmPfYjzwFuvdQe3ttLfYmPINecadD364VA1SDYPnYyxnUBbKZHmImx7ZXGrQoP+K5PzbLs1GaTOAZZxlPb6EYlEYCU55mYQbP4dGEJbFRZIsNciAAVLKEDe9ZmGWzML7GEljTm07TZArDzTk7PD8/ZSn/fcaJVGJS+W6Yvpa9Nb7OX5QsjH18xNhXW1/TnPmRl2XsQA7nUI6Vf8h5HGRM/r32vzWsQ1OIny+N8Xtp6sEY4oB/kA+36f9+Emc56x+fn/1ydXCy/+5n+PqW7bKOrtqBZXHI+kkUcT8PYb6mXgqrmSNjlKienJ4PTo6v9k+Ojvr7+BXpFnUrCPMP3mQa8SZU+//Z+/n0qI8kZS2gh6Vcmgmswl0awjIlU+pyPc2Tf/fP3p8NzomqrldHV1AbgYikPJ+lsWQOlkSBnvj6ts765+/OoMmjA2xMUDiJgraNxfyueWPH/fdFY8f8DlfAbelHnjOPAQdewzpo6SLx8YyFl8VVrb0o9DIGSzZOAurlNc+/vx8E3Q2n4Jt8nCZ3Get/8Pm0gtAbWnqWgSKBEa4bnMY2Tb4LAwYNeqogtBjPJkPNMIrOJPzAA8bW1UAGAdLRwwoD+DcchaV6QlzYupj3jB5uylXwop58nozkT5mqPufz3fT1iaTmpZztNKkSha87V6AMolnABzHIAzSedaAneTrjqGjkM2KFUBZgXg6TMpzlPNtiB3zkzSKhlUZQmX+3DUSbt30dJyk/DAOYqD1N1uxBNk7u2JgKrLDhlN+GGeoIbGnMDUWmnrQiF45+9sAiILVhkkQcTF04YtfhLXRaEcSRzEB0J1iSGCrJGzeyPX3tMrKQMq2znYFIExW4hsmS4elsGIU+G81iwfQgVF1DJHomXyue1Cy7yy4uhfQJs4Af2af1fBxmm6+VjNaTVMQ2hFb6s6wu9sfcv8HJ9Iqh8Q9oUp35OIcm2V0YRcz34J+MR6OdHRzQhmbc6B7NMvORZIY0YVpSrgjcobzHQFwqDkaaJGZ34xDWK+XTlGfC1MXsH1/9Q9njrUUKiL0fI+vGIM7YHuNpmpAbAT8SocT3Z6k7nHo9tSI1NU9LuTwmeXou74y9rHahXTbJ03vjL1rxbbF2NHnsLbFqMYOwVEAHKvkkQSA4bMiR2dKQ3/LAolTwXn13pGPgcC1qnG/1gz+Bj1BQu25n1vlGRec5KV3+YYrtwUqIpQXdZE+hUFVWbRhcd51Tj/eTgAO/7u7uYm23GaOrROVb6+mfa26ffpuBgYYKOKXWMzHJ6+Zg1+rkbzlzXQijaEvIWlHfhz2AWMQaNbVQql7M+pwqf1mz/uh22PUdzk2uDjMpn8A70GyYizZ4to3MLr/rfmw9P+O/wFo3cABQmYFsTRMwBmbVznZng/0N9BqtqavZ3kRg0M2GWc9U19ASKNYIlSPQcVW5IvKn/rYeeLlnz+GuYRfUpHXfpVG2s/Pu7EjvTHussa9CDcmfLoDjM9zvXLJdpZtrfCI/5bCj/wHWZQ9n832Yj/cTkMAPMH7sdhOfqFond7Ugi22SuzMinSx3UCEBEuwuSW/GSZpxe0sFKoFhbzXmgV4TlucBgiQa/rFZsp2GnqWRXpxNg0U3M1CuDNYEjAMWRGdOWfgXNW9XeVHzn7uaV4tWo/4Fny2j+9MkB1HBUob614oRpXOeKmxgCNbH3At4mqm/sYyhOIUy9ILgPPXizKNGDqlGV9W0OmC67JbYM0O3T7wbvq+fdeuqm6qHqoMdOOTRlKc7O8NZGAXwt5yCi7o5uDSsANo8mpGrG35/JTanXc2jhkJnf/87KxfUfGaUdA0k7RG0sVGkL2mngKJWtVVQ83jRGYw2dQXW+aLDtgzLpZu/hJ/hobOrYByEcxH14yTmyzfh7kKIPGy2p1CZW5YbLGUsF3dDbvEEp8rOmMtMU6aoUOHDPJ8aO6xvyjsssVlByFOA5dqWdTva04J9Lm1AfTCD1zzY6myUtlH4UVbf6sFPGfZ8nl3PQE+DLQYlgtztDZNZhanPHn//ZdNbzsa3Ry22HELSPi/GLdyKyiqsS1HBh5usnbFwaepR6UrsgZZhgVb31FcfHEQv1JC8n2A0IudMcL208uopqBY2lpyuWqh1+FHlzoPn9FB3YYUilDQ1oeKH+fgf9q+tk61aLJqa7weDQ+ttkr+PLuzjeMU0S0/hFVu2aVmveFVgYWO0sFTPEhDlFRcE1ONHlNkHOVCapRa5TMTfi3yl1jL0F/OcivlBeAAnBN0kPUfqx0qPSGmI1t6PbnPFLs9cuhVIRYW/Y81vnetjcl7h+7gdZQ4x2xsSZboV9S46yoDQ2Oq8qAqMQxKo1di0S53wgLIatBzBHpBiNmTcbHykKKQdFJEO4gvQpFqdrhvSq3+z9+J1SJqruH+10yd+dRzDRSqiBdzjqoErJTP7lJuhmcH+vWIR7AI7O04fmuNMb3PY3ZuBN1ioRU5nSPExD8P126Cg09yfUb3Mu0XHG21myqeR58NfW8APWQ4sg1DJ2LslFyZhASZmTMKYy9BbIpzXb/SsEmowy3hPtZyF4BHdsynOk6XKsWEchGwZHDJyikfh9QxGhs61bCLmigtdE9LclcYhBowyKGiAwZJBDL3V0FpTLvBmaXDQKlgCDmYGuoF/4RRwaeZ1QXSMpK2rMdkly1DhNyzwGiQm5qBi7MHAGH1cdExkOjWsi2COkIHCxCGoI36TLnUxWPLbKS8L1/Wey3hzYxynaPTOC/MfkvTtfexje0g647RuuGfvYcsoKhEwzCS5BRcpAUvqiWESx4UgHl6cA2sjewEZ4J84xAVGMQmzG7bNBiPhlYaiv9mU++icBZK8PbpOBtJFyBuRA7IodrCk1Bxy03QKCi5oOdj6AIVgsE1kIVj1Qmho6gsHViSkvdr6au6GRYhyWTwsf0e7WQ2jFZoKWbcBwvhdwl/K7obZSI1bgp85KMKeI1a0Yfx9FqZiSTOpcM2kKwtgwI8T6EXrjOup7QNp2mrvqzKIQUSKScjUJIhITXWoXDZaiXw4U9UCY9mLhaihmqnSrzg7AQLZiZwjg7HnozBiZpThqZ+PCiMIMsjT3FSnsgMNwBfQzSWV7agbYRBF/oFREgQ1DGrpNrJEyxkfbREkY8zfSy6wCUpU/5CyaNiz1dsybYBkzw0ztAoT9DAj9JHM0F/MEMnhFpm1VYMVEqQEToq3lGmpIYrxO5lnd+C/C1hGjY7wNi+CNQzuZWLaUn0ucmZrF0im48IiSPNp9kvMmkIfH9AFzBGe2wXl3da3DtXBOx/NgI9i6O0d1pxlpCh0rrSIW7Tu5xN5GoIraq1om/jXR4dvdO3WG8p1UqxGSRlPllpwEJ/S867tSshZ6bGLkmdkKyIxhtfCXSuXzcIIDaHxE5Qlp6SisCHyReEuYocb7I2ORImkUDcZ/7KCniELTekVCff1BEm+WxI87r93CF7qv9yAVzcEk5kbocKSwbmkKOT8An/8Ya9offxNcEK3+F2yhh7D/ll/77xfimdKkpH33/t9pwOO0AkWrPbuCI+0QEiwGjwOBFsiFlkOPiAyt01YXXUz1nSG2ZUnIRMpIuWRUOxht9AOZgZpBZBYKk/zuBdFIBYD0jrvplCEd2uG3CAuOk0yHRgVRX7LkviKx34S8Ku7FCcpFSjQRjV+iOUFj9YEMHXR7W0ZQQENBO4goip0QApm744D02PQZEhA7gQa72kEBj2E6wQUbko50SItO7nh6oiUzNEe8ii52zJb2/dmOM4dEzoyDPTgoKdyce1zLNQJWGXwIIe/wVzZI+BsECic6XsseYolpR+q84zxlBZCREgT94oYFEJjkVs9fE/jHnpZ6FPKedEPICcaZ5h33sO5SVKM4OFsoP/h+xRcoWpgQYuOM+q58LktvzkMLIZdH+rOu0unh9Ut8bDaJenKVUl16mO1t1gVgjJpoN/qeoSMWLvJbCCdJp2LEjAqTqX9q//LZbWsRYnvSUjBnssj+UAabiei8TddsU1+QSjy2kchiIJuWEd41bFC1Y2a/e46ULEUopHVMwgQAlZd7xadNC2+jQPI4Nm/OMzxoik09UclFUwtnUdkcFBP40zGVeZTOOv/+7KUAgIzgjEkB+YJylIwZ3F+hIXBEGQMe6Mw0IvgJk3ULUoTcEVxaqmbCpjAf11sYtAYm1CHEksgPcW4pbu7MT9fYC6wVOUSM8cnttGYBT52GZlxBi/spDiy44JGYWxNQq8IWpMSFxs/lTVxhXoVpE5hBKB8r1J+K+L9CEOgAtZwnGp+L8+RJOEiaED0DjaR+2CZVID5QjJXiInNxy2eCYZ6r7Ze1SI8MzE4S9dbp4eXxoYEZRcdgs37NIHVxmPIat8nDip1UU/gnGAuRJQM6Ts2MrsWW+GS86dSLHSChARyjKPUCOnQHINAzXBIeU/0F3wSsJxcHuRCJ0ARI7dC7D9ljDVxxpgnm0O+qbenMpsj8yZcmU0M81ASweoiM2LxbR4Rfa1dR+ArOjlWToGoiKE8DLpqn1VMSIBgBYQBZP8lbwiUbpYRCgs8BQsFvfGTeASPc9btEMt0eqwDahm2bsAyx++OjtgFOjMS77ncaLjnp57ccD49hv0hAWXCHZtJ2AkxqXQGzerLCih2SJlRWiMUOcdUHh1GYLZceoVhKhiQAoq4DbUTkymJuYtdMOkQnCFFhEIAbcbjIHHOkEAX+ya+JpwAl8/lmhQYlcLgOKbHqIXR8mI0yUaRdw3iB0qQQ1Go5A0jLg5UUyYTKLTUhOmaDq0elsEdLuayRXfefWYhcIaewn2COHyJ/DPXCInBVwaBWp9PFbTEoRfL7ha7UbTAvYqzI2aVjQV2a4WGywHg46C8E3ixTM/VMsnxPYZhUql/DkTYPmJTJASYZ2Ls9L8WgR8nhWHTNZQi+0Lmt4qpMDQtrlKhn0scsiDz4OFBnyXO5LDnZEF1bz4jK6rH9HlaUhreU1vTBcc+V2JrSfDbJoM/klVdmBTeWutaibGbyyRtv2juF81d0ZsXzf2pa+4FJxAerNHLOcdC1S46l7CkVn+Jay+Ma+++rgzNLYyVvt8bnF+9/eV4f6MiflwoAkahY+KUcjEraD4nXi5Obp/x26wzj5xShorcUuN6d3qwd96/Oj05Guz/UjU2K9i+yjj7qkLsVkRBhtgFD100HDaF3W1+akmAUk6Fk3NKq7Kz0z87OzkrOurmrJonj2x8Q4dTnDRQHB6dwKGIiapeebxG9t5kJOPyi1JxfbIkHG1O5KmZVRybKWUALHMMaXEegVSmpWSEgoSbhVuOyptaeV5YflFewPyY/a7qSunAMZVaPqpWGvJHjf+Wruyq2BGcyWS+ZSNERdkc+12La6mkwUeAxFQw4/PBxJwgjXl0+kmiNU7GsTPBzzcQo5jso0ViPk+v/QmxFnX6YCVwiiRmxy5WHah4iAJtEql4yuDC2YsmXV6T1hwTfH4glaPdX1Cn5VCnVeh6yZhChJ+PwqcxPrnSfxKEfdb6RsPHMgaPDrAveTPKi/6aLxcv+uvT0F9PcQciY49wDeIzAchni684fIHHPyl4/Dni3mf906O9/U8a+Fbf2+De9rCXAb4dCo2Qb7MFG8auuIby8RHtJe6+VN8MsLb5UTEby2YruJurklBTXLwBHD5bzRm1F7zb8NAnya11X1PpmtD2MPdKsVbs3/OHWj92zvtqvFfnIoeP77k+6a4bOW1VSCvSag+06gKF1jEfN9hvLyXNbXDXVuif44Uuu3e2N86td86SiHHDKLMuGZ2Tgo1CJNKjqlWQc2/ZQ7fTy2ymn48i+rxV0UdQRotehFa6Jba1ooLZzfgDrltehUZaMfC3GthvRaDfwyA/RcTSXKtRXCvGAV8U16emuJ4eQRO6pv3V188AQWt75/ULGLYSMOygf9R/iiTQh+NXVk+Xga9sAu3zNp97FqYNET2H7Mtm0Ezp6qaFIJWwuvUXrRMVAqLmw1D4WQjxLNuJJtCQmFnrxvVrbl8cEihvrki8SZ0ClLRS49BV34s+fwvoOFEnZ/Pjn65dUzf+GTTaGrbw1rqIvm4775oowxOsvPnLuldYXp7pc/AvFPXyLWKVFJ1LYByGobuG8BakEF/ZVVDAC9xgzFfCI616MooSr1wFik/sH1F1dTptbsrZFwlXXpTz1L04U7zLyFitBZf2Fj154esH83UFCuVyteOtuRcpteLnVkcPKl+bJYrVrvwcbMr4I8YkOLzgqAnk85He4OjewHh+P6WLa79Q8/YFjuBr2jsUiY2tdw7YVu3DL/AdRtTON9QO/rlkGxV3fOKtrJ/fjcPGTqx2n9Tggsu6138UhQ7l+6Z2hcp1f+9WOw7VmxjcUlliXX4fYSU/znk3oXZCcyxIL4ypvV2UaFXftlfdGZOZmvTBLG93xXpS2YPKt9J7ec4nU+Lcyou67W6UFk298HfhrabqbfML3jNv6LYJKChgYXnYFy9KF7dQG0OTA4T/fIxwXtGNbzosIru4s0MPe6zzK3gA3jWPM/XSm+GvTlm02P8HXsDLdQ== - + - ArangoDB PHP client: vertex document handler + ArangoDB PHP client: statement - - - - \ArangoDBClient\DocumentHandler - VertexHandler - \ArangoDBClient\VertexHandler - - A handler that manages vertices. - A vertex-document handler that fetches vertices from the server and -persists them on the server. It does so by issuing the -appropriate HTTP requests to the server. - - - + + + Statement + \ArangoDBClient\Statement + + Container for an AQL query + Optional bind parameters can be used when issuing the AQL query to separate +the query from the values. +Executing a query will result in a cursor being created. + +There is an important distinction between two different types of statements: +<ul> +<li> statements that produce an array of documents as their result AND<br /> +<li> statements that do not produce documents +</ul> + +For example, a statement such as "FOR e IN example RETURN e" will produce +an array of documents as its result. The result can be treated as an array of +documents, and each document can be updated and sent back to the server by +the client.<br /> +<br /> +However, the query "RETURN 1 + 1" will not produce an array of documents as +its result, but an array with a single scalar value (the number 2). +"2" is not a valid document so creating a document from it will fail.<br /> +<br /> +To turn the results of this query into a document, the following needs to +be done: +<ul> +<li> modify the query to "RETURN { value: 1 + 1 }". The result will then be a + an array of documents with a "value" attribute<br /> +<li> use the "_flat" option for the statement to indicate that you don't want + to treat the statement result as an array of documents, but as a flat array +</ul> + + - - ENTRY_DOCUMENTS - \ArangoDBClient\DocumentHandler::ENTRY_DOCUMENTS - 'documents' - - documents array index + + ENTRY_QUERY + \ArangoDBClient\Statement::ENTRY_QUERY + 'query' + + Query string index - - OPTION_COLLECTION - \ArangoDBClient\DocumentHandler::OPTION_COLLECTION - 'collection' - - collection parameter + + ENTRY_COUNT + \ArangoDBClient\Statement::ENTRY_COUNT + 'count' + + Count option index - - OPTION_EXAMPLE - \ArangoDBClient\DocumentHandler::OPTION_EXAMPLE - 'example' - - example parameter + + ENTRY_BATCHSIZE + \ArangoDBClient\Statement::ENTRY_BATCHSIZE + 'batchSize' + + Batch size index - - OPTION_OVERWRITE - \ArangoDBClient\DocumentHandler::OPTION_OVERWRITE - 'overwrite' - - overwrite option + + ENTRY_RETRIES + \ArangoDBClient\Statement::ENTRY_RETRIES + 'retries' + + Retries index - - OPTION_RETURN_OLD - \ArangoDBClient\DocumentHandler::OPTION_RETURN_OLD - 'returnOld' - - option for returning the old document + + ENTRY_BINDVARS + \ArangoDBClient\Statement::ENTRY_BINDVARS + 'bindVars' + + Bind variables index - - OPTION_RETURN_NEW - \ArangoDBClient\DocumentHandler::OPTION_RETURN_NEW - 'returnNew' - - option for returning the new document + + ENTRY_FAIL_ON_WARNING + \ArangoDBClient\Statement::ENTRY_FAIL_ON_WARNING + 'failOnWarning' + + Fail on warning flag - + + ENTRY_MEMORY_LIMIT + \ArangoDBClient\Statement::ENTRY_MEMORY_LIMIT + 'memoryLimit' + + Memory limit threshold for query + + + + + FULL_COUNT + \ArangoDBClient\Statement::FULL_COUNT + 'fullCount' + + Full count option index + + + + + ENTRY_STREAM + \ArangoDBClient\Statement::ENTRY_STREAM + 'stream' + + Stream attribute + + + + + ENTRY_TTL + \ArangoDBClient\Statement::ENTRY_TTL + 'ttl' + + TTL attribute + + + + + ENTRY_TRANSACTION + \ArangoDBClient\Statement::ENTRY_TRANSACTION + 'transaction' + + transaction attribute (used internally) + + + + $_connection - \ArangoDBClient\Handler::_connection + \ArangoDBClient\Statement::_connection - - Connection object + + The connection object - + \ArangoDBClient\Connection - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - + + $_bindVars + \ArangoDBClient\Statement::_bindVars + + + The bind variables and values used for the statement - - string + + \ArangoDBClient\BindVars - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - + + $_batchSize + \ArangoDBClient\Statement::_batchSize + + + The current batch size (number of result documents retrieved per round-trip) - - string + + mixed - - createFromArrayWithContext - \ArangoDBClient\VertexHandler::createFromArrayWithContext() - - Intermediate function to call the createFromArray function from the right context + + $_doCount + \ArangoDBClient\Statement::_doCount + false + + The count flag (should server return total number of results) - - - - \ArangoDBClient\Document - - - \ArangoDBClient\ClientException + + boolean - - - $data - - - - - $options - - - - - - get - \ArangoDBClient\DocumentHandler::get() - - Get a single document from a collection - Alias method for getById() - - \ArangoDBClient\Exception - - - string - - - mixed - - - array - - - \ArangoDBClient\Document + + + $_fullCount + \ArangoDBClient\Statement::_fullCount + false + + The count flag (should server return total number of results ignoring the limit) +Be careful! This option also prevents ArangoDB from using some server side optimizations! + + + boolean - - $collection - - string - - - $documentId - - mixed - - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - - has - \ArangoDBClient\DocumentHandler::has() - - Check if a document exists - This will call self::get() internally and checks if there -was an exception thrown which represents an 404 request. - - \ArangoDBClient\Exception - - + + + $_query + \ArangoDBClient\Statement::_query + + + The query string + + string - - mixed + + + + $_flat + \ArangoDBClient\Statement::_flat + false + + "flat" flag (if set, the query results will be treated as a simple array, not documents) + + + boolean - + + + + $_sanitize + \ArangoDBClient\Statement::_sanitize + false + + Sanitation flag (if set, the _id and _rev attributes will be removed from the results) + + boolean - - $collection - - string - - - $documentId - - mixed - - \ArangoDBClient\DocumentHandler - - - getById - \ArangoDBClient\DocumentHandler::getById() - - Get a single document from a collection - This will throw if the document cannot be fetched from the server. - - \ArangoDBClient\Exception + + + $_retries + \ArangoDBClient\Statement::_retries + 0 + + Number of retries in case a deadlock occurs + + + boolean - - string + + + + $_cache + \ArangoDBClient\Statement::_cache + + + Whether or not the query cache should be consulted + + + boolean - - mixed + + + + $_stream + \ArangoDBClient\Statement::_stream + + + Whether or not the query results should be build up dynamically and streamed to the +client application whenever available, or build up entirely on the server first and +then streamed incrementally (false) + + + boolean - - array + + + + $_ttl + \ArangoDBClient\Statement::_ttl + + + Number of seconds the cursor will be kept on the server if the statement result +is bigger than the initial batch size. The default value is a server-defined +value + + + double - - \ArangoDBClient\Document + + + + $_failOnWarning + \ArangoDBClient\Statement::_failOnWarning + false + + Whether or not the cache should abort when it encounters a warning + + + boolean - - $collection - - string - - - $documentId - - mixed - - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - - getHead - \ArangoDBClient\DocumentHandler::getHead() - - Gets information about a single documents from a collection - This will throw if the document cannot be fetched from the server - - \ArangoDBClient\Exception + + + $_memoryLimit + \ArangoDBClient\Statement::_memoryLimit + 0 + + Approximate memory limit value (in bytes) that a query can use on the server-side +(a value of 0 or less will mean the memory is not limited) + + + integer - + + + + $_trxId + \ArangoDBClient\Statement::_trxId + null + + transaction id (used internally) + + string - - mixed + + + + $resultType + \ArangoDBClient\Statement::resultType + + + resultType + + + string - - boolean + + + + $_documentClass + \ArangoDBClient\Statement::_documentClass + + + + + + + + __construct + \ArangoDBClient\Statement::__construct() + + Initialise the statement + The $data property can be used to specify the query text and further +options for the query. + +An important consideration when creating a statement is whether the +statement will produce a list of documents as its result or any other +non-document value. When a statement is created, by default it is +assumed that the statement will produce documents. If this is not the +case, executing a statement that returns non-documents will fail. + +To explicitly mark the statement as returning non-documents, the '_flat' +option should be specified in $data. + + \ArangoDBClient\Exception - - string + + \ArangoDBClient\Connection - + array - $collection + $connection - string + \ArangoDBClient\Connection - $documentId + $data - mixed - - - $revision - null - string - - - $ifMatch - null - boolean + array - \ArangoDBClient\DocumentHandler - - createFromArrayWithContext - \ArangoDBClient\DocumentHandler::createFromArrayWithContext() - - Intermediate function to call the createFromArray function from the right context + + getConnection + \ArangoDBClient\Statement::getConnection() + + Return the connection object - - - - \ArangoDBClient\Document + + \ArangoDBClient\Connection - - \ArangoDBClient\ClientException + + + + execute + \ArangoDBClient\Statement::execute() + + Execute the statement + This will post the query to the server and return the results as +a Cursor. The cursor can then be used to iterate the results. + + \ArangoDBClient\Exception + + + \ArangoDBClient\Cursor - - $data - - - - - $options - - - - \ArangoDBClient\DocumentHandler - - store - \ArangoDBClient\DocumentHandler::store() - - Store a document to a collection - This is an alias/shortcut to save() and replace(). Instead of having to determine which of the 3 functions to use, -simply pass the document to store() and it will figure out which one to call. - -This will throw if the document cannot be saved or replaced. - + + explain + \ArangoDBClient\Statement::explain() + + Explain the statement's execution plan + This will post the query to the server and return the execution plan as an array. + \ArangoDBClient\Exception - - \ArangoDBClient\Document + + array - - mixed + + + + validate + \ArangoDBClient\Statement::validate() + + Validates the statement + This will post the query to the server for validation and return the validation result as an array. + + \ArangoDBClient\Exception - + array - + + + + __invoke + \ArangoDBClient\Statement::__invoke() + + Invoke the statement + This will simply call execute(). Arguments are ignored. + + \ArangoDBClient\Exception + + mixed - + + \ArangoDBClient\Cursor + - $document + $args - \ArangoDBClient\Document - - - $collection - null mixed - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - save - \ArangoDBClient\DocumentHandler::save() - - save a document to a collection - This will add the document to the collection and return the document's id + + __toString + \ArangoDBClient\Statement::__toString() + + Return a string representation of the statement + + + string + + + + + bind + \ArangoDBClient\Statement::bind() + + Bind a parameter to the statement + This method can either be called with a string $key and a +separate value in $value, or with an array of all bind +bind parameters in $key, with $value being NULL. -This will throw if the document cannot be saved - +Allowed value types for bind parameters are string, int, +double, bool and array. Arrays must not contain any other +than these types. + \ArangoDBClient\Exception - + mixed - - \ArangoDBClient\Document - array - - - array - - + mixed - + + void + - $collection + $key mixed - $document - - \ArangoDBClient\Document|array - - - $options - array() - array + $value + null + mixed - \ArangoDBClient\DocumentHandler - - insert - \ArangoDBClient\DocumentHandler::insert() - - Insert a document into a collection - This is an alias for save(). + + getBindVars + \ArangoDBClient\Statement::getBindVars() + + Get all bind parameters as an array + + + array + - - $collection - - - - - $document - - - - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - update - \ArangoDBClient\DocumentHandler::update() - - Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document. - Attention - The behavior of this method has changed since version 1.1 - -This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the document to-be-replaced is the same as the one given. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document + + setQuery + \ArangoDBClient\Statement::setQuery() + + Set the query string + + + \ArangoDBClient\ClientException - - array + + string - - boolean + + void - $document + $query - \ArangoDBClient\Document - - - $options - array() - array + string - \ArangoDBClient\DocumentHandler - - updateById - \ArangoDBClient\DocumentHandler::updateById() - - Update an existing document in a collection, identified by collection id and document id -Attention - The behavior of this method has changed since version 1.1 - This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the document to-be-updated is the same as the one given. - - \ArangoDBClient\Exception - - + + getQuery + \ArangoDBClient\Statement::getQuery() + + Get the query string + + string - - mixed - - - \ArangoDBClient\Document - - - array - - - boolean + + + + setResultType + \ArangoDBClient\Statement::setResultType() + + setResultType + + + + string - $collection - - string - - - $documentId + $resultType - mixed + + + + setCount + \ArangoDBClient\Statement::setCount() + + Set the count option for the statement + + + boolean + + + void + + - $document + $value - \ArangoDBClient\Document - - - $options - array() - array + boolean - \ArangoDBClient\DocumentHandler - - replace - \ArangoDBClient\DocumentHandler::replace() - - Replace an existing document in a collection, identified by the document itself - This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document - - - array + + getCount + \ArangoDBClient\Statement::getCount() + + Get the count option value of the statement + + + boolean - + + + + setFullCount + \ArangoDBClient\Statement::setFullCount() + + Set the full count option for the statement + + boolean + + void + - $document + $value - \ArangoDBClient\Document - - - $options - array() - array + boolean - \ArangoDBClient\DocumentHandler - - replaceById - \ArangoDBClient\DocumentHandler::replaceById() - - Replace an existing document in a collection, identified by collection id and document id - This will update the document on the server - -This will throw if the document cannot be Replaced - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given. - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - \ArangoDBClient\Document + + getFullCount + \ArangoDBClient\Statement::getFullCount() + + Get the full count option value of the statement + + + boolean - - array + + + + setTtl + \ArangoDBClient\Statement::setTtl() + + Set the ttl option for the statement + + + double - - boolean + + void - $collection + $value - mixed + double - - $documentId - - mixed - - - $document - - \ArangoDBClient\Document - - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - remove - \ArangoDBClient\DocumentHandler::remove() - - Remove a document from a collection, identified by the document itself + + getTtl + \ArangoDBClient\Statement::getTtl() + + Get the ttl option value of the statement - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document - - - array + + double - + + + + setStream + \ArangoDBClient\Statement::setStream() + + Set the streaming option for the statement + + boolean + + void + - $document + $value - \ArangoDBClient\Document - - - $options - array() - array + boolean - \ArangoDBClient\DocumentHandler - - removeById - \ArangoDBClient\DocumentHandler::removeById() - - Remove a document from a collection, identified by the collection id and document id + + getStream + \ArangoDBClient\Statement::getStream() + + Get the streaming option value of the statement - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed - - - array + + boolean - + + + + setCache + \ArangoDBClient\Statement::setCache() + + Set the caching option for the statement + + boolean + + void + - $collection - - mixed - - - $documentId + $value - mixed - - - $revision - null - mixed - - - $options - array() - array + boolean - \ArangoDBClient\DocumentHandler - - getDocumentId - \ArangoDBClient\DocumentHandler::getDocumentId() - - Helper function to get a document id from a document or a document id value + + getCache + \ArangoDBClient\Statement::getCache() + + Get the caching option value of the statement - - \ArangoDBClient\ClientException + + boolean - - mixed + + + + setFailOnWarning + \ArangoDBClient\Statement::setFailOnWarning() + + Set whether or not the cache should abort when it encounters a warning + + + boolean - - mixed + + void - $document - - mixed + $value + true + boolean - \ArangoDBClient\DocumentHandler - - getRevision - \ArangoDBClient\DocumentHandler::getRevision() - - Helper function to get a document id from a document or a document id value + + getFailOnWarning + \ArangoDBClient\Statement::getFailOnWarning() + + Get the configured value for fail-on-warning - - \ArangoDBClient\ClientException + + boolean - - mixed + + + + setMemoryLimit + \ArangoDBClient\Statement::setMemoryLimit() + + Set the approximate memory limit threshold to be used by the query on the server-side +(a value of 0 or less will mean the memory is not limited) + + + integer - - mixed + + void - $document + $value - mixed + integer - \ArangoDBClient\DocumentHandler - - createCollectionIfOptions - \ArangoDBClient\DocumentHandler::createCollectionIfOptions() - - + + getMemoryLimit + \ArangoDBClient\Statement::getMemoryLimit() + + Get the configured memory limit for the statement - - - array + + integer - - $collection - - - - - $options - - array - - \ArangoDBClient\DocumentHandler - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler - - - \ArangoDBClient\Connection + + setBatchSize + \ArangoDBClient\Statement::setBatchSize() + + Set the batch size for the statement + The batch size is the number of results to be transferred +in one server round-trip. If a query produces more results +than the batch size, it creates a server-side cursor that +provides the additional results. + +The server-side cursor can be accessed by the client with subsequent HTTP requests. + + \ArangoDBClient\ClientException + + + integer + + + void - $connection + $value - \ArangoDBClient\Connection + integer - \ArangoDBClient\Handler - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object + + getBatchSize + \ArangoDBClient\Statement::getBatchSize() + + Get the batch size for the statement - - \ArangoDBClient\Connection + + integer - \ArangoDBClient\Handler - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection + + buildData + \ArangoDBClient\Statement::buildData() + + Build an array of data to be posted to the server when issuing the statement - - - mixed - - - \ArangoDBClient\ClientException + + array - - $optionName - - - - \ArangoDBClient\Handler - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - + + getCursorOptions + \ArangoDBClient\Statement::getCursorOptions() + + Return an array of cursor options + + array - + + + + setDocumentClass + \ArangoDBClient\Statement::setDocumentClass() + + Sets the document class to use + + string - - \ArangoDBClient\ClientException + + \ArangoDBClient\Statement - $body + $class - array + string - \ArangoDBClient\Handler - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - + + + No summary for property $_documentClass + + eJzFHNtWG0fy3V/R5nBWIpGw47dgw0ZgsJWDwREi2azjw2lJLdTxaEY7M+KSxP++VdXXufRIArLLgy003XW/dXUNb/65mC2ePXvxzTfP2Desl/L4Onl7yD6+/8jGkRRxvseynOdiDh9hBS76YcHHX/i1YMyuP6Kl9JAv81mSwjP2I4/ZRS7EnMcxPRoni/tUXs9ydmQ/vXr53asOy1MJAOOMvZuP3nfgcZRcx6LD3okUdt/D7hfPnsV8LjLALUpoX1vyj5I45zIWKZsCCYC+99Mp+89SpPea9PNFLpOYR2wk4wlb8BRA5iLN2BgWjwRbZmLCbmciZjLLljK+ZvlMOCgsT1gmcFsuEBw+VA+maTKnX294tBTZLj49vhPjZY5AuF51K6OIpSJbRjmTMXw9XqYZUDoSuGqcCoA72dW0DmciFUAH8iHniyTNeZyzicwA5BjZgG35rQBa89sEvp9OYT2syO8XImPJ1Okt20N4b5bRAf0fyQPvGVDNc7ZIk8kSJAu4eJrye9w/ScZLtYTjKiFTQ3vv7O2bUcpehOFNEhYnDqwFRRteKErw8wlwL+74fBGBtrkDw7LleIZ4t07OB0yw/plZxgbHw8sB/LqlxKlRILAg8RL+U6TvolgNG1rpuZI7LvQgIEALBGgDexEcaDLfWZNZTNRuWJDh9yPwDjQUtIZMpDdgjaN7Yy3Kp3Y96dlP75NbAYs7nlVtaV6/Y9+y7zS/vlhDDCM4x3OHjZa5W3sr8xmKGkwOpJmNecRTZbasjajj5XwENL/aISPeerWFNohYOa6SEyeBLFE2q0zcfk2+IHNF7pTLqJbdIUhomcbEraKTjDafATbFvYxBig6uEsw0iaLkFjHGQkzA2hIENkITi0XVzucJOMa9J1IAaaT6p+J6T4mXfd0qGAdRn2MoAOAcAbKAvLVAtwjaFuM5RDOQuCi5CMQWomPrahrxfIslFIsoUpGpWNMHEiE6yTH8rpzpPlkiey0giqsoy8jAUPalvZr4oin7dkymAE8ZEqFWlH3Sxvea6A5WM8bA/3L3FQXlccSzDKK8yRB/PsPIT+EYfyiKsXESx0KFrGT0O3zSD82aH27AAo/sIv31C/p/kcobFMT2lYMCAb8GC4V0gCT5KBIZ+aMKxiqqV+RcR8QhwPiZp1mAhJF+XE8ABPNUBYAc4kQm/wCH0s4EOtCacWaTCrAT8HjIQ7AiTZbxpAvfLHbqCJvLOzEJUYX4LgBdgCyAnKO6r1k7myXLaGLCElBAHpjkkBHLlGa1dIySJAqQMUmOCNM++HyUPTExTF7HSWoSciTnMjf0sUMAy1MxXUbPAQeED+1ZQEUC9IGIUdy2tKHwtMTwBwFsbmN0JieCds7lHxz3Z883FAAQEK0hAhWHshy5qcNQeFLGQZurcLdUSFFylZD6Re7nESNEimmljAeMU1qlUNChQG9tdFMToJgSZP6CxzLnKuhVCL2SKoVegb5cCHUkp2KeoK/YQuuBVpohEeiaQTLPPNtDD82wVBtziN6QiwSfRAnk92SMpduGuA28ffayivaXmQC2AG9KOnDKG0PVAVaqnGVE0RQ5t+FgXewEZwO8xmgc5tFSwoflgk3uoRaHBBVF96ruQYOag3ZU2WNAq2KH8cUiwmyGisfaGqscxm+gMMBI3UHMFjKsl6kAsEnsF1BTmWY5oTKwKTNbvJCVUgrqRFKbNLuxZRCw1/Rt2CYyAfKfZKqYU9W7MdEvYpGX6JbT2vxswEKsGsnra4GZiauNEs0TDyg2iaiqZCKmHPOHKtQkOS7h6MITOPIYa1AL6lifJEsQd4D5PI/qOa8xj4JB8hEcTPSRKQf1UYDHExWHYiWNAzGuKYaAXZzHv6i9YS/tLaAIvpNz3DSH2AAGS1nBVLLgs6N7CCA7qoTi1pliKsQKaupi7DeA21yDAGW/RLahmNBhaC60kjRCXRcTXjGptTdp64wynwrGKdFMAaFO+jkkrYyr0gkCZJsqGYkCjtHSa1E25o88vetPAF8MuaoqVGWdQzhAbgrY7axC/clLeFjZirsCDIxnOTs+Gw5+vfrp8njwK5DXIm21qrBUftUJvhnW0fnl2RBhkUnWwDp0dVozpMPe8Oj9Rf/fxwjNVls1EAc2YTSBg+PHoH98gcB0RqgjrljNriCwf/b2596AQJoatVVvUSfgXmj92jkpEwfhnvT6p1fnZ1e/9AZn/bN3CL7gngEcH3x/zGdgG7MkUhW4bsYE8H04/nAO/532P/RJc56P1IjoBGxYF5QrDOLk8vTU2YOt0wLkX1AicEVIkNyL4eC49wFBqtwRgDccnq4BDFcBJAjEHqsu3XmBwMIKxoMa6IPe2UXvaNg/PyMsDlyNYPsqB0l9YA2dmDAtbU94zrEfAWeY/L7QRsNe2UKMS8dvcafy+HSZYl4xsJQCM3tKo9W7JYQ9vxGG3EHYTl1d4TcjXMaFIH2rc5hXmrjnfhMJNgLXeUP/iFFfEcoTn/g4ibu2+0HJYxfzZlymQzf44BB+b/O5xCcGEJyll1RGzSoH+wKZlrhd1tctE52L/OoLStYOE14T0msxIAJ14soK5Gde16as7gSAYSUnc6ix5jz9UiKRZxokdWd8oKrEb9H5oFVUuVdeKmuRZNHKsMok/ADBJLnN2PHdWCy8VoF9Th1dr5XAtr3eQ1dVL+4LsFBtrCUAqnFCP8rA1U/XV6f2EXVWZLiqmBmh2JJjMHPdq726IndMl+O8XU9fR6MljMqTVTeFyEAldw+8Jgi48bbfEimvNHkAvoJ0L25tb6O9oz0ef6BAbcsMTmFtQvspE9F0b89Lxp93djwyPASwhxJ7eKOj6av9tBZiFVebMKsQ3bDVx70WTsoOTSgpY4Q3bozQFhVNSA9NsdEM4MGShqTThH6YR6FNm/Ora5QgPmuxhLoRwgbIXeoPI/YbN208muwoJ/x0RAe8ApCNRG32a9vsnfWHTQr3mxO1dJTgPFjtugINE+I6FXCQyg0ZdSDWUkWR/pPTXpMyVA+pgX/a/wC8R72j9w3CV8faRswKwoPFXiqnG2RQOgMXSGqC+GDS/Mo7TFfxzBoyjQKsjeOEV6l+3mH/+EcNAn8JJGJIyvFYQM2msgKIbOjK2xAr5iDcDL17cC3y/qRdibBf685+5jpr5X2H7nUfNdQmhY3msJ3k8B02QU1VcY15yexpl4sGjaZaO7wO8KBurFdV/VIXiYsk8/uFxStPrPFTUbnh467WZcq3ds3dCbbSxqrBUjhEyByLfOGDWbcudJIm8I0FmiqURUWIaKvPZXal+hdtI0ziueIoRAdVW+rOzBLUbukuiK12ue6ItOqzma07943+qEf6Fr4tFHDbM8En2G/bZ588Z0OqC6ZepvTFC/AcNLFSj6noLBr4p9Zdl9P9SReAdeWk9dnRpeDXM6GyCHMNLvy5nckI75rTpajID0RU/IbAgNoXUD0LD6kz5u4BGmL7Mo2yvb3LASTqy8HF+aBjlpZ8pHvwe5bEV9ipnIir25Qv4Oiq4tBOx3Lsi9j8aFsi7ZI9tavEdByxhPnHDHEWaKGtahAFanFP+yQ8cAHsSrUvyI2s/bDtiqycmlHI337LDvbL+btuC4mZzHRbvK48/VqPQjGjaDoCubV32PP9ffbq+xAGMK9X3+OhdMtemUyEil5bjyYJgKOh8Gsu42f1S22Uroa4RQTbiiGulZlzMkganpfPlQ+LeUWQ/p38xvFL39PTl6HwRXxVwpc7v9YHErtuMx87/tfH017/7GFO9umz714mS9X4zeuQFn/GQRSO94NPkKqw53SjAFJ7rahF70l1uOJvUKTGV01Ef5Mm6bD+/9JjP75Jvqxbb9BFNfYY4bPN1rusl16bTh3Oy+GcAA3RraUY+1w1fmjMgm3z9DqDkoxbyGgiEmhVt5gde+WnsYXqO1XUdL3SRRc6jRZwdSVJLG2io7mos3IIlXS6LDXVBmxfACV4U6rKzGmj8A0nenPXXHvSnEvNIEOIoTy5UOXTihJVjzfUs0JXItxNbVo3brIcWDlLJlRYCkldYLxCBxPCQU89CaeY2/4i1G22aeTZUU9z6Qp00ie6slabvSErNEtsYZjd5RFT3A4oOmqngqQnP88uT08rzW6ccxN6hkkPdaIZlsGi0SsOOngT0DH71XVvh65aFVsUsMBd4D+QyxIiInaMx2pmttrVNlfSmcb+OJdC4WIHFYd4UVqFaS12PqgVpbsAqweqZNPVMrLSMbsCxnyTyEmjvSKQttKVRqEuTENN2VLjytsYdMt3Indc+tp0uSVAvRJS1wmrKKgXauatkT+Iy64Z3OyQjjXYBCYZDjQXws+w9eNN2mJKZ6N6uzFeqeB1G+Guq1jXs1bHtxVHvb/9jOdHPczWjeHv3RoCLofrulBdmBAJGoiS02PCNQh7EJwnUDreDg8clDlxK03Oql4l16jbUdD2kDWz5aHaL042NFt+4Sp65bipkgBF55o45sN6hLXrSwsViwLRy81tmjYjLV9lhgVu7cTMOsUE8exs0+6t4TlonoqxFeapOVult2lljuCRyqsAfIQGT8zdxAot1t1hFPSI/4Z0WZXAkyg0JIegVh2zKzRruW3izug3z6MNFatqpzrVOliP0CldqzVqE9GAHhUd63qkx+dG6tPc1iiwwm1Qc8jSCp3ZEcNmbWWmif9EzqjgPV5p5sq5UW8a2QNcsML2k3hgHfNBHWoOV6jRH5NtyIV8PHs6Hbbobq71BPkQ4azQYfkecL1sWOT3SZRXy3U4IxJrq66A1Ay4M8daN7x98pnfFfmSy6ibxN3A5k2ypX9x2raHN7pqCCXOwF3r2p4LB+ipvF6m9qy+PkvBxFncvW72LDC/KoP6i9eJyzw0cO0GPN08FU64ubPK/2LYWlmYBCnWGJhP7yOs64O7/l4RQ2ovyh9iUQVJr4yimheUQo1VFWCtZ1I+xysMymN5VXLwXpBbxdKwuFyqhn/19TBlenSVORWpa8li1y2JbavfvWVHk5PmrQA9V5kxYMFeMhsI9tUMR0cH456a5vRexKA3yPRFNg5YGgAA/QYeKdL5ZCL1O+iBy+xh0VX8q3FsKYyBTs/D9Ds21FPMlqNMAEfw+/vh8CMggF+y8HX5Wn2Ygkt5qqh9z2QDZ/JG22pdyTRjpDv6sL/+KvgSe7PPXm7QnvEG/v0ezSLJQCU3ggapr0W6oltjXwAIeHbIqzew+npHDgg/3OOzEl7V5HMvkGoWyjwc0vtZhVeK8TJKeR1eKNl3v4ynVf6IwipeK31ND0OmX4tWsIt86zdQXPPW3YmVgzNB3GefCvZSGVxl+wfFBlcnuF6/UnBQ7jgUd7T0cHvLfgM7ikQ4wP6rCgfV824nsC3wvsZBfb4vAPlsf/PmRwpuWDrd4M0/tcPLo1U0SmW5/Vw3mOvdSfoHCfwJTKz5R+JmzOUZVX9ExZw9FaJaBKrEbUZRNw7oX7O68noNjvwi4aAayFYM1nloK6l3DeSFxr7uuaxHhR3D9SgIXRM0iNuF0fWw2mlnH20xcJWwmSiHsFZdj3qRTedbbcbrRqvi8kBsqo7/lEOUviUuB6n6AWD0b3NcKU0Qdxq24/wsfV3djsO3TVsPexfHl4NT2loeuKoLI6hw9CZyq0p7vaJ19ajkZcNfP/pKL/fjG0zMvH9yRH+kwng2zZQGV7RaIapaxdWFEbjCk0ZjVMAK5ujmOrfLgGoqaFVGur9CQ5RDboRjV30BZy7S1Mq3DRutdV+UcnWwiHvrk9tWKML3DL6s9zVBrysSwuVGPiAhWnXFI8mztqVrb4++7rDWb+ZPR/2m/8DD6De7Cgu5/wL9fMYY + + + + ArangoDB PHP client: exception base class + + + + + + + \Exception + Exception + \ArangoDBClient\Exception + + Exception base class used to throw Arango specific exceptions + <br> + + + + + $enableLogging + \ArangoDBClient\Exception::enableLogging + false + + + + + + + __construct + \ArangoDBClient\Exception::__construct() + + Exception constructor. + + + string + + + integer + + + \Exception + + + + $message + '' + string + + + $code + 0 + integer + + + $previous + null + \Exception + + + + enableLogging + \ArangoDBClient\Exception::enableLogging() + + Turn on exception logging + + + + + disableLogging + \ArangoDBClient\Exception::disableLogging() + + Turn off exception logging + + + + + + No summary for property $enableLogging + + eJydVF1vmzAUfedX3AckoGJJlkfaZu26qtVUaZXSx0jIOBewRmxkmy7VtP++i8NHgtJpql9sfM+599wPfPWlLmvPm19ceHABt5rJQn37Cs+Pz8ArgdImgHuOtRVKQsYM0jUzhsAt/qZm/CcrEGCg3jmWM7LGlkqTDb4zCWuLuGNSOhNX9ZsWRWnhbjgtF5+XMVgtyKE08LDLHmMyV6qQGMMDamK/EXvueZLt0FBsnIS9HDK5PyMaGoNbsApsqdWvjgqmRi5ywcc8++yuMr36r0SNkLw1ASxmS6fwEG8UgXuLcmtgM1x5v72W4OS261gyJw1WN9wqPeusPYiEaLYDMgtZuDufSmFI2gQhpIVu+Vxtp+ZRCPi1xlehGtNB5m6vm6yiouSN5A6VpoOqsA8J1xAE8cE/nRfxWbdkkU1VRc7tIet2iRxCg1WeJD5KllX4pIqCkoqOMO26Qa2VTmkMwgJt6iob+rYUJoIZBAkEtPWKosv3uMHaUgtpvGhqkmCCy5VGxksIcV9XlExI85/e/3ii3NpAn1YU+aVl3pq1q3wYRcAM+AKuV+BXQuJU9jQ8fTqhDnsa/Y83noYjtan9+5Jzde9KHo817jx2/KOhemm0BDeAfV+qQ5nPNdtYZo97ftKXcNrAc82jXpNU/LeaPP+YnK0wH9CTs8qcCqq1eGUWe//vMQjthi1llWAmHCY7Sdx1DMGmf6w23aOQjfPfjthfI0+USQ== + + + + ArangoDB PHP client: base handler + + + + + + + + Handler + \ArangoDBClient\Handler + + A base class for REST-based handlers + + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string + + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string + + + + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection + + + + $connection + + \ArangoDBClient\Connection + + + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + + + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + + mixed + + + \ArangoDBClient\ClientException + + + + $optionName + + + + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + + string + + + \ArangoDBClient\ClientException + + + + $body + + array + + + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + Helper function that runs through the options given and includes them into the parameters array given. Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - + array - + array - + array - + array @@ -19822,21 +20699,20 @@ This is only for options that are to be sent to the ArangoDB server in a json bo array() array - \ArangoDBClient\Handler - + makeCollection \ArangoDBClient\Handler::makeCollection() - + Turn a value into a collection name - + \ArangoDBClient\ClientException - + mixed - + string @@ -19845,7 +20721,30 @@ This is only for options that are to be sent to the ArangoDB server in a json bo mixed - \ArangoDBClient\Handler + + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + setDocumentClass @@ -19888,840 +20787,1046 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\DocumentClassable - eJyNU8tu2zAQvOsr9mAgqaHYjY9OH0mdJk6BAgYatBcDAU2tLSISyZKr1kKQf++SethWLtWFwu7OcGZW+vDZ5jZJpuNxAmO4cULvzO0XWC1XIAuFmubwBx3hHjIjq5ILkAudFeh4PkCurZDPYocAPXoRgbEpKsqN4x58Exp+EGIptB607hj3DN9FHUnhWhpbO7XLCRb92+z95SwFcoqv0h7uy80y5XZhdhpTuEfHvHVEe6VlUANwOZlxZZokWpToWScOJF4djHeugHJBwGR8j4/WlUQ/aWaaJC6GSTSYLZLMjzCwdabkFoJHx0Xg4UBj0XnlyYdWCUYfjUzggThnxnoDmxqU95XSuzARkMJaZyxHQAjLx8cVOPxdYaQyxyz/tZm3MclCeA8/o8dl6wz3hDrzcNtabuvJSxKQMbzwjOFBE+8AsyhuW2lJKlgzIEVRRHHSIffuOJQb50R9GOpzajYtDVPtqSXu+NmMEyWMMkFiWDM28PghwiFVTvfS+zrlzvz1sD4NZd0cX/cSI107Po2nrTaFkgfJAy+/FOWLRvZ5VJj2ot5FfBNXeEZP3deziHF/hBHlyl98Oq3zl9khWhsD4Hw+0PDm4qvI8Jq8Js1mn0ShhD8/2S+zhFYKZ+vu1+pi2axPJs+Y7x/mhFdE + eJztWG1v2zYQ/p5fcQWMxglsp+tHZ+maul2TYWiMxv0wNIVBS4zFmhIFkoptDP3vO75IpmTZTouuKLAJRSOTvLvn7jnekfr1tzzJj47OTk+P4BQuJcnm4vUrGF+NIeKMZnoIM6IoJCSLOZW4yKx7mZNoQeYUoBIZ2dV2khQ6ERLn4A+Swa2mNCVZZqcika8lmycaRtXb82e/PO+BlgwVZgreprOrHk5zMc9oD95SidJrlD47OspIShXapg2z5xsPHNyIE6XgHlG8f3M76ZuxuPRBNZ1ocUGxLDLePRs8t5bJTGlJIu0VX/lo/H1kvLSmzXMK12kupIbONBZRkaK2kQNSZJFmIiOc6bVfe2b/Fgj2dbiWzDhFdxp6RyLLqFUBYvYZ3/xEOY++SJIGy2pGcskeiKYIK6oWoI0WI+hlgV4SyOhyw/l+U9DZaIU+BD+0gBk1LsZ1HR5VMeMsqmIDU4POAei2az+xci7o5unohKn+i8AruAjXn9uVX7YcfU91IRFeQkO07YGVbu0odHGfYBlxoXEMk65yb071Rkm36Yo3s+1R5cMOJ0gNSR5wDxPUBfjPLnmgGWY3JnUFSCcE85lwruCzEtkUZ0VMp0tJ8pxKEM0AtedBx9l8hzsTIzNBCTdgyJclxAfCC2q2447opmyFoXKBdeLHyglVK3UixVLBXX2z3rk/b1YRzVvSfj8JN1akG3iwn5UGg3agRcdhxky4wYU7Bsx4ls1trTLuEynJGnKsBDQe/FAmneXOTMRrz6R9RR6dPmAZvhsDO1j0nvSdf/6XuLfGnSqDc0mUd+87c9vietd685Ws7tbTYPZMi1gMofvyHnEvUrKm8gSihEYLYPdo5R4bhrBBIDBjGlIhKaRkQRUo7HR0MBg0U+SKcsNYnVlZYFs0MSrmSbBFFMwZ5gJglUZqIl7E1CyjqSPKLLTEUo09z7NrJaq0usn4ulJmTRFEqKhGDdDxOi+t4JJxboq5H9xOTWF0mSTe0ue6AHqswcOqjhmKygd0F62hZGpypZA8RN3lbEHheEmY/l3I23UWHffgeEFp/q7gHN+pjjCMJzDYm9MlJvuEVaqMiwWbCB6rWoARr3fYYKxHtN1SLWjOUmAhpvcsQ5aWCYuSAAIu4lwsMZtdsMoo9yy5SyOKxpk0CkjBtS+oTA1syOmKpDmnw3qgLl5gL6U79qqHa7ErBOp+IwFB8I1qcz5hpmYhMd+2X+ElpiOVePaBWqQq05N6otrkdQEKqdiVgDvLgV/oCrS6zsbWXlmpVa+VsQv4+GnrlOGRmrnzahSDQwlirBQC1rXOgqKOF9Cx/JwESsyDRaFrjU5x2ZSumNKIB997dRQnTcFS2Km/uIBmD1PD4c14cn3zbvph/Ppy8mY6vvnzevRXmx7zfMhjPA6OBR6/1sMhYmXmd9ejPt+S+bI14mPy0SD6ZA5dVnRb0qJ2yWpwZ7hpd4HaUhmGxI0eQrb55c985tkQVWP6UWw92UWX5/wnZGofBU++loIdrD4i6mWPdRr/b5z/WuP0p0lzPvHNkrOUadMm1YLlP2GLtEfB8glb5FdW/v9e5310r3tlsmHT6WzIH9/wfnRrs/C+pZXA06dtbeJwnasb/E6Npix5RvmuLw+T8D5s891c6Tj393fzfauZNv6w1X64amwFd4/2UepD+RGqF9rA1HJXs0O3uHZcO3PQ1OdRJVK2qEZqBSSyTGmC11jM/I1Yk7EyplbE3tXMFbsbdL4vB3SXH9cOa96guI7rFrYoDlK05Z5/GcdIq8ZarYiLTUJJjOXaV/Fqx7thc+TF2ztud11d8wNhPDcLbG3EKtpbwkt1WFM47mCssnYjGjb9VHu6BESjaIYVc51Tgy+Y6EYkM/XxVqPmFFVONghHteQS6KI8OZQtJI4DDVcWnqsg8LR0pBdCa82kAGBA+X6MzUQorX08XvWJ7a99LVd9Fh9/cl8TS0GbJBO5amaH+x/zwH4bnuIZjaiu/0I8HNpBbMZ35Qfu8tY0u/NrjlHbP3VFJs0= - + - ArangoDB PHP client: statement + ArangoDB PHP client: mixin for $_documentClass functionality - + - - - Statement - \ArangoDBClient\Statement - - Container for an AQL query - Optional bind parameters can be used when issuing the AQL query to separate -the query from the values. -Executing a query will result in a cursor being created. - -There is an important distinction between two different types of statements: -<ul> -<li> statements that produce an array of documents as their result AND<br /> -<li> statements that do not produce documents -</ul> - -For example, a statement such as "FOR e IN example RETURN e" will produce -an array of documents as its result. The result can be treated as an array of -documents, and each document can be updated and sent back to the server by -the client.<br /> -<br /> -However, the query "RETURN 1 + 1" will not produce an array of documents as -its result, but an array with a single scalar value (the number 2). -"2" is not a valid document so creating a document from it will fail.<br /> -<br /> -To turn the results of this query into a document, the following needs to -be done: -<ul> -<li> modify the query to "RETURN { value: 1 + 1 }". The result will then be a - an array of documents with a "value" attribute<br /> -<li> use the "_flat" option for the statement to indicate that you don't want - to treat the statement result as an array of documents, but as a flat array -</ul> - - + + DocumentClassable + \ArangoDBClient\DocumentClassable + + Add functionality for $_documentClass + + + - - ENTRY_QUERY - \ArangoDBClient\Statement::ENTRY_QUERY - 'query' - - Query string index + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + string + - - - ENTRY_COUNT - \ArangoDBClient\Statement::ENTRY_COUNT - 'count' - - Count option index + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + string + - - - ENTRY_BATCHSIZE - \ArangoDBClient\Statement::ENTRY_BATCHSIZE - 'batchSize' - - Batch size index + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + string + + + \ArangoDBClient\DocumentClassable + - - - ENTRY_RETRIES - \ArangoDBClient\Statement::ENTRY_RETRIES - 'retries' - - Retries index + + $class + + string + + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + string + + + \ArangoDBClient\DocumentClassable + - - - ENTRY_BINDVARS - \ArangoDBClient\Statement::ENTRY_BINDVARS - 'bindVars' - - Bind variables index + + $class + + string + + + + eJydUU1PwkAQve+vmAMJSlD8OhjxAwWC8UTClcQs26Hd2O42u1MjMfx3t1uoFAoS59Jm5817897cP6VRylin1WLQgmfDVagHLzB+HYOIJSq6g0R+SQVzbaDxHmiRJe61H3NrYZ4pQVIrHktauPmcopdy8cFDBCjZ+p7IN3lGkSNy9cYVTAgx4Ur5ltDpwsgwIuiXf1cXl7dtICMdobIwSmavbdeOdaiwDSM0bjoX7jCmeILWaeOWbPfXXBBUN67ztO2ixoOVSuT2rs9vvDQZLgkGmyx8FiP7ZrlPL56Xm/zkBqxzo8IS7lLOkyQNmcUVsOO/qdGEgjDYif0BmtPqXtM1XbPrZw8pDwNn6yhVdMi9ijmNU9tWmiA53gghOGCwXCvlhifrxRoF8lAy0DNImVE1aVdMZLNYivLYYJEqAyeF1KkHF2fKq0GRtGePO2kX6G6JW+3g4cXrsjb1MgvcE/nBHPbd6f8ZDNf3/MP/5t2P8c6W7AdpWkd8 + + + + ArangoDB PHP client: vertex document handler + + + + + + + + + \ArangoDBClient\DocumentHandler + VertexHandler + \ArangoDBClient\VertexHandler + + A handler that manages vertices. + A vertex-document handler that fetches vertices from the server and +persists them on the server. It does so by issuing the +appropriate HTTP requests to the server. + + + + + + ENTRY_DOCUMENTS + \ArangoDBClient\DocumentHandler::ENTRY_DOCUMENTS + 'documents' + + documents array index - - ENTRY_FAIL_ON_WARNING - \ArangoDBClient\Statement::ENTRY_FAIL_ON_WARNING - 'failOnWarning' - - Fail on warning flag + + OPTION_COLLECTION + \ArangoDBClient\DocumentHandler::OPTION_COLLECTION + 'collection' + + collection parameter - - ENTRY_MEMORY_LIMIT - \ArangoDBClient\Statement::ENTRY_MEMORY_LIMIT - 'memoryLimit' - - Memory limit threshold for query + + OPTION_EXAMPLE + \ArangoDBClient\DocumentHandler::OPTION_EXAMPLE + 'example' + + example parameter - - FULL_COUNT - \ArangoDBClient\Statement::FULL_COUNT - 'fullCount' - - Full count option index + + OPTION_OVERWRITE + \ArangoDBClient\DocumentHandler::OPTION_OVERWRITE + 'overwrite' + + overwrite option - - ENTRY_STREAM - \ArangoDBClient\Statement::ENTRY_STREAM - 'stream' - - Stream attribute + + OPTION_RETURN_OLD + \ArangoDBClient\DocumentHandler::OPTION_RETURN_OLD + 'returnOld' + + option for returning the old document - - ENTRY_TTL - \ArangoDBClient\Statement::ENTRY_TTL - 'ttl' - - TTL attribute + + OPTION_RETURN_NEW + \ArangoDBClient\DocumentHandler::OPTION_RETURN_NEW + 'returnNew' + + option for returning the new document - + $_connection - \ArangoDBClient\Statement::_connection + \ArangoDBClient\Handler::_connection - - The connection object + + Connection object - + \ArangoDBClient\Connection - - $_bindVars - \ArangoDBClient\Statement::_bindVars - - - The bind variables and values used for the statement + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + - - \ArangoDBClient\BindVars + + string - - $_batchSize - \ArangoDBClient\Statement::_batchSize - - - The current batch size (number of result documents retrieved per round-trip) + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - - mixed + + string - - $_doCount - \ArangoDBClient\Statement::_doCount - false - - The count flag (should server return total number of results) - - - boolean - - - - - $_fullCount - \ArangoDBClient\Statement::_fullCount - false - - The count flag (should server return total number of results ignoring the limit) -Be careful! This option also prevents ArangoDB from using some server side optimizations! + + createFromArrayWithContext + \ArangoDBClient\VertexHandler::createFromArrayWithContext() + + Intermediate function to call the createFromArray function from the right context - - boolean + + + + \ArangoDBClient\Document + + + \ArangoDBClient\ClientException + - - - $_query - \ArangoDBClient\Statement::_query - - - The query string - - + + $data + + + + + $options + + + + + + get + \ArangoDBClient\DocumentHandler::get() + + Get a single document from a collection + Alias method for getById() + + \ArangoDBClient\Exception + + string - - - - $_flat - \ArangoDBClient\Statement::_flat - false - - "flat" flag (if set, the query results will be treated as a simple array, not documents) - - - boolean + + mixed - - - - $_sanitize - \ArangoDBClient\Statement::_sanitize - false - - Sanitation flag (if set, the _id and _rev attributes will be removed from the results) - - - boolean + + array - - - - $_retries - \ArangoDBClient\Statement::_retries - 0 - - Number of retries in case a deadlock occurs - - - boolean + + \ArangoDBClient\Document - - - $_cache - \ArangoDBClient\Statement::_cache - - - Whether or not the query cache should be consulted - - - boolean + + $collection + + string + + + $documentId + + mixed + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + has + \ArangoDBClient\DocumentHandler::has() + + Check if a document exists + This will call self::get() internally and checks if there +was an exception thrown which represents an 404 request. + + \ArangoDBClient\Exception - - - - $_stream - \ArangoDBClient\Statement::_stream - - - Whether or not the query results should be build up dynamically and streamed to the -client application whenever available, or build up entirely on the server first and -then streamed incrementally (false) - - - boolean + + string - - - - $_ttl - \ArangoDBClient\Statement::_ttl - - - Number of seconds the cursor will be kept on the server if the statement result -is bigger than the initial batch size. The default value is a server-defined -value - - - double + + mixed - - - - $_failOnWarning - \ArangoDBClient\Statement::_failOnWarning - false - - Whether or not the cache should abort when it encounters a warning - - + boolean - - - $_memoryLimit - \ArangoDBClient\Statement::_memoryLimit - 0 - - Approximate memory limit value (in bytes) that a query can use on the server-side -(a value of 0 or less will mean the memory is not limited) - - - integer + + $collection + + string + + + $documentId + + mixed + + \ArangoDBClient\DocumentHandler + + + getById + \ArangoDBClient\DocumentHandler::getById() + + Get a single document from a collection + This will throw if the document cannot be fetched from the server. + + \ArangoDBClient\Exception - - - - $resultType - \ArangoDBClient\Statement::resultType - - - resultType - - + string - - - - $_documentClass - \ArangoDBClient\Statement::_documentClass - - - - - - - - __construct - \ArangoDBClient\Statement::__construct() - - Initialise the statement - The $data property can be used to specify the query text and further -options for the query. - -An important consideration when creating a statement is whether the -statement will produce a list of documents as its result or any other -non-document value. When a statement is created, by default it is -assumed that the statement will produce documents. If this is not the -case, executing a statement that returns non-documents will fail. - -To explicitly mark the statement as returning non-documents, the '_flat' -option should be specified in $data. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Connection + + mixed - + array + + \ArangoDBClient\Document + - $connection + $collection - \ArangoDBClient\Connection + string - $data + $documentId - array + mixed + + $options + array() + array + + \ArangoDBClient\DocumentHandler - - getConnection - \ArangoDBClient\Statement::getConnection() - - Return the connection object - - - \ArangoDBClient\Connection - - - - - execute - \ArangoDBClient\Statement::execute() - - Execute the statement - This will post the query to the server and return the results as -a Cursor. The cursor can then be used to iterate the results. - + + getHead + \ArangoDBClient\DocumentHandler::getHead() + + Gets information about a single documents from a collection + This will throw if the document cannot be fetched from the server + \ArangoDBClient\Exception - - \ArangoDBClient\Cursor + + string - - - - explain - \ArangoDBClient\Statement::explain() - - Explain the statement's execution plan - This will post the query to the server and return the execution plan as an array. - - \ArangoDBClient\Exception + + mixed - - array + + boolean - - - - validate - \ArangoDBClient\Statement::validate() - - Validates the statement - This will post the query to the server for validation and return the validation result as an array. - - \ArangoDBClient\Exception + + string - + array - - - __invoke - \ArangoDBClient\Statement::__invoke() - - Invoke the statement - This will simply call execute(). Arguments are ignored. - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\Cursor - - - $args + $collection + + string + + + $documentId mixed + + $revision + null + string + + + $ifMatch + null + boolean + + \ArangoDBClient\DocumentHandler - - __toString - \ArangoDBClient\Statement::__toString() - - Return a string representation of the statement + + createFromArrayWithContext + \ArangoDBClient\DocumentHandler::createFromArrayWithContext() + + Intermediate function to call the createFromArray function from the right context - - string + + + + \ArangoDBClient\Document + + + \ArangoDBClient\ClientException + + $data + + + + + $options + + + + \ArangoDBClient\DocumentHandler - - bind - \ArangoDBClient\Statement::bind() - - Bind a parameter to the statement - This method can either be called with a string $key and a -separate value in $value, or with an array of all bind -bind parameters in $key, with $value being NULL. + + store + \ArangoDBClient\DocumentHandler::store() + + Store a document to a collection + This is an alias/shortcut to save() and replace(). Instead of having to determine which of the 3 functions to use, +simply pass the document to store() and it will figure out which one to call. -Allowed value types for bind parameters are string, int, -double, bool and array. Arrays must not contain any other -than these types. - +This will throw if the document cannot be saved or replaced. + \ArangoDBClient\Exception - - mixed + + \ArangoDBClient\Document - + mixed - - void + + array + + mixed + + - $key + $document - mixed + \ArangoDBClient\Document - $value + $collection null mixed + + $options + array() + array + + \ArangoDBClient\DocumentHandler - - getBindVars - \ArangoDBClient\Statement::getBindVars() - - Get all bind parameters as an array - - - array + + insert + \ArangoDBClient\DocumentHandler::insert() + + insert a document into a collection + This will add the document to the collection and return the document's id + +This will throw if the document cannot be saved + + \ArangoDBClient\Exception - - - - setQuery - \ArangoDBClient\Statement::setQuery() - - Set the query string - - - \ArangoDBClient\ClientException + + mixed - - string + + \ArangoDBClient\Document + array - - void + + array + + mixed + + - $query + $collection - string + mixed + + $document + + \ArangoDBClient\Document|array + + + $options + array() + array + + \ArangoDBClient\DocumentHandler - - getQuery - \ArangoDBClient\Statement::getQuery() - - Get the query string - - - string - - - - - setResultType - \ArangoDBClient\Statement::setResultType() - - setResultType - - - - string - + + save + \ArangoDBClient\DocumentHandler::save() + + Insert a document into a collection + This is an alias for insert(). - $resultType + $collection - - - setCount - \ArangoDBClient\Statement::setCount() - - Set the count option for the statement - - - boolean - - - void - - - $value + $document - boolean + + + + $options + array() + array + \ArangoDBClient\DocumentHandler - - getCount - \ArangoDBClient\Statement::getCount() - - Get the count option value of the statement - - - boolean + + update + \ArangoDBClient\DocumentHandler::update() + + Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document. + Attention - The behavior of this method has changed since version 1.1 + +This will update the document on the server + +This will throw if the document cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the document to-be-replaced is the same as the one given. + + \ArangoDBClient\Exception - - - - setFullCount - \ArangoDBClient\Statement::setFullCount() - - Set the full count option for the statement - - - boolean + + \ArangoDBClient\Document - - void + + array + + + boolean - $value + $document - boolean + \ArangoDBClient\Document + + + $options + array() + array + \ArangoDBClient\DocumentHandler - - getFullCount - \ArangoDBClient\Statement::getFullCount() - - Get the full count option value of the statement - - - boolean + + updateById + \ArangoDBClient\DocumentHandler::updateById() + + Update an existing document in a collection, identified by collection id and document id +Attention - The behavior of this method has changed since version 1.1 + This will update the document on the server + +This will throw if the document cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the document to-be-updated is the same as the one given. + + \ArangoDBClient\Exception - - - - setTtl - \ArangoDBClient\Statement::setTtl() - - Set the ttl option for the statement - - - double + + string - - void + + mixed + + + \ArangoDBClient\Document + + + array + + + boolean - $value + $collection - double + string + + + $documentId + + mixed + + + $document + + \ArangoDBClient\Document + + + $options + array() + array + \ArangoDBClient\DocumentHandler - - getTtl - \ArangoDBClient\Statement::getTtl() - - Get the ttl option value of the statement - - - double + + replace + \ArangoDBClient\DocumentHandler::replace() + + Replace an existing document in a collection, identified by the document itself + This will replace the document on the server + +This will throw if the document cannot be replaced + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given. + + \ArangoDBClient\Exception - - - - setStream - \ArangoDBClient\Statement::setStream() - - Set the streaming option for the statement - - - boolean + + \ArangoDBClient\Document - - void + + array + + + boolean - $value + $document - boolean + \ArangoDBClient\Document + + + $options + array() + array + \ArangoDBClient\DocumentHandler - - getStream - \ArangoDBClient\Statement::getStream() - - Get the streaming option value of the statement - - + + replaceById + \ArangoDBClient\DocumentHandler::replaceById() + + Replace an existing document in a collection, identified by collection id and document id + This will update the document on the server + +This will throw if the document cannot be Replaced + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given. + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + \ArangoDBClient\Document + + + array + + boolean + + $collection + + mixed + + + $documentId + + mixed + + + $document + + \ArangoDBClient\Document + + + $options + array() + array + + \ArangoDBClient\DocumentHandler - - setCache - \ArangoDBClient\Statement::setCache() - - Set the caching option for the statement + + remove + \ArangoDBClient\DocumentHandler::remove() + + Remove a document from a collection, identified by the document itself - - boolean + + \ArangoDBClient\Exception - - void + + \ArangoDBClient\Document + + + array + + + boolean - $value + $document - boolean + \ArangoDBClient\Document + + + $options + array() + array + \ArangoDBClient\DocumentHandler - - getCache - \ArangoDBClient\Statement::getCache() - - Get the caching option value of the statement + + removeById + \ArangoDBClient\DocumentHandler::removeById() + + Remove a document from a collection, identified by the collection id and document id - + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + array + + boolean + + $collection + + mixed + + + $documentId + + mixed + + + $revision + null + mixed + + + $options + array() + array + + \ArangoDBClient\DocumentHandler - - setFailOnWarning - \ArangoDBClient\Statement::setFailOnWarning() - - Set whether or not the cache should abort when it encounters a warning + + getDocumentId + \ArangoDBClient\DocumentHandler::getDocumentId() + + Helper function to get a document id from a document or a document id value - - boolean + + \ArangoDBClient\ClientException - - void + + mixed + + + mixed - $value - true - boolean + $document + + mixed + \ArangoDBClient\DocumentHandler - - getFailOnWarning - \ArangoDBClient\Statement::getFailOnWarning() - - Get the configured value for fail-on-warning + + getRevision + \ArangoDBClient\DocumentHandler::getRevision() + + Helper function to get a document id from a document or a document id value - - boolean + + \ArangoDBClient\ClientException - - - - setMemoryLimit - \ArangoDBClient\Statement::setMemoryLimit() - - Set the approximate memory limit threshold to be used by the query on the server-side -(a value of 0 or less will mean the memory is not limited) - - - integer + + mixed - - void + + mixed - $value + $document - integer + mixed + \ArangoDBClient\DocumentHandler - - getMemoryLimit - \ArangoDBClient\Statement::getMemoryLimit() - - Get the configured memory limit for the statement + + lazyCreateCollection + \ArangoDBClient\DocumentHandler::lazyCreateCollection() + + - - integer + + mixed + + + array + + $collection + + mixed + + + $options + + array + + \ArangoDBClient\DocumentHandler - - setBatchSize - \ArangoDBClient\Statement::setBatchSize() - - Set the batch size for the statement - The batch size is the number of results to be transferred -in one server round-trip. If a query produces more results -than the batch size, it creates a server-side cursor that -provides the additional results. - -The server-side cursor can be accessed by the client with subsequent HTTP requests. - + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection + + + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\Handler + + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + + + \ArangoDBClient\Handler + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + + mixed + + \ArangoDBClient\ClientException - - integer + + + $optionName + + + + \ArangoDBClient\Handler + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array - - void + + string + + + \ArangoDBClient\ClientException - $value + $body - integer + array + \ArangoDBClient\Handler - - getBatchSize - \ArangoDBClient\Statement::getBatchSize() - - Get the batch size for the statement - - - integer + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array + + + array + + + array + + + array + + $options + + array + + + $body + + array + + + $includeArray + array() + array + + \ArangoDBClient\Handler - - buildData - \ArangoDBClient\Statement::buildData() - - Build an array of data to be posted to the server when issuing the statement + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name - - array + + \ArangoDBClient\ClientException + + + mixed + + + string + + $value + + mixed + + \ArangoDBClient\Handler - - getCursorOptions - \ArangoDBClient\Statement::getCursorOptions() - - Return an array of cursor options + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation - + array + + mixed + + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler - + setDocumentClass - \ArangoDBClient\Statement::setDocumentClass() - + \ArangoDBClient\DocumentClassable::setDocumentClass() + Sets the document class to use - + string - - \ArangoDBClient\Statement + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable @@ -20729,1216 +21834,1461 @@ The server-side cursor can be accessed by the client with subsequent HTTP reques string + \ArangoDBClient\DocumentClassable - - No summary for property $_documentClass - - eJzFHNtWG0fy3V/R5nAikUjg+G2xYSMw2ORgcIRINuv46LSkFup4NKOdGYFJ4n/fqurrXHokAdnlwYiZ7rrfurrk1/9czBbPnu19++0z9i3rpTy+Sd4csQ/vPrBxJEWc77Ms57mYw0dYgYt+WPDxZ34jGLPrj2kpveTLfJak8I79yGN2lQsx53FMr8bJ4j6VN7OcHdtPL198/7LD8lQCwDhjb+ejdx14HSU3seiwtyKF3fewe+/Zs5jPRQa4RQntK0v+cRLnXMYiZVMgAdD3fjpn/1mK9F6TfrnIZRLziI1kPGELngLIXKQZG8PikWDLTEzY3UzETGbZUsY3LJ8JB4XlCcsEbssFgsOX6sU0Teb05y2PliLbxbcnX8R4mSMQrlfdyShiqciWUc5kDI/HyzQDSkcCV41TAXAnu5rWwUykAuhAPuR8kaQ5j3M2kRmAHCMbsC2/E0BrfpfA8+kU1sOK/H4hMpZMnd6yfYT3ehkd0u9IHnrvgGqes0WaTJYgWcDF05Tf4/5JMl6qJRxXCZka2nsXb16PUrYXhjdJWJw4sBYUbdhTlODnU+BefOHzRQTa5g4My5bjGeLdOr3sM8HOLswy1j8ZXPfhzy0lTo0CgQWJl/BLkb6LYjVsaKXnSu640IOAAC0QoA3sRXCgyTyzJrOYqN2wIMPnI/AONBS0hkykt2CNo3tjLcqndj3p2U/vkjsBizueVW1pXr9n37HvNb++WEMMIzjHc4eNlrlbeyfzGYoaTA6kmY15xFNltqyNqOPlfAQ0v9whI956uYU2iFg5rpITJ4EsUTarTNw+Jl+QuSJ3ymVUy+4AJLRMY+JW0UlGm88Am+JexiBFB1cJZppEUXKHGGMhJmBtCQIboYnFomrn8wQc494TKYA0Uv1Tcb2vxMu+bhWMg6jPMRQAcI4AWUDeWqBbBG2L8RyiGUhclFwEYgvRsTWcRjzfYgnFIopUZCrW9IFEiE5yDH8rZ7pPlsheC4jiKsoyMjCUfWmvJr5oyr4dkynAW4ZEqBVln7TxvSa6g9WMMfC/2H1JQXkc8SyDKG8yxJ/PMPJTOMYfimJsnMSxUCErGf0On/RLs+aHW7DAY7tIP96j34tU3qIgtocOCgT8GiwU0gGS5KNIZOSPKhirqF6Rcx0RRwDjZ55mARJG+nU9ARDMUxUAcogTmfwDHEo7E+hAa8aZTSrATsDjIQ/BijRZxpMuPFns1BE2l1/EJEQV4rsCdAGyAHKO6r5h7WyWLKOJCUtAAXlgkkNGLFOa1dIxSpIoQMYkOSZMB+DzUfbExDB5EyepSciRnMvc0MeOACxPxXQZPQccED60ZwEVCdAHIkZx29KGwtMSwx8EsLmN0ZmcCNo5l39w3J8931AAQEC0hghUHMpy5KYOQ+FNGQdtrsLdUiFFyVVC6he5n0eMECmmlTIeME5plUJBhwK9tdFNTYBiSpD5Kx7LnKugVyF0KFUKHYK+XAh1JKdinqCv2ELrgVaaIRHomkEyLzzbQw/NsFQbc4jekIsEn0QJ5PdkjKXbhrgNvAP2oor2l5kAtgBvSjpwyhtD1QFWqpxlRNEUObfhYF3sBGcDvMZoHObRUsKH5YJN7qEWhwQVRfeq7kGDmoN2VNljQKtih/HFIsJshorH2hqrHMZvoTDASN1BzBYyrJepALBJ7BdQU5lmOaEysCkzW7yQlVIK6kRSmzS7sWUQsFf0NGwTmQD5TzJVzKnq3ZjoZ7HIS3TLaW1+NmAhVo3kzY3AzMTVRonmiQcUm0RUVTIRU475QxVqkhyXcHThDRx5jDWoBXWsT5IliDvAfJ5H9ZzXmEfBIPkIDib6yJSD+ijA44mKQ7GSxoEY1xRDwC4u41/U3rCX9hZQBH+Rc9w0h9gABktZwVSy4LOjewggO6qE4taZYirECmrqYuw3gNtcgwBlv0C2oZjQYWgutJI0Ql0XE14xqbU3aeuMMp8KxjnRXBsQlKkM4DS3aZZwOwFqGexPXvrBOlN8KQDB6JKzk4tB/9fhT9cn/V+BuBbJrlUlUWU7nW6bYR1fXl8MEBYZSA2sI1c1NUM66g2O312d/fsEodnapwZi34bvJnBwGOifnVwhMB2f64gr1pYrCDy7ePNzr08gTcXYqveuUzB2tEXtKpQXg3BPe2fnw8uL4S+9/sXZxVsEX3CWAI73vnfkMzCOWRKpeli3RgL43p+8v4Rf52fvz0hznsXWiOgUqh9d3q0wiNPr83NnD7ZqCpB/RWHZlQRBcq8G/ZPeewSpInkA3mBwvgYwXAWQICzWsHqmYrTUB7rQiQLD9vaE5xzP61Dj5/eFNhP2khZiXDqeii8qz02XKcZdA0uJNLOnGFq9W0LY8xtFyA2EtdTlXf+w7jISBLE7HeO91O3e+00W2Ahc5w39FUZ9N0jfPvFxEndtd4CC6y7mlbhMh26AwSH13uY7iW8MIDhrLqnMmFUOvgUyLXG77Ey3FHSs9qsTKOk6THhNOu8IjgjUiSQrkJ95XY2yuhMAhpWOzKEGmfP0c4lEnmmQ1L3wgaoSuEX1c6uocq/8UtYiqdxRhlUm4Qdw7+QuYydfxmLhHaXte+p4ekdttu2dzbsqu7sHYKHaWEsAVGOBfpSBq5+ur07tI+osxXBVMVlBMSLHYOa6lzkckvuly3Herqevo9ESRpVsVbeByEAldw+9JgG477bfMiivNJEZHh2wWNzZs397R3s8/kAB15YZnFLahPZjJqLp/r6XHj/t7HhkeAhgD6Xa8EZH01f7aS3EKtI1YVZBs2Grj3stnBSvm1BSDA9v3BihTfNNSI9M+m8G8GBJQxpoQj/Io9CmzfnVVUMQn7VYQt0IYQPkLhmHEfuNjTaW7jvKCT8e0wGoAGQjUZv92jZ7F2eDJoX7h/daOkpwHqx2XROGCXEneTho5IaMOhBrqaJI/+l5r0kZqsfSwD/tfwDe497xuwbhq2NfI2YF4cFiLxW4DTIonRELJDVBfDBpfi0cpqt4pguZRgFWmaKvdccYc0+yspGum6jHDUm9sNEcHJMcnmF3zaTjGwzoZk+7nG01mmrSfRXgQV2FriqXpa6uFknmN6KKd2lYHKeicnXEXZHIlFHumqY89mjG6uReqL7h0J5yTZQGs25B5SRN4BsrG1VhiooQ0dyey2yojuJtI0ziuWJhRAeVKeoyxhLUbukDvS0TuT7ct+rTgCrYDozyqPP2Bh4Vyp5tr1Fpnt3NZIRXhOlSVKgDAopPCAgIdQFFnXDYPFPpHqKa29dplO3vX/chf1z3ry77HbO0ZIHdw9+zJB5ig2kihncpX8CJSjnqTod9/ORTXzJTkhrpqV0lo+PIJJw/ZoitQAVtVZMDUBx6UiXJgmlh46J9ReZp9cK2K1IySlfC/e47dnhQTih1W5z6t8Wrytuv9SgUM4qmY5BYe4c9PzhgL/8RwrC3By/xlLRle9wToaLC1qNJAuBoIvyGy/hZ/VIb/aqhYxHBtmLoaGXm4AaShvflg87DYkkRpH+JunFc0Ber9DAUFoivSlhwB6p6H7XrNvOuk399OO+dXTyFe5noX+M3r0Ja/BknBzhe6DxBCsAmyK0CSPd8RS16b6q34X+DIjW+aoD/mzRJp8f/lx7P4tvk87p5nG4WsekFn20W3GW99Ma0jnDACS92aeppLcWUOhF0L862eXqTQanDLWQ0EQm0qmunjr2j0dhCdZMqFrpeSaALiEYLGA4liaVNdDQXS1YOoVJJl3smi8P2BVCCV1uqfJs2Ct9wojd3zT0VDSbU3DyHGMqTK1WWrCj99H10PSvUNeduzM66cZPlwMpZMqGCTUhqS+KdJ5gQTubp0SXF3PZnoa4fTWfJzuaZWzKgkz7RHaPa7E3FoFnimdrsLs8E4nZA0VE7FSQ9qncBB95K9xUHk4QeOtFTeGiGZbBo9IqDDl4Pdcx+dT/XobsxxRYFLHAX+AVyWUJExBbmWA05Vtus5g4x09gf51IoXGzp4dQlSqswXsMu+7WidHck9UCVbLpaRlY6ZlfAmG8TOWm0VwTSVrrSKA5YvIyiUJew1EnxNgbd8q3IHZe+Nl1uCVCvhNR1wioKak8NKTXyB3HZdSebHdKxBpvAJMOB5kr4GbZ+HkVbTOnMUW83xisVvG4j3HUV65qo6li04gj1t5+d/KiH2box/L1dQ8DlcF0XqgtX+kEDUXJ6TLgGYfeDd85Kx9vhS+kyJ26lyVnV28YadTsK2h6yZrY8VAfF2+9myy/cVq6cD1QSoOhcE8d8WI+wdt1FV7EoEL3coJ3pe9HyVWZY4NaOOKxTTBDPzjbt3hqeg+apGFthnpqzVXqbVq6aH6m8CsBHaPDUNMtXaLGuqV7QI/4b0mVVAk+i0JAcglp1zK7QrOW2iTuj3zyPNlSsqp3qVOtgPUKndM/TqE1EA3pUdKzrkR6fG6lPc1ujwAq3Qc0hSyt0ZmfCmrWlpi0w6D+NMyp4j1eauQNt1JtG9gAXrLD9JB5Yx3xQh5rDFWr05xobciEfz55Ohy26LGo9QT5EOCt0WL6YWi8bFvl9EuXVch3OiMTaqqsVNbTrzLHWDe+efEhzRb7kMuomcTeweZNs6d/kte3hjS4ZQokzcPm3tufCAXoqb5apPauvz1IwcRZ3r5s9C8yvyqD+4nXiMg9NyLoZQDfggyNX7qzyv5iOVRYmQYo1BubT+wjreu/uY1fEkNqb24dYVEHSK6Oo5gWlUGNVBVjrmZTP8QqD8lhelRy8bzStYmlQXC5Vw7/6fR5lennK42wqUteSxa5bEttWv/taFI3ymTFuPeiXMWDBXt4aCHaW3tHRwbinxgu9yXn6yo++IMaJPwMAoN/CK0U6n0yk/tJw4JJ4UHQV/8oZWwpjoNPzMP2lCOopZstRJoAj+PvdYPABEMAfWfgaeq0+TMGlPFXUfjFgA2fyZq1qXck0Y6Q7+rC//ir4Ent9wF5s0J7xZsL9Hs0iyUAlt9jgzcWNSFd0a+yMeMCzQ169gdXXO3JA+OEen5Xwqiaf+8afZqHMwxF9oabwHVC8jFJehxdK9ss6xtMq33pfxWulr+lhyPT3WBXsIt/6WwqueevuxMrBWY8qfCzYS2WSkh0cFhtcneB6PXV+WO44FHe09LR1yz6BHUUiHGB/mv2wet7tBLYFRvoP6/N9Acgn+5c3PVRww9LpBm/+qR1eHlui0STL7ae6SVHvTtI/SOBPYITKPxI3Yy4PTXq47NlTIapFoErcZhR182n+Nasrr9fgyC8SDquBbMWkl4e2knrXQF5o7Ouey3pU2LlQj4LQNUGDuF0YXQ+rHb/10RYDVwmbiXIIa9X1qBfZdL7VZrxutCouD8Sm6vhPOUTpW+JykKqfSEX/NseV0khrp2E7DnTS4+p2nAZt2nrUuzq57p/T1vKoVV0YQYWjN5FbVdrrFa2rVyUvG/z6wVd6uR/fYGLmCxHH9L8KGM9m33zDwitarRBVreLqlm+IhTeNxqiAFczRzUtulwHVVNCqjHT/bQhRDrkRjl31BZy5SFMr3zRstNZ9VcrVwSLujU9uW6EI3zP4sj7QBL2qSAiXG/mAhGjVkEeSZ21L1/4+Pe6w1m/m//r5TX8jf/SbXYWF3H8Bkj0gYQ== + eJyNU8tu2zAQvOsr9mAgqaHYjY9OH0mdJk6BAgYatBcDAU2tLSISyZKr1kKQf++SethWLtWFwu7OcGZW+vDZ5jZJpuNxAmO4cULvzO0XWC1XIAuFmubwBx3hHjIjq5ILkAudFeh4PkCurZDPYocAPXoRgbEpKsqN4x58Exp+EGIptB607hj3DN9FHUnhWhpbO7XLCRb92+z95SwFcoqv0h7uy80y5XZhdhpTuEfHvHVEe6VlUANwOZlxZZokWpToWScOJF4djHeugHJBwGR8j4/WlUQ/aWaaJC6GSTSYLZLMjzCwdabkFoJHx0Xg4UBj0XnlyYdWCUYfjUzggThnxnoDmxqU95XSuzARkMJaZyxHQAjLx8cVOPxdYaQyxyz/tZm3MclCeA8/o8dl6wz3hDrzcNtabuvJSxKQMbzwjOFBE+8AsyhuW2lJKlgzIEVRRHHSIffuOJQb50R9GOpzajYtDVPtqSXu+NmMEyWMMkFiWDM28PghwiFVTvfS+zrlzvz1sD4NZd0cX/cSI107Po2nrTaFkgfJAy+/FOWLRvZ5VJj2ot5FfBNXeEZP3deziHF/hBHlyl98Oq3zl9khWhsD4Hw+0PDm4qvI8Jq8Js1mn0ShhD8/2S+zhFYKZ+vu1+pi2axPJs+Y7x/mhFdE - + - ArangoDB PHP client: Base URLs + ArangoDB PHP client: HTTP response - + - Urls - \ArangoDBClient\Urls - - Some basic URLs - - - + HttpResponse + \ArangoDBClient\HttpResponse + + Container class for HTTP responses + <br> + + - - URL_DOCUMENT - \ArangoDBClient\Urls::URL_DOCUMENT - '/_api/document' - - URL base part for document-related CRUD operations REST calls + + HEADER_LOCATION + \ArangoDBClient\HttpResponse::HEADER_LOCATION + 'location' + + HTTP location header - - URL_EDGE - \ArangoDBClient\Urls::URL_EDGE - '/_api/document' - - URL base part for edge-related CRUD operations REST calls + + HEADER_LEADER_ENDPOINT + \ArangoDBClient\HttpResponse::HEADER_LEADER_ENDPOINT + 'x-arango-endpoint' + + HTTP leader endpoint header, used in failover - - URL_EDGES - \ArangoDBClient\Urls::URL_EDGES - '/_api/edges' - - URL base part for all retrieving connected edges + + $_header + \ArangoDBClient\HttpResponse::_header + '' + + The header retrieved - - - - URL_GRAPH - \ArangoDBClient\Urls::URL_GRAPH - '/_api/gharial' - - URL base part for all graph-related REST calls + + string + + + + + $_body + \ArangoDBClient\HttpResponse::_body + '' + + The body retrieved + + string + - - - URL_VIEW - \ArangoDBClient\Urls::URL_VIEW - '/_api/view' - - URL base part for all view-related REST calls + + + $_headers + \ArangoDBClient\HttpResponse::_headers + array() + + All headers retrieved as an assoc array + + array + - - - URLPART_VERTEX - \ArangoDBClient\Urls::URLPART_VERTEX - 'vertex' + + + $_result + \ArangoDBClient\HttpResponse::_result + '' - URL part vertex-related graph REST calls + The result status-line (first line of HTTP response header) + + string + - - - URLPART_EDGE - \ArangoDBClient\Urls::URLPART_EDGE - 'edge' - - URL part for edge-related graph REST calls + + + $_httpCode + \ArangoDBClient\HttpResponse::_httpCode + + + The HTTP status code of the response + + integer + - - - URL_COLLECTION - \ArangoDBClient\Urls::URL_COLLECTION - '/_api/collection' - - URL base part for all collection-related REST calls + + + $_wasAsync + \ArangoDBClient\HttpResponse::_wasAsync + false + + Whether or not the response is for an async request without a response body + + boolean + - - - URL_INDEX - \ArangoDBClient\Urls::URL_INDEX - '/_api/index' - - URL base part for all index-related REST calls + + + $batchPart + \ArangoDBClient\HttpResponse::batchPart + + + Whether or not the response is for an async request without a response body + + \ArangoDBClient\Batchpart + - - - URL_CURSOR - \ArangoDBClient\Urls::URL_CURSOR - '/_api/cursor' - - base URL part for cursor related operations + + + __construct + \ArangoDBClient\HttpResponse::__construct() + + Set up the response + + string + + + string + + + string + + + boolean + + + \ArangoDBClient\ClientException + - - - URL_EXPORT - \ArangoDBClient\Urls::URL_EXPORT - '/_api/export' - - URL for export related operations + + $responseString + + string + + + $originUrl + null + string + + + $originMethod + null + string + + + $wasAsync + false + boolean + + + + getHttpCode + \ArangoDBClient\HttpResponse::getHttpCode() + + Return the HTTP status code of the response + + integer + - - - URL_EXPLAIN - \ArangoDBClient\Urls::URL_EXPLAIN - '/_api/explain' - - URL for AQL explain-related operations + + + getHeader + \ArangoDBClient\HttpResponse::getHeader() + + Return an individual HTTP headers of the response + + string + + + string + - - - URL_QUERY - \ArangoDBClient\Urls::URL_QUERY - '/_api/query' - - URL for AQL query validation-related operations + + $name + + string + + + + getHeaders + \ArangoDBClient\HttpResponse::getHeaders() + + Return the HTTP headers of the response + + array + - - - URL_EXAMPLE - \ArangoDBClient\Urls::URL_EXAMPLE - '/_api/simple/by-example' - - URL for select-by-example + + + getLocationHeader + \ArangoDBClient\HttpResponse::getLocationHeader() + + Return the location HTTP header of the response + + string + - - - URL_FIRST_EXAMPLE - \ArangoDBClient\Urls::URL_FIRST_EXAMPLE - '/_api/simple/first-example' - - URL for first-example + + + getLeaderEndpointHeader + \ArangoDBClient\HttpResponse::getLeaderEndpointHeader() + + Return the leader location HTTP header of the response + + string + - - - URL_ANY - \ArangoDBClient\Urls::URL_ANY - '/_api/simple/any' - - URL for any + + + getBody + \ArangoDBClient\HttpResponse::getBody() + + Return the body of the response + + string + - - - URL_FULLTEXT - \ArangoDBClient\Urls::URL_FULLTEXT - '/_api/simple/fulltext' - - URL for fulltext + + + getResult + \ArangoDBClient\HttpResponse::getResult() + + Return the result line (first header line) of the response + + string + - - - URL_REMOVE_BY_EXAMPLE - \ArangoDBClient\Urls::URL_REMOVE_BY_EXAMPLE - '/_api/simple/remove-by-example' - - URL remove-by-example + + + getJson + \ArangoDBClient\HttpResponse::getJson() + + Return the data from the JSON-encoded body + + \ArangoDBClient\ClientException + + + array + - - - URL_REMOVE_BY_KEYS - \ArangoDBClient\Urls::URL_REMOVE_BY_KEYS - '/_api/simple/remove-by-keys' - - URL for remove-by-keys + + + setBatchPart + \ArangoDBClient\HttpResponse::setBatchPart() + + + + \ArangoDBClient\Batchpart + + + \ArangoDBClient\HttpResponse + - - - URL_UPDATE_BY_EXAMPLE - \ArangoDBClient\Urls::URL_UPDATE_BY_EXAMPLE - '/_api/simple/update-by-example' - - URL for update-by-example + + $batchPart + + \ArangoDBClient\Batchpart + + + + getBatchPart + \ArangoDBClient\HttpResponse::getBatchPart() + + + + \ArangoDBClient\Batchpart + - - - URL_REPLACE_BY_EXAMPLE - \ArangoDBClient\Urls::URL_REPLACE_BY_EXAMPLE - '/_api/simple/replace-by-example' - - URL for replace-by-example + + + + No summary for method setBatchPart() + No summary for method getBatchPart() + + eJzNWFtv2zYUfvevOAGC2g7spMv25NRdkzSoG6RJkKTYQ1sYtETb2mRSI6m4xtD/vsOLZIm6xFmAYmoRyeS5n4+Hh3zze7JMOp2jg4MOHMCpIGzB35/B7eQWgjiiTI1g8vBwC4LKhDNJkUoTvktI8BdZUICc59yQm0mSqiUXOAeXhMG9onRFGDNTAU82IlosFZznX8evfzkegBIRCmQSPqxmkwFOx3zB6AA+UIHcG+Q+6nQYWaEhJKCe2pPchXPOFIkYFWg/kRLmaEjJA+lceDMTb31vanyREQu0m68Pj40JVupEqeQuC8k/He2q0a+fA3hYUlhSEqIRgqJf9JGGbi4jefdIBEicYws3dGTeiYgeiaKwP3UCxtDtonc1GmY83LxAvmGvl34ax85+uVUARAJmE73nARAhyKZOZXGi3iOJSr98q3cJc5TGCu0mKpXDGNMIvXkkpALzzeflVDoj+8/23elpjq1RY82AgIdGtbIGumVQ1RhpxNQ7jmg5RylVXX8sKYoVgCBlXJVUQGTBa2K+YQFO/J1SDMU6wtWVKiBbUp3LOpNmnMcNNq2JPDVixzAnsfz5tp0RFSwTIhqCNtPTtzhdNcwkJ+YBURFnDgMlIQEqVjC5OH1/cTe9ujk/ffh4c62znTFh1jVdvWC77igLE44pdfIHkEpcAxHDaEUxf2zVaF8X1+9vbz5eP2jF34fElJZhJrYGd/dUQZq0wCwPH0aNrBzCYT8jvre/h0ZCwFdJTBX1FgyuYZkmCZa3EGYbQymp2Hrjy+ZYoSP2WcRm2iwNO0Ri+Hx3VQEFqtV8c8FXrRI/IbR46CQaE1d2RC0JogjNNOFeLylDA1moWUOiCChudFop2oT62Gjg4+/9DOU+lVoKvpZg6/zF94AmGhZlJKazOApgnrLA4Gw6NUkWaaB6XswHxUCNgaVxPPA8zUf9dWeLl91C9LOvlpEcvi2uz5znJKeK5tAr6NwbW/nw6pWnN5vpF1TkAjzkjMe6IPqU+jHhAkbXfsR6FVL9dD9gvWB8iwyNhwLYgMyV2Rtt0cCcdmvlHHrOHEIX/x0Wo62HhnDNFR2BjhysyAZmCHRQ0YrqUhRJmdKq/P5JaehHZ/uVf8aRxFy7hGR1IPut61ofs6NbgQmNEypGIwSfpHrgE5USG4o2oHgIKdhTVuv2jq1iu3ltf7tttd4WO+c50T/plJFUcMmgwGGpFKGKRQZbx69/M6Crm/vVzu3l+O3nAn2QHR3BwsOMNmavitmXgF4//wXKuM1F7JHEUfgTIL07Utvd2dXybkG+lf2jsjXdUZUKZpie2xkJy6p30mEts8dYX3wXVE0ctHp+xXQafAietPtiIhNGj1GY4l5mDMv60yc8Ku9n+kSCnpkXMpa6ET8IMtuhXW+PiUlxYV9/vrrS4HajuFpYF5tgbAdwi9s5PIa5Z+zxI4Q9OxWqF8mptcBRFcuA9WOsTVR48lrnorxSgdWU+jVRfjGk3/r+evMzU6Iuos7PpV68T+Qvx+KOWXOSzfkEM2DfyEMKZx3dvdqkyN3CLZ8EoyXbwZe8ny04taNPrbCSL4PVlTPLwavd3S0MJY3no5HXgfezMOi/baGwBv9fI2KYL1wf/6K4lM8J/R1QYnboZ8aghafRyTPkeQrbWu4OJruzdvEw7+Kvh/rP9aZBZHY/UL4RaPTvzkh4ykOrZwcfzdEk31cv72+u8aCnN7iw9vjbevpoLlW2MjXoqTtvN7p/KbFBqJw83I3QFrQWBdtCvf8n8iGFfk1DqhX3DJe+vUsre8UebjjG+J5hrGwPxdYzbxFrWjYXjy/f/EbIbyHlkqdxaNp/F76BOa4D1xcZ6yhDl3ue6p3wLBHPuVjZ6GrEtbZOFRRpp5vA47qI/BKkcOHRsAJKV45t+cV6dpbJ6m3FNhw083mdef/SpeiNJm/0xhE13OnU1JfcwPYlWDDIacb/5gp2ik0tkb1iVEYjMzOA7tfsMvmru9GdfS0S6rz9C8rpmwY= + + + + ArangoDB PHP client: bind variables + + + + + + + + BindVars + \ArangoDBClient\BindVars + + A simple container for bind variables + This container also handles validation of the bind values.<br> +<br> + + + + + $_values + \ArangoDBClient\BindVars::_values + array() + + Current bind values + + array + - - - URL_LOOKUP_BY_KEYS - \ArangoDBClient\Urls::URL_LOOKUP_BY_KEYS - '/_api/simple/lookup-by-keys' - - URL for lookup-by-keys + + + getAll + \ArangoDBClient\BindVars::getAll() + + Get all registered bind variables + + array + - - - URL_RANGE - \ArangoDBClient\Urls::URL_RANGE - '/_api/simple/range' - - URL for select-range + + + getCount + \ArangoDBClient\BindVars::getCount() + + Get the number of bind variables registered + + integer + - - - URL_ALL - \ArangoDBClient\Urls::URL_ALL - '/_api/simple/all' - - URL for select-all + + + set + \ArangoDBClient\BindVars::set() + + Set the value of a single bind variable or set all bind variables at once + This will also validate the bind values. + +Allowed value types for bind parameters are string, int, +double, bool and array. Arrays must not contain any other +than these types. + + \ArangoDBClient\ClientException + + + string + integer + array + + + string + + + void + + + + $name + + string|integer|array + + + $value + null + string + + + + get + \ArangoDBClient\BindVars::get() + + Get the value of a bind variable with a specific name + + string + + + mixed + - - - URL_ALL_KEYS - \ArangoDBClient\Urls::URL_ALL_KEYS - '/_api/simple/all-keys' - - URL for select-all-keys + + $name + + string + + + + eJylVlFP2zAQfs+vuEmVaKsWGI8tMKCbQHsZGhMvgCo3vSYWrh3ZDqVa+993dhzapA1sml8CuTvf9919d+nplyzNouio242gC5eayUR9vYLbm1uIBUdpBzDhcgovTHM2EWjIzXleZCx+ZgkCvAWNvL83stymSpMNvjMJdxZxzqT0plhlS82T1MLo7a+T488nPbCUIUFp4Ho+uemRWahEYg+uUVP0kqKPokiyORrKjbW0ww0HMHyeCYRYScu4RA0zwrKXxa+Umy0/JoyClMkpeZCv4FNmuZKgZmBTLK8QOZrD04k+dzeE58clMVzGzgRwfHjiucSCGQNXdOk90yb6HTmjJ+FOF0a51hS9nTaYSo8L4gNMa7YMb478M9P8hVmE1riIgjN4eKIC1e6/RkuMBWhMuLGocbpTpGo2jTbXskgI/fCk2vzNJQFZPhE8hlkuY1/YBO2lEO2ONxYFcCckallqT/88sBh683ovDdcdmc8n1EPCUwWwBa2BEKci9/8hvpHLSOXSNrGJvbHKqdNE6i6Q8m6+xqRqmQisggMStgltrKFmFhQprkbZC37Byd1rPWgcd+RdC6MmqQUGK9hlRgnehipjmoaSCkRJNYKhOZZJz1W1V8ZPFRWLRnmiFGWmGK+dQ5oTehiY58aCVLYcRXIhYREmXV5gaSodSBOy1wFe2FSrhYFi4L69xpi5ptS9PNSAcEUAV4WGW26rgNOAe9YVAD9+EqAg9wW36Z5y780Am9MqKtcPFdxZSA3KfFH8fdFR89sefa9McUZCFqKuQT6DNjdjz6EI6HS2zO4QJmRxCoUZmAk31v3cuXeG+0I8Sg8GpY7aIWRYiVhX/qtOAOH1+TYRa0BBba4mDfi5DHQ7sFoBvSgK3cBoN9tDuwjoFEmfXHZvGf4vxX2g3fG6BImLujTbB1cVkfmim1TlgjZoOUVuvonzQWNB1x8sxa39UdV0oWMwGcZ8Ropy6d+bljAjDSPSIN85f6Wl0d+g2BfUuE1DV/co+ZPX8fgZl2N8pd1s3magul3rggiw3IBs6S16/7vzUEil3NTk7j/cY9IDM+3y8z0Y+Lc9OHgsf8c8hl8Bk8fSyfXxDz43w2I= + + + + ArangoDB PHP client: update policies + + + + + + + + UpdatePolicy + \ArangoDBClient\UpdatePolicy + + Document update policies + + + + + + LAST + \ArangoDBClient\UpdatePolicy::LAST + 'last' + + last update will win in case of conflicting versions - - URL_NEAR - \ArangoDBClient\Urls::URL_NEAR - '/_api/simple/near' - - URL for select-range + + ERROR + \ArangoDBClient\UpdatePolicy::ERROR + 'error' + + an error will be returned in case of conflicting versions - - URL_WITHIN - \ArangoDBClient\Urls::URL_WITHIN - '/_api/simple/within' - - URL for select-range + + validate + \ArangoDBClient\UpdatePolicy::validate() + + Check if the supplied policy value is valid + + \ArangoDBClient\ClientException + + + string + + + void + - - - URL_IMPORT - \ArangoDBClient\Urls::URL_IMPORT - '/_api/import' - - URL for document import + + $value + + string + + + + eJydU2Fr2zAQ/e5fcYNRJyFdunx0G9ouLe3GYCFdvwWKopxtUVsSkpwslP73nSTHpF6hMGFko7v33t07+eJSlzpJJqNRAiO4NkwW6uYbLO4XwCuB0mXQ6A1zCFpVggu0lOdTrzTjz6xAgA41D4AQZI0rlaEY/GASHhxizaQMIa703oiidDDvvqZnX6djcEYQobRwV6/vxxSuVCFxDHdoCL0n9CRJJKvRkjb2ZM+7Jm4Ub2o6+ajwd8q2QnLf0dmXaVDjFbMWHgPPwtPsk5fEdxWk/BoBpXRSO1FVtEmghzOLoHLgSuaEdEIWsEVjhZK2xU7CmxKI4ef1w2+YQerpUmqmp0IuojFkaZBYIxh0jZG4+Q+p2+Xy19JrBcZ3xOYl8mcQObgSwTZak0Ob6OMetqxqEIT1H2LTQg7IK1catbMQPb39w1E7qqKfpZlhNVgaOFX6OTKevplXq9MHxq5hqzrl2Jhu1gQiRubolTeSe9lYInEOosYw5MYJ+kXDReMGwj7FUg5pw9YSv8iF9hg+zWZgscqzLAzr5AT+CQRrh0cSfgVPQOKub8sg/S5DiW9bT0n/gH1N4v6axMv4ROnMDo6vZJaFyBjS1eEPWrV3e706TvS8fwH05C35 + + + + ArangoDB PHP client: Base URLs + + + + + + + + Urls + \ArangoDBClient\Urls + + Some basic URLs + + + + + + URL_DOCUMENT + \ArangoDBClient\Urls::URL_DOCUMENT + '/_api/document' + + URL base part for document-related CRUD operations REST calls - - URL_BATCH - \ArangoDBClient\Urls::URL_BATCH - '/_api/batch' - - URL for batch processing + + URL_EDGE + \ArangoDBClient\Urls::URL_EDGE + '/_api/document' + + URL base part for edge-related CRUD operations REST calls - - URL_TRANSACTION - \ArangoDBClient\Urls::URL_TRANSACTION - '/_api/transaction' - - URL for transactions + + URL_EDGES + \ArangoDBClient\Urls::URL_EDGES + '/_api/edges' + + URL base part for all retrieving connected edges - - URL_ENGINE - \ArangoDBClient\Urls::URL_ENGINE - '/_api/engine' - - URL for storage engine + + URL_GRAPH + \ArangoDBClient\Urls::URL_GRAPH + '/_api/gharial' + + URL base part for all graph-related REST calls - - URL_ADMIN_VERSION - \ArangoDBClient\Urls::URL_ADMIN_VERSION - '/_api/version' - - URL for admin version + + URL_VIEW + \ArangoDBClient\Urls::URL_VIEW + '/_api/view' + + URL base part for all view-related REST calls - - URL_ADMIN_SERVER_ROLE - \ArangoDBClient\Urls::URL_ADMIN_SERVER_ROLE - '/_admin/server/role' - - URL for server role + + URLPART_VERTEX + \ArangoDBClient\Urls::URLPART_VERTEX + 'vertex' + + URL part vertex-related graph REST calls - - URL_ADMIN_TIME - \ArangoDBClient\Urls::URL_ADMIN_TIME - '/_admin/time' - - URL for admin time + + URLPART_EDGE + \ArangoDBClient\Urls::URLPART_EDGE + 'edge' + + URL part for edge-related graph REST calls - - URL_ADMIN_LOG - \ArangoDBClient\Urls::URL_ADMIN_LOG - '/_admin/log' - - URL for admin log + + URL_COLLECTION + \ArangoDBClient\Urls::URL_COLLECTION + '/_api/collection' + + URL base part for all collection-related REST calls - - URL_ADMIN_ROUTING_RELOAD - \ArangoDBClient\Urls::URL_ADMIN_ROUTING_RELOAD - '/_admin/routing/reload' - - base URL part for admin routing reload + + URL_INDEX + \ArangoDBClient\Urls::URL_INDEX + '/_api/index' + + URL base part for all index-related REST calls - - URL_ADMIN_STATISTICS - \ArangoDBClient\Urls::URL_ADMIN_STATISTICS - '/_admin/statistics' - - base URL part for admin statistics + + URL_CURSOR + \ArangoDBClient\Urls::URL_CURSOR + '/_api/cursor' + + base URL part for cursor related operations - - URL_ADMIN_STATISTICS_DESCRIPTION - \ArangoDBClient\Urls::URL_ADMIN_STATISTICS_DESCRIPTION - '/_admin/statistics-description' - - base URL part for admin statistics-description + + URL_EXPORT + \ArangoDBClient\Urls::URL_EXPORT + '/_api/export' + + URL for export related operations - - URL_AQL_USER_FUNCTION - \ArangoDBClient\Urls::URL_AQL_USER_FUNCTION - '/_api/aqlfunction' - - base URL part for AQL user functions statistics + + URL_EXPLAIN + \ArangoDBClient\Urls::URL_EXPLAIN + '/_api/explain' + + URL for AQL explain-related operations - - URL_USER - \ArangoDBClient\Urls::URL_USER - '/_api/user' - - base URL part for user management + + URL_QUERY + \ArangoDBClient\Urls::URL_QUERY + '/_api/query' + + URL for AQL query validation-related operations - - URL_TRAVERSAL - \ArangoDBClient\Urls::URL_TRAVERSAL - '/_api/traversal' - - base URL part for user management + + URL_EXAMPLE + \ArangoDBClient\Urls::URL_EXAMPLE + '/_api/simple/by-example' + + URL for select-by-example - - URL_ENDPOINT - \ArangoDBClient\Urls::URL_ENDPOINT - '/_api/endpoint' - - base URL part for endpoint management + + URL_FIRST_EXAMPLE + \ArangoDBClient\Urls::URL_FIRST_EXAMPLE + '/_api/simple/first-example' + + URL for first-example - - URL_DATABASE - \ArangoDBClient\Urls::URL_DATABASE - '/_api/database' - - base URL part for database management + + URL_ANY + \ArangoDBClient\Urls::URL_ANY + '/_api/simple/any' + + URL for any - - URL_QUERY_CACHE - \ArangoDBClient\Urls::URL_QUERY_CACHE - '/_api/query-cache' - - URL for AQL query result cache + + URL_FULLTEXT + \ArangoDBClient\Urls::URL_FULLTEXT + '/_api/simple/fulltext' + + URL for fulltext - - URL_UPLOAD - \ArangoDBClient\Urls::URL_UPLOAD - '/_api/upload' - - URL for file uploads + + URL_REMOVE_BY_EXAMPLE + \ArangoDBClient\Urls::URL_REMOVE_BY_EXAMPLE + '/_api/simple/remove-by-example' + + URL remove-by-example - - URL_FOXX_INSTALL - \ArangoDBClient\Urls::URL_FOXX_INSTALL - '/_admin/foxx/install' - - URL for foxx-app installations + + URL_REMOVE_BY_KEYS + \ArangoDBClient\Urls::URL_REMOVE_BY_KEYS + '/_api/simple/remove-by-keys' + + URL for remove-by-keys - - URL_FOXX_UNINSTALL - \ArangoDBClient\Urls::URL_FOXX_UNINSTALL - '/_admin/foxx/uninstall' - - URL for foxx-app deinstallation + + URL_UPDATE_BY_EXAMPLE + \ArangoDBClient\Urls::URL_UPDATE_BY_EXAMPLE + '/_api/simple/update-by-example' + + URL for update-by-example - - eJytmG1zozYQx9/7U+hd2kxcX/My105LMOfQw0B4yCUzmfHIWGczwcBJwpdMp9+9K2Eb/CDBpc2bZIL2/9Muu6sVv/1RrsrBYHR5OUCXyKA4XxbjW+Tf+SjJUpLzG3SLGUFx4DBYIRb9WeLkBS8JQvv1plwqH+KKrwoKz9BfOEchJ2SN81w+SoryjabLFUfm/q/rD79eXyFOUxDMGZqs53dX8Dgrljm5QhNCwfoNrEeDQY7XhAGbHGE/7rcfFmuC5pilydn9ntktS/NEOPLhl2sJwXPGKU44OI8ZQzHN2ODvgfBGIsTPpdAWFIJKTDn6Ct4uiqRag+aQkgxzskBmEI9RURKKeVqAX4EVRijBGcjVIiP5O4FnXOjNxp4ZTy03Qr+ji9EMl+lop3kB/nVugCyW5P1wazyx3gkGVUQJvD+ySfOl0MxJIjYhdqTjhQ1QLu1NW1Jcrva+dvo2CQz/rmEtVxhyLQOaWNaPuEnJ9/7AB9v60vCErcI1ydgQysnrXl0618nwjSCaPVhBZD0KUq2ho5ykyA9wdskh7Hu/pKTIMsgDSL/+gTM9x7HMyPbcJnyNTm90mi9aAe2k2u64jmINlNZnWPNtE2xYSUUZ/NqBmnpTuRcHoRe0XJP2CrfkC3stC2D1BliPvhe0GkhtrwEY946AZDht3lIfimPY7gFGKHRwvlWEvqENztIFPkiLTuB9bAVPDU4KaWCMiIQZzt+G5BWvy4wo/TCmvtNqeywVq0eNoQbyNaWMdwA+2UEYKTEHChqSPP3O6hvu04kqrNbtusoyaBRcteHYcaCjRKd73doppClZFxvSHfHAmnoP1uz2SRmUEyWNM83aF/Kmyp0G+dl6CjU8oaGBVSVkbQ8XY39sRFoXT5S0LkJlJb0iCzVpdoT2WEsDzoripSo7Yut43ufYV8b2UKO7YMVspvTPcCdnXBIW3cLQ+1UV5DinFZRlvSR1kQHd8zHZ2f23aLiWEZxI5wTrzpIesl/s6K7d17fC31O+0nb33biIYD2cN6pjdnp4ONWLNbJzzJMVKmmREAZT+lKhe2tEZmu8k1YaVRjuc4YT3XkTQbaFxtEc0rLTjI4y0ryg4rJB8mWaKw8fd2K7rYyuF+uOgcU6zcWwyGAHqrQbT21XjIXhwda3RtrkoLAI0ULZYGrp0ApAfRZ4+/4idjWqzUfCvNMDnq71jMieHogLg05VuC1qRR1v0taE5b0mvFqcFhUXVxsYWAq80HICL45sdwL92PGMcRu5FRnVIj9AZxyGI8bTRNls6lcTGZEdRrYZHryZvfG7iMMFYQlNS96Vcw19NrZCM7D9VvUc7aQt2mtXYnqsIMdgfMnrwu0RlHs4iyFdYaZxjyoZf8t2Qr3wEr3GOdT0Wn41OAsUsIYhbP5HcehIoqoN56AfibrG5w6rUwzJF2WRQovuRFnu2Pfs9meInW0vEMw2WP63EwRzknFrhO3PDlvbXhcJSliVcbjYJStVP5H3hplpmHfW0e1hKM20431GYOYTparKsNhvlbh45aWisPeaxevrEJcl3E8hfbNMe+f55D0+ws0U6mo/osgyEiKjrUAf1oK0aTpY7KpwVd4A/xkM5IexGdzjMPtJfB67uZH/uUIXz7uveM/bD23zZ7Hg4uePg38BaMq1fw== - - - - ArangoDB PHP client: connection - - - - - - - - - TraceResponse - \ArangoDBClient\TraceResponse - - Class TraceResponse - - - - - - - $_headers - \ArangoDBClient\TraceResponse::_headers - array() - - Stores each header as an array (key => value) element + + URL_REPLACE_BY_EXAMPLE + \ArangoDBClient\Urls::URL_REPLACE_BY_EXAMPLE + '/_api/simple/replace-by-example' + + URL for replace-by-example - - array - - - - $_httpCode - \ArangoDBClient\TraceResponse::_httpCode - - - The http status code + + + URL_LOOKUP_BY_KEYS + \ArangoDBClient\Urls::URL_LOOKUP_BY_KEYS + '/_api/simple/lookup-by-keys' + + URL for lookup-by-keys - - integer - - - - $_body - \ArangoDBClient\TraceResponse::_body - - - The raw body of the response + + + URL_RANGE + \ArangoDBClient\Urls::URL_RANGE + '/_api/simple/range' + + URL for select-range - - string - - - - $_type - \ArangoDBClient\TraceResponse::_type - 'response' - - The type of http message + + + URL_ALL + \ArangoDBClient\Urls::URL_ALL + '/_api/simple/all' + + URL for select-all - - string - - - - $_timeTaken - \ArangoDBClient\TraceResponse::_timeTaken - - - The time taken to send and receive a response in seconds + + + URL_ALL_KEYS + \ArangoDBClient\Urls::URL_ALL_KEYS + '/_api/simple/all-keys' + + URL for select-all-keys - - float - - - - $_httpCodeDefinitions - \ArangoDBClient\TraceResponse::_httpCodeDefinitions - array(100 => 'Continue', 101 => 'Switching Protocols', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Requested Range Not Satisfiable', 417 => 'Expectation Failed', 418 => 'I\'m a teapot', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported') - - Used to look up the definition for an http code + + + URL_NEAR + \ArangoDBClient\Urls::URL_NEAR + '/_api/simple/near' + + URL for select-range - - array - - - - __construct - \ArangoDBClient\TraceResponse::__construct() - - Set up the response trace + + + URL_WITHIN + \ArangoDBClient\Urls::URL_WITHIN + '/_api/simple/within' + + URL for select-range - - array - - - integer - - - string - - - - $headers - - array - - - $httpCode - - integer - - - $body - - string - - - $timeTaken - - - - - - getHeaders - \ArangoDBClient\TraceResponse::getHeaders() - - Get an array of the response headers + + + URL_IMPORT + \ArangoDBClient\Urls::URL_IMPORT + '/_api/import' + + URL for document import - - array - - - - getHttpCode - \ArangoDBClient\TraceResponse::getHttpCode() - - Get the http response code + + + URL_BATCH + \ArangoDBClient\Urls::URL_BATCH + '/_api/batch' + + URL for batch processing - - integer - - - - getHttpCodeDefinition - \ArangoDBClient\TraceResponse::getHttpCodeDefinition() - - Get the http code definition + + + URL_TRANSACTION + \ArangoDBClient\Urls::URL_TRANSACTION + '/_api/transaction' + + URL for transactions - - \ArangoDBClient\ClientException - - - string - - - - getBody - \ArangoDBClient\TraceResponse::getBody() - - Get the response body - - - string - + + + URL_ENGINE + \ArangoDBClient\Urls::URL_ENGINE + '/_api/engine' + + URL for storage engine + - - - getType - \ArangoDBClient\TraceResponse::getType() - - Get the http message type + + + URL_ADMIN_VERSION + \ArangoDBClient\Urls::URL_ADMIN_VERSION + '/_api/version' + + URL for admin version - - string - - - - getTimeTaken - \ArangoDBClient\TraceResponse::getTimeTaken() - - Get the time taken for this request + + + URL_ADMIN_SERVER_ROLE + \ArangoDBClient\Urls::URL_ADMIN_SERVER_ROLE + '/_admin/server/role' + + URL for server role - + + + URL_ADMIN_TIME + \ArangoDBClient\Urls::URL_ADMIN_TIME + '/_admin/time' + + URL for admin time + + + + + URL_ADMIN_LOG + \ArangoDBClient\Urls::URL_ADMIN_LOG + '/_admin/log' + + URL for admin log + + + + + URL_ADMIN_ROUTING_RELOAD + \ArangoDBClient\Urls::URL_ADMIN_ROUTING_RELOAD + '/_admin/routing/reload' + + base URL part for admin routing reload + + + + + URL_ADMIN_STATISTICS + \ArangoDBClient\Urls::URL_ADMIN_STATISTICS + '/_admin/statistics' + + base URL part for admin statistics + + + + + URL_ADMIN_STATISTICS_DESCRIPTION + \ArangoDBClient\Urls::URL_ADMIN_STATISTICS_DESCRIPTION + '/_admin/statistics-description' + + base URL part for admin statistics-description + + + + + URL_AQL_USER_FUNCTION + \ArangoDBClient\Urls::URL_AQL_USER_FUNCTION + '/_api/aqlfunction' + + base URL part for AQL user functions statistics + + + + + URL_USER + \ArangoDBClient\Urls::URL_USER + '/_api/user' + + base URL part for user management + + + + + URL_TRAVERSAL + \ArangoDBClient\Urls::URL_TRAVERSAL + '/_api/traversal' + + base URL part for user management + + + + + URL_ENDPOINT + \ArangoDBClient\Urls::URL_ENDPOINT + '/_api/endpoint' + + base URL part for endpoint management + + + + + URL_DATABASE + \ArangoDBClient\Urls::URL_DATABASE + '/_api/database' + + base URL part for database management + + + + + URL_QUERY_CACHE + \ArangoDBClient\Urls::URL_QUERY_CACHE + '/_api/query-cache' + + URL for AQL query result cache + + + + + URL_UPLOAD + \ArangoDBClient\Urls::URL_UPLOAD + '/_api/upload' + + URL for file uploads + + + + + URL_FOXX_INSTALL + \ArangoDBClient\Urls::URL_FOXX_INSTALL + '/_admin/foxx/install' + + URL for foxx-app installations + + + + + URL_FOXX_UNINSTALL + \ArangoDBClient\Urls::URL_FOXX_UNINSTALL + '/_admin/foxx/uninstall' + + URL for foxx-app deinstallation + + + - eJylV9ty2zYQfddXbGc8I9kjJ5FvbZ0mjaM4ttu40dhKX+KMByZXEsYUwACgHDXTf+/iQoqgaGva8sEX7sHu2YMFdvnLr/ks7zzf2enADpwoJqby3VsYnY8gyTgKcwyJFAITw6UgiEW9yVlyz6YIUC0YOqwzssLMpCIb/MYEXBvEOROiYXpP6xKuYTgryIEzJjJfKj6dGRhWf+29GOz1wShO0YSGs/ndeZ/MmZwK7MMZKnK9pNXPOx3B5qiJGDY4veyUyQ0zpjWMFWGuCCqFxjKhJ4k9ma3mIrEmgMGzfcckaQnzvWMRjod9dkgWqVADsmQGM2QpKmAaSC+mFFtC7x6X8Oo1LFhW4DZghnMX0C0ufbxZMOXx4c1z9ztXfMEMwtatd6zhFXz+QjI0KIxnCDNjctCGmULTNqfYFoFXgdf80+ohrWr3rdgD3Ml0CXICxv5fab4eQ9MWW7Vbw1gn7SHMMkfr3qVB269pm/61e+fkFXRLft1HYvE5/WD3KMBI0ChS2q6UskqQLxBYlR8JRmY6NKlu4zLJJHtMUBtjbEOsU/ikMbWBMynvocidoilOuOD2YMKEqpeqxwnx2EY+WSphK99VLl3ZeLQt7hcvbD12h1IYLgrs9mumgTNdP3CTzEhnGClpZCIzXUPtBQcff49e+qVDhUQjjSx7znKSJJg3TfvO9IcUuyfu3HIqYLsHF4JkmDPLPsIfBDxY9nSOIuOhM9JJRdNqP3L2EVOGs6wFsR8Suywyw/MM6eaQPEEdQXyal3JBmzhytxY5yZYRxif8XhYijd77bK8R4SNtuopsZWYGLmXKJxzjpT43Kh27Jd/icD862xjnuVRMLeEKU07FXE/tIKT2lqVk/lqgjq0+q0/C3578ryj6QUhoxJb27nIOKEAM2Q85qzuepigi2yq3piYHIbFLpLgpWMhJlsmHhvOjyoGvInaXYQTwEjhpwFYS0eSJK592tj+FUnFKwJgOqyxiRX4uD8kk47GUAy/lmRQRh4HX8AOKqZm1Rh0EGZW7Uvxpf8941kDtR9xOKROzhLGU8IGpaRzyoA7d/XR14XFSTCNYKB6hi5xKhM4gXFKJMBjTfRkBj+r+CHZFTRLdrlyTmHrCm8IPvPCn33KqN/ZYRl7ti5vunC5XgyyXdUEPQ21e0HlUgk7mNaoFddFTpaSKcIOqDC7muW+kUaTDUKi2ys/oGnpgy8hanj+1oGMNVO0L4tpI6TBUa1jfUhuHoWbPx+MR/Eld2WbtNCrlDeCWTn1NV1O48qsmY+x80bzlc6bYPIwQsFW2f9h1S/3rslsGY2Mp9Xr7/1bZDsLSZlsp4b6vwpZr8/bx8PC6DGWtjYXh2aoaXtyWijs6PjAphJs64faWSp+cFonplVn1VyT7nkC/5m7b+fneWQWacb37upqIgJpb6enlOqrM3qGqIacJq7K2MD+kNCEVIQupdXeL+Xttn89on6sRsDE1NTas0lOhKZRo6+0NEadozr2LXlOd4KMh0lMsq6Ko6LUNHcHv2gDZwiyIvJFatBkbuFlKtRmpyc7MlHygQd/N8qffbIdYoSrybaPj4/xX49NaJnwCvR+4pjGj18ymNnR9DrZIky/b2zVH9nHcQeBDk36PLkT6aOBpTYJcyQVPMX3W3V5VaNDuCY03stq0CVVt1C6A/ybvW3KwqTRWB3BDWYTvBPfx8L9Y2Ua4iZUNsolV7cvCjvF2Jblx3XQjhfJK2cijefcQHfehekvFwnQv+lw9PnamPnRvyk/vm/Dpe3cTIW1F/QNKpHLw + eJytmG1zozYQx9/7U+hd2kxcX/My105LMOfQw0B4yCUzmfHIWGczwcBJwpdMp9+9K2Eb/CDBpc2bZIL2/9Muu6sVv/1RrsrBYHR5OUCXyKA4XxbjW+Tf+SjJUpLzG3SLGUFx4DBYIRb9WeLkBS8JQvv1plwqH+KKrwoKz9BfOEchJ2SN81w+SoryjabLFUfm/q/rD79eXyFOUxDMGZqs53dX8Dgrljm5QhNCwfoNrEeDQY7XhAGbHGE/7rcfFmuC5pilydn9ntktS/NEOPLhl2sJwXPGKU44OI8ZQzHN2ODvgfBGIsTPpdAWFIJKTDn6Ct4uiqRag+aQkgxzskBmEI9RURKKeVqAX4EVRijBGcjVIiP5O4FnXOjNxp4ZTy03Qr+ji9EMl+lop3kB/nVugCyW5P1wazyx3gkGVUQJvD+ySfOl0MxJIjYhdqTjhQ1QLu1NW1Jcrva+dvo2CQz/rmEtVxhyLQOaWNaPuEnJ9/7AB9v60vCErcI1ydgQysnrXl0618nwjSCaPVhBZD0KUq2ho5ykyA9wdskh7Hu/pKTIMsgDSL/+gTM9x7HMyPbcJnyNTm90mi9aAe2k2u64jmINlNZnWPNtE2xYSUUZ/NqBmnpTuRcHoRe0XJP2CrfkC3stC2D1BliPvhe0GkhtrwEY946AZDht3lIfimPY7gFGKHRwvlWEvqENztIFPkiLTuB9bAVPDU4KaWCMiIQZzt+G5BWvy4wo/TCmvtNqeywVq0eNoQbyNaWMdwA+2UEYKTEHChqSPP3O6hvu04kqrNbtusoyaBRcteHYcaCjRKd73doppClZFxvSHfHAmnoP1uz2SRmUEyWNM83aF/Kmyp0G+dl6CjU8oaGBVSVkbQ8XY39sRFoXT5S0LkJlJb0iCzVpdoT2WEsDzoripSo7Yut43ufYV8b2UKO7YMVspvTPcCdnXBIW3cLQ+1UV5DinFZRlvSR1kQHd8zHZ2f23aLiWEZxI5wTrzpIesl/s6K7d17fC31O+0nb33biIYD2cN6pjdnp4ONWLNbJzzJMVKmmREAZT+lKhe2tEZmu8k1YaVRjuc4YT3XkTQbaFxtEc0rLTjI4y0ryg4rJB8mWaKw8fd2K7rYyuF+uOgcU6zcWwyGAHqrQbT21XjIXhwda3RtrkoLAI0ULZYGrp0ApAfRZ4+/4idjWqzUfCvNMDnq71jMieHogLg05VuC1qRR1v0taE5b0mvFqcFhUXVxsYWAq80HICL45sdwL92PGMcRu5FRnVIj9AZxyGI8bTRNls6lcTGZEdRrYZHryZvfG7iMMFYQlNS96Vcw19NrZCM7D9VvUc7aQt2mtXYnqsIMdgfMnrwu0RlHs4iyFdYaZxjyoZf8t2Qr3wEr3GOdT0Wn41OAsUsIYhbP5HcehIoqoN56AfibrG5w6rUwzJF2WRQovuRFnu2Pfs9meInW0vEMw2WP63EwRzknFrhO3PDlvbXhcJSliVcbjYJStVP5H3hplpmHfW0e1hKM20431GYOYTparKsNhvlbh45aWisPeaxevrEJcl3E8hfbNMe+f55D0+ws0U6mo/osgyEiKjrUAf1oK0aTpY7KpwVd4A/xkM5IexGdzjMPtJfB67uZH/uUIXz7uveM/bD23zZ7Hg4uePg38BaMq1fw== - + - ArangoDB PHP client: admin document handler + ArangoDB PHP client: single document - - - - + + + - - \ArangoDBClient\Handler - AdminHandler - \ArangoDBClient\AdminHandler - - Provides access to ArangoDB's administration interface - The admin handler utilizes ArangoDB's Admin API. - - - + + + EdgeDefinition + \ArangoDBClient\EdgeDefinition + + Value object representing an edge Definition. + An edge definition contains a collection called 'relation' to store the edges and +multiple vertices collection defined in 'fromCollections' and 'toCollections'. + +<br> + + - - OPTION_DETAILS - \ArangoDBClient\AdminHandler::OPTION_DETAILS - 'details' - - details for server version - - - - - $_connection - \ArangoDBClient\Handler::_connection + + $_relation + \ArangoDBClient\EdgeDefinition::_relation - - Connection object - - - \ArangoDBClient\Connection - - - - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - + + The name of the edge collection for this relation. - + string - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - + + $_fromCollections + \ArangoDBClient\EdgeDefinition::_fromCollections + array() + + An array containing the names of the vertices collections holding the start vertices. - - string + + array - - getEngine - \ArangoDBClient\AdminHandler::getEngine() - - Get the server's storage engine - This will throw if the engine data cannot be retrieved - - \ArangoDBClient\Exception - - - mixed + + $_toCollections + \ArangoDBClient\EdgeDefinition::_toCollections + array() + + An array containing the names of the vertices collections holding the end vertices. + + + array - - - - getServerVersion - \ArangoDBClient\AdminHandler::getServerVersion() - - Get the server version - This will throw if the version cannot be retrieved - - boolean + + + __construct + \ArangoDBClient\EdgeDefinition::__construct() + + Constructs an new edge definition + + + string - - \ArangoDBClient\Exception + + array + string - + + array string - + - $details - false - boolean + $relation + null + string + + + $fromCollections + array() + array|string + + + $toCollections + array() + array|string - - getServerRole - \ArangoDBClient\AdminHandler::getServerRole() - - Get the server role - This will throw if the role cannot be retrieved - - \ArangoDBClient\Exception - - + + setRelation + \ArangoDBClient\EdgeDefinition::setRelation() + + Set the relation of the edge definition + + string - - - - - getServerTime - \ArangoDBClient\AdminHandler::getServerTime() - - Get the server time - This will throw if the time cannot be retrieved - - \ArangoDBClient\Exception - - - double - - - - - - getServerLog - \ArangoDBClient\AdminHandler::getServerLog() - - Get the server log - This will throw if the log cannot be retrieved - - \ArangoDBClient\Exception - - - array - - - array - - + - $options - array() - array + $relation + + string - - reloadServerRouting - \ArangoDBClient\AdminHandler::reloadServerRouting() - - Reload the server's routing information -The call triggers a reload of the routing information from the _routing collection - This will throw if the routing cannot be reloaded - - \ArangoDBClient\Exception - - - boolean + + getRelation + \ArangoDBClient\EdgeDefinition::getRelation() + + Get the relation of the edge definition. + + + string - + - - getServerStatistics - \ArangoDBClient\AdminHandler::getServerStatistics() - - Get the server statistics -Returns the statistics information. The returned objects contains the statistics figures, grouped together -according to the description returned by _admin/statistics-description. - For instance, to access a figure userTime from the group system, you first select the sub-object -describing the group stored in system and in that sub-object the value for userTime is stored in the -attribute of the same name.In case of a distribution, the returned object contains the total count in count -and the distribution list in counts. -For more information on the statistics returned, please lookup the statistics interface description at - - - \ArangoDBClient\Exception - - + + getToCollections + \ArangoDBClient\EdgeDefinition::getToCollections() + + Get the 'to' collections of the graph. + + array - - + - - getServerStatisticsDescription - \ArangoDBClient\AdminHandler::getServerStatisticsDescription() - - Returns a description of the statistics returned by getServerStatistics(). - The returned objects contains a list of statistics groups in the attribute groups -and a list of statistics figures in the attribute figures. -For more information on the statistics returned, please lookup the statistics interface description at - - - \ArangoDBClient\Exception - - - array - - + + getFromCollections + \ArangoDBClient\EdgeDefinition::getFromCollections() + + Get the 'from' collections of the graph. + + array - - + - - $options - array() - array - - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler + + addToCollection + \ArangoDBClient\EdgeDefinition::addToCollection() + + Add a 'to' collections of the graph. - - \ArangoDBClient\Connection + + string + - $connection + $toCollection - \ArangoDBClient\Connection + string - \ArangoDBClient\Handler - - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object - - - \ArangoDBClient\Connection - - - \ArangoDBClient\Handler - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection + + addFromCollection + \ArangoDBClient\EdgeDefinition::addFromCollection() + + Add a 'from' collections of the graph. - - - mixed - - - \ArangoDBClient\ClientException + + string + - $optionName + $fromCollection - + string - \ArangoDBClient\Handler - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - + + clearToCollection + \ArangoDBClient\EdgeDefinition::clearToCollection() + + Resets the 'to' collections of the graph. + + + + + + clearFromCollection + \ArangoDBClient\EdgeDefinition::clearFromCollection() + + Resets the 'from' collections of the graph. + + + + + + transformToArray + \ArangoDBClient\EdgeDefinition::transformToArray() + + Transforms an edge definition to an array. + + array - + + + + + createUndirectedRelation + \ArangoDBClient\EdgeDefinition::createUndirectedRelation() + + Constructs an undirected relation. This relation is an edge definition where the edges can start and end +in any vertex from the collection list. + + string - - \ArangoDBClient\ClientException + + array + + \ArangoDBClient\EdgeDefinition + + - $body + $relation + + string + + + $vertexCollections array - \ArangoDBClient\Handler - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array + + createDirectedRelation + \ArangoDBClient\EdgeDefinition::createDirectedRelation() + + Constructs a directed relation. This relation is an edge definition where the edges can start only in the +vertices defined in 'fromCollections' and end in vertices defined in 'toCollections'. + + + string - + array + string - + array + string - - array + + \ArangoDBClient\EdgeDefinition + - $options + $relation - array + string - $body + $fromCollections - array + array|string - $includeArray - array() - array + $toCollections + + array|string - \ArangoDBClient\Handler - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name + + eJztWE1v4zYQvftXzCGAnMBx2qCn7Ec3m+xmj4tt2ksSGLRE22ppSqCobI1t/3uHFEWRlGRL2aS91AgQm0POzJs3M+Lo9c/5Jp9Mzk5OJnACl4LwdXb9Hj5/+gwxSymXF1CkfM0oJFlcbnEB96mt73IS/0HWFMCeutIHtJCUcpMJlMFHlomUcHhPhKSs0NI4y3ciXW8kXNlv5z/8+NMMJO5dU17AzXb5aYZilq05ncENFVvCd7VtdClWlgHO5+e4cjaZcLKlBfpEA3deWXC/EVZSyJa/01iCoLmgBcoRHKB7NEEo13SV8lSmGZ/raJjlxC5DnHFJUvSP4FfGUJNeJfg1gUhQRtRCBDKDQmaCgtxQrQRP8EQp3ZZMpjnG85EKmcYocBRpS6gp5RCtRLa9sqIiUgogkpm7NjcBeb0Ubwfx0g5czEhRwAd0sUE/+TZRW3Tc1OcEbhGGijBkKwvJdXyFZMtNWkAdgrk5WSt490gEhkSocO9RZLaf6f+5yCQuYzyOFrVepDNwDVkiQpBdzY2yII27RW2mI9gFbDKW1LsLiflpt3V6X1nx1PqnhuAIWIU3cPfwUpgoJsxYRO6ZIXi8fOxBc4UiKcpYqiIATr+GZRX6lhNBtnW2VJ+jOgHMbzj10shKp+pXyRMq2E6dDvLreB4Y0SH4y5g6Ctk5xTpnaSGVGTfKGIHHtImzru8gF7AgSA2hJoXUvdSpHIViv1N+iGGUUx6dT3HJehZ0DldosqJcsjSGVckrLYtFXPM+bdh7A7xkbNYOtUqdWQhWLR5r7VVH0pmg+szp24Wj8ijoDnpb28BUx/W4JXrl6A5i7RzyRK4h40/b3j471Zm2udCM2v13q6J+odJPe7ebDqyrhpNT21vCchqUBd30F1R+MVoa+sdx2Y39Zhj2luuCylJwg/4JgNYOoBCH0R3CsRD6MODjPPJq2GBZC5Jv+hDohHwagFs3uQ6hGJSJFonK9X8Vy0e/uA6h6azFNp7LJMGeOI4Xv6zcsHWUFkkSfHA2ur+jxFCVS+jUM91Xah6rdw9hyzkQl5Es+5HxKXjx2PgJMg3M98UnyJMqQv5iX4y+4ECBd5zxhT0cVswoER7pg3g2F7PDbo/kd6TjASPjKnYvhlscdQocQraFHeacqQ2nMWJ6zXM3Ilkbvs0ulYoOPuodNPmQgP9pILW33kUNDVFVpzou3nOo/7Bm8sHaaQ63+ma/DkziB8fXRkfwHHFuQ5ZDV1Pvc9CfDPDanopqsLAXEJw8nakS0k5+v26oN2rHhJvruJqZqRq8K3s4VxO+0zdi+ieoEOlTzt1XXawPtLFwEnneWQRZqNz7vjnEAO+f/wxRweA/uADQivTqW1Ai6a+Wwfbdb9YBrKcDqBHRd2y/mk7Vg5IOnj3jMs52Ks9QVhu0A9jB1zuKMRR2Hmi9+dmTo6ac/5+Z/9uZ+UVq7HpfhQVkhAP10+rtkFJbafinXycuCEtJMfVVXlxo2Qyi+/ot7715Q7m897dGqPIfNEzqrA== + + + + ArangoDB PHP client: client exception + + + + + + + \ArangoDBClient\Exception + ClientException + \ArangoDBClient\ClientException + + Client-Exception + This exception type will be thrown by the client when there is an error +on the client side, i.e. something the server is not involved in.<br> +<br> + + + + + + $enableLogging + \ArangoDBClient\Exception::enableLogging + false + + - - \ArangoDBClient\ClientException - - - mixed - - + + + + __toString + \ArangoDBClient\ClientException::__toString() + + Return a string representation of the exception + + + string - - $value - - mixed - - \ArangoDBClient\Handler - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use + + __construct + \ArangoDBClient\Exception::__construct() + + Exception constructor. - + string - - \ArangoDBClient\DocumentClassable + + integer + + + \Exception - $class - + $message + '' string - \ArangoDBClient\DocumentClassable + + $code + 0 + integer + + + $previous + null + \Exception + + \ArangoDBClient\Exception - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use + + enableLogging + \ArangoDBClient\Exception::enableLogging() + + Turn on exception logging - - string - - - \ArangoDBClient\DocumentClassable - - - $class - - string - - \ArangoDBClient\DocumentClassable + \ArangoDBClient\Exception + + + disableLogging + \ArangoDBClient\Exception::disableLogging() + + Turn off exception logging + + + \ArangoDBClient\Exception - eJzlWV9v2zgSf/enmIcAdgrHbtN9cppcvbGbeJHGge0ucGgLl5ZomxtJ1JJUGu+i331nSEqWZadxc7k9HNZAUUWc/7/hzJB68690mdZq7RcvavACuoolC9n7GW4ubyCIBE9MB1gYiwRCGWQx/g1LloQRV0hOHG9TFtyyBQcomM8tn11kmVlKhWvwC0tgbDiPWZJUlt4h3y28ZysrFN4GMl0psVgaOC+ejl++Om6CUQJVJRou4tllE5cjuUh4Ey64Qrkry61FEpA1AK9ax/imXaslLOYa7eQVE08Kv2+UvBMh18CCgGsNRhakde0CILRRzAiZgEgMV3MU50MwWXIfIx8ayIyIxB8oriSkaym6N4PWXpHb4UYQMe3lXHpF/N7wJNTg/679WSMO6xT9XkDIDRORhjmGWnN1hzz4T6MbnqJt/w9kog0MbyaD4fW01590B1djOIW6Z6+fWKqq8AtuwKDzTjD6qI1U5BFPFiLhniynniyFhq8iipBHya8g5pbZ0ULIDIMAk0MamHFQHLHmdzysCHlreTX07wOemrUbxToyZiqBWNzzEI4As07OfuOBAbcgkkVZq0gwMDErCcoj/5qiXopQms0iEcA8SwKbBAtu+lZG49DFxYWefgcKsw0DyjGCBwa9PjpD6nOZJNzyNg7ti8YHFelO58Poatq/vhhc9w9PChHei0KSZfhFE68j+lb7PhgVlB/BwBPvE/+UKRbDTMoIDvLkOoKJyjhtGrQSGMRScZ95CELuwxORxG1HoCGU+eNSRmGOY1GwNv3NUXz1OIpjG69fHXuj8OkU5izS/LCKbaYiXFtD1+29H1xPf+2Pxrh1TmoFIUa2EHZYErAp5JJHKVedDktT3Mc3FFuNrxtE0YSPxf6D0zMsfhn/XMqRb7UfzjgSW5JwYDcd/U4fSLW93MmTlaTtNK9M8LHukap/3jOTlYz2LCVE+Yw15PuZV7IOGry1aMGH617/He7jHnam4XDUG1x3J8NRE3o/j/sjzJDDSnIet17ul5wj1NHYmYkevGo6On3T0fCqf/I3JskmzhSZEsiPoGxEvCfKRPmMKIcSw84tyv6xjDIp04bF6VMLywQFbGP3wx3C4ToZvO8/BzTk1f7Q4JC1HzJI+BzAuBbDlGIrOJCWRLtW7t7JOeRvzZIZ7DRz6uW2AnCdReZIc9OpSH2Tng09E8Pu1HkzU2fFWiTO6llqZB3VuEghFXpHDuFAhm5oyFJqcIzeHUXoVtSCa2m4M6F4CXGmrfcSLZLzzps2yi7ZUFY5RywiaMPLTSJ85krhvNaGV1srX5mbYdpwvLVGwwwuvN5aCPksI5afNlfam+bUrQN1wBhAJGJhdAFqHgMMAL1C37SPeogjFGyF44t98wUhC+ELBfaLDXqcGTaLVji1BlGmxR1vbZlal/M5okdAgL4VqdU3FwqD6lZyW3awahy50fzCfsubZPEMcxhzxgGLFhNYJY+IbZc0w5Rx0Rg9kBI6C5bOYdQkVCF4BXiWSIyYC9SMO2WhODNkBA7sv2eIOWqNRLhLqbQ6SekYH3MACnO5wDcKmA5wXKA8wJ0XCuWqBqnClSbpwbNMiQRjIbR9RwccqVx5k7nZaEoJPKtTILBxKjUdiSDADZvQWUsEaDyyc7XLds5UsLTIDRNE2Zecqgt41MApohjEDR5hfHtttVoPJWi1aLtCUKoJ5Zp9x5SQGRpuUOwsM6gU4bc7t0OeNV3CNtfFvenMoHS1NknamCyWWUJpt4H5jM9puk0Zzv723NB6ame4kotGpcidwsfPj/T5hybGaqu4Gl40C8GHT54CfuhEUu0jIx5JFm4eEZXEwzFl5fbJi87RAe0xjPRigVMiYqacCJkPeFvMMFcytovTfDWQUeSc2Xds9Hyl1kVanzxS0OnoB7PCaczHPWvP9tTwAFy4TbdHhdHww2RwfTEd9a+GXZxI6/UdaNKRYt8pADeKEdqIQK/hdWXREhWrZXBaFtOi8LqTeFECtjjnYpFhfjWxYMosRQYj0dklXQs5jdXiZUuaEqkPoVczW8HU3se017KPSpTFjn2HhRLNMAwRatru7m5/mLcEMu0GuHWSWctAr7ThcRNWMvPNSXNKOedQNjtynuZ6nO5ZXp+8DIN1xLZPJ81WH5G4GryW4StahOdrusMpLBK6JAFpihDlRS/fM5ohNd2AtQZ0wNfcFcOQ7rOIEAPS9LPTBkybKLmSGNiKiArtQ6HSl82ySKyzek2pN0JurwfKW1gm1UzIbWlCGnGyOZLyNku3U83fxG0kAjPVfRmJ5BZgaUyqO+12KAPdYvbiIJy1Ahm3LyeTm3Z345avm4TvZSIwxAhbWyQhv28tTRztV1JKNj7fScU2i+qa5nRLWDSVcaG4t45I43CLyxel1/u1qrXUx46h+7an8aQ7GYwng/Nxk3re/6o/+bluI33kFoTlyrIzJq11Onyv3DG3K1BBSbitBtrv4tL2de/Le2wnu6+Z2/x+4Z+788ol///3WLrAaGURTrRmRaM11n/AYNmhlvoBgxIBmeAXmzgRZ8rR2KemTaGQrdw7enDdGc1kaBw1FM+7Y7b3yVS31yR5FhbtGoGMGXpHETIcDxM3UmtBVyl5dpJvlATrfYza/43dE3GxPtmxz98f42OevFULqzK2LY14sjD2FDKY2/78lSV0J21vjbB5CjKYMInZvYixpzmGYtdbCjxG2QzHIfS7ZrI7JiJGjm4MPWWOIFOKvpp5LnsawiDZ5ohbCDv7hhP/Wc1/xkJfbh//vVPKug1Me/3x+Whgv0D93QeXb/7b2pRFgulG+Qtbp2NXcH7+lH98/OS/Ocw+lQlpvP4LCNYG2Q== + eJyFUsFu4jAQvecr5rASFEHocoSqpUurVqtWqsoekSLHDIm1yTgaGyiq+u87NoFW0Ur1ZWy/ec/zXnJ105RNkowHgwQGcMuKCnv3C14eX0BXBslP2wr4prHxxpI0ht55o/RfVSDAmbaInRFUW19aFgx+K4KlR6wVUYS0bQ5sitLD4rybXP6cDMGzEUFy8FDnj0OBK1sQDuEBWdgHYY+ThFSNTt7GzrOzs4vjeXTfGfhPadynC/CHBmFvqgpyBF+y3RPkB9nhyfG+RApnRhCm2EBmy0HK0tc+Z9YypEkxBWdr9KWhIuIOeYccyGQ9GNrZaodr2aRXOV8HobZ+n6czpAMEcJlOYhC6Us61Xs9WxZ9HWjv4NP+eBFaMJqwBvKLfMoECJ3nLpIwNoxMVFRXsJs7+5XNH2ok9r1VhdPeSj5qt4uj/0m33ONZmm1dGw2ZLOj6bZd4uI6t/ERuOc4fVimfZ4ul2ucwySKE3hZ6UH5K1G10X6J/ROQmvfzGLtI/kIzkmlKnKKNfv5DSdRnAIvdXpp1u1qeerTm9PNP8BNt79Cg== - + - ArangoDB PHP client: document handler + ArangoDB PHP client: export - - + - - \ArangoDBClient\DocumentHandler - EdgeHandler - \ArangoDBClient\EdgeHandler - - A handler that manages edges - An edge-document handler that fetches edges from the server and -persists them on the server. It does so by issuing the -appropriate HTTP requests to the server. - - - + + + Export + \ArangoDBClient\Export + + Collection export + + + - - ENTRY_DOCUMENTS - \ArangoDBClient\EdgeHandler::ENTRY_DOCUMENTS - 'edge' - - documents array index - - - - - - ENTRY_EDGES - \ArangoDBClient\EdgeHandler::ENTRY_EDGES - 'edges' - - edges array index - - - - - OPTION_COLLECTION - \ArangoDBClient\EdgeHandler::OPTION_COLLECTION - 'collection' - - collection parameter + + ENTRY_COUNT + \ArangoDBClient\Export::ENTRY_COUNT + 'count' + + Count option index - - - OPTION_EXAMPLE - \ArangoDBClient\EdgeHandler::OPTION_EXAMPLE - 'example' - - example parameter + + ENTRY_BATCHSIZE + \ArangoDBClient\Export::ENTRY_BATCHSIZE + 'batchSize' + + Batch size option index - - - OPTION_FROM - \ArangoDBClient\EdgeHandler::OPTION_FROM - 'from' - - example parameter + + ENTRY_FLUSH + \ArangoDBClient\Export::ENTRY_FLUSH + 'flush' + + Flush option index - - OPTION_TO - \ArangoDBClient\EdgeHandler::OPTION_TO - 'to' - - example parameter + + ENTRY_RESTRICT + \ArangoDBClient\Export::ENTRY_RESTRICT + 'restrict' + + Export restrictions - - OPTION_VERTEX - \ArangoDBClient\EdgeHandler::OPTION_VERTEX - 'vertex' - - vertex parameter + + ENTRY_LIMIT + \ArangoDBClient\Export::ENTRY_LIMIT + 'limit' + + Optional limit for the number of documents - - OPTION_DIRECTION - \ArangoDBClient\EdgeHandler::OPTION_DIRECTION - 'direction' - - direction parameter + + $_connection + \ArangoDBClient\Export::_connection + + + The connection object + + \ArangoDBClient\Connection + - - - ENTRY_DOCUMENTS - \ArangoDBClient\DocumentHandler::ENTRY_DOCUMENTS - 'documents' - - documents array index + + + $_collection + \ArangoDBClient\Export::_collection + + + The collection name or collection object + + mixed + - - - OPTION_COLLECTION - \ArangoDBClient\DocumentHandler::OPTION_COLLECTION - 'collection' - - collection parameter + + + $_batchSize + \ArangoDBClient\Export::_batchSize + + + The current batch size (number of result documents retrieved per round-trip) + + mixed + - - - OPTION_EXAMPLE - \ArangoDBClient\DocumentHandler::OPTION_EXAMPLE - 'example' - - example parameter + + + $_flat + \ArangoDBClient\Export::_flat + false + + "flat" flag (if set, the query results will be treated as a simple array, not documents) + + boolean + - - - OPTION_OVERWRITE - \ArangoDBClient\DocumentHandler::OPTION_OVERWRITE - 'overwrite' - - overwrite option + + + $_flush + \ArangoDBClient\Export::_flush + true + + Flush flag (if set, then all documents from the collection that are currently only +in the write-ahead log (WAL) will be moved to the collection's datafiles. This may cause +an initial delay in the export, but will lead to the documents in the WAL not being +excluded from the export run. If the flush flag is set to false, the documents still +in the WAL may be missing in the export result. + + boolean + - - - OPTION_RETURN_OLD - \ArangoDBClient\DocumentHandler::OPTION_RETURN_OLD - 'returnOld' - - option for returning the old document + + + $_type + \ArangoDBClient\Export::_type + + + The underlying collection type - - - OPTION_RETURN_NEW - \ArangoDBClient\DocumentHandler::OPTION_RETURN_NEW - 'returnNew' - - option for returning the new document + + + $_restrictions + \ArangoDBClient\Export::_restrictions + + + export restrictions - either null for no restrictions or an array with a "type" and a "fields" index + + mixed + - - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object + + + $_limit + \ArangoDBClient\Export::_limit + 0 + + optional limit for export - if specified and positive, will cap the amount of documents in the cursor to +the specified value - - \ArangoDBClient\Connection + + integer @@ -21966,3038 +23316,5301 @@ appropriate HTTP requests to the server. - + __construct - \ArangoDBClient\EdgeHandler::__construct() - - Construct a new handler + \ArangoDBClient\Export::__construct() + + Initialize the export - + + \ArangoDBClient\Exception + + \ArangoDBClient\Connection + + string + + + array + $connection \ArangoDBClient\Connection - - - createFromArrayWithContext - \ArangoDBClient\EdgeHandler::createFromArrayWithContext() - - Intermediate function to call the createFromArray function from the right context - - - - - \ArangoDBClient\Edge - - - \ArangoDBClient\ClientException - - - - $data + $collection - + string - $options - - - - - - saveEdge - \ArangoDBClient\EdgeHandler::saveEdge() - - save an edge to an edge-collection - This will save the edge to the collection and return the edges-document's id - -This will throw if the document cannot be saved - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed - - - mixed - - - array - - - mixed - - - - - $collection - - mixed - - - $from - - mixed - - - $to - - mixed - - - $document - - mixed - - - $options + $data array() array - - edges - \ArangoDBClient\EdgeHandler::edges() - - Get connected edges for a given vertex + + getConnection + \ArangoDBClient\Export::getConnection() + + Return the connection object - - \ArangoDBClient\Exception + + \ArangoDBClient\Connection - - mixed + + + + execute + \ArangoDBClient\Export::execute() + + Execute the export + This will return the results as a Cursor. The cursor can then be used to iterate the results. + + \ArangoDBClient\Exception - - mixed + + \ArangoDBClient\ExportCursor - - string + + + + setBatchSize + \ArangoDBClient\Export::setBatchSize() + + Set the batch size for the export + The batch size is the number of results to be transferred +in one server round-trip. If an export produces more documents +than the batch size, it creates a server-side cursor that +provides the additional results. + +The server-side cursor can be accessed by the client with subsequent HTTP requests. + + \ArangoDBClient\ClientException - - array + + integer - - array + + void - - $collection - - mixed - - - $vertexHandle + $value - mixed - - - $direction - 'any' - string - - - $options - array() - array + integer - - inEdges - \ArangoDBClient\EdgeHandler::inEdges() - - Get connected inbound edges for a given vertex + + getBatchSize + \ArangoDBClient\Export::getBatchSize() + + Get the batch size for the export - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - array + + integer - - $collection - - mixed - - - $vertexHandle - - mixed - - - outEdges - \ArangoDBClient\EdgeHandler::outEdges() - - Get connected outbound edges for a given vertex + + getCursorOptions + \ArangoDBClient\Export::getCursorOptions() + + Return an array of cursor options - - \ArangoDBClient\Exception - - - mixed - - - mixed - - + array - - $collection - - mixed - - - $vertexHandle - - mixed - - - createCollectionIfOptions - \ArangoDBClient\EdgeHandler::createCollectionIfOptions() - - + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use - - - array + + string + + + \ArangoDBClient\DocumentClassable - - $collection - - - - - $options + $class - array + string + \ArangoDBClient\DocumentClassable - - get - \ArangoDBClient\DocumentHandler::get() - - Get a single document from a collection - Alias method for getById() - - \ArangoDBClient\Exception - - + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + string - - mixed - - - array - - - \ArangoDBClient\Document + + \ArangoDBClient\DocumentClassable - $collection + $class string - - $documentId - - mixed - - - $options - array() - array - - \ArangoDBClient\DocumentHandler + \ArangoDBClient\DocumentClassable - - has - \ArangoDBClient\DocumentHandler::has() - - Check if a document exists - This will call self::get() internally and checks if there -was an exception thrown which represents an 404 request. - - \ArangoDBClient\Exception - - - string - - - mixed - - - boolean - - - - $collection - - string - - - $documentId - - mixed - - \ArangoDBClient\DocumentHandler - - - getById - \ArangoDBClient\DocumentHandler::getById() - - Get a single document from a collection - This will throw if the document cannot be fetched from the server. - - \ArangoDBClient\Exception - - - string + + eJylWdtuGzcQffdXTAyjkgLJTgu0D07k1lbV2EWaGLaCXhJDoHYpic2KuyW5ttUm/94Zci/cm2y3AtrIu+TM4XDmzCH16vtkneztHT1/vgfP4VQxuYp/PIPL80sIIsGlOQZ+n8TK4Gsa8UPCgk9sxQGKwRM7zr5kqVnHCt/Bz0zCteF8w6S0r4I42SqxWhuYFN++efH1t0MwSqBBqeH1ZnE+xNdRvJJ8CK+5wtlbnH20tyfZhmv0zWtuXxbYcV7EAyNi2YG4Ba8WMqClfHP4nXUTRExrmLrp/+zRQqx1+jyHiw09h4N5GAfpBm1M7PBlKq1bFgmzzcYe2X9TzeFHfyxbRBwR1+zO1hyCWMoMfbz4E79lL/MxP9wyhUvMB1XcJErcMsMRWGmly0sRIwoo4F55j7odb8Q9Dzt95gY6fKZK4fphwUywBi3+5tCX6WbBFcRLUFynkYE8ohofYD7wWx5CgiNUnMpwhE+SwVNxWX/X6K4Ja38ZMbMP+P8V9MUSNDeYhoj1r5SrbYZJw52IIlhwTFCOJkNgGhguYJNEHJhSbDsEGXvYWyEu4jjqQEgoYAxLFukWkD9FqV43MUpgiKqM11LFG4vd20izRsNMFbGPthDLKM9NENJOuFPC8BFbcxYClhz0fz19MygWvYlpD0xcs93TEDLDliLi+hD3V2jYsC0EDHM9t4+lL6QwgiFOHuHbzKEryyEsUuPcROQ6c1GuKBuNaGx4F1zIVW6a3wdRGiKwYtnOKKhUHsLF0j5alpFDeBg48mGjPKy50gZh1MJCfmlJFAOhkSFWVfxZehw+ebMJ1BiTKe2gAMx0rqItOfT3cpvwDpP0qmmqRIllY21oGAEXuAIFMsWwL7HsZVwdgY9w22xW496YNWb6Ptnfx8ch/bEUPAr1PsYi5PdPrUXfVRNxnDj6hEhshLHwskWMgDI/4YFA96GFksQaU+sWt9KmUMASuzdsg0xhiFEaiYRFoNGkiXN/9LA0esuilLctSEjTsRyHcwwvmmuZOBh2RZVYORtI0NrA9O3s6vf55N37tzO00gtoTq9p66xkzEcZPDudTc6vL/6YktGC/loMO2p5lM2f3ry/Pid7Nn9bbE2b6dZp7Gp6Pbu6mNhF5xNaTL5r5gNtWdk0ii3u9PTm4pcL68aaaPFx4QiKYluWdj0LzFrFd6QHAp54Xbd4nzDFNl5XhgOvjY8y5iweIAkhpyBPhjUDFAgsevoceJU/atB6XMWZz3dV6+YTObuvVPRub9xGV4OVpItIBIV2gfnchk+lgem3L2jogxtmTp2/MXy4cc3PaSaLxGBvGJ14kgSHHTQECn2wxvvP+v7SBUJhKM1wr0tZNxh45mvBOkdqiDA5xiD5nTcne95vohm87LKVPxq3OBidrLjxoXpmvrSsvbBZMeat/egIgjUPPlEQ7jhWBdzF6hOlg2NhFLPhqpIFlrxNwxeRNXlpuLaQZ/i2P6jFHLsbLYa28IPm0fL42Kv5m0a4ESr1UoZNfclItHnMWQOTN7su237QHgWpoLYmrMwnzjvLKW+3gSc7t2TS6bjoBn1sGIOWJbvpT/aak+XNAL76quJY6Lmtvp2TihkN2JW+37ZHhREvX3K0zzK4vpEPPUq+HgL9/LkygT7PhMzRts0ZwoceHsJI1PWG0Mv0HT0noTSomKuvhD6YlJiGIqTG7Ns/LHWT97GE7ijCHgILZu/3LqS1U1VFtqgw3a2cRfFbI40vj42PE0+dEdLtESpm/fcoOBP/Ow7OzOMjgXjolOIstRZNPQmrCrHFbL1UnO6YWG1XksvpjjrNjlt9Eul5nXZaqdP6l4aCuOImVbLe5NvP0MqNnexQB5WJueCMDT6j007eppHKSyP9es/N3DSb3cuONUzveZCaHRLIHvCs0FblcvPzsT0Pu9gd5kd9UtoBk+6kmskdEi541FQs85TNb5ygOuRWET5/s3aKGe6W1YhPoVYq+dFoTzA+qXayYef4TMOfWLYqRt3UGm1urNDkcAIvGmm6o2d5jd271igztNWb60uP8uRalOfFzt1RhzlhtVRzs/66G4zn8UECOKiqqYbOeVkNwoNqsltMVsWa1U9v2cbqpzZcqYrctzG8V9E5jxKOXMKShMvwkgS6xsd9/E8fH7+/ejOf/nb57mpGjc+7VrE5V/7tqxTixgSjUpV3eWmPTvBEjKSIKIb56xpLjE7+1LGccxnEIZ/fKYKmHI0OfE2YlRm1Bb/UWsTzsARlvf2syU/Fv53qTnK6Pxh0MdA13c4gJ3i3g/l5r4OQKmORnapHw5yb3GHLKCb1kitVnrkEUq3E8z9Xt5X7RXt7xPK7Y+LeMA24hk2seOPASTdssoZ7iBwHgb0qtPeE1sFIi7C8gViz4uiG9m/xlYPPwlBkR94ObqRlt1gkpsVlsgCREtEutq6t2KbuThA6XWj+V0p/n89ml+gA/9Dd7FsTBO1HXlS6cGDlPzYybzta71KytLqNRe16qMbaVQVvTdUJPFNYc/Sfj0BFlStvB+jVuMl4O/SOd8mi13EahTagxTUTLZWvuOp1FH+D2ccVNF1p//qJaZ8HkQI/artS9yPfHt6VH94HlEOtyXSKn+LKECsvS8nqZUMdvxs9Kme13k1kF20V1VPlk3pjz35GqLf2LnlH75BwcynoCcThg/PPTq+nSOM0v8HpD06e/X45zZz7B/fqxF71B6ae/86bWBlUWrhpMnoWnnwzcTvtD11zlOdM9x3O42P7DM9gH/Mf5D5mv5gtProhVAP/Au9WPJE= + + + + ArangoDB PHP client: value validator + + + + + + + + ValueValidator + \ArangoDBClient\ValueValidator + + A simple validator for values to be stored in the database + + + + + + validate + \ArangoDBClient\ValueValidator::validate() + + Validate the value of a variable + Allowed value types are string, integer, double and boolean. Arrays are also allowed if they contain only one of the former types. + + \ArangoDBClient\ClientException - + mixed - - array - - - \ArangoDBClient\Document + + void - $collection - - string - - - $documentId + $value mixed - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - getHead - \ArangoDBClient\DocumentHandler::getHead() - - Gets information about a single documents from a collection - This will throw if the document cannot be fetched from the server - - \ArangoDBClient\Exception - - - string - - - mixed - - - boolean - - - string - - - array - + + eJyNVE1v2zAMvftX8FAgWZAlXY5Jg6XrhnY7FRiQU4CAdmhbqCwZktzUWPvfR8kfSYxgmAF/QHzie4+kfPe1zMsomk8mEUzg3qDK9Pdv8Pz0DIkUpNwSXlFW5J/igE4bxnnopsTkBTMC6Hc9hA0hiJXLteEY/EIFvx1RgUqFUKLL2ogsd/DQfy1uvyym4IzghMrCYxE/TTksdaZoCo9keHfNu+dRpLAgy9w0oF2dTIAVRSnPJEPKd7BhwWmICSyv0gGEApcTMAhjtDS0dsWYFSrxnm9ni6AnkWgtbH3ubV+hP5F3HuT4awJtiAJbU0+dAvInW44ltbgOfi+lPrK8BunqknWj8aqNUNmUZTvKyEzhoCveDagOEGstCdWMRRusGzxKq/nRJBOpZ68h0cohG9dK1vwISrwsrlFBpmGbDQRtXG700UJTiB9vCZVOaDVElWiwgEK8Md1NI/5zZ0J37Ria3RhylVHwqsWB4UchJQQ6r5iHR6iw8awYICyUXHY6tDnm4V1yLUTCRULHr7RSidfY044bRZ8CtumQv5hkLOy+KW2Hgfd3JtlznQcrqdQ4XPOVP19SFTtYr9fQrZ3IwljMexNtay7CTTVW/dpHNJSKvsEd4ZXsRWUdJDklL54ASFLBTbNd4wd83HbCJIc2IaCFG1vF22vS/WVJpsvlqag9dnUBPZP9H65abqG4eXy+eCL58EsKDRyK+Eeqs9K2U9OHmolSdBzO8Hj0sx2wWPAxCiNMjtr/xai19RExTTjre8aiHV+e+OUyxKYw2nU/sV3784h3l1Cf8S+uaaQg + + + + ArangoDB PHP client: graph handler + + + + + + + + + + \ArangoDBClient\Handler + GraphHandler + \ArangoDBClient\GraphHandler + + A handler that manages graphs. + + + + + + + ENTRY_GRAPH + \ArangoDBClient\GraphHandler::ENTRY_GRAPH + 'graph' + + documents array index + - - $collection - - string - - - $documentId - - mixed - - - $revision - null - string - - - $ifMatch - null - boolean - - \ArangoDBClient\DocumentHandler - - - createFromArrayWithContext - \ArangoDBClient\DocumentHandler::createFromArrayWithContext() - - Intermediate function to call the createFromArray function from the right context + + + OPTION_REVISION + \ArangoDBClient\GraphHandler::OPTION_REVISION + 'revision' + + conditional update of edges or vertices - - - - \ArangoDBClient\Document - - - \ArangoDBClient\ClientException - - - $data - - - - - $options - - - - \ArangoDBClient\DocumentHandler - - - store - \ArangoDBClient\DocumentHandler::store() - - Store a document to a collection - This is an alias/shortcut to save() and replace(). Instead of having to determine which of the 3 functions to use, -simply pass the document to store() and it will figure out which one to call. - -This will throw if the document cannot be saved or replaced. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document - - - mixed - - - array - - - mixed - - + + + OPTION_VERTICES + \ArangoDBClient\GraphHandler::OPTION_VERTICES + 'vertices' + + vertex parameter + - - $document - - \ArangoDBClient\Document - - - $collection - null - mixed - - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - - save - \ArangoDBClient\DocumentHandler::save() - - save a document to a collection - This will add the document to the collection and return the document's id - -This will throw if the document cannot be saved - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\Document - array - - - array - - - mixed - - + + + OPTION_EDGES + \ArangoDBClient\GraphHandler::OPTION_EDGES + 'edges' + + direction parameter + - - $collection - - mixed - - - $document - - \ArangoDBClient\Document|array - - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - - insert - \ArangoDBClient\DocumentHandler::insert() - - Insert a document into a collection - This is an alias for save(). + + + OPTION_KEY + \ArangoDBClient\GraphHandler::OPTION_KEY + '_key' + + direction parameter + + + + + OPTION_COLLECTION + \ArangoDBClient\GraphHandler::OPTION_COLLECTION + 'collection' + + collection parameter + + + + + OPTION_COLLECTIONS + \ArangoDBClient\GraphHandler::OPTION_COLLECTIONS + 'collections' + + collections parameter + + + + + KEY_FROM + \ArangoDBClient\GraphHandler::KEY_FROM + '_from' + + example parameter + + + + + KEY_TO + \ArangoDBClient\GraphHandler::KEY_TO + '_to' + + example parameter + + + + + OPTION_NAME + \ArangoDBClient\GraphHandler::OPTION_NAME + 'name' + + name parameter + + + + + OPTION_EDGE_DEFINITION + \ArangoDBClient\GraphHandler::OPTION_EDGE_DEFINITION + 'edgeDefinition' + + edge definition parameter + + + + + OPTION_EDGE_DEFINITIONS + \ArangoDBClient\GraphHandler::OPTION_EDGE_DEFINITIONS + 'edgeDefinitions' + + edge definitions parameter + + + + + OPTION_ORPHAN_COLLECTIONS + \ArangoDBClient\GraphHandler::OPTION_ORPHAN_COLLECTIONS + 'orphanCollections' + + orphan collection parameter + + + + + OPTION_DROP_COLLECTION + \ArangoDBClient\GraphHandler::OPTION_DROP_COLLECTION + 'dropCollection' + + drop collection + + + + + $cache + \ArangoDBClient\GraphHandler::cache + + + GraphHandler cache store + + + + + $cacheEnabled + \ArangoDBClient\GraphHandler::cacheEnabled + false + + + + + + + + $batchsize + \ArangoDBClient\GraphHandler::batchsize + + + batchsize + + + + + $count + \ArangoDBClient\GraphHandler::count + + + count + + + + + $limit + \ArangoDBClient\GraphHandler::limit + + + limit + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string + + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string + + + + + createGraph + \ArangoDBClient\GraphHandler::createGraph() + + Create a graph + This will create a graph using the given graph object and return an array of the created graph object's attributes.<br><br> + + \ArangoDBClient\Exception + + + \ArangoDBClient\Graph + + + array + + - $collection - - - - - $document + $graph - - - - $options - array() - array + \ArangoDBClient\Graph - \ArangoDBClient\DocumentHandler - - update - \ArangoDBClient\DocumentHandler::update() - - Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document. - Attention - The behavior of this method has changed since version 1.1 - -This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the document to-be-replaced is the same as the one given. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document + + getGraph + \ArangoDBClient\GraphHandler::getGraph() + + Get a graph + This will get a graph.<br><br> + + String - + array - - boolean + + \ArangoDBClient\Graph + false + + + \ArangoDBClient\ClientException + - $document + $graph - \ArangoDBClient\Document + String $options array() array - \ArangoDBClient\DocumentHandler - - updateById - \ArangoDBClient\DocumentHandler::updateById() - - Update an existing document in a collection, identified by collection id and document id -Attention - The behavior of this method has changed since version 1.1 - This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the document to-be-updated is the same as the one given. - - \ArangoDBClient\Exception - - - string - - - mixed - - - \ArangoDBClient\Document - - - array - - - boolean + + setBatchsize + \ArangoDBClient\GraphHandler::setBatchsize() + + Sets the batchsize for any method creating a cursor. + Will be reset after the cursor has been created. + + integer - $collection + $batchsize - string + integer + + + setCount + \ArangoDBClient\GraphHandler::setCount() + + Sets the count for any method creating a cursor. + Will be reset after the cursor has been created. + + integer + + - $documentId + $count - mixed + integer + + + setLimit + \ArangoDBClient\GraphHandler::setLimit() + + Sets the limit for any method creating a cursor. + Will be reset after the cursor has been created. + + integer + + - $document + $limit - \ArangoDBClient\Document - - - $options - array() - array + integer - \ArangoDBClient\DocumentHandler - - replace - \ArangoDBClient\DocumentHandler::replace() - - Replace an existing document in a collection, identified by the document itself - This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given. - + + properties + \ArangoDBClient\GraphHandler::properties() + + Get a graph's properties<br><br> + + \ArangoDBClient\Exception - - \ArangoDBClient\Document - - - array + + mixed - + boolean + - $document + $graph - \ArangoDBClient\Document - - - $options - array() - array + mixed - \ArangoDBClient\DocumentHandler - - replaceById - \ArangoDBClient\DocumentHandler::replaceById() - - Replace an existing document in a collection, identified by collection id and document id - This will update the document on the server - -This will throw if the document cannot be Replaced - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given. - + + dropGraph + \ArangoDBClient\GraphHandler::dropGraph() + + Drop a graph and remove all its vertices and edges, also drops vertex and edge collections<br><br> + + \ArangoDBClient\Exception - - mixed - - + mixed - - \ArangoDBClient\Document - - - array + + boolean - + boolean + - $collection - - mixed - - - $documentId + $graph mixed - $document - - \ArangoDBClient\Document - - - $options - array() - array + $dropCollections + true + boolean - \ArangoDBClient\DocumentHandler - - remove - \ArangoDBClient\DocumentHandler::remove() - - Remove a document from a collection, identified by the document itself - - + + addOrphanCollection + \ArangoDBClient\GraphHandler::addOrphanCollection() + + add an orphan collection to the graph. + This will add a further orphan collection to the graph.<br><br> + \ArangoDBClient\Exception - - \ArangoDBClient\Document + + mixed - - array + + string - - boolean + + \ArangoDBClient\Graph + - $document + $graph - \ArangoDBClient\Document + mixed - $options - array() - array + $orphanCollection + + string - \ArangoDBClient\DocumentHandler - - removeById - \ArangoDBClient\DocumentHandler::removeById() - - Remove a document from a collection, identified by the collection id and document id - - + + deleteOrphanCollection + \ArangoDBClient\GraphHandler::deleteOrphanCollection() + + deletes an orphan collection from the graph. + This will delete an orphan collection from the graph.<br><br> + \ArangoDBClient\Exception - - mixed - - - mixed - - + mixed - - array + + string - + boolean + + \ArangoDBClient\Graph + + - $collection + $graph mixed - $documentId + $orphanCollection - mixed - - - $revision - null - mixed + string - $options - array() - array + $dropCollection + false + boolean - \ArangoDBClient\DocumentHandler - - getDocumentId - \ArangoDBClient\DocumentHandler::getDocumentId() - - Helper function to get a document id from a document or a document id value - - - \ArangoDBClient\ClientException - - + + getVertexCollections + \ArangoDBClient\GraphHandler::getVertexCollections() + + gets all vertex collection from the graph. + This will get all vertex collection (orphans and used in edge definitions) from the graph.<br><br> + +If this method or any method that calls this method is used in batch mode and caching is off,<br> +then for each call, this method will make an out of batch API call to the db in order to get the appropriate collections.<br><br> + +If caching is on, then the GraphHandler will only call the DB API once for the chosen graph, and return data from cache for the following calls.<br> + mixed - - mixed + + array + + + array + + + \ArangoDBClient\ClientException@since - $document + $graph mixed - \ArangoDBClient\DocumentHandler + + $options + array() + array + - - getRevision - \ArangoDBClient\DocumentHandler::getRevision() - - Helper function to get a document id from a document or a document id value - - - \ArangoDBClient\ClientException + + addEdgeDefinition + \ArangoDBClient\GraphHandler::addEdgeDefinition() + + adds an edge definition to the graph. + This will add a further edge definition to the graph.<br><br> + + \ArangoDBClient\Exception - + mixed - - mixed + + \ArangoDBClient\EdgeDefinition + + + \ArangoDBClient\Graph + - $document + $graph mixed - \ArangoDBClient\DocumentHandler + + $edgeDefinition + + \ArangoDBClient\EdgeDefinition + - - createCollectionIfOptions - \ArangoDBClient\DocumentHandler::createCollectionIfOptions() - - - - - - array + + deleteEdgeDefinition + \ArangoDBClient\GraphHandler::deleteEdgeDefinition() + + deletes an edge definition from the graph. + This will delete an edge definition from the graph.<br><br> + + \ArangoDBClient\Exception + + + mixed + + + string + + + boolean + + + \ArangoDBClient\Graph + - $collection + $graph - + mixed - $options + $edgeDefinition - array + string - \ArangoDBClient\DocumentHandler - - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler - - - \ArangoDBClient\Connection - - - $connection - - \ArangoDBClient\Connection + $dropCollection + false + boolean - \ArangoDBClient\Handler - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object - - - \ArangoDBClient\Connection + + getEdgeCollections + \ArangoDBClient\GraphHandler::getEdgeCollections() + + gets all edge collections from the graph. + This will get all edge collections from the graph.<br><br> + +If this method or any method that calls this method is used in batch mode and caching is off,<br> +then for each call, this method will make an out of batch API call to the db in order to get the appropriate collections.<br><br> + +If caching is on, then the GraphHandler will only call the DB API once for the chosen graph, and return data from cache for the following calls.<br> + + \ArangoDBClient\Exception - - \ArangoDBClient\Handler - - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection - - - + mixed - - \ArangoDBClient\ClientException + + array + - $optionName + $graph - + mixed - \ArangoDBClient\Handler - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - - array + + replaceEdgeDefinition + \ArangoDBClient\GraphHandler::replaceEdgeDefinition() + + replaces an edge definition of the graph. + This will replace an edge definition in the graph.<br><br> + + \ArangoDBClient\Exception - - string + + mixed - - \ArangoDBClient\ClientException + + \ArangoDBClient\EdgeDefinition + + + \ArangoDBClient\Graph + - $body + $graph - array + mixed + + + $edgeDefinition + + \ArangoDBClient\EdgeDefinition - \ArangoDBClient\Handler - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array + + saveVertex + \ArangoDBClient\GraphHandler::saveVertex() + + save a vertex to a graph + This will add the vertex-document to the graph and return the vertex id + +This will throw if the vertex cannot be saved<br><br> + + \ArangoDBClient\Exception - - array + + mixed - - array + + mixed - - array + + string + + + string + - $options + $graph - array + mixed - $body + $document - array + mixed - $includeArray - array() - array + $collection + null + string - \ArangoDBClient\Handler - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name - - - \ArangoDBClient\ClientException + + getVertex + \ArangoDBClient\GraphHandler::getVertex() + + Get a single vertex from a graph + This will throw if the vertex cannot be fetched from the server<br><br> + + \ArangoDBClient\Exception + + + mixed - + mixed - + + array + + string + + \ArangoDBClient\Document + + - $value + $graph mixed - \ArangoDBClient\Handler - - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use - - - string - - - \ArangoDBClient\DocumentClassable - - - $class + $vertexId + mixed + + + $options + array() + array + + + $collection + null string - \ArangoDBClient\DocumentClassable - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use - - - string + + hasVertex + \ArangoDBClient\GraphHandler::hasVertex() + + Check if a vertex exists + This will call self::getVertex() internally and checks if there +was an exception thrown which represents an 404 request. + + \ArangoDBClient\Exception - - \ArangoDBClient\DocumentClassable + + mixed + + + mixed + + + boolean - $class + $graph - string + mixed + + + $vertexId + + mixed - \ArangoDBClient\DocumentClassable - - - No summary for method createCollectionIfOptions() - - eJztWltz2zYWfvevQD2elZSR7DZ9U2NvXFmxlXFij62k7TgeDURCFhoKZAnQtma3/73n4EKCEGVLzuZtOZNEAnFu37kCypt/Z/NsZ+fg1asd8ooc51TcpSe/ksuzSxIlnAnVJ3EaFQv4ROZUxAnLYSPufZvR6Cu9Y4SUZANNoV/SQs3THN6R91SQa8XYggoRvHoHdF/JB7rUTMnbKM2WOb+bKzIoP73+8afXXaJyDqKEJKeL6VkXXifpnWBdcspy4LsE6oOdHUEXTIJWLFDol8o+ZwNRc6oIkAJXSVgMf1uzjoX+2gutNhQzpqK5oyCzPF3AOiOS5fewBXYii4zlkksl8dWCpMLbsk9GCgAFWpmS6ZJwKQsu7nAHUtIsy9MMbFWMnI3HlyRnfxVMs0p9Lhu5QHIR4StCftr/USMUJVRKMgTdz6xR7FExEUtyYq216zv/2UE6jRo+r8ogkITmOQXFRcwe7csD/W+UCqnI8OP46o/JycXg0wf4eE0OSQuxaoEPAo4Gwk24DU9OhyUn2cAqSpOERYoD1BnNIQoUBtQKt4vL8eji42RwcX4+HOBH5FnRNun4SBdZwjbhOvz9+MPl+VCraai+jd+7q4sPyAxj7Ns4jS+Qj0obuEAsKfa4CZPPw6vx8HdkZGgamMU839wJJ6OrygclZQPXAVLlRaQIJYI9VEVIv3a73mqRuFlYHfai6nOPeF8gk6aMFJLFdR5GyayYJjwis0KY3ZNJ5BRoN3PvaDqTMJoDzbFs9n1Kf7s1EZ89NeeydySZcvk3wAxtt77U0/kLpmwLKJHo7xWIRgKgXrBYl41Sc7Azokmiy0aUM3j3DkLpWOdbuamsYKbYgprgW9UM7l5MFQ3X0gz5yJAiZ6rIhS415Zqa5+mDJKFt5p/hY8Q0qye9EdjxG1fzgVG5rbXrlgqFXtmbYPHQ8ELEWeCrNc8pVnWPoN8P5K4IKz0TuuZ9ASGvDYfmAElrjSR8RiS9Z+0OdADtJhZjo9AFbj8Ek6N/BU2a3bLgj0CMJnplsOfXRB4TCg0Heih0Gui8olhMywxybFwEgpvdJwJsMDbKBZM6NI7L3HHUpoyjEk8HhFb2v/cpj8OwaA6DcpdkppX53avfRwxxod3ZJJc14h5K3crWrrXAqQ8xcnMbxpDxIxahQNn27lA3sxgqGA4M9wCS8y/UwXka75PLhFGp6w6ptN5dHzlSczEhgcDbj71K/QCiMYQ0eeCQ8ZoUHedodQmo4gHQc1Hudsly3mlJwuO1rA0EEL21uIhgtEsVxgaKDqmdh9f61o9jP4jts30sW1a6uNWenil4poU1EwFcJCSCtadIvISpSCywvabk6SJi+C2D6sK0RfA9nf4JRqJR8EWHY2OSlSHqizNrNHFxnM7sUllNQqtWnjfZ0YXlDB2M9N9M86ONaRN+1DJFclDNU+g5vRYGIMQPt2Mwxs2SKSiNMDHvvzkARlsJfaBcvUvz66WIUJ4urEyDDZ0XDgggGcCEyM3ZIr2nCcDCcmrM1BHNoUdToZKlDl9gA8EqOHoFeMRcft3fBogRZgYkCzeWyYxFfMbR41qROg6QajGb0SJRWjAoAKWDg/+1YhgsWQaFJt4SloPsKMwwv/oCSpBEECBV+monVRXZHBz0oUGvrK+muorVKyomWBfTaNvq6md+2aEX9KsXUb4of44Cp7e5nFDbm63UTsfjriU8NwPUNpfwHD43Czh5FYO/d1bY6DEPqdoaIm9zfcs4bQN4tSlRZ7+nMrgnKWJms3UkLvX7dl19C3WX3NTW8aknjX4OjxzzO6aqOdeIaIcLgIId4387Ho0n1398HHS6q2JWC8JLxQyuhsfjYacm4rb81jBSh6JHM8syiFYDbY0BjnaIdeUV0PU4SQCwkYDzt/qUwRZo3j5RkScWSPIpT85YkuF4AvkLp2vjHlhuwx+w6dPVuT7Skn3SOmjB32tUKpnnTGagOqsioIZeu9M7ylIJIzBo0XVb/pSpmDARpTGbPOSoSW7G1k5N8SSNqEs5J0fzP7cvzhiNgdTTB7Pth5IwTLL1Q1LrBOoOVsUZHPdJKXiuBUAddrcoTo1WLaEqldGyFXXfSwTCA43HoTfuqmPWKMZMdCa2K2NqgeCn5cjO4KO4rRW4wdLX75sLitHJ7dp8vmL3XGohK2RXw8+3YRlDvX84DMMPpK5UsyeAPgWQYYbgAhoej0tAw/uqdQDXDZcf2UN7RhPJOg2npBU11w60p0y5Yzg0IXuBhsMOueP30BtrE9aLZseV4bEXjszbjI9kz2hkDhvEDXX2ygSwTZP7lXOQ5bxX3YVYRdyA5jq+vtFrUbFs7ZML4JsTSGHJpyDpM00KwKbFoWD+i7TSQrWaT1vhJPjUGLjZ9BDOgBtS4SA2sV3JJYrEcQxnMDTUvtMAutMsoQrAmhYKTrzkxENFx9oWI48VfyfSnJ1xmK/FccnZV0LOIV/mesP/Tvb6Yct4oFd5Igj+LcctTRN0Lz9Au37QHZrQ+t5zl5tMsNDWxwzJklnZve3dITFjRk3p9UTeBeGRZ1pJcOsV3Jd03+uy/QK16ZM1M1/aiWFBN2KPrF7gp1RFc9BKrfSwX92b1WLvym1J3Fy5rZ9vIB2wbLduQYYOac8G3T5rz7O91BTrOsmN5wAo44xGc2J7nPGjd3d/i0XXDB/hSK5Z39xWgG5xxdeIgUNKM96wGXExTQvxfZpSvSd9U0eqN6Sn2tELa1Fz5eFi+EztCUuK84Hx6POVC1vd2tvtuqugG/7fV+t9BfB8d2fhQLLWWxYEm901PA0w3hL+Xosw8ubb5Pp4843DzQsmm7WXWm6g2OhyS19sbTpRNIocLzOGYnfdrL2LoL3WsV/d4ZTbt5G19uUuxoGW87OWo2+SXyCjGo9svOapMrEc/Kbz/FF93Q87Zc9rxA07y89Vo3A/zm0r1IU7BLz+EX0CBysq27UfI/QLyI8v7j8ruF+6pl+8fZg6/wAr7LY+ - - - - ArangoDB PHP client: export - - - - - - - - Export - \ArangoDBClient\Export - - Collection export - - - - - - ENTRY_COUNT - \ArangoDBClient\Export::ENTRY_COUNT - 'count' - - Count option index - - - - - ENTRY_BATCHSIZE - \ArangoDBClient\Export::ENTRY_BATCHSIZE - 'batchSize' - - Batch size option index - - - - - ENTRY_FLUSH - \ArangoDBClient\Export::ENTRY_FLUSH - 'flush' - - Flush option index - - - - - ENTRY_RESTRICT - \ArangoDBClient\Export::ENTRY_RESTRICT - 'restrict' - - Export restrictions - - - - - ENTRY_LIMIT - \ArangoDBClient\Export::ENTRY_LIMIT - 'limit' - - Optional limit for the number of documents - - - - - $_connection - \ArangoDBClient\Export::_connection - - - The connection object - - - \ArangoDBClient\Connection + + replaceVertex + \ArangoDBClient\GraphHandler::replaceVertex() + + Replace an existing vertex in a graph, identified graph name and vertex id + This will update the vertex on the server + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced vertex is the same as the one given.<br><br> + + \ArangoDBClient\Exception - - - - $_collection - \ArangoDBClient\Export::_collection - - - The collection name or collection object - - + mixed - - - - $_batchSize - \ArangoDBClient\Export::_batchSize - - - The current batch size (number of result documents retrieved per round-trip) - - + mixed - - - - $_flat - \ArangoDBClient\Export::_flat - false - - "flat" flag (if set, the query results will be treated as a simple array, not documents) - - - boolean - - - - - $_flush - \ArangoDBClient\Export::_flush - true - - Flush flag (if set, then all documents from the collection that are currently only -in the write-ahead log (WAL) will be moved to the collection's datafiles. This may cause -an initial delay in the export, but will lead to the documents in the WAL not being -excluded from the export run. If the flush flag is set to false, the documents still -in the WAL may be missing in the export result. - - - boolean + + \ArangoDBClient\Document - - - - $_type - \ArangoDBClient\Export::_type - - - The underlying collection type - - - - - $_restrictions - \ArangoDBClient\Export::_restrictions - - - export restrictions - either null for no restrictions or an array with a "type" and a "fields" index - - + mixed - - - - $_limit - \ArangoDBClient\Export::_limit - 0 - - optional limit for export - if specified and positive, will cap the amount of documents in the cursor to -the specified value - - - integer - - - - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - - - + string - - - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - - - - string - - - - - __construct - \ArangoDBClient\Export::__construct() - - Initialize the export - - - \ArangoDBClient\Exception - - - \ArangoDBClient\Connection - - - string - - - array + + boolean + - $connection + $graph - \ArangoDBClient\Connection + mixed - $collection + $vertexId - string + mixed - $data + $document + + \ArangoDBClient\Document + + + $options array() - array + mixed + + + $collection + null + string - - getConnection - \ArangoDBClient\Export::getConnection() - - Return the connection object - - - \ArangoDBClient\Connection - - - - - execute - \ArangoDBClient\Export::execute() - - Execute the export - This will return the results as a Cursor. The cursor can then be used to iterate the results. - + + updateVertex + \ArangoDBClient\GraphHandler::updateVertex() + + Update an existing vertex in a graph, identified by graph name and vertex id + This will update the vertex on the server + +This will throw if the vertex cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed vertex-document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given.<br><br> + \ArangoDBClient\Exception - - \ArangoDBClient\ExportCursor + + mixed - - - - setBatchSize - \ArangoDBClient\Export::setBatchSize() - - Set the batch size for the export - The batch size is the number of results to be transferred -in one server round-trip. If an export produces more documents -than the batch size, it creates a server-side cursor that -provides the additional results. - -The server-side cursor can be accessed by the client with subsequent HTTP requests. - - \ArangoDBClient\ClientException + + mixed - - integer + + \ArangoDBClient\Document - - void + + mixed + + + string + + boolean + + - $value + $graph - integer + mixed + + + $vertexId + + mixed + + + $document + + \ArangoDBClient\Document + + + $options + array() + mixed + + + $collection + null + string - - getBatchSize - \ArangoDBClient\Export::getBatchSize() - - Get the batch size for the export + + removeVertex + \ArangoDBClient\GraphHandler::removeVertex() + + Remove a vertex from a graph, identified by the graph name and vertex id<br><br> - - integer + + \ArangoDBClient\Exception - - - - getCursorOptions - \ArangoDBClient\Export::getCursorOptions() - - Return an array of cursor options - - - array + + mixed - - - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use - - + + mixed + + + mixed + + + mixed + + string - - \ArangoDBClient\DocumentClassable + + boolean + - $class + $graph + mixed + + + $vertexId + + mixed + + + $revision + null + mixed + + + $options + array() + mixed + + + $collection + null string - \ArangoDBClient\DocumentClassable - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use - - + + saveEdge + \ArangoDBClient\GraphHandler::saveEdge() + + save an edge to a graph + This will save the edge to the graph and return the edges-document's id + +This will throw if the edge cannot be saved<br><br> + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + mixed + + + mixed + + string - - \ArangoDBClient\DocumentClassable + + mixed + - $class + $graph - string + mixed - \ArangoDBClient\DocumentClassable - - - eJylWdtuGzcQffdXTAyjkgLJTgu0D07k1lbV2EWaGLaCXhJDoHYpic2KuyW5ttUm/94Zci/cm2y3AtrIu+TM4XDmzCH16vtkneztHT1/vgfP4VQxuYp/PIPL80sIIsGlOQZ+n8TK4Gsa8UPCgk9sxQGKwRM7zr5kqVnHCt/Bz0zCteF8w6S0r4I42SqxWhuYFN++efH1t0MwSqBBqeH1ZnE+xNdRvJJ8CK+5wtlbnH20tyfZhmv0zWtuXxbYcV7EAyNi2YG4Ba8WMqClfHP4nXUTRExrmLrp/+zRQqx1+jyHiw09h4N5GAfpBm1M7PBlKq1bFgmzzcYe2X9TzeFHfyxbRBwR1+zO1hyCWMoMfbz4E79lL/MxP9wyhUvMB1XcJErcMsMRWGmly0sRIwoo4F55j7odb8Q9Dzt95gY6fKZK4fphwUywBi3+5tCX6WbBFcRLUFynkYE8ohofYD7wWx5CgiNUnMpwhE+SwVNxWX/X6K4Ja38ZMbMP+P8V9MUSNDeYhoj1r5SrbYZJw52IIlhwTFCOJkNgGhguYJNEHJhSbDsEGXvYWyEu4jjqQEgoYAxLFukWkD9FqV43MUpgiKqM11LFG4vd20izRsNMFbGPthDLKM9NENJOuFPC8BFbcxYClhz0fz19MygWvYlpD0xcs93TEDLDliLi+hD3V2jYsC0EDHM9t4+lL6QwgiFOHuHbzKEryyEsUuPcROQ6c1GuKBuNaGx4F1zIVW6a3wdRGiKwYtnOKKhUHsLF0j5alpFDeBg48mGjPKy50gZh1MJCfmlJFAOhkSFWVfxZehw+ebMJ1BiTKe2gAMx0rqItOfT3cpvwDpP0qmmqRIllY21oGAEXuAIFMsWwL7HsZVwdgY9w22xW496YNWb6Ptnfx8ch/bEUPAr1PsYi5PdPrUXfVRNxnDj6hEhshLHwskWMgDI/4YFA96GFksQaU+sWt9KmUMASuzdsg0xhiFEaiYRFoNGkiXN/9LA0esuilLctSEjTsRyHcwwvmmuZOBh2RZVYORtI0NrA9O3s6vf55N37tzO00gtoTq9p66xkzEcZPDudTc6vL/6YktGC/loMO2p5lM2f3ry/Pid7Nn9bbE2b6dZp7Gp6Pbu6mNhF5xNaTL5r5gNtWdk0ii3u9PTm4pcL68aaaPFx4QiKYluWdj0LzFrFd6QHAp54Xbd4nzDFNl5XhgOvjY8y5iweIAkhpyBPhjUDFAgsevoceJU/atB6XMWZz3dV6+YTObuvVPRub9xGV4OVpItIBIV2gfnchk+lgem3L2jogxtmTp2/MXy4cc3PaSaLxGBvGJ14kgSHHTQECn2wxvvP+v7SBUJhKM1wr0tZNxh45mvBOkdqiDA5xiD5nTcne95vohm87LKVPxq3OBidrLjxoXpmvrSsvbBZMeat/egIgjUPPlEQ7jhWBdzF6hOlg2NhFLPhqpIFlrxNwxeRNXlpuLaQZ/i2P6jFHLsbLYa28IPm0fL42Kv5m0a4ESr1UoZNfclItHnMWQOTN7su237QHgWpoLYmrMwnzjvLKW+3gSc7t2TS6bjoBn1sGIOWJbvpT/aak+XNAL76quJY6Lmtvp2TihkN2JW+37ZHhREvX3K0zzK4vpEPPUq+HgL9/LkygT7PhMzRts0ZwoceHsJI1PWG0Mv0HT0noTSomKuvhD6YlJiGIqTG7Ns/LHWT97GE7ijCHgILZu/3LqS1U1VFtqgw3a2cRfFbI40vj42PE0+dEdLtESpm/fcoOBP/Ow7OzOMjgXjolOIstRZNPQmrCrHFbL1UnO6YWG1XksvpjjrNjlt9Eul5nXZaqdP6l4aCuOImVbLe5NvP0MqNnexQB5WJueCMDT6j007eppHKSyP9es/N3DSb3cuONUzveZCaHRLIHvCs0FblcvPzsT0Pu9gd5kd9UtoBk+6kmskdEi541FQs85TNb5ygOuRWET5/s3aKGe6W1YhPoVYq+dFoTzA+qXayYef4TMOfWLYqRt3UGm1urNDkcAIvGmm6o2d5jd271igztNWb60uP8uRalOfFzt1RhzlhtVRzs/66G4zn8UECOKiqqYbOeVkNwoNqsltMVsWa1U9v2cbqpzZcqYrctzG8V9E5jxKOXMKShMvwkgS6xsd9/E8fH7+/ejOf/nb57mpGjc+7VrE5V/7tqxTixgSjUpV3eWmPTvBEjKSIKIb56xpLjE7+1LGccxnEIZ/fKYKmHI0OfE2YlRm1Bb/UWsTzsARlvf2syU/Fv53qTnK6Pxh0MdA13c4gJ3i3g/l5r4OQKmORnapHw5yb3GHLKCb1kitVnrkEUq3E8z9Xt5X7RXt7xPK7Y+LeMA24hk2seOPASTdssoZ7iBwHgb0qtPeE1sFIi7C8gViz4uiG9m/xlYPPwlBkR94ObqRlt1gkpsVlsgCREtEutq6t2KbuThA6XWj+V0p/n89ml+gA/9Dd7FsTBO1HXlS6cGDlPzYybzta71KytLqNRe16qMbaVQVvTdUJPFNYc/Sfj0BFlStvB+jVuMl4O/SOd8mi13EahTagxTUTLZWvuOp1FH+D2ccVNF1p//qJaZ8HkQI/artS9yPfHt6VH94HlEOtyXSKn+LKECsvS8nqZUMdvxs9Kme13k1kF20V1VPlk3pjz35GqLf2LnlH75BwcynoCcThg/PPTq+nSOM0v8HpD06e/X45zZz7B/fqxF71B6ae/86bWBlUWrhpMnoWnnwzcTvtD11zlOdM9x3O42P7DM9gH/Mf5D5mv5gtProhVAP/Au9WPJE= - - - - ArangoDB PHP client: graph handler - - - - - - - - - + + $from + + mixed + + + $to + + mixed + + + $label + null + mixed + + + $document + + mixed + + + $collection + null + string + + + + getEdge + \ArangoDBClient\GraphHandler::getEdge() + + Get a single edge from a graph + This will throw if the edge cannot be fetched from the server<br><br> + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + array + + + string + + + \ArangoDBClient\Document + + + + + $graph + + mixed + + + $edgeId + + mixed + + + $options + array() + array + + + $collection + null + string + + + + hasEdge + \ArangoDBClient\GraphHandler::hasEdge() + + Check if an edge exists + This will call self::getEdge() internally and checks if there +was an exception thrown which represents an 404 request. + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + boolean + + + + $graph + + mixed + + + $edgeId + + mixed + + + + replaceEdge + \ArangoDBClient\GraphHandler::replaceEdge() + + Replace an existing edge in a graph, identified graph name and edge id + This will replace the edge on the server + +This will throw if the edge cannot be Replaced + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced edge is the same as the one given.<br><br> + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + \ArangoDBClient\Edge + + + mixed + + + string + + + boolean + + + + + $graph + + mixed + + + $edgeId + + mixed + + + $label + + mixed + + + $document + + \ArangoDBClient\Edge + + + $options + array() + mixed + + + $collection + null + string + + + + updateEdge + \ArangoDBClient\GraphHandler::updateEdge() + + Update an existing edge in a graph, identified by graph name and edge id + This will update the edge on the server + +This will throw if the edge cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed edge-document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given.<br><br> + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + \ArangoDBClient\Edge + + + mixed + + + string + + + boolean + + + + + $graph + + mixed + + + $edgeId + + mixed + + + $label + + mixed + + + $document + + \ArangoDBClient\Edge + + + $options + array() + mixed + + + $collection + null + string + + + + removeEdge + \ArangoDBClient\GraphHandler::removeEdge() + + Remove a edge from a graph, identified by the graph name and edge id<br><br> + + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + mixed + + + string + + + boolean + + + + + $graph + + mixed + + + $edgeId + + mixed + + + $revision + null + mixed + + + $options + array() + mixed + + + $collection + null + string + + + + clearCache + \ArangoDBClient\GraphHandler::clearCache() + + Clears the GraphHandler's cache + + + \ArangoDBClient\GraphHandler + + + + + + getCacheEnabled + \ArangoDBClient\GraphHandler::getCacheEnabled() + + Checks if caching in enabled + + + boolean + + + + + setCacheEnabled + \ArangoDBClient\GraphHandler::setCacheEnabled() + + + + + boolean + + + \ArangoDBClient\GraphHandler + + + + + $useCache + + boolean + + + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection + + + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\Handler + + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + + + \ArangoDBClient\Handler + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + + mixed + + + \ArangoDBClient\ClientException + + + + $optionName + + + + \ArangoDBClient\Handler + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + + string + + + \ArangoDBClient\ClientException + + + + $body + + array + + \ArangoDBClient\Handler + + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array + + + array + + + array + + + array + + + + $options + + array + + + $body + + array + + + $includeArray + array() + array + + \ArangoDBClient\Handler + + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name + + + \ArangoDBClient\ClientException + + + mixed + + + string + + + + $value + + mixed + + \ArangoDBClient\Handler + + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + + No summary for method setCacheEnabled() + + eJztXe1T20iT/56/Yp4r6rG8Zchmaz+RwC0xTuJnk0AB2b0UoVyyNWBthOSTZAh3t//7dc+bZkYjW8I2GB67KhUjzfT0vHX/uqd7/OY/J+PJixcvf/rpBfmJHKR+fJUcviXHH47JKAppnO+Sq9SfjMnYj4OIplAKC/428Uff/StKiKrTZcXZS3+aj5MU3pF/+TE5zSm99uPYevUO6n0nn/w7RtR4EyVpCBXf+mlOo4y9HSWTuzS8Guekq7798vOrXzskh7JXNM7I++vhhw68jpKrmHbIe5pCq3eS4SyMR8guIa92foEnL1+8iP1rmkFHqNWH18V4yG6TfOznBOhBUxkfkWzHHgvHSMhWZZujyM+AU6z/QVCmP3IaBxkRf7/43xfIJGMAPz+RIBlNr4FgRvw09e9IGAf0h3j5kv0/SuIsJ73PZydfB+9PDo4/kD3SYky2oC8WOSgchHmYxH5EppPAzylJLgkNsGMw/jc0zcMRzRwNHB2f9Y8+D056f/RP4Qs2ktKbMANajnaQEP1BJn4Kw5zjJFcR/KN3ctbv9k6RoGzeQTAIUzpCxuvQ7B2+5wRZxxal9nvvK9IafKd3zhGNovq0ukcfP/a6Z2IAi7ozCWfNKJ+apF39pz/860lEZ9KFbg/enRx9Yn2/TJPrBeicHTEqeeKggRuxTgc/H3zqIRUs72IFppoE9DKMwybLZHDYe9f/3JczglQOFZH5zdSaGqud03JDrjky5MTIH40pyfIkpUY7kzTJYZppQLZYkTKZ3278VLzsxf4wgqLDJIkoiFijhWlGa7ciCe2RSz/KHI12U4qixefCUjyVL8/GYUZuwygiI6MYsBDGVyBsKbkKb2gsnibDv6BtAmySlObTNIavQhiC6MLSnExglG+BwMxBOwynOc123gzTffxncfJbPk6T24z0fozoBOfBfs8ml48T2eLkt4F/arJ2Ow5HoCOTCAQ58hPGlwmoH7YMBYu8fJ6QoWLXbkt2DnumHhoqRJ+R6TAKR+RyGnPRw2kyRj2d3TYrzbUKfrasdQdTeH7xWr0GvilMMPF47e39K5r3zBpem/gZ0mlrZF2kzy+AODzc3s9BNWY4JGfJAfbOaxct/v2i4I2NdgbfgCmDdEajy91dXQ6Yn719ojH8O4UWOtUEStuRE7DYn0Hg6OT4w4ElcQ0OjtIJQIduIYK9tqKmjfbWNI1EB8iXNMp2d7+cfOQ6XCuUAkwBEhRHM4etw1roJnHMaXvt7f1JkuUeUuvIIn9lSTyg8SgJ6OAW+JrQ1BPj29ZGfwvLCQ5UQ6yBf2VIWispepfRvB+DtAMA0Q88Vv9coI2Lc7bydnc5FukfXrjre0YxUA8dYtEpzXcFpRMBQGbyAYgFq6v6Yp9p03UQRbKrf5dEWcLmsqGad60Q0krsZeFCJmky0RqrbuLw5OjYghNYtzsLUgz9fDTOwv+xpXt4g2J4S712gZEpglpXLfYKathVovA6rKjCXjk0Hs3nqoyrokylVOdS+xSkP6gTIbaJENwMbehC2arFFQvZSiZcPm6TI/ENhPcE8Tv8j5VhBYyTKiHOFuD/MeVo65pvpqHwjf9na6D6kh8GhIt93tGO6IHqAAr4khZAwcNkzgcagWjY3R1OwyiAvz1LDnXIOadrbKE8vbOFfw0pBQ+YkNKlP0COHPWN6j/IYVuxiDEVUENV1RQH2DF+pQQriokhOW8NwuwzvW1dFABGljHE7jTKoYQQJlzDvgMczHUYa1SJnI6i3n5t06gUegYFt9ArSS1OskpYndKcQxC1lVGlA2C6E+uVAwXcFz4ZTdMsSXdk3T9xewE8gRZwj13mzPClohjYwhm8pRJqBDvuXRfGuSZIZq5caOatLOgVdUqLlS+nokd7hqQSA1E5Ekw8PcooOGRmeQS6WMjjZSt6znuwpyTtvB4z6fooPXaI/HKPP2Ihj5et6DHvwZ5SFBU91vQFwH0wUiboP6DZYmj/OvyBho5E+/x/pjZgJHywjphagZEJQRv7KKRBnbx3KC2pDNDcAkIn7K/MsF40E4XPA2ORhEw/pWBJsOI0TZNUUeWKYZ5aKEbDc1sC0IZ4ozoi+1FC9rzYXglku6VxHeVyeNT98glkIdkhrZcD7lJruZVNIYlrKJYKeVmCtI7VdIjIS5qi3Nq8Tm5g1mFaQtha0jnF3jHHEujaKEsYZMukx0u+1N03S1yPxec+K1OSZCsS9I+BFxHrwKJAIQAQh+nFAiVlhjuKIbE4yVFsIJGJQyyYi9+Pbv07EE/plHZ49aWtdGTAREClju2xhle+AxbFV9XV0YCLg2NmvyEVbuudW4g/azE71HpoUK7YQQGNwKCp2kQ4eFWIww8CnLiylSRgMkfqlXCeVYe5THEVzKPi3kf32k7l/bTQhhIlt2wLD4gi+85+wd6B3gMv0BavX7WHzBb5rvhlzq4A0rYXotgfNpsPqxsa7oxO4Rs5Pjg5YwcGvf8yVrXA/zOcRrqhvF8eAFXxYmErp6YvBlluN7WEuMyM6S2xrEZvi9s8n2iW+VfUa1cM/+KG0hM3kLigy9wiCw856ggtTqQWjWWKrNXIrMZCi8Mih9jS0QUeL1iKiLFbAAxUKsJAUyVggPnYBh0GL/6aZrlqb/bsLCIreZv1xWUJYcjt8QTlqKN7DUVryRFZgiC6dJ3RAzfI4ZJyYbFsIhw1pBup+xBS9wpdE2hHCSPpHjKX+X2dFDy+frldNs1AUoRx6Zi2XU8wkz7aI9Cm8JqYPhQWBjICLjKjEHyTzTK/FLkGTc+4wcNSlLFQIrm87GjtIScx89Gw8zYk2jGIsk5f+9+5mpnmKMU59YPjPisvsXEwxJaTNEC/TcIGCh/DboJNmIbocNdstxkd17mNO5xDpGQcEzO+kji6EzzA+8O3jKcERS32iAn1cZLJE9yOfnbL9gKbC37YLCtcAovJLTbPBnin2q9fYQ83+CyiNS3v+r1a55X9qGP4ggRJ2d7SPm8m+/IIwwdDe1dfhctrJAr3W/THKJoGQpGCMbqtoMCNH03pLhbkaj8hoqyGNFgAknA7JDAP/L18F/K1yOXMzkr6cEgvfSCeKffHm5fQqwqcYR7TCxxn6Yea8AN27B9MqukHxg1Oc1aHMswJLZ+WbA1A8HXZPmYfpX71KBFNWyCnHq6JdtGjf/4TBA5qokL/Wevooo2F/hFmA6w6q1w5JMHugAY3oOtvgR4/JpxF1Tk2bNCL7u/tCR+TxQErZnMhyrJe0etJDlpbGzbpECpzct7iy9/RU/xIXVyT1o295loaPLN6K7syk10HweZ81uCq/O0e/rZqr4I5xRVzV1pptV12tpBkoSfGs4oVtzVSgFY8qUK72gZlkKHrT2DE6SeEJXs6ne39MOvHb60yXmkQylSqhqECfcujvhP631Oa5R63lpzdfNiz5UWx/WqGh9W9hy1RKsWgfIUj7FT3dWVJmnslU+txhFxdObIAPTk2lmghFNFH3Zbq03XNpJSCRXGnc50fi1ixrffxrc+ksVQ3lRw0C6EvgrrNGEQ7Vk84rHAXW71cskfdZKNwEJnsPCkvEAZDuhw+Vp/cQZwLCu2GrvKN1+bRfOW28GjuKZ9DYaV+8qV4yd0iR4smLGUGpDTydSE0zz/u9I6XqOrn8GjPC4f58v3h9YTd8/CFoxQsdW09/eCy4sYN/uQEqnKD2wFCjb3g8whsvNuljq+9d/uRohN1R2ZDPSGSg8puy4eT/ZpxWsP36LBl59unZg8dtuhsv5td/f4xk/WA/MZftPEXrZm/aAl7rGa9sv9lnsfF1tEpnUT+yG316GlD1TpaUHAREIdYz8jnskJ/ixjHZ+pzKfWAtXsiTEav/Wg+mekmenFtDYjMx3wEGQMDcHhetiS6gHGb8hrb8jIRw/mr49eiLAnt3MaCqh66rwJy/FgkBCCTwTJSHgxptogkk+RU94mQXsVAymDsDnYE/8JUTx7kqMZbZPszq8k6/zejwEeWTyeJKdpQmcouuQ1ztKNSdPGgARRTR1wTPr3GAEiwdG7CQCWSVn+saEroFrvKQetqlXwWnAO3AQ6iZMa4qKBuPgbOP49n0BIyxMh3jMHZI/E0ih5MdCPhMBv4Yn8LlspQYyBfddl9PUpWms+1zctqqcW1Z1NwCRfZeDVI1MdpT4yUzWnpBIo/16V7VWSJ1rKbVFdkHY54gmLpvUWA8VxB5B/A/yvXCV61Rmgd6CuZbQPclHwnBDstq3VHqEJlj6qYMVdmufr5zzMiERxQWkyxfcMAK7TM8N2C7VLa3KoOYF6+5NoAPTgZyaZckOU47re0hdlcurOoQ8K8SBm7StSRJHMijZPvILhj4Veho++Ybholtzt6a11/ijzvkj5IBOozIeWru7FI/7ADDTN3OBdo8h4ZxgQI51wI7x2zC5T0A4nqmUF1jEWFBgBKaUgx8nzI3UFIFIawH3htZDg0qf3JOj70sxDL3mmMoITnqgMz3TqFPwuHA5X4aASLOs5ZtanIuuPDx1gPmRpizjDZYamciW5RMuZteKS65VX6LVRlN+rCJcHE1nwzUugNwkSQqidPylu6AantD+tKEV74nAuuistEjMrFLSDOqvb9H1bLCBGVf6FsK+q7WOOyOo2UJyXjTUaR0urMIzgPq81GVZcUJknPgshoCoXWEmdx5vsBsXAWW+XhZUhTq6J96QZ8ZsbI7s7HQm8mNQJEMWr1zXB/IIJN5fxmb14O95F1EasqY1H53U68jJG6PTNytE77VzHgtA8hIND4QNG1uMjGsDzGrMxyGn9ZDNGDAFgLn9bAswmJEj+ogV8PxTZtCFUVPiqQqly7zsjbx4CvqjDqAmSD/phE6HVtvWxp/Gp1kAOB2lidNsM8v9itR2GW6zBTJ4Y8sbobfPrc8Kl559gy4ae2gC4sN0kDd/zKgUct91BjG1AChrmmH2ep5FByIIkuomFcK8oDQX/AnpUZImUEwc4suZ+pkGxtpbIAXXLEzUC2vHlBkrn1uc9bOfDY4o/F5YYpneD9MOwe2pj8+vOv8ISdPZQkso08yJ940ornzAmPQ8QrHrja8BmhZIQ3zcwCKAU+WRydFOBkNjSxNYwI2pmpTsZ+VqVObC1Rds6CCaHBwFOG7opBhNkCBqESiLsokHdvKBPFlJWWcHVwYzkvSvc8sBUpfbo2L2XPLvLOzS9QTrir2T1DOLmgws0BJNqlaOLDw4eFVMDjRCYDofaM5AErEYXx+8LmSaQPsxE13vEx3qK2nnVswhPtNAd3H3ZNrplY4qFOsX4CY4XCdpvvThX3MGurUZjDHOJb9fqXZJLAsrvDSAYRLcb3lBcl3PSE71dRMmTfsavTqzGjV8hckRDWlkSRUSwhvJ7KzhyzPTZI6Q1P4cIGO9wU9XMfjF0qJA/KFEmMuQJ4shY3zKSJnSfbQ7otznWKkeG2bSa2NEsIi8UVsAte3KpOx5Zs4cy0cYrEeKQYT6+HJXtHwtVKl7ThqYeNzpdIUMlNXcOJeBml3L/SJiI2xcjRYxErW2KBefjHKLme+Hk4DKMwv8MrHBMWiAN8sql9tfOKT68K7mnXsM5q2mfKQpIrSZhEamFxBu0rzaGbrSy5xqXGy22HQYucS9eKWORhXNAJA8D2PPcQu4cWFysup6GVqbIX7Zr2lWKej6ZgXWx2McJidgU7I9xPMJjQo0t4nUM32M4GnN8CNJG3kLnPXz5+FMxxw685Q7d+mL9L0tO7eCS4Ei4vxgiakUkKeyCD97DN4jAzrjJWS1NsZPYdLxvz5alDEGbfCcUbnGWnlEjQmiaXkX8FEibg18tBJX6ptIyZQoGa6gZj/W5WWrbkYW1bF4hY7WVYYk6qrdqy6FkbS3dj6laQ2pi69zN1iwXNVvjgmqZX1DNP4ovfs9jnCsA86zfWJF5OriZUOAUFkurHPF7bM6dSEOpYceP4aWmikGeBOmxjTt0rATfF/p8H/bPB6dfPXevCc9YCVzIt/td9WzjpHX886PYGx0cf+92vbXN2L9Rf5vFQX/OYzlXWsETQmARhb51qSEvdOWEXRtScOeyqSfscTh0V2BYQtof7mm0QVd+5NvlCOJ81YorDglTlemU5hzW6W5I4zfiYTXx2vM0jHGVW+ZJqZ0uIu+6bHog2in5auavqwc/IbHeWcfOjbRp/4VC2vmU8vFu1cVz3NM20px7StLbtu5Va2MV58cbG1mzsCfNr2TPBHZ2goHI/jPkYFcdsfLXiBGUrNMmXbzivne35ndLJZ1C0bsMT10Y6hdbVb9GhOcmTSJWQ0WYlFOEgsGlyEfMRpto8oUo3T0iZbe8hFzqdW/RRix3P4P0jmdTyJ9k21vRaWNN8Op6kMa0Kb2zpjS29saUXtqWl3mLWNLTAxM2KTO4vx4cHZ+tucRtzszG4l2Jwi9iMh7WmG9rT2pzP+VkOBrPrmNMl94LrJ+r2Kn/Lg5USoGJP/pRcYU6rIosEjdaxh0/E74W4oj5tO7jIvinbwk8sprOGLSaJKDFh3oLqsmSN1Bxxx0kF1bU6/JyPqJtEpq6L+bbsg0PYKKCO1sjMWZNg2Ic3cfjt+tUmjq7aUV9vDJyNgfOcDJyNUVKTkcPex14zo6QexF8Y3i/3GpWG6Pl+0HnxX+GysSfPDBc3TtRIDGfl1QUOs9LB2S/dbWuBUHUTw/kdVU8gLZzhdEkOOW/hk5ZQ4hWVYMiIWSlP5lSJfMCesoonoWobeOZvFIaBgasgUTrKwLJ2sGBlIrtYHo+cx14P+fAey4R0vpbunY6Od4gU4AZnFy3SpCPnREKb9clTrwUjrOtv+FMdRFTczvV6JhkLQFhvXfDBSeBxwIO7LzWhg1W5nme09q0CjLqVTaKeWVNiXCagCtW9SEBnrVDAbKmX2DKcIl6Ll2rJneFG3EYdZMZje6oy+OAs8WC3lS60sT/zIk20y6l+730dvDs5+sQgAbZdXezs6ILTzpPXS0UK4hafR0i/bxJuwiSnHF4t3ASf1ww2waLnKEqaBZqUqj1mIjYbhuZp2BaGeUpJ2Mh6PxDkWD/umX7d+PeJNqnXcxtfT2+TOs7W73aTzyrWfkM0JkCJeY3b08m25twuxackSC3Jo7SBgvVYWSkUXFZudQlZqOXy0HnV9dFDvazqmhhYJVPPgr74rlkatbB/G2VRM2n1jHKol5BBLZDFSvKnXcrhcXKnnZxs8qYXyZvmKLRW1rQArJWbVF6yq3DKPaLCLXAvOH6MoPCHiQbnY7rySPCHMGQaxBwYXteyoxXrt1pW3R5Xe6a71YTDNYLA69lTm6iEtYlKWMt05jW1FR8sldltLvJt3eE79clFX2/MyI0Zaa2UTax10UIWRnjUzP+S/XOU4767E3qTtVYe/mClQZvNrCwoe2tM/QDUOhNkprhY61htfWo0T0CpuOgelL/cvkarCUpD8dZ/tMiOxukOPll+QLcWjlp8GoRuN+zxPXtbJyMb9mM/Btsn5zm5nqValngIaDq7HsTP1TjOppGLrEHKd0dN4TM8jbtnxvcsm76c7z3PrNeyvZdk1T9eprcZmvNc8ryfq3XPc8LNOVtmRnhzZ8CzttmfVxr4c08C/7f1QfCp2Lggis/GBbFxQfwbuCAeL937gTwLmwvWHj/fe6WmOXmgKJRnlEMurHOVQy6tcvdkLNm2VtnjpVDVGrnjwnB6jhaeM2e8ZBDLNKZ7JotvzmTX9Ux2kym+LrYQzxSvsIWeaJb4xgraWEHWSvl7Y7jcLyV8huGiz+OTywhf1SmVqrl4Njj+p0c8A1BJub+aSc4PABEjmrYy0JajsYxWtjUI42OmBhgh3S6S8Gy5LTrB6AvR7kjiwkKVTKuQaiSC+hS0O42Z0p6h8+bFFOOwIlM9TqnEuM6a4F8UrWJUKH2JB7dAw3cXGtbMYlFRnDXIojBuAFl8zoBDT0YYSj/wo9DPPH1l7O6yN4AAvwGU8a9onH0TrvfhN2MJwUr8f9uEO8k= + + + + ArangoDB PHP client: streaming transaction collection + + + + + + + \ArangoDBClient\Collection + StreamingTransactionCollection + \ArangoDBClient\StreamingTransactionCollection + + Streaming transaction collection object + <br> + + + + + + ENTRY_ID + \ArangoDBClient\Collection::ENTRY_ID + 'id' + + Collection id index + + + + + ENTRY_NAME + \ArangoDBClient\Collection::ENTRY_NAME + 'name' + + Collection name index + + + + + ENTRY_TYPE + \ArangoDBClient\Collection::ENTRY_TYPE + 'type' + + Collection type index + + + + + ENTRY_WAIT_SYNC + \ArangoDBClient\Collection::ENTRY_WAIT_SYNC + 'waitForSync' + + Collection 'waitForSync' index + + + + + ENTRY_JOURNAL_SIZE + \ArangoDBClient\Collection::ENTRY_JOURNAL_SIZE + 'journalSize' + + Collection 'journalSize' index + + + + + ENTRY_STATUS + \ArangoDBClient\Collection::ENTRY_STATUS + 'status' + + Collection 'status' index + + + + + ENTRY_KEY_OPTIONS + \ArangoDBClient\Collection::ENTRY_KEY_OPTIONS + 'keyOptions' + + Collection 'keyOptions' index + + + + + ENTRY_IS_SYSTEM + \ArangoDBClient\Collection::ENTRY_IS_SYSTEM + 'isSystem' + + Collection 'isSystem' index + + + + + ENTRY_IS_VOLATILE + \ArangoDBClient\Collection::ENTRY_IS_VOLATILE + 'isVolatile' + + Collection 'isVolatile' index + + + + + ENTRY_DISTRIBUTE_SHARDS_LIKE + \ArangoDBClient\Collection::ENTRY_DISTRIBUTE_SHARDS_LIKE + 'distributeShardsLike' + + Collection 'distributeShardsLike' index + + + + + ENTRY_NUMBER_OF_SHARDS + \ArangoDBClient\Collection::ENTRY_NUMBER_OF_SHARDS + 'numberOfShards' + + Collection 'numberOfShards' index + + + + + ENTRY_REPLICATION_FACTOR + \ArangoDBClient\Collection::ENTRY_REPLICATION_FACTOR + 'replicationFactor' + + Collection 'replicationFactor' index + + + + + ENTRY_MIN_REPLICATION_FACTOR + \ArangoDBClient\Collection::ENTRY_MIN_REPLICATION_FACTOR + 'minReplicationFactor' + + Collection 'minReplicationFactor' index + + + + + ENTRY_SHARDING_STRATEGY + \ArangoDBClient\Collection::ENTRY_SHARDING_STRATEGY + 'shardingStrategy' + + Collection 'shardingStrategy' index + + + + + ENTRY_SHARD_KEYS + \ArangoDBClient\Collection::ENTRY_SHARD_KEYS + 'shardKeys' + + Collection 'shardKeys' index + + + + + ENTRY_SMART_JOIN_ATTRIBUTE + \ArangoDBClient\Collection::ENTRY_SMART_JOIN_ATTRIBUTE + 'smartJoinAttribute' + + Collection 'smartJoinAttribute' index + + + + + OPTION_PROPERTIES + \ArangoDBClient\Collection::OPTION_PROPERTIES + 'properties' + + properties option + + + + + TYPE_DOCUMENT + \ArangoDBClient\Collection::TYPE_DOCUMENT + 2 + + document collection type + + + + + TYPE_EDGE + \ArangoDBClient\Collection::TYPE_EDGE + 3 + + edge collection type + + + + + STATUS_NEW_BORN + \ArangoDBClient\Collection::STATUS_NEW_BORN + 1 + + New born collection + + + + + STATUS_UNLOADED + \ArangoDBClient\Collection::STATUS_UNLOADED + 2 + + Unloaded collection + + + + + STATUS_LOADED + \ArangoDBClient\Collection::STATUS_LOADED + 3 + + Loaded collection + + + + + STATUS_BEING_UNLOADED + \ArangoDBClient\Collection::STATUS_BEING_UNLOADED + 4 + + Collection being unloaded + + + + + STATUS_DELETED + \ArangoDBClient\Collection::STATUS_DELETED + 5 + + Deleted collection + + + + + $_trx + \ArangoDBClient\StreamingTransactionCollection::_trx + + + The transaction - assigned on construction + + + \ArangoDBClient\StreamingTransaction + + + + + $_name + \ArangoDBClient\StreamingTransactionCollection::_name + + + Collection name - assigned on construction + + + string + + + + + + $_mode + \ArangoDBClient\StreamingTransactionCollection::_mode + + + Lock mode for this collection, i.e. 'read', 'write' or 'exclusive' + + + string + + + + + $_id + \ArangoDBClient\Collection::_id + + + The collection id (might be NULL for new collections) + + + mixed + + + + + $_name + \ArangoDBClient\Collection::_name + + + The collection name (might be NULL for new collections) + + + string + + + + + $_type + \ArangoDBClient\Collection::_type + + + The collection type (might be NULL for new collections) + + + integer + + + + + $_waitForSync + \ArangoDBClient\Collection::_waitForSync + + + The collection waitForSync value (might be NULL for new collections) + + + boolean + + + + + $_journalSize + \ArangoDBClient\Collection::_journalSize + + + The collection journalSize value (might be NULL for new collections) + + + integer + + + + + $_isSystem + \ArangoDBClient\Collection::_isSystem + + + The collection isSystem value (might be NULL for new collections) + + + boolean + + + + + $_isVolatile + \ArangoDBClient\Collection::_isVolatile + + + The collection isVolatile value (might be NULL for new collections) + + + boolean + + + + + $_distributeShardsLike + \ArangoDBClient\Collection::_distributeShardsLike + + + The distributeShardsLike value (might be NULL for new collections) + + + mixed + + + + + $_numberOfShards + \ArangoDBClient\Collection::_numberOfShards + + + The collection numberOfShards value (might be NULL for new collections) + + + mixed + + + + + $_replicationFactor + \ArangoDBClient\Collection::_replicationFactor + + + The replicationFactor value (might be NULL for new collections) + + + mixed + + + + + $_minReplicationFactor + \ArangoDBClient\Collection::_minReplicationFactor + + + The minimum replicationFactor value for writes to be successful + + + mixed + + + + + $_shardingStrategy + \ArangoDBClient\Collection::_shardingStrategy + + + The shardingStrategy value (might be NULL for new collections) + + + mixed + + + + + $_shardKeys + \ArangoDBClient\Collection::_shardKeys + + + The collection shardKeys value (might be NULL for new collections) + + + array + + + + + $_smartJoinAttribute + \ArangoDBClient\Collection::_smartJoinAttribute + + + The smartJoinAttribute value (might be NULL for new collections) + + + mixed + + + + + $_status + \ArangoDBClient\Collection::_status + + + The collection status value + + + integer + + + + + $_keyOptions + \ArangoDBClient\Collection::_keyOptions + + + The collection keyOptions value + + + array + + + + + __construct + \ArangoDBClient\StreamingTransactionCollection::__construct() + + Constructs a streaming transaction collection object + + + \ArangoDBClient\StreamingTransaction + + + string + + + string + + + + + $trx + + \ArangoDBClient\StreamingTransaction + + + $name + + string + + + $mode + + string + + + + __toString + \ArangoDBClient\StreamingTransactionCollection::__toString() + + Return the name of the collection + Returns the collection as JSON-encoded string + + + string + + + + + + getName + \ArangoDBClient\StreamingTransactionCollection::getName() + + Return the name of the collection + + + string + + + + + + getMode + \ArangoDBClient\StreamingTransactionCollection::getMode() + + Return the lock mode of the collection + + + string + + + + + getTrxId + \ArangoDBClient\StreamingTransactionCollection::getTrxId() + + Return the transaction's id + + + string + + + + + __construct + \ArangoDBClient\Collection::__construct() + + Constructs an empty collection + + + string + + + \ArangoDBClient\ClientException + + + + $name + null + string + + \ArangoDBClient\Collection + + + createFromArray + \ArangoDBClient\Collection::createFromArray() + + Factory method to construct a new collection + + + \ArangoDBClient\ClientException + + + array + + + \ArangoDBClient\Collection + + + + $values + + array + + \ArangoDBClient\Collection + + + getDefaultType + \ArangoDBClient\Collection::getDefaultType() + + Get the default collection type + + + string + + + \ArangoDBClient\Collection + + + __clone + \ArangoDBClient\Collection::__clone() + + Clone a collection + Returns the clone + + + void + + + \ArangoDBClient\Collection + + + __toString + \ArangoDBClient\Collection::__toString() + + Get a string representation of the collection + Returns the collection as JSON-encoded string + + + string + + + \ArangoDBClient\Collection + + + toJson + \ArangoDBClient\Collection::toJson() + + Returns the collection as JSON-encoded string + + + string + + + \ArangoDBClient\Collection + + + toSerialized + \ArangoDBClient\Collection::toSerialized() + + Returns the collection as a serialized string + + + string + + + \ArangoDBClient\Collection + + + getAll + \ArangoDBClient\Collection::getAll() + + Get all collection attributes + + + array + + + \ArangoDBClient\Collection + + + set + \ArangoDBClient\Collection::set() + + Set a collection attribute + The key (attribute name) must be a string. + +This will validate the value of the attribute and might throw an +exception if the value is invalid. + + \ArangoDBClient\ClientException + + + string + + + mixed + + + void + + + + $key + + string + + + $value + + mixed + + \ArangoDBClient\Collection + + + setId + \ArangoDBClient\Collection::setId() + + Set the collection id + This will throw if the id of an existing collection gets updated to some other id + + \ArangoDBClient\ClientException + + + mixed + + + boolean + + + + $id + + mixed + + \ArangoDBClient\Collection + + + getId + \ArangoDBClient\Collection::getId() + + Get the collection id (if already known) + Collection ids are generated on the server only. + +Collection ids are numeric but might be bigger than PHP_INT_MAX. +To reliably store a collection id elsewhere, a PHP string should be used + + mixed + + + \ArangoDBClient\Collection + + + setName + \ArangoDBClient\Collection::setName() + + Set the collection name + + + \ArangoDBClient\ClientException + + + string + + + void + + + + $name + + string + + \ArangoDBClient\Collection + + + getName + \ArangoDBClient\Collection::getName() + + Get the collection name (if already known) + + + string + + + \ArangoDBClient\Collection + + + setType + \ArangoDBClient\Collection::setType() + + Set the collection type. + This is useful before a collection is create() 'ed in order to set a different type than the normal one. +For example this must be set to 3 in order to create an edge-collection. + + \ArangoDBClient\ClientException + + + integer + + + void + + + + $type + + integer + + \ArangoDBClient\Collection + + + getType + \ArangoDBClient\Collection::getType() + + Get the collection type (if already known) + + + string + + + \ArangoDBClient\Collection + + + setStatus + \ArangoDBClient\Collection::setStatus() + + Set the collection status. + This is useful before a collection is create()'ed in order to set a status. + + \ArangoDBClient\ClientException + + + integer + + + void + + + + $status + + integer + + \ArangoDBClient\Collection + + + getStatus + \ArangoDBClient\Collection::getStatus() + + Get the collection status (if already known) + + + integer + + + \ArangoDBClient\Collection + + + setKeyOptions + \ArangoDBClient\Collection::setKeyOptions() + + Set the collection key options. + + + \ArangoDBClient\ClientException + + + array + + + void + + + + $keyOptions + + array + + \ArangoDBClient\Collection + + + getKeyOptions + \ArangoDBClient\Collection::getKeyOptions() + + Get the collection key options (if already known) + + + array + + + \ArangoDBClient\Collection + + + setWaitForSync + \ArangoDBClient\Collection::setWaitForSync() + + Set the waitForSync value + + + boolean + + + void + + + + $value + + boolean + + \ArangoDBClient\Collection + + + getWaitForSync + \ArangoDBClient\Collection::getWaitForSync() + + Get the waitForSync value (if already known) + + + boolean + + + \ArangoDBClient\Collection + + + setJournalSize + \ArangoDBClient\Collection::setJournalSize() + + Set the journalSize value + + + integer + + + void + + + + $value + + integer + + \ArangoDBClient\Collection + + + getJournalSize + \ArangoDBClient\Collection::getJournalSize() + + Get the journalSize value (if already known) + + + integer + + + \ArangoDBClient\Collection + + + setIsSystem + \ArangoDBClient\Collection::setIsSystem() + + Set the isSystem value + + + boolean + + + void + + + + $value + + boolean + + \ArangoDBClient\Collection + + + getIsSystem + \ArangoDBClient\Collection::getIsSystem() + + Get the isSystem value (if already known) + + + boolean + + + \ArangoDBClient\Collection + + + setIsVolatile + \ArangoDBClient\Collection::setIsVolatile() + + Set the isVolatile value + + + boolean + + + void + + + + $value + + boolean + + \ArangoDBClient\Collection + + + getIsVolatile + \ArangoDBClient\Collection::getIsVolatile() + + Get the isVolatile value (if already known) + + + boolean + + + \ArangoDBClient\Collection + + + setDistributeShardsLike + \ArangoDBClient\Collection::setDistributeShardsLike() + + Set the distribute shards like value + + + string + + + void + + + + $value + + string + + \ArangoDBClient\Collection + + + getDistributeShardsLike + \ArangoDBClient\Collection::getDistributeShardsLike() + + Get the distributeShardsLike (if already known) + + + mixed + + + \ArangoDBClient\Collection + + + setNumberOfShards + \ArangoDBClient\Collection::setNumberOfShards() + + Set the numberOfShards value + + + integer + + + void + + + + $value + + integer + + \ArangoDBClient\Collection + + + getNumberOfShards + \ArangoDBClient\Collection::getNumberOfShards() + + Get the numberOfShards value (if already known) + + + mixed + + + \ArangoDBClient\Collection + + + setReplicationFactor + \ArangoDBClient\Collection::setReplicationFactor() + + Set the replicationFactor value + + + mixed + + + void + + + + $value + + mixed + + \ArangoDBClient\Collection + + + getReplicationFactor + \ArangoDBClient\Collection::getReplicationFactor() + + Get the replicationFactor value (if already known) + + + mixed + + + \ArangoDBClient\Collection + + + setMinReplicationFactor + \ArangoDBClient\Collection::setMinReplicationFactor() + + Set the minReplicationFactor value + + + integer + + + void + + + + $value + + integer + + \ArangoDBClient\Collection + + + getMinReplicationFactor + \ArangoDBClient\Collection::getMinReplicationFactor() + + Get the minReplicationFactor value (if already known) + + + mixed + + + \ArangoDBClient\Collection + + + setShardingStrategy + \ArangoDBClient\Collection::setShardingStrategy() + + Set the shardingStrategy value + + + string + + + void + + + + $value + + string + + \ArangoDBClient\Collection + + + getShardingStrategy + \ArangoDBClient\Collection::getShardingStrategy() + + Get the sharding strategy value (if already known) + + + mixed + + + \ArangoDBClient\Collection + + + setShardKeys + \ArangoDBClient\Collection::setShardKeys() + + Set the shardKeys value + + + array + + + void + + + + $value + + array + + \ArangoDBClient\Collection + + + getShardKeys + \ArangoDBClient\Collection::getShardKeys() + + Get the shardKeys value (if already known) + + + array + + + \ArangoDBClient\Collection + + + setSmartJoinAttribute + \ArangoDBClient\Collection::setSmartJoinAttribute() + + Set the smart join attribute value + + + string + + + void + + + + $value + + string + + \ArangoDBClient\Collection + + + getSmartJoinAttribute + \ArangoDBClient\Collection::getSmartJoinAttribute() + + Get the smart join attribute value (if already known) + + + mixed + + + \ArangoDBClient\Collection + + + eJytVU2P2jAQvedXzGGlsChAP9RD2bLdlkq7rdpqVTgiIZOY4G5iR7ZDWVX97x072eCYr65KDmBlZp7fezOO370vVkUQDLrdALrwQRKeik8f4f7uHuKMUa6HoLSkJGc8BY1hRWLNBIdYZBm1Syw0tTcFiR9ISgEamLFFsEFS6pWQGIMvhMNEU5oTzm0oFsWjZOlKw7hZvXrx8m20pXObL+4iDGci5TSCWyqx+hGrB0HASU4V7k29ba8aVZMTAkAsfuLK17FHhWI8NgJf99/YzeOMKLXFn27hx1t0utGUJwqcV8HvwFhh+ZmnC9MVbbHrASIzVJuA5cqxC2Vtt614KrxZE7mXAUI4gHX6wP4Xkq2JpnAx13KDPnlcHKLG3GdywaCxuucabGAOMDChXQpfRfwAuUgoLHFq9IopBy4C1qd9CFFzEkYQ/pJM0xAwMaSbOCsVW9PwKLXsCf4AKRNCUrvG1NIVkJPHopmqNo+CSJLvb9gFdgNM29qz4JXWIi5sa9rPIc/9UmusX9p4st/eaI+5tW3lImMxLEtebTyfNyPSOagzqgREFZlLC1QdCgQk0nx4hi6Qzb6sBwUQAkeidz23jlXPyOJeeQmOS6NqSz/DMWNUsaky/thffwR+UF1KbltkocXSrt2vYbvfOUlZ7L+UFcq/HZUde7WY2MJO2zaAGtbVflYt/0M7pfo75pyRczOwzyd+tllHVd8Q5pQqd6qOKHIOfaiAJadkuB+eJvsg0ancfE58ph5RPEG9a8w1iTVhCJCzvejmJGNEdZyjPBzaAPo1Q054aXI1q6/Nxez4tRgi/l+n73yn + + + + ArangoDB PHP client: admin document handler + + + + + + + + \ArangoDBClient\Handler - GraphHandler - \ArangoDBClient\GraphHandler - - A handler that manages graphs. - - - + AdminHandler + \ArangoDBClient\AdminHandler + + Provides access to ArangoDB's administration interface + The admin handler utilizes ArangoDB's Admin API. + + - - ENTRY_GRAPH - \ArangoDBClient\GraphHandler::ENTRY_GRAPH - 'graph' - + + OPTION_DETAILS + \ArangoDBClient\AdminHandler::OPTION_DETAILS + 'details' + + details for server version + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string + + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string + + + + + getEngine + \ArangoDBClient\AdminHandler::getEngine() + + Get the server's storage engine + This will throw if the engine data cannot be retrieved + + \ArangoDBClient\Exception + + + mixed + + + + + + getServerVersion + \ArangoDBClient\AdminHandler::getServerVersion() + + Get the server version + This will throw if the version cannot be retrieved + + boolean + + + \ArangoDBClient\Exception + + + string + + + + + $details + false + boolean + + + + getServerRole + \ArangoDBClient\AdminHandler::getServerRole() + + Get the server role + This will throw if the role cannot be retrieved + + \ArangoDBClient\Exception + + + string + + + + + + getServerTime + \ArangoDBClient\AdminHandler::getServerTime() + + Get the server time + This will throw if the time cannot be retrieved + + \ArangoDBClient\Exception + + + double + + + + + + getServerLog + \ArangoDBClient\AdminHandler::getServerLog() + + Get the server log + This will throw if the log cannot be retrieved + + \ArangoDBClient\Exception + + + array + + + array + + + + + $options + array() + array + + + + reloadServerRouting + \ArangoDBClient\AdminHandler::reloadServerRouting() + + Reload the server's routing information +The call triggers a reload of the routing information from the _routing collection + This will throw if the routing cannot be reloaded + + \ArangoDBClient\Exception + + + boolean + + + + + + getServerStatistics + \ArangoDBClient\AdminHandler::getServerStatistics() + + Get the server statistics +Returns the statistics information. The returned objects contains the statistics figures, grouped together +according to the description returned by _admin/statistics-description. + For instance, to access a figure userTime from the group system, you first select the sub-object +describing the group stored in system and in that sub-object the value for userTime is stored in the +attribute of the same name.In case of a distribution, the returned object contains the total count in count +and the distribution list in counts. +For more information on the statistics returned, please lookup the statistics interface description at + + + \ArangoDBClient\Exception + + + array + + + + + + + getServerStatisticsDescription + \ArangoDBClient\AdminHandler::getServerStatisticsDescription() + + Returns a description of the statistics returned by getServerStatistics(). + The returned objects contains a list of statistics groups in the attribute groups +and a list of statistics figures in the attribute figures. +For more information on the statistics returned, please lookup the statistics interface description at + + + \ArangoDBClient\Exception + + + array + + + array + + + + + + $options + array() + array + + + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection + + + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\Handler + + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + + + \ArangoDBClient\Handler + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + + mixed + + + \ArangoDBClient\ClientException + + + + $optionName + + + + \ArangoDBClient\Handler + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + + string + + + \ArangoDBClient\ClientException + + + + $body + + array + + \ArangoDBClient\Handler + + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array + + + array + + + array + + + array + + + + $options + + array + + + $body + + array + + + $includeArray + array() + array + + \ArangoDBClient\Handler + + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name + + + \ArangoDBClient\ClientException + + + mixed + + + string + + + + $value + + mixed + + \ArangoDBClient\Handler + + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + eJzlWV9v2zgSf/enmIcAdgrHbtN9cppcvbGbeJHGge0ucGgLl5ZomxtJ1JJUGu+i331nSEqWZadxc7k9HNZAUUWc/7/hzJB68690mdZq7RcvavACuoolC9n7GW4ubyCIBE9MB1gYiwRCGWQx/g1LloQRV0hOHG9TFtyyBQcomM8tn11kmVlKhWvwC0tgbDiPWZJUlt4h3y28ZysrFN4GMl0psVgaOC+ejl++Om6CUQJVJRou4tllE5cjuUh4Ey64Qrkry61FEpA1AK9ax/imXaslLOYa7eQVE08Kv2+UvBMh18CCgGsNRhakde0CILRRzAiZgEgMV3MU50MwWXIfIx8ayIyIxB8oriSkaym6N4PWXpHb4UYQMe3lXHpF/N7wJNTg/679WSMO6xT9XkDIDRORhjmGWnN1hzz4T6MbnqJt/w9kog0MbyaD4fW01590B1djOIW6Z6+fWKqq8AtuwKDzTjD6qI1U5BFPFiLhniynniyFhq8iipBHya8g5pbZ0ULIDIMAk0MamHFQHLHmdzysCHlreTX07wOemrUbxToyZiqBWNzzEI4As07OfuOBAbcgkkVZq0gwMDErCcoj/5qiXopQms0iEcA8SwKbBAtu+lZG49DFxYWefgcKsw0DyjGCBwa9PjpD6nOZJNzyNg7ti8YHFelO58Poatq/vhhc9w9PChHei0KSZfhFE68j+lb7PhgVlB/BwBPvE/+UKRbDTMoIDvLkOoKJyjhtGrQSGMRScZ95CELuwxORxG1HoCGU+eNSRmGOY1GwNv3NUXz1OIpjG69fHXuj8OkU5izS/LCKbaYiXFtD1+29H1xPf+2Pxrh1TmoFIUa2EHZYErAp5JJHKVedDktT3Mc3FFuNrxtE0YSPxf6D0zMsfhn/XMqRb7UfzjgSW5JwYDcd/U4fSLW93MmTlaTtNK9M8LHukap/3jOTlYz2LCVE+Yw15PuZV7IOGry1aMGH617/He7jHnam4XDUG1x3J8NRE3o/j/sjzJDDSnIet17ul5wj1NHYmYkevGo6On3T0fCqf/I3JskmzhSZEsiPoGxEvCfKRPmMKIcSw84tyv6xjDIp04bF6VMLywQFbGP3wx3C4ToZvO8/BzTk1f7Q4JC1HzJI+BzAuBbDlGIrOJCWRLtW7t7JOeRvzZIZ7DRz6uW2AnCdReZIc9OpSH2Tng09E8Pu1HkzU2fFWiTO6llqZB3VuEghFXpHDuFAhm5oyFJqcIzeHUXoVtSCa2m4M6F4CXGmrfcSLZLzzps2yi7ZUFY5RywiaMPLTSJ85krhvNaGV1srX5mbYdpwvLVGwwwuvN5aCPksI5afNlfam+bUrQN1wBhAJGJhdAFqHgMMAL1C37SPeogjFGyF44t98wUhC+ELBfaLDXqcGTaLVji1BlGmxR1vbZlal/M5okdAgL4VqdU3FwqD6lZyW3awahy50fzCfsubZPEMcxhzxgGLFhNYJY+IbZc0w5Rx0Rg9kBI6C5bOYdQkVCF4BXiWSIyYC9SMO2WhODNkBA7sv2eIOWqNRLhLqbQ6SekYH3MACnO5wDcKmA5wXKA8wJ0XCuWqBqnClSbpwbNMiQRjIbR9RwccqVx5k7nZaEoJPKtTILBxKjUdiSDADZvQWUsEaDyyc7XLds5UsLTIDRNE2Zecqgt41MApohjEDR5hfHtttVoPJWi1aLtCUKoJ5Zp9x5SQGRpuUOwsM6gU4bc7t0OeNV3CNtfFvenMoHS1NknamCyWWUJpt4H5jM9puk0Zzv723NB6ame4kotGpcidwsfPj/T5hybGaqu4Gl40C8GHT54CfuhEUu0jIx5JFm4eEZXEwzFl5fbJi87RAe0xjPRigVMiYqacCJkPeFvMMFcytovTfDWQUeSc2Xds9Hyl1kVanzxS0OnoB7PCaczHPWvP9tTwAFy4TbdHhdHww2RwfTEd9a+GXZxI6/UdaNKRYt8pADeKEdqIQK/hdWXREhWrZXBaFtOi8LqTeFECtjjnYpFhfjWxYMosRQYj0dklXQs5jdXiZUuaEqkPoVczW8HU3se017KPSpTFjn2HhRLNMAwRatru7m5/mLcEMu0GuHWSWctAr7ThcRNWMvPNSXNKOedQNjtynuZ6nO5ZXp+8DIN1xLZPJ81WH5G4GryW4StahOdrusMpLBK6JAFpihDlRS/fM5ohNd2AtQZ0wNfcFcOQ7rOIEAPS9LPTBkybKLmSGNiKiArtQ6HSl82ySKyzek2pN0JurwfKW1gm1UzIbWlCGnGyOZLyNku3U83fxG0kAjPVfRmJ5BZgaUyqO+12KAPdYvbiIJy1Ahm3LyeTm3Z345avm4TvZSIwxAhbWyQhv28tTRztV1JKNj7fScU2i+qa5nRLWDSVcaG4t45I43CLyxel1/u1qrXUx46h+7an8aQ7GYwng/Nxk3re/6o/+bluI33kFoTlyrIzJq11Onyv3DG3K1BBSbitBtrv4tL2de/Le2wnu6+Z2/x+4Z+788ol///3WLrAaGURTrRmRaM11n/AYNmhlvoBgxIBmeAXmzgRZ8rR2KemTaGQrdw7enDdGc1kaBw1FM+7Y7b3yVS31yR5FhbtGoGMGXpHETIcDxM3UmtBVyl5dpJvlATrfYza/43dE3GxPtmxz98f42OevFULqzK2LY14sjD2FDKY2/78lSV0J21vjbB5CjKYMInZvYixpzmGYtdbCjxG2QzHIfS7ZrI7JiJGjm4MPWWOIFOKvpp5LnsawiDZ5ohbCDv7hhP/Wc1/xkJfbh//vVPKug1Me/3x+Whgv0D93QeXb/7b2pRFgulG+Qtbp2NXcH7+lH98/OS/Ocw+lQlpvP4LCNYG2Q== + + + + ArangoDB PHP client: document handler + + + + + + + + \ArangoDBClient\DocumentHandler + EdgeHandler + \ArangoDBClient\EdgeHandler + + A handler that manages edges + An edge-document handler that fetches edges from the server and +persists them on the server. It does so by issuing the +appropriate HTTP requests to the server. + + + + + + ENTRY_DOCUMENTS + \ArangoDBClient\EdgeHandler::ENTRY_DOCUMENTS + 'edge' + documents array index + - - OPTION_REVISION - \ArangoDBClient\GraphHandler::OPTION_REVISION - 'revision' - - conditional update of edges or vertices + + ENTRY_EDGES + \ArangoDBClient\EdgeHandler::ENTRY_EDGES + 'edges' + + edges array index - - OPTION_VERTICES - \ArangoDBClient\GraphHandler::OPTION_VERTICES - 'vertices' - + + OPTION_COLLECTION + \ArangoDBClient\EdgeHandler::OPTION_COLLECTION + 'collection' + + collection parameter + + + + + + OPTION_EXAMPLE + \ArangoDBClient\EdgeHandler::OPTION_EXAMPLE + 'example' + + example parameter + + + + + + OPTION_FROM + \ArangoDBClient\EdgeHandler::OPTION_FROM + 'from' + + example parameter + + + + + OPTION_TO + \ArangoDBClient\EdgeHandler::OPTION_TO + 'to' + + example parameter + + + + + OPTION_VERTEX + \ArangoDBClient\EdgeHandler::OPTION_VERTEX + 'vertex' + vertex parameter - - OPTION_EDGES - \ArangoDBClient\GraphHandler::OPTION_EDGES - 'edges' - + + OPTION_DIRECTION + \ArangoDBClient\EdgeHandler::OPTION_DIRECTION + 'direction' + direction parameter - - OPTION_KEY - \ArangoDBClient\GraphHandler::OPTION_KEY - '_key' - - direction parameter + + ENTRY_DOCUMENTS + \ArangoDBClient\DocumentHandler::ENTRY_DOCUMENTS + 'documents' + + documents array index - + OPTION_COLLECTION - \ArangoDBClient\GraphHandler::OPTION_COLLECTION + \ArangoDBClient\DocumentHandler::OPTION_COLLECTION 'collection' - + collection parameter - - OPTION_COLLECTIONS - \ArangoDBClient\GraphHandler::OPTION_COLLECTIONS - 'collections' - - collections parameter + + OPTION_EXAMPLE + \ArangoDBClient\DocumentHandler::OPTION_EXAMPLE + 'example' + + example parameter + + + + + OPTION_OVERWRITE + \ArangoDBClient\DocumentHandler::OPTION_OVERWRITE + 'overwrite' + + overwrite option + + + + + OPTION_RETURN_OLD + \ArangoDBClient\DocumentHandler::OPTION_RETURN_OLD + 'returnOld' + + option for returning the old document + + + + + OPTION_RETURN_NEW + \ArangoDBClient\DocumentHandler::OPTION_RETURN_NEW + 'returnNew' + + option for returning the new document + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string + + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string + + + + + __construct + \ArangoDBClient\EdgeHandler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection + + + + $connection + + \ArangoDBClient\Connection + + + + createFromArrayWithContext + \ArangoDBClient\EdgeHandler::createFromArrayWithContext() + + Intermediate function to call the createFromArray function from the right context + + + + \ArangoDBClient\Edge + + + \ArangoDBClient\ClientException + + + + + $data + + + + + $options + + + + + + saveEdge + \ArangoDBClient\EdgeHandler::saveEdge() + + save an edge to an edge-collection + This will save the edge to the collection and return the edges-document's id + +This will throw if the document cannot be saved + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + mixed + + + array + + + mixed + + - - - KEY_FROM - \ArangoDBClient\GraphHandler::KEY_FROM - '_from' - - example parameter + + $collection + + mixed + + + $from + + mixed + + + $to + + mixed + + + $document + + mixed + + + $options + array() + array + + + + edges + \ArangoDBClient\EdgeHandler::edges() + + Get connected edges for a given vertex + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + string + + + array + + + array + + - - - KEY_TO - \ArangoDBClient\GraphHandler::KEY_TO - '_to' - - example parameter + + $collection + + mixed + + + $vertexHandle + + mixed + + + $direction + 'any' + string + + + $options + array() + array + + + + inEdges + \ArangoDBClient\EdgeHandler::inEdges() + + Get connected inbound edges for a given vertex + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + array + - - - OPTION_NAME - \ArangoDBClient\GraphHandler::OPTION_NAME - 'name' - - name parameter + + $collection + + mixed + + + $vertexHandle + + mixed + + + + outEdges + \ArangoDBClient\EdgeHandler::outEdges() + + Get connected outbound edges for a given vertex + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + array + - - - OPTION_EDGE_DEFINITION - \ArangoDBClient\GraphHandler::OPTION_EDGE_DEFINITION - 'edgeDefinition' - - edge definition parameter + + $collection + + mixed + + + $vertexHandle + + mixed + + + + lazyCreateCollection + \ArangoDBClient\EdgeHandler::lazyCreateCollection() + + + + + array + + - - - OPTION_EDGE_DEFINITIONS - \ArangoDBClient\GraphHandler::OPTION_EDGE_DEFINITIONS - 'edgeDefinitions' - - edge definitions parameter - + + $collection + + mixed + + + $options + + array + + + + get + \ArangoDBClient\DocumentHandler::get() + + Get a single document from a collection + Alias method for getById() + + \ArangoDBClient\Exception + + + string + + + mixed + + + array + + + \ArangoDBClient\Document + - - - OPTION_ORPHAN_COLLECTIONS - \ArangoDBClient\GraphHandler::OPTION_ORPHAN_COLLECTIONS - 'orphanCollections' - - orphan collection parameter - + + $collection + + string + + + $documentId + + mixed + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + has + \ArangoDBClient\DocumentHandler::has() + + Check if a document exists + This will call self::get() internally and checks if there +was an exception thrown which represents an 404 request. + + \ArangoDBClient\Exception + + + string + + + mixed + + + boolean + - - - OPTION_DROP_COLLECTION - \ArangoDBClient\GraphHandler::OPTION_DROP_COLLECTION - 'dropCollection' + + $collection + + string + + + $documentId + + mixed + + \ArangoDBClient\DocumentHandler + + + getById + \ArangoDBClient\DocumentHandler::getById() - drop collection - + Get a single document from a collection + This will throw if the document cannot be fetched from the server. + + \ArangoDBClient\Exception + + + string + + + mixed + + + array + + + \ArangoDBClient\Document + - - - $cache - \ArangoDBClient\GraphHandler::cache - - - GraphHandler cache store - + + $collection + + string + + + $documentId + + mixed + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + getHead + \ArangoDBClient\DocumentHandler::getHead() + + Gets information about a single documents from a collection + This will throw if the document cannot be fetched from the server + + \ArangoDBClient\Exception + + + string + + + mixed + + + boolean + + + string + + + array + - - - $cacheEnabled - \ArangoDBClient\GraphHandler::cacheEnabled - false - - + + $collection + + string + + + $documentId + + mixed + + + $revision + null + string + + + $ifMatch + null + boolean + + \ArangoDBClient\DocumentHandler + + + createFromArrayWithContext + \ArangoDBClient\DocumentHandler::createFromArrayWithContext() + + Intermediate function to call the createFromArray function from the right context - + + + + \ArangoDBClient\Document + + + \ArangoDBClient\ClientException + - - - $batchsize - \ArangoDBClient\GraphHandler::batchsize - - - batchsize - + + $data + + + + + $options + + + + \ArangoDBClient\DocumentHandler + + + store + \ArangoDBClient\DocumentHandler::store() + + Store a document to a collection + This is an alias/shortcut to save() and replace(). Instead of having to determine which of the 3 functions to use, +simply pass the document to store() and it will figure out which one to call. + +This will throw if the document cannot be saved or replaced. + + \ArangoDBClient\Exception + + + \ArangoDBClient\Document + + + mixed + + + array + + + mixed + + - - - $count - \ArangoDBClient\GraphHandler::count - - - count - + + $document + + \ArangoDBClient\Document + + + $collection + null + mixed + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + insert + \ArangoDBClient\DocumentHandler::insert() + + insert a document into a collection + This will add the document to the collection and return the document's id + +This will throw if the document cannot be saved + + \ArangoDBClient\Exception + + + mixed + + + \ArangoDBClient\Document + array + + + array + + + mixed + + - - - $limit - \ArangoDBClient\GraphHandler::limit - - - limit - + + $collection + + mixed + + + $document + + \ArangoDBClient\Document|array + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + save + \ArangoDBClient\DocumentHandler::save() + + Insert a document into a collection + This is an alias for insert(). - - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object - - - \ArangoDBClient\Connection + + $collection + + + + + $document + + + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + update + \ArangoDBClient\DocumentHandler::update() + + Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document. + Attention - The behavior of this method has changed since version 1.1 + +This will update the document on the server + +This will throw if the document cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the document to-be-replaced is the same as the one given. + + \ArangoDBClient\Exception - - - - $_documentClass - \ArangoDBClient\DocumentClassable::_documentClass - '\ArangoDBClient\Document' - - - - - string + + \ArangoDBClient\Document + + + array + + + boolean - - - $_edgeClass - \ArangoDBClient\DocumentClassable::_edgeClass - '\ArangoDBClient\Edge' - - - - + + $document + + \ArangoDBClient\Document + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + updateById + \ArangoDBClient\DocumentHandler::updateById() + + Update an existing document in a collection, identified by collection id and document id +Attention - The behavior of this method has changed since version 1.1 + This will update the document on the server + +This will throw if the document cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the document to-be-updated is the same as the one given. + + \ArangoDBClient\Exception + + string + + mixed + + + \ArangoDBClient\Document + + + array + + + boolean + - - - createGraph - \ArangoDBClient\GraphHandler::createGraph() - - Create a graph - This will create a graph using the given graph object and return an array of the created graph object's attributes.<br><br> - + + $collection + + string + + + $documentId + + mixed + + + $document + + \ArangoDBClient\Document + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + replace + \ArangoDBClient\DocumentHandler::replace() + + Replace an existing document in a collection, identified by the document itself + This will replace the document on the server + +This will throw if the document cannot be replaced + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given. + \ArangoDBClient\Exception - - \ArangoDBClient\Graph + + \ArangoDBClient\Document - + array - + + boolean + - $graph + $document - \ArangoDBClient\Graph + \ArangoDBClient\Document + + $options + array() + array + + \ArangoDBClient\DocumentHandler - - getGraph - \ArangoDBClient\GraphHandler::getGraph() - - Get a graph - This will get a graph.<br><br> - - String + + replaceById + \ArangoDBClient\DocumentHandler::replaceById() + + Replace an existing document in a collection, identified by collection id and document id + This will update the document on the server + +This will throw if the document cannot be Replaced + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given. + + \ArangoDBClient\Exception - - array + + mixed - - \ArangoDBClient\Graph - false + + mixed - - \ArangoDBClient\ClientException + + \ArangoDBClient\Document + + + array + + + boolean - - $graph + $collection - String + mixed + + + $documentId + + mixed + + + $document + + \ArangoDBClient\Document $options array() array + \ArangoDBClient\DocumentHandler - - setBatchsize - \ArangoDBClient\GraphHandler::setBatchsize() - - Sets the batchsize for any method creating a cursor. - Will be reset after the cursor has been created. - - integer + + remove + \ArangoDBClient\DocumentHandler::remove() + + Remove a document from a collection, identified by the document itself + + + \ArangoDBClient\Exception + + + \ArangoDBClient\Document + + + array + + + boolean - $batchsize + $document - integer + \ArangoDBClient\Document + + + $options + array() + array + \ArangoDBClient\DocumentHandler - - setCount - \ArangoDBClient\GraphHandler::setCount() - - Sets the count for any method creating a cursor. - Will be reset after the cursor has been created. - - integer + + removeById + \ArangoDBClient\DocumentHandler::removeById() + + Remove a document from a collection, identified by the collection id and document id + + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + array + + + boolean - $count + $collection - integer + mixed + + + $documentId + + mixed + + + $revision + null + mixed + + + $options + array() + array + \ArangoDBClient\DocumentHandler - - setLimit - \ArangoDBClient\GraphHandler::setLimit() - - Sets the limit for any method creating a cursor. - Will be reset after the cursor has been created. - - integer + + getDocumentId + \ArangoDBClient\DocumentHandler::getDocumentId() + + Helper function to get a document id from a document or a document id value + + + \ArangoDBClient\ClientException + + + mixed + + + mixed - $limit + $document - integer + mixed + \ArangoDBClient\DocumentHandler - - properties - \ArangoDBClient\GraphHandler::properties() - - Get a graph's properties<br><br> + + getRevision + \ArangoDBClient\DocumentHandler::getRevision() + + Helper function to get a document id from a document or a document id value - - \ArangoDBClient\Exception + + \ArangoDBClient\ClientException - + mixed - - boolean + + mixed - - $graph + $document mixed + \ArangoDBClient\DocumentHandler - - dropGraph - \ArangoDBClient\GraphHandler::dropGraph() - - Drop a graph and remove all its vertices and edges, also drops vertex and edge collections<br><br> + + lazyCreateCollection + \ArangoDBClient\DocumentHandler::lazyCreateCollection() + + - - \ArangoDBClient\Exception - - + mixed - - boolean - - - boolean + + array - - $graph + $collection mixed - $dropCollections - true - boolean + $options + + array + \ArangoDBClient\DocumentHandler - - addOrphanCollection - \ArangoDBClient\GraphHandler::addOrphanCollection() - - add an orphan collection to the graph. - This will add a further orphan collection to the graph.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - string - - - \ArangoDBClient\Graph + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection - - $graph - - mixed - - - $orphanCollection + $connection - string + \ArangoDBClient\Connection + \ArangoDBClient\Handler - - deleteOrphanCollection - \ArangoDBClient\GraphHandler::deleteOrphanCollection() - - deletes an orphan collection from the graph. - This will delete an orphan collection from the graph.<br><br> - - \ArangoDBClient\Exception + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection - + + \ArangoDBClient\Handler + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + mixed - - string - - - boolean - - - \ArangoDBClient\Graph + + \ArangoDBClient\ClientException - - $graph + $optionName - mixed + + \ArangoDBClient\Handler + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + + string + + + \ArangoDBClient\ClientException + + - $orphanCollection + $body - string - - - $dropCollection - false - boolean + array + \ArangoDBClient\Handler - - getVertexCollections - \ArangoDBClient\GraphHandler::getVertexCollections() - - gets all vertex collection from the graph. - This will get all vertex collection (orphans and used in edge definitions) from the graph.<br><br> - -If this method or any method that calls this method is used in batch mode and caching is off,<br> -then for each call, this method will make an out of batch API call to the db in order to get the appropriate collections.<br><br> - -If caching is on, then the GraphHandler will only call the DB API once for the chosen graph, and return data from cache for the following calls.<br> - - mixed + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array - + array - + array - - \ArangoDBClient\ClientException@since + + array - $graph + $options - mixed + array - $options + $body + + array + + + $includeArray array() array + \ArangoDBClient\Handler - - addEdgeDefinition - \ArangoDBClient\GraphHandler::addEdgeDefinition() - - adds an edge definition to the graph. - This will add a further edge definition to the graph.<br><br> - - \ArangoDBClient\Exception + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name + + + \ArangoDBClient\ClientException - + mixed - - \ArangoDBClient\EdgeDefinition - - - \ArangoDBClient\Graph + + string - - $graph + $value mixed + \ArangoDBClient\Handler + + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + - $edgeDefinition + $collection - \ArangoDBClient\EdgeDefinition + mixed + \ArangoDBClient\Handler - - deleteEdgeDefinition - \ArangoDBClient\GraphHandler::deleteEdgeDefinition() - - deletes an edge definition from the graph. - This will delete an edge definition from the graph.<br><br> - - \ArangoDBClient\Exception + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string - - mixed + + \ArangoDBClient\DocumentClassable - + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + string - - boolean - - - \ArangoDBClient\Graph + + \ArangoDBClient\DocumentClassable - - $graph - - mixed - - - $edgeDefinition + $class string - - $dropCollection - false - boolean - + \ArangoDBClient\DocumentClassable - - getEdgeCollections - \ArangoDBClient\GraphHandler::getEdgeCollections() - - gets all edge collections from the graph. - This will get all edge collections from the graph.<br><br> - -If this method or any method that calls this method is used in batch mode and caching is off,<br> -then for each call, this method will make an out of batch API call to the db in order to get the appropriate collections.<br><br> - -If caching is on, then the GraphHandler will only call the DB API once for the chosen graph, and return data from cache for the following calls.<br> - - \ArangoDBClient\Exception - - - mixed - - - array - - + + + No summary for method lazyCreateCollection() + + eJztWm1zGrcW/u5foXo8ATLYbtNv3Ng3LiY2GSf22CRtx2EYsStAzaLdroRtetP/fs/Ry65WLDY4zbfuTBLQ6rw951Uir/+bzbKdncOXL3fIS3KSUzFNT38hV+dXJEo4E6pD4jRazOETmVERJyyHjbj3TUajL3TKCCnIuppCv6QLNUtzeEfeUUFuFGNzKkTw6i3QfSHv6VIzJW+iNFvmfDpTpFt8evXjT6/aROUcRAlJzubj8za8TtKpYG1yxnLguwTqw50dQedMglYsUOg/pX3OBqJmVBEgBa6SsBj+tmadCP11P7TaUEyYimaOgkzydA7rjEiW38EW2IksMpZLLpXEV3OSCm/LAekrABRoZUrGS8KlXHAxxR1ISbMsTzOwVTFyPhhckZz9uWCaVepz2cgFkosIXxHy08GPGqEooVKSHuh+bo1iD4qJWJJTa61d3/nfDtJp1PB5WQSBJDTPKSguYvZgXx7qf6NUSEV6HwbXv49OL7sf38PHG3JEGohVA3wQcDQQbsKtd3rWKzjJGlZRmiQsUhygzmgOUaAwoFa4XV4N+pcfRt3Li4teFz8iz5K2TscHOs8StgnX3m8n768uelpNQ/Vt/N5eX75HZhhj38ZpcIl8VFrDBWJJsYdNmHzqXQ96vyEjQ1PDLOb55k447V+XPigoa7h2kSpfRIpQIth9WYT0a7frjRaJm4XVYS8qP+8T7wtk0piRhWRxlYdRMluMEx6RyUKY3aNR5BRo1nNvaTqTMJoDzbFsdnxKf7s1EZ89NeNy/1gy5fKvixnabHyupvNnTNkGUCLR3ysQ9QVAPWexLhuF5mBnRJNEl40oZ/DuLYTSic63YlNRwUyxBTXBt6oe3L2YKhqupRnykSFFztQiF7rUFGtqlqf3koS2mX96DxHTrB71RmDHr1zNukblptauXSgUemVvhMVDwwsRZ4Ev1zynWNU9gk4nkLsirPBM6Jp3Cwh5bTg0B0haayThEyLpHWu2oANoN7EYG4UucAchmBz9K2hS75Y5fwBiNNErg/t+TeQxodBwoIdCp4HOKxbzcZFBjo2LQHCz+0SADcZGsWBSh8ZxkTuO2pRxVOLxgNDKfr1LeRyGRX0YFLskM63M716dDmKIC83WJrmsEfdQape2tq0FTn2IkdthGEPGj1iEAmWbuz3dzGKoYDgw3AFIzr9QB2dpfECuEkalrjuk1Hp3feRIzcWEBAJvP+6X6gcQDSCkyT2HjNek6DhHq0tAGQ+Anotyt0sW805DEh6vZW0ggOitxEUEo12qMDZQdEjtPLzWt34c+0Fsn+1j2bLSxa3y7JuCZ1pYPRHARUIiWHuMxEuYksQCu1+XPG1EDL9lUF2Ytgi+p+M/wEg0Cr7ocKxNsiJEfXFmjSYujtOJXSqqSWjVyvM6O760nKGDkc7rcX68MW3CjxumSHbLeQo9p9fCAIT44XYMxrhZMgWlESbmg9eHwGgrofeUq7dpfrMUEcrThZVpsKHzwgEBJAOYELk5m6d3NAFYWE6NmTqiOfRoKlSy1OELbCBYBUevAI+Yyy8H2wDRx8yAZOHGMpmxiE84elwrUsUBUi1mE7pIlBYMCkDp4OB/rRgGS5ZBoYm3hOUwOw4zzK++gBIkEQRImb7aSWVFNgcHfWjQK+urqa5i1YqKCdbGNNq2uvqZX3ToOf3iRZQvyp+jwOlNLkfU9mYrtdXyuGsJT80Alc0FPEdPzQJOXsng750VNnrMQ6qmhsjbXN0ySJsAXmVK1NnvqQzuSRYxs9naF1f6fbOqvoW6TW4r6/hUk0Y/R8eO+ZSpcs41IprhAqBgx/hfT/qD0c3vH7qtdkXMsPgW+gkcBVY2nX63q2Vj2CIvXpDHN3z9WrW2RvdmSy88aUL3uncy6K0Gi2GZ0L+W3UCBIOKNeyre93wLgyJ6rvQx6HSSJAB/X8BpXn3MYAuMAr7DF3li3UI+5sk5SzIcdqAawFndOBuWm/AHrPh4faEPyOSANA4b8PcTyu3lTGZgPyvjaQW2LJXgIdCi7bb8IVMxYiJKYza6z1GT3AzBrYriSRpRl8BOjuZ/YV+cMxoDqacPxsQPBWHohfUjV+MUqhjW2AmHcaYQPNMCoKq7OxmnRmONg9CyFXXfSQTCA43HoTem5aGtH2NeOxObpTE+NJUk79uJvh83tQK3WEg7HXPd0T8drq0O1+yOSy1khey692kYJhvq/cNRGH4gdSXcHwH6DECGiYQLaJ88LgANb7/WAVw1XH5g980JTSRr1Zy5VtRcOx6fMeUO9dDS7HUcjk5kyu+g01bmtWdNoiuj6H44gG8zjJI9o5E5uhA3ItoLGMA2Te5WTlWW8155s2IVceOemx/0/WCDimXjgFwC35xACks+BkmfaLIAbBoc5rEXpJEuVKP+7BbOlY8NlZvNIuFEuSEVjnUj2+Ncokgc7nCiQ0PtOw2gOxsTqgCs8ULB+ZmceqjoWNtigLLipyLN2TmHaV2cFJx9JeQM8mWmN/xzstePbsYD+6UnguDfcnjTNEEf8wO07QfdkQmt7z3FuTkHC211aJEsmRT92t5EEjO0VJReT+RdNx57phUEQ6/gPqf73hTtF6hNn6yY+dxOPGWmEXtk1QI/piqagVZqpYf94t6sFntXbgvi+spdTGAjjmW7MQQZOqQ9G3T7rDxP9lJTrKskt54DoIwzGs2I7XHGj94vAUMsumb4CGc2zfp2WAK6xYVhLQYOKc14w2bExThdiO/TlKo96Zs6UrUhPdaOnlmL6isPF70nak9YUpwPjEefrlzY6tbelVddBd3wX1+t9xXA892dhQPJWm9ZEGx2V/A0wHhL+Osvwsjr76ar4803DjfPmGzWXpG5gWKjqzJ9TbbpRFErcrDMGIrddbP2LoL2Ssd+eSNUbN9G1tqXuxgHWs7PWo6+l36GjHI8svGap8rEchGyG5zX1/1CtPbCQUOGTeXnske4X/m2kOeCHMJc/xA/guMUlc3KDxr6BWTFZ/cfHtyvZePP3j5MmP8DIK/JBg== + + + + ArangoDB PHP client: connection options + + + + + + + + \ArrayAccess + ConnectionOptions + \ArangoDBClient\ConnectionOptions + + Simple container class for connection options. + This class also provides the default values for the connection +options and will perform a simple validation of them.<br> +It provides array access to its members.<br> +<br> + + + + + OPTION_ENDPOINT + \ArangoDBClient\ConnectionOptions::OPTION_ENDPOINT + 'endpoint' + + Endpoint string index constant + + + + + OPTION_HOST + \ArangoDBClient\ConnectionOptions::OPTION_HOST + 'host' + + Host name string index constant (deprecated, use endpoint instead) + + + + + OPTION_PORT + \ArangoDBClient\ConnectionOptions::OPTION_PORT + 'port' + + Port number index constant (deprecated, use endpoint instead) + + + + + OPTION_TIMEOUT + \ArangoDBClient\ConnectionOptions::OPTION_TIMEOUT + 'timeout' + + Timeout value index constant + + + + + OPTION_FAILOVER_TRIES + \ArangoDBClient\ConnectionOptions::OPTION_FAILOVER_TRIES + 'failoverTries' + + Number of servers tried in case of failover +if set to 0, then an unlimited amount of servers will be tried + + + + + OPTION_FAILOVER_TIMEOUT + \ArangoDBClient\ConnectionOptions::OPTION_FAILOVER_TIMEOUT + 'failoverTimeout' + + Max amount of time (in seconds) that is spent waiting on failover + + + + + OPTION_TRACE + \ArangoDBClient\ConnectionOptions::OPTION_TRACE + 'trace' + + Trace function index constant + + + + + OPTION_VERIFY_CERT + \ArangoDBClient\ConnectionOptions::OPTION_VERIFY_CERT + 'verifyCert' + + "verify certificates" index constant + + + + + OPTION_VERIFY_CERT_NAME + \ArangoDBClient\ConnectionOptions::OPTION_VERIFY_CERT_NAME + 'verifyCertName' + + "verify certificate host name" index constant + + + + + OPTION_ALLOW_SELF_SIGNED + \ArangoDBClient\ConnectionOptions::OPTION_ALLOW_SELF_SIGNED + 'allowSelfSigned' + + "allow self-signed" index constant + + + + + OPTION_CA_FILE + \ArangoDBClient\ConnectionOptions::OPTION_CA_FILE + 'caFile' + + "caFile" index constant + + + + + OPTION_CIPHERS + \ArangoDBClient\ConnectionOptions::OPTION_CIPHERS + 'ciphers' + + ciphers allowed to be used in SSL + + + + + OPTION_ENHANCED_TRACE + \ArangoDBClient\ConnectionOptions::OPTION_ENHANCED_TRACE + 'enhancedTrace' + + Enhanced trace + + + + + OPTION_CREATE + \ArangoDBClient\ConnectionOptions::OPTION_CREATE + 'createCollection' + + "Create collections if they don't exist" index constant + + + + + OPTION_REVISION + \ArangoDBClient\ConnectionOptions::OPTION_REVISION + 'rev' + + Update revision constant + + + + + OPTION_UPDATE_POLICY + \ArangoDBClient\ConnectionOptions::OPTION_UPDATE_POLICY + 'policy' + + Update policy index constant + + + + + OPTION_UPDATE_KEEPNULL + \ArangoDBClient\ConnectionOptions::OPTION_UPDATE_KEEPNULL + 'keepNull' + + Update keepNull constant + + + + + OPTION_REPLACE_POLICY + \ArangoDBClient\ConnectionOptions::OPTION_REPLACE_POLICY + 'policy' + + Replace policy index constant + + + + + OPTION_DELETE_POLICY + \ArangoDBClient\ConnectionOptions::OPTION_DELETE_POLICY + 'policy' + + Delete policy index constant + + + + + OPTION_WAIT_SYNC + \ArangoDBClient\ConnectionOptions::OPTION_WAIT_SYNC + 'waitForSync' + + Wait for sync index constant + + + + + OPTION_LIMIT + \ArangoDBClient\ConnectionOptions::OPTION_LIMIT + 'limit' + + Limit index constant + + + + + OPTION_SKIP + \ArangoDBClient\ConnectionOptions::OPTION_SKIP + 'skip' + + Skip index constant + - - $graph - - mixed - - - - replaceEdgeDefinition - \ArangoDBClient\GraphHandler::replaceEdgeDefinition() - - replaces an edge definition of the graph. - This will replace an edge definition in the graph.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\EdgeDefinition - - - \ArangoDBClient\Graph - - + + + OPTION_BATCHSIZE + \ArangoDBClient\ConnectionOptions::OPTION_BATCHSIZE + 'batchSize' + + Batch size index constant + - - $graph - - mixed - - - $edgeDefinition - - \ArangoDBClient\EdgeDefinition - - - - saveVertex - \ArangoDBClient\GraphHandler::saveVertex() - - save a vertex to a graph - This will add the vertex-document to the graph and return the vertex id - -This will throw if the vertex cannot be saved<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - string - - - string - - + + + OPTION_JOURNAL_SIZE + \ArangoDBClient\ConnectionOptions::OPTION_JOURNAL_SIZE + 'journalSize' + + Wait for sync index constant + - - $graph - - mixed - - - $document - - mixed - - - $collection - null - string - - - - getVertex - \ArangoDBClient\GraphHandler::getVertex() - - Get a single vertex from a graph - This will throw if the vertex cannot be fetched from the server<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - array - - - string - - - \ArangoDBClient\Document - - + + + OPTION_IS_SYSTEM + \ArangoDBClient\ConnectionOptions::OPTION_IS_SYSTEM + 'isSystem' + + Wait for sync index constant + - - $graph - - mixed - - - $vertexId - - mixed - - - $options - array() - array - - - $collection - null - string - - - - hasVertex - \ArangoDBClient\GraphHandler::hasVertex() - - Check if a vertex exists - This will call self::getVertex() internally and checks if there -was an exception thrown which represents an 404 request. - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - boolean - + + + OPTION_IS_VOLATILE + \ArangoDBClient\ConnectionOptions::OPTION_IS_VOLATILE + 'isVolatile' + + Wait for sync index constant + - - $graph - - mixed - - - $vertexId - - mixed - - - - replaceVertex - \ArangoDBClient\GraphHandler::replaceVertex() - - Replace an existing vertex in a graph, identified graph name and vertex id - This will update the vertex on the server - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced vertex is the same as the one given.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - \ArangoDBClient\Document - - - mixed - - - string - - - boolean - - + + + OPTION_AUTH_USER + \ArangoDBClient\ConnectionOptions::OPTION_AUTH_USER + 'AuthUser' + + Authentication user name + + + + + OPTION_AUTH_PASSWD + \ArangoDBClient\ConnectionOptions::OPTION_AUTH_PASSWD + 'AuthPasswd' + + Authentication password + + + + + OPTION_AUTH_TYPE + \ArangoDBClient\ConnectionOptions::OPTION_AUTH_TYPE + 'AuthType' + + Authentication type + + + + + OPTION_CONNECTION + \ArangoDBClient\ConnectionOptions::OPTION_CONNECTION + 'Connection' + + Connection + - - $graph - - mixed - - - $vertexId - - mixed - - - $document - - \ArangoDBClient\Document - - - $options - array() - mixed - - - $collection - null - string - - - - updateVertex - \ArangoDBClient\GraphHandler::updateVertex() - - Update an existing vertex in a graph, identified by graph name and vertex id - This will update the vertex on the server - -This will throw if the vertex cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed vertex-document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - \ArangoDBClient\Document - - - mixed - - - string - - - boolean - - + + + OPTION_RECONNECT + \ArangoDBClient\ConnectionOptions::OPTION_RECONNECT + 'Reconnect' + + Reconnect flag + - - $graph - - mixed - - - $vertexId - - mixed - - - $document - - \ArangoDBClient\Document - - - $options - array() - mixed - - - $collection - null - string - - - - removeVertex - \ArangoDBClient\GraphHandler::removeVertex() - - Remove a vertex from a graph, identified by the graph name and vertex id<br><br> + + + OPTION_BATCH + \ArangoDBClient\ConnectionOptions::OPTION_BATCH + 'Batch' + + Batch flag - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed - - - mixed - - - string - - - boolean - - - - $graph - - mixed - - - $vertexId - - mixed - - - $revision - null - mixed - - - $options - array() - mixed - - - $collection - null - string - - - - saveEdge - \ArangoDBClient\GraphHandler::saveEdge() - - save an edge to a graph - This will save the edge to the graph and return the edges-document's id - -This will throw if the edge cannot be saved<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed - - - mixed - - - mixed - - - string - - - mixed - - + + + OPTION_BATCHPART + \ArangoDBClient\ConnectionOptions::OPTION_BATCHPART + 'BatchPart' + + Batchpart flag + - - $graph - - mixed - - - $from - - mixed - - - $to - - mixed - - - $label - null - mixed - - - $document - - mixed - - - $collection - null - string - - - - getEdge - \ArangoDBClient\GraphHandler::getEdge() - - Get a single edge from a graph - This will throw if the edge cannot be fetched from the server<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - array - - - string - - - \ArangoDBClient\Document - - + + + OPTION_DATABASE + \ArangoDBClient\ConnectionOptions::OPTION_DATABASE + 'database' + + Database flag + - - $graph - - mixed - - - $edgeId - - mixed - - - $options - array() - array - - - $collection - null - string - - - - hasEdge - \ArangoDBClient\GraphHandler::hasEdge() - - Check if an edge exists - This will call self::getEdge() internally and checks if there -was an exception thrown which represents an 404 request. - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - boolean - + + + OPTION_CHECK_UTF8_CONFORM + \ArangoDBClient\ConnectionOptions::OPTION_CHECK_UTF8_CONFORM + 'CheckUtf8Conform' + + UTF-8 CHeck Flag + - - $graph - - mixed - - - $edgeId - - mixed - - - - replaceEdge - \ArangoDBClient\GraphHandler::replaceEdge() - - Replace an existing edge in a graph, identified graph name and edge id - This will replace the edge on the server - -This will throw if the edge cannot be Replaced - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced edge is the same as the one given.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed - - - \ArangoDBClient\Edge - - - mixed - - - string - - - boolean - - + + + OPTION_MEMCACHED_SERVERS + \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_SERVERS + 'memcachedServers' + + Entry for memcached servers array + - - $graph - - mixed - - - $edgeId - - mixed - - - $label - - mixed - - - $document - - \ArangoDBClient\Edge - - - $options - array() - mixed - - - $collection - null - string - - - - updateEdge - \ArangoDBClient\GraphHandler::updateEdge() - - Update an existing edge in a graph, identified by graph name and edge id - This will update the edge on the server - -This will throw if the edge cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed edge-document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed - - - \ArangoDBClient\Edge - - - mixed - - - string - - - boolean - - + + + OPTION_MEMCACHED_OPTIONS + \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_OPTIONS + 'memcachedOptions' + + Entry for memcached options array + - - $graph - - mixed - - - $edgeId - - mixed - - - $label - - mixed - - - $document - - \ArangoDBClient\Edge - - - $options - array() - mixed - - - $collection - null - string - - - - removeEdge - \ArangoDBClient\GraphHandler::removeEdge() - - Remove a edge from a graph, identified by the graph name and edge id<br><br> + + + OPTION_MEMCACHED_ENDPOINTS_KEY + \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_ENDPOINTS_KEY + 'memcachedEndpointsKey' + + Entry for memcached endpoints key + + + + + OPTION_MEMCACHED_PERSISTENT_ID + \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_PERSISTENT_ID + 'memcachedPersistentId' + + Entry for memcached persistend id - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed - - - mixed - - - string - - - boolean - - - - $graph - - mixed - - - $edgeId - - mixed - - - $revision - null - mixed - - - $options - array() - mixed - - - $collection - null - string - - - - clearCache - \ArangoDBClient\GraphHandler::clearCache() - - Clears the GraphHandler's cache + + + OPTION_MEMCACHED_TTL + \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_TTL + 'memcachedTtl' + + Entry for memcached cache ttl - - \ArangoDBClient\GraphHandler - - - - - getCacheEnabled - \ArangoDBClient\GraphHandler::getCacheEnabled() - - Checks if caching in enabled + + + OPTION_NOTIFY_CALLBACK + \ArangoDBClient\ConnectionOptions::OPTION_NOTIFY_CALLBACK + 'notifyCallback' + + Entry for notification callback - - boolean - - - - setCacheEnabled - \ArangoDBClient\GraphHandler::setCacheEnabled() - - + + + $_values + \ArangoDBClient\ConnectionOptions::_values + array() + + The current options - - boolean - - - \ArangoDBClient\GraphHandler + + array - - - $useCache - - boolean - - - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler + + + $_currentEndpointIndex + \ArangoDBClient\ConnectionOptions::_currentEndpointIndex + 0 + + The index into the endpoints array that we will connect to (or are currently +connected to). This index will be increased in case the currently connected +server tells us there is a different leader. We will then simply connect +to the new leader, adjusting this index. If we don't know the new leader +we will try the next server from the list of endpoints until we find the leader +or have tried to often - - \ArangoDBClient\Connection + + integer - - $connection - - \ArangoDBClient\Connection - - \ArangoDBClient\Handler - - - getConnection - \ArangoDBClient\Handler::getConnection() + + + $_cache + \ArangoDBClient\ConnectionOptions::_cache + null - Return the connection object + Optional Memcached instance for endpoints caching - - \ArangoDBClient\Connection + + \ArangoDBClient\Memcached - \ArangoDBClient\Handler - - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection + + + __construct + \ArangoDBClient\ConnectionOptions::__construct() + + Set defaults, use options provided by client and validate them - - - mixed + + array - + \ArangoDBClient\ClientException - $optionName + $options - + array - \ArangoDBClient\Handler - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - + + getAll + \ArangoDBClient\ConnectionOptions::getAll() + + Get all options + + array - - string - - - \ArangoDBClient\ClientException - - - $body - - array - - \ArangoDBClient\Handler - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array + + offsetSet + \ArangoDBClient\ConnectionOptions::offsetSet() + + Set and validate a specific option, necessary for ArrayAccess + + + \ArangoDBClient\Exception - - array + + string - - array + + mixed - - array + + void - $options + $offset - array + string - $body + $value - array - - - $includeArray - array() - array + mixed - \ArangoDBClient\Handler - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name + + offsetExists + \ArangoDBClient\ConnectionOptions::offsetExists() + + Check whether an option exists, necessary for ArrayAccess - - \ArangoDBClient\ClientException - - - mixed - - + string + + boolean + - $value + $offset - mixed + string - \ArangoDBClient\Handler - - setDocumentClass - \ArangoDBClient\DocumentClassable::setDocumentClass() - - Sets the document class to use + + offsetUnset + \ArangoDBClient\ConnectionOptions::offsetUnset() + + Remove an option and validate, necessary for ArrayAccess - + + \ArangoDBClient\Exception + + string - - \ArangoDBClient\DocumentClassable + + void - $class + $offset string - \ArangoDBClient\DocumentClassable - - setEdgeClass - \ArangoDBClient\DocumentClassable::setEdgeClass() - - Sets the edge class to use + + offsetGet + \ArangoDBClient\ConnectionOptions::offsetGet() + + Get a specific option, necessary for ArrayAccess - + + \ArangoDBClient\ClientException + + string - - \ArangoDBClient\DocumentClassable + + mixed - $class + $offset string - \ArangoDBClient\DocumentClassable - - - No summary for method setCacheEnabled() - - eJztXe1T20iT/56/Yp4r6rG8Zchmaz+RwC0xTuJnk0AB2b0UoVyyNWBthOSTZAh3t//7dc+bZkYjW8I2GB67KhUjzfT0vHX/uqd7/OY/J+PJixcvf/rpBfmJHKR+fJUcviXHH47JKAppnO+Sq9SfjMnYj4OIplAKC/428Uff/StKiKrTZcXZS3+aj5MU3pF/+TE5zSm99uPYevUO6n0nn/w7RtR4EyVpCBXf+mlOo4y9HSWTuzS8Guekq7798vOrXzskh7JXNM7I++vhhw68jpKrmHbIe5pCq3eS4SyMR8guIa92foEnL1+8iP1rmkFHqNWH18V4yG6TfOznBOhBUxkfkWzHHgvHSMhWZZujyM+AU6z/QVCmP3IaBxkRf7/43xfIJGMAPz+RIBlNr4FgRvw09e9IGAf0h3j5kv0/SuIsJ73PZydfB+9PDo4/kD3SYky2oC8WOSgchHmYxH5EppPAzylJLgkNsGMw/jc0zcMRzRwNHB2f9Y8+D056f/RP4Qs2ktKbMANajnaQEP1BJn4Kw5zjJFcR/KN3ctbv9k6RoGzeQTAIUzpCxuvQ7B2+5wRZxxal9nvvK9IafKd3zhGNovq0ukcfP/a6Z2IAi7ozCWfNKJ+apF39pz/860lEZ9KFbg/enRx9Yn2/TJPrBeicHTEqeeKggRuxTgc/H3zqIRUs72IFppoE9DKMwybLZHDYe9f/3JczglQOFZH5zdSaGqud03JDrjky5MTIH40pyfIkpUY7kzTJYZppQLZYkTKZ3278VLzsxf4wgqLDJIkoiFijhWlGa7ciCe2RSz/KHI12U4qixefCUjyVL8/GYUZuwygiI6MYsBDGVyBsKbkKb2gsnibDv6BtAmySlObTNIavQhiC6MLSnExglG+BwMxBOwynOc123gzTffxncfJbPk6T24z0fozoBOfBfs8ml48T2eLkt4F/arJ2Ow5HoCOTCAQ58hPGlwmoH7YMBYu8fJ6QoWLXbkt2DnumHhoqRJ+R6TAKR+RyGnPRw2kyRj2d3TYrzbUKfrasdQdTeH7xWr0GvilMMPF47e39K5r3zBpem/gZ0mlrZF2kzy+AODzc3s9BNWY4JGfJAfbOaxct/v2i4I2NdgbfgCmDdEajy91dXQ6Yn719ojH8O4UWOtUEStuRE7DYn0Hg6OT4w4ElcQ0OjtIJQIduIYK9tqKmjfbWNI1EB8iXNMp2d7+cfOQ6XCuUAkwBEhRHM4etw1roJnHMaXvt7f1JkuUeUuvIIn9lSTyg8SgJ6OAW+JrQ1BPj29ZGfwvLCQ5UQ6yBf2VIWispepfRvB+DtAMA0Q88Vv9coI2Lc7bydnc5FukfXrjre0YxUA8dYtEpzXcFpRMBQGbyAYgFq6v6Yp9p03UQRbKrf5dEWcLmsqGad60Q0krsZeFCJmky0RqrbuLw5OjYghNYtzsLUgz9fDTOwv+xpXt4g2J4S712gZEpglpXLfYKathVovA6rKjCXjk0Hs3nqoyrokylVOdS+xSkP6gTIbaJENwMbehC2arFFQvZSiZcPm6TI/ENhPcE8Tv8j5VhBYyTKiHOFuD/MeVo65pvpqHwjf9na6D6kh8GhIt93tGO6IHqAAr4khZAwcNkzgcagWjY3R1OwyiAvz1LDnXIOadrbKE8vbOFfw0pBQ+YkNKlP0COHPWN6j/IYVuxiDEVUENV1RQH2DF+pQQriokhOW8NwuwzvW1dFABGljHE7jTKoYQQJlzDvgMczHUYa1SJnI6i3n5t06gUegYFt9ArSS1OskpYndKcQxC1lVGlA2C6E+uVAwXcFz4ZTdMsSXdk3T9xewE8gRZwj13mzPClohjYwhm8pRJqBDvuXRfGuSZIZq5caOatLOgVdUqLlS+nokd7hqQSA1E5Ekw8PcooOGRmeQS6WMjjZSt6znuwpyTtvB4z6fooPXaI/HKPP2Ihj5et6DHvwZ5SFBU91vQFwH0wUiboP6DZYmj/OvyBho5E+/x/pjZgJHywjphagZEJQRv7KKRBnbx3KC2pDNDcAkIn7K/MsF40E4XPA2ORhEw/pWBJsOI0TZNUUeWKYZ5aKEbDc1sC0IZ4ozoi+1FC9rzYXglku6VxHeVyeNT98glkIdkhrZcD7lJruZVNIYlrKJYKeVmCtI7VdIjIS5qi3Nq8Tm5g1mFaQtha0jnF3jHHEujaKEsYZMukx0u+1N03S1yPxec+K1OSZCsS9I+BFxHrwKJAIQAQh+nFAiVlhjuKIbE4yVFsIJGJQyyYi9+Pbv07EE/plHZ49aWtdGTAREClju2xhle+AxbFV9XV0YCLg2NmvyEVbuudW4g/azE71HpoUK7YQQGNwKCp2kQ4eFWIww8CnLiylSRgMkfqlXCeVYe5THEVzKPi3kf32k7l/bTQhhIlt2wLD4gi+85+wd6B3gMv0BavX7WHzBb5rvhlzq4A0rYXotgfNpsPqxsa7oxO4Rs5Pjg5YwcGvf8yVrXA/zOcRrqhvF8eAFXxYmErp6YvBlluN7WEuMyM6S2xrEZvi9s8n2iW+VfUa1cM/+KG0hM3kLigy9wiCw856ggtTqQWjWWKrNXIrMZCi8Mih9jS0QUeL1iKiLFbAAxUKsJAUyVggPnYBh0GL/6aZrlqb/bsLCIreZv1xWUJYcjt8QTlqKN7DUVryRFZgiC6dJ3RAzfI4ZJyYbFsIhw1pBup+xBS9wpdE2hHCSPpHjKX+X2dFDy+frldNs1AUoRx6Zi2XU8wkz7aI9Cm8JqYPhQWBjICLjKjEHyTzTK/FLkGTc+4wcNSlLFQIrm87GjtIScx89Gw8zYk2jGIsk5f+9+5mpnmKMU59YPjPisvsXEwxJaTNEC/TcIGCh/DboJNmIbocNdstxkd17mNO5xDpGQcEzO+kji6EzzA+8O3jKcERS32iAn1cZLJE9yOfnbL9gKbC37YLCtcAovJLTbPBnin2q9fYQ83+CyiNS3v+r1a55X9qGP4ggRJ2d7SPm8m+/IIwwdDe1dfhctrJAr3W/THKJoGQpGCMbqtoMCNH03pLhbkaj8hoqyGNFgAknA7JDAP/L18F/K1yOXMzkr6cEgvfSCeKffHm5fQqwqcYR7TCxxn6Yea8AN27B9MqukHxg1Oc1aHMswJLZ+WbA1A8HXZPmYfpX71KBFNWyCnHq6JdtGjf/4TBA5qokL/Wevooo2F/hFmA6w6q1w5JMHugAY3oOtvgR4/JpxF1Tk2bNCL7u/tCR+TxQErZnMhyrJe0etJDlpbGzbpECpzct7iy9/RU/xIXVyT1o295loaPLN6K7syk10HweZ81uCq/O0e/rZqr4I5xRVzV1pptV12tpBkoSfGs4oVtzVSgFY8qUK72gZlkKHrT2DE6SeEJXs6ne39MOvHb60yXmkQylSqhqECfcujvhP631Oa5R63lpzdfNiz5UWx/WqGh9W9hy1RKsWgfIUj7FT3dWVJmnslU+txhFxdObIAPTk2lmghFNFH3Zbq03XNpJSCRXGnc50fi1ixrffxrc+ksVQ3lRw0C6EvgrrNGEQ7Vk84rHAXW71cskfdZKNwEJnsPCkvEAZDuhw+Vp/cQZwLCu2GrvKN1+bRfOW28GjuKZ9DYaV+8qV4yd0iR4smLGUGpDTydSE0zz/u9I6XqOrn8GjPC4f58v3h9YTd8/CFoxQsdW09/eCy4sYN/uQEqnKD2wFCjb3g8whsvNuljq+9d/uRohN1R2ZDPSGSg8puy4eT/ZpxWsP36LBl59unZg8dtuhsv5td/f4xk/WA/MZftPEXrZm/aAl7rGa9sv9lnsfF1tEpnUT+yG316GlD1TpaUHAREIdYz8jnskJ/ixjHZ+pzKfWAtXsiTEav/Wg+mekmenFtDYjMx3wEGQMDcHhetiS6gHGb8hrb8jIRw/mr49eiLAnt3MaCqh66rwJy/FgkBCCTwTJSHgxptogkk+RU94mQXsVAymDsDnYE/8JUTx7kqMZbZPszq8k6/zejwEeWTyeJKdpQmcouuQ1ztKNSdPGgARRTR1wTPr3GAEiwdG7CQCWSVn+saEroFrvKQetqlXwWnAO3AQ6iZMa4qKBuPgbOP49n0BIyxMh3jMHZI/E0ih5MdCPhMBv4Yn8LlspQYyBfddl9PUpWms+1zctqqcW1Z1NwCRfZeDVI1MdpT4yUzWnpBIo/16V7VWSJ1rKbVFdkHY54gmLpvUWA8VxB5B/A/yvXCV61Rmgd6CuZbQPclHwnBDstq3VHqEJlj6qYMVdmufr5zzMiERxQWkyxfcMAK7TM8N2C7VLa3KoOYF6+5NoAPTgZyaZckOU47re0hdlcurOoQ8K8SBm7StSRJHMijZPvILhj4Veho++Ybholtzt6a11/ijzvkj5IBOozIeWru7FI/7ADDTN3OBdo8h4ZxgQI51wI7x2zC5T0A4nqmUF1jEWFBgBKaUgx8nzI3UFIFIawH3htZDg0qf3JOj70sxDL3mmMoITnqgMz3TqFPwuHA5X4aASLOs5ZtanIuuPDx1gPmRpizjDZYamciW5RMuZteKS65VX6LVRlN+rCJcHE1nwzUugNwkSQqidPylu6AantD+tKEV74nAuuistEjMrFLSDOqvb9H1bLCBGVf6FsK+q7WOOyOo2UJyXjTUaR0urMIzgPq81GVZcUJknPgshoCoXWEmdx5vsBsXAWW+XhZUhTq6J96QZ8ZsbI7s7HQm8mNQJEMWr1zXB/IIJN5fxmb14O95F1EasqY1H53U68jJG6PTNytE77VzHgtA8hIND4QNG1uMjGsDzGrMxyGn9ZDNGDAFgLn9bAswmJEj+ogV8PxTZtCFUVPiqQqly7zsjbx4CvqjDqAmSD/phE6HVtvWxp/Gp1kAOB2lidNsM8v9itR2GW6zBTJ4Y8sbobfPrc8Kl559gy4ae2gC4sN0kDd/zKgUct91BjG1AChrmmH2ep5FByIIkuomFcK8oDQX/AnpUZImUEwc4suZ+pkGxtpbIAXXLEzUC2vHlBkrn1uc9bOfDY4o/F5YYpneD9MOwe2pj8+vOv8ISdPZQkso08yJ940ornzAmPQ8QrHrja8BmhZIQ3zcwCKAU+WRydFOBkNjSxNYwI2pmpTsZ+VqVObC1Rds6CCaHBwFOG7opBhNkCBqESiLsokHdvKBPFlJWWcHVwYzkvSvc8sBUpfbo2L2XPLvLOzS9QTrir2T1DOLmgws0BJNqlaOLDw4eFVMDjRCYDofaM5AErEYXx+8LmSaQPsxE13vEx3qK2nnVswhPtNAd3H3ZNrplY4qFOsX4CY4XCdpvvThX3MGurUZjDHOJb9fqXZJLAsrvDSAYRLcb3lBcl3PSE71dRMmTfsavTqzGjV8hckRDWlkSRUSwhvJ7KzhyzPTZI6Q1P4cIGO9wU9XMfjF0qJA/KFEmMuQJ4shY3zKSJnSfbQ7otznWKkeG2bSa2NEsIi8UVsAte3KpOx5Zs4cy0cYrEeKQYT6+HJXtHwtVKl7ThqYeNzpdIUMlNXcOJeBml3L/SJiI2xcjRYxErW2KBefjHKLme+Hk4DKMwv8MrHBMWiAN8sql9tfOKT68K7mnXsM5q2mfKQpIrSZhEamFxBu0rzaGbrSy5xqXGy22HQYucS9eKWORhXNAJA8D2PPcQu4cWFysup6GVqbIX7Zr2lWKej6ZgXWx2McJidgU7I9xPMJjQo0t4nUM32M4GnN8CNJG3kLnPXz5+FMxxw685Q7d+mL9L0tO7eCS4Ei4vxgiakUkKeyCD97DN4jAzrjJWS1NsZPYdLxvz5alDEGbfCcUbnGWnlEjQmiaXkX8FEibg18tBJX6ptIyZQoGa6gZj/W5WWrbkYW1bF4hY7WVYYk6qrdqy6FkbS3dj6laQ2pi69zN1iwXNVvjgmqZX1DNP4ovfs9jnCsA86zfWJF5OriZUOAUFkurHPF7bM6dSEOpYceP4aWmikGeBOmxjTt0rATfF/p8H/bPB6dfPXevCc9YCVzIt/td9WzjpHX886PYGx0cf+92vbXN2L9Rf5vFQX/OYzlXWsETQmARhb51qSEvdOWEXRtScOeyqSfscTh0V2BYQtof7mm0QVd+5NvlCOJ81YorDglTlemU5hzW6W5I4zfiYTXx2vM0jHGVW+ZJqZ0uIu+6bHog2in5auavqwc/IbHeWcfOjbRp/4VC2vmU8vFu1cVz3NM20px7StLbtu5Va2MV58cbG1mzsCfNr2TPBHZ2goHI/jPkYFcdsfLXiBGUrNMmXbzivne35ndLJZ1C0bsMT10Y6hdbVb9GhOcmTSJWQ0WYlFOEgsGlyEfMRpto8oUo3T0iZbe8hFzqdW/RRix3P4P0jmdTyJ9k21vRaWNN8Op6kMa0Kb2zpjS29saUXtqWl3mLWNLTAxM2KTO4vx4cHZ+tucRtzszG4l2Jwi9iMh7WmG9rT2pzP+VkOBrPrmNMl94LrJ+r2Kn/Lg5USoGJP/pRcYU6rIosEjdaxh0/E74W4oj5tO7jIvinbwk8sprOGLSaJKDFh3oLqsmSN1Bxxx0kF1bU6/JyPqJtEpq6L+bbsg0PYKKCO1sjMWZNg2Ic3cfjt+tUmjq7aUV9vDJyNgfOcDJyNUVKTkcPex14zo6QexF8Y3i/3GpWG6Pl+0HnxX+GysSfPDBc3TtRIDGfl1QUOs9LB2S/dbWuBUHUTw/kdVU8gLZzhdEkOOW/hk5ZQ4hWVYMiIWSlP5lSJfMCesoonoWobeOZvFIaBgasgUTrKwLJ2sGBlIrtYHo+cx14P+fAey4R0vpbunY6Od4gU4AZnFy3SpCPnREKb9clTrwUjrOtv+FMdRFTczvV6JhkLQFhvXfDBSeBxwIO7LzWhg1W5nme09q0CjLqVTaKeWVNiXCagCtW9SEBnrVDAbKmX2DKcIl6Ll2rJneFG3EYdZMZje6oy+OAs8WC3lS60sT/zIk20y6l+730dvDs5+sQgAbZdXezs6ILTzpPXS0UK4hafR0i/bxJuwiSnHF4t3ASf1ww2waLnKEqaBZqUqj1mIjYbhuZp2BaGeUpJ2Mh6PxDkWD/umX7d+PeJNqnXcxtfT2+TOs7W73aTzyrWfkM0JkCJeY3b08m25twuxackSC3Jo7SBgvVYWSkUXFZudQlZqOXy0HnV9dFDvazqmhhYJVPPgr74rlkatbB/G2VRM2n1jHKol5BBLZDFSvKnXcrhcXKnnZxs8qYXyZvmKLRW1rQArJWbVF6yq3DKPaLCLXAvOH6MoPCHiQbnY7rySPCHMGQaxBwYXteyoxXrt1pW3R5Xe6a71YTDNYLA69lTm6iEtYlKWMt05jW1FR8sldltLvJt3eE79clFX2/MyI0Zaa2UTax10UIWRnjUzP+S/XOU4767E3qTtVYe/mClQZvNrCwoe2tM/QDUOhNkprhY61htfWo0T0CpuOgelL/cvkarCUpD8dZ/tMiOxukOPll+QLcWjlp8GoRuN+zxPXtbJyMb9mM/Btsn5zm5nqValngIaDq7HsTP1TjOppGLrEHKd0dN4TM8jbtnxvcsm76c7z3PrNeyvZdk1T9eprcZmvNc8ryfq3XPc8LNOVtmRnhzZ8CzttmfVxr4c08C/7f1QfCp2Lggis/GBbFxQfwbuCAeL937gTwLmwvWHj/fe6WmOXmgKJRnlEMurHOVQy6tcvdkLNm2VtnjpVDVGrnjwnB6jhaeM2e8ZBDLNKZ7JotvzmTX9Ux2kym+LrYQzxSvsIWeaJb4xgraWEHWSvl7Y7jcLyV8huGiz+OTywhf1SmVqrl4Njj+p0c8A1BJub+aSc4PABEjmrYy0JajsYxWtjUI42OmBhgh3S6S8Gy5LTrB6AvR7kjiwkKVTKuQaiSC+hS0O42Z0p6h8+bFFOOwIlM9TqnEuM6a4F8UrWJUKH2JB7dAw3cXGtbMYlFRnDXIojBuAFl8zoBDT0YYSj/wo9DPPH1l7O6yN4AAvwGU8a9onH0TrvfhN2MJwUr8f9uEO8k= - - - - ArangoDB PHP client: default values - - - - - - - - DefaultValues - \ArangoDBClient\DefaultValues - - Contains default values used by the client - <br> - - - - - DEFAULT_PORT - \ArangoDBClient\DefaultValues::DEFAULT_PORT - 8529 - - Default port number (used if no port specified) - - - - - DEFAULT_TIMEOUT - \ArangoDBClient\DefaultValues::DEFAULT_TIMEOUT - 30 - - Default timeout value (used if no timeout value specified) - - - - - DEFAULT_FAILOVER_TRIES - \ArangoDBClient\DefaultValues::DEFAULT_FAILOVER_TRIES - 3 - - Default number of failover servers to try (used in case there is an automatic failover) -if set to 0, then an unlimited amount of servers will be tried - - - - - DEFAULT_FAILOVER_TIMEOUT - \ArangoDBClient\DefaultValues::DEFAULT_FAILOVER_TIMEOUT - 30 - - Default max amount of time (in seconds) that is spent waiting on failover - - - - - DEFAULT_AUTH_TYPE - \ArangoDBClient\DefaultValues::DEFAULT_AUTH_TYPE - 'Basic' - - Default Authorization type (use HTTP basic authentication) - - - - - DEFAULT_WAIT_SYNC - \ArangoDBClient\DefaultValues::DEFAULT_WAIT_SYNC - false - - Default value for waitForSync (fsync all data to disk on document updates/insertions/deletions) - - - - - DEFAULT_JOURNAL_SIZE - \ArangoDBClient\DefaultValues::DEFAULT_JOURNAL_SIZE - 33554432 - - Default value for collection journal size - - - - - DEFAULT_IS_VOLATILE - \ArangoDBClient\DefaultValues::DEFAULT_IS_VOLATILE - false - - Default value for isVolatile + + getCurrentEndpoint + \ArangoDBClient\ConnectionOptions::getCurrentEndpoint() + + Get the current endpoint to use + + string + - - - DEFAULT_CREATE - \ArangoDBClient\DefaultValues::DEFAULT_CREATE - false - - Default value for createCollection (create the collection on the fly when the first document is added to an unknown collection) + + + haveMultipleEndpoints + \ArangoDBClient\ConnectionOptions::haveMultipleEndpoints() + + Whether or not we have multiple endpoints to connect to + + boolean + - - - DEFAULT_CONNECTION - \ArangoDBClient\DefaultValues::DEFAULT_CONNECTION - 'Keep-Alive' - - Default value for HTTP Connection header + + + addEndpoint + \ArangoDBClient\ConnectionOptions::addEndpoint() + + Add a new endpoint to the list of endpoints +if the endpoint is already in the list, it will not be added again +as a side-effect, this method will modify _currentEndpointIndex + + string + + + void + - - - DEFAULT_VERIFY_CERT - \ArangoDBClient\DefaultValues::DEFAULT_VERIFY_CERT - false - - Default value for SSL certificate verification + + $endpoint + + string + + + + nextEndpoint + \ArangoDBClient\ConnectionOptions::nextEndpoint() + + Return the next endpoint from the list of endpoints +As a side-effect this function switches to a new endpoint + + string + - - - DEFAULT_VERIFY_CERT_NAME - \ArangoDBClient\DefaultValues::DEFAULT_VERIFY_CERT_NAME - false - - Default value for SSL certificate host name verification + + + getDefaults + \ArangoDBClient\ConnectionOptions::getDefaults() + + Get the default values for the options + + array + - - - DEFAULT_ALLOW_SELF_SIGNED - \ArangoDBClient\DefaultValues::DEFAULT_ALLOW_SELF_SIGNED - true - - Default value for accepting self-signed SSL certificates + + + getSupportedAuthTypes + \ArangoDBClient\ConnectionOptions::getSupportedAuthTypes() + + Return the supported authorization types + + array + - - - DEFAULT_CIPHERS - \ArangoDBClient\DefaultValues::DEFAULT_CIPHERS - null - - Default value for ciphers to be used in SSL + + + getSupportedConnectionTypes + \ArangoDBClient\ConnectionOptions::getSupportedConnectionTypes() + + Return the supported connection types + + array + - - - DEFAULT_UPDATE_POLICY - \ArangoDBClient\DefaultValues::DEFAULT_UPDATE_POLICY - \ArangoDBClient\UpdatePolicy::ERROR - - Default update policy + + + validate + \ArangoDBClient\ConnectionOptions::validate() + + Validate the options + + \ArangoDBClient\ClientException + + + void + - - - DEFAULT_REPLACE_POLICY - \ArangoDBClient\DefaultValues::DEFAULT_REPLACE_POLICY - \ArangoDBClient\UpdatePolicy::ERROR - - Default replace policy + + + loadOptionsFromCache + \ArangoDBClient\ConnectionOptions::loadOptionsFromCache() + + load and merge connection options from optional Memcached cache into +ihe current settings + + void + - - - DEFAULT_DELETE_POLICY - \ArangoDBClient\DefaultValues::DEFAULT_DELETE_POLICY - \ArangoDBClient\UpdatePolicy::ERROR - - Default delete policy + + + storeOptionsInCache + \ArangoDBClient\ConnectionOptions::storeOptionsInCache() + + store the updated options in the optional Memcached cache + + void + - - - DEFAULT_CHECK_UTF8_CONFORM - \ArangoDBClient\DefaultValues::DEFAULT_CHECK_UTF8_CONFORM - false - - Default value for checking if data is UTF-8 conform + + + getEndpointsCache + \ArangoDBClient\ConnectionOptions::getEndpointsCache() + + Initialize and return a memcached cache instance, +if option "memcachedServers" is set + + \ArangoDBClient\Memcached + - + - eJydVltP4zgUfu+vOG8UBFO2DBJbZi+ZNKWZCU2VpoxYIUVu4rReHDuKHdjOav/7HLsX6EjNFvqSNOfyfedqf/qjXJStVufkpAUn4FREzGX/M4yHY0g5o0L3IKM5qbmGJ8JrqlDNaP5ZkvSRzCnA1si1+lZIar2QFcrgCxEw0ZQWRAgrSmW5rNh8ocHdvnXPf+megq4YOhQKborZ8BTFXM4FPYUbWqH1Eq07rZYgBVWITX+Cvd7G4EqhCUM3u7yhVjSD2RL0gq5DW4fyaVb9flBUionUiADOP3QtHTJTuiKpRodEKeivEO9Wifq3ZVQtK/M72YihlJUGURczWkHb0mI5CLn6rkqaspzR7Hht1rHPVAqloe8NnGkQJ+MwiuE3uLrs/oqB74HRrKCyXse/A7QrOQgx9m+9cGpAL86vrXwf7DowmUNOGJdP+K5ohQ8FGqGr5YaKgJQoaupRUWAKsFOwb2RBNEu3thtOhrmi2rg4PzU2wujXgrOCafRGClkLbVA3YM+Mc5hR01Y0a4hs4PhBeOdFSRz53sQE2BxfQf55hWZSCW2MRVF0m6lj5Ea0CQfTiirPhGkm5iDFNqSDuBycbseOGvuOWUMMvSxXpYZhHI9hRhTm0kwjcmGp1WmqsjONh0l8P/YQ+OizMT7a31+r7slxzk2QA1lNliKFdq7Mg2DyM6KJKVjG1KNJQCbTujBJqUsUUdXBKaWV4aQ6GeXUvjXR++b4cTK5H7lILydc0UPIpZJzmtrs/C3rShAOin2nDTBfwmk0coJk4v9lEnFxcXn58eNF9xAwpu4kxzTzJv/+JLkLAyf2A+9NgVQUs+a+hNNefVlttJfPpg3wS86X8GzmxP5hFRLYFsBMW5bh2GB17Bg9CvksXjlpqoIbeU78Jua2F3EvizXDBSVZ4xy44WjkubEfjkwjfqW0PHM4e6IHdeNkEkBq+io3HU8BR271itANmDh2/uA+cT27WtexNU3efsSFRL/mpHoHdjJybt+UXJKmtLQ7RlGenymGh2b2MyXVNPRBEH5LJl4wwI6/GXl9RNdVfVhPsnKx3uy4ajd7HcGbiuuPh15kNq2oOd+PstoSeCpyli4b/E3HfexHPBMD371Hr1NrN7ZmvZ4XRWG0H6SiJTe3if9Fibxx4LjvhbHr7QCUvhd4747lVVkWNH00LYGnpt3COPDTeHB2ZeBQoWgqz9BzvyaofWXGcBBGty/d+F+rZW86CeGMqPbOfafXs6JTOHrY3OQe1peo2cOO5tHxdesHwdIT5g== + eJzFXOtTGzkS/85foaW4s9kYyO6Hqy0ScusYE7wxxoUNuRxJuYRHxrPMq2bGEHY3//t16zUvzQvYOn8Ijkf961ar1Wq1WvP238E62No6+PHHLfIj6YfUu/WP35Pp6ZQsHZt58SFZ+p7HlrHte8QP8E8ETbH1rwFd3tFbRogmHHAa/pBu4rUfwjPyG/XILGbMpZ7HHy394DG0b9cxGehvP7/+6eceiUMbAL2IfHBvTnvw2PFvPdYjH1gI1I9AfbC15VGXRcCb5di+0f2Y2W7gMJQ8prbHQugLjSKyAnmKvdmX3Zmv7Ug2pE7kkyD0722LRSReM2KxFd04MbmnzoYJJPw5QUMECUioZ5EH23FIwEJo6RJKIiERkNsWFdxXiODuv70J3yHxKE440jCkj4QulwyEiX1ixxFxmXvDwki3l3/rByKyvSU+IuT1/s9cg6KTAy37uZSby+gCXUS+9FGEPpdg688tpOa6xQ+qCrq+CUNomtgEf6Ra/HpPQ9EN+csB/xuE9j2NGdlZSEUekeuvMG4GfNuz2Df4F7qPmmaeFfg2iiaUE69pTB6Y0LMcBlRV10e+WjxH8VdtmAWtdvfFaAseHOIGOS5DRiNoYXtkCV/EECugBEFBRiy8B+OKmeNEZMMNBTgDLiWWvVoxrh+HUYuF++STlBUaecIcNKLCk1312IOk6hFq/b6JYtu7hSdK4H0yWmHXLd/rxOTO8x9yZApPqScOH2WLb7ESehX6Lv/RsaMYjTFR8MaLbQeJV8BOtMnAgobX9J7hZOXaBOqYeSYDsL24ZPilVoeS6YgPxBF5XbQFYZzUIWfMXdLlmg9PFFM0apyGidz4FDRlEkTTlomDD4G/t3GcoghKShJBl2EohNnA4KEY2R7yH8n5dD46nyyGk+Pp+WgyB+COErNThD/1gQSdmhmfdC0WhGwJklo9MLNkLnBFwNDslotwej7j7NfAw8B66ofAeoOe5SW5Ts8vONcA4A1c57bL/I10po21OR+dDc8vOW4sAAAaW+XhJ6I/YNPC1iNpqWpWw4MVtR3/PjFpG9ty//G6J2YorFkbz7FdGz0Gdf2NF6cRlc/gyOUyn/RH4/Or4cVifjEazlB0xXkOhFFJB87otxRL7CzpgvARA2wr2hW+D7xBFKCDeaA2dxCwpuS6VSlQok0tktZqYcBCXG1XG08snI1H7KI/GPLxQnoD7jZwtVfgB1kY2ysbjS3abgwP3RidfF4MhsLYBNaAhWV2YeBG1mruPYntYtI/G2Z5TwDL1FPqOOCnI+as9iIbYhqrOcP+eHz+aTEbjk8Ws9GHyfAYOXK8GcDNOFpZl5f0xHZadG7QX5yMxrxPgtTQl6UdrHEOcBHECgAzYSMXztlsXAE/mp4OL/hEkCgG/KG3Ru8OwGg2Ve71tD8ZDI8TO2OScl5mbwNY4GMM2xxHhD4RTn2Y8I9yNWXfYDlsoa6LYX8utMWRBxrYwP0ysJB5yO7tCKdRPfzF8Go0gy/IAMjKMQPfsZePjcW+nB6D2OCmx6PBZ+Gokb4c/46xYLIRkVYz7I/D4XRyOR4juqI24F+wwEHf0rIDF8PpGMa8SQ+OmcPaa+h4OB4209AncL88EIkevWVj/E/90Xwx+zwZIDZ68BM/nAGAgcEYF6HGwOPR2Yi7Q752GeBmd3bQGG32cTRFsAiIDFjvabxcQzD7R/NV/H1/Pjidjf7LJ80N0s+A/MX0+tv55cWkP14oDr/7mxCCxxflMZrByM3mwzNkYEezRwiH3JdEvzof9+fSC9vRle/AjtHoifsbjFViXMrQoYALDvliVrGWXM5PF5ez4QViI/kl0NQjB7BhfPDDikiHA0/7s9mnYwU9RSKrHjx+DOoknn+eDhXsHJobQAeprXgZ1uB8MhkO5tKjJhRGx6Q2lSuH3pZDXgwlKCJqotK5Ug3GJwcC8cZlIAEN66TiQNO+CIw40ZQaQ/FjGtMbDIqr8cCl99/3Z3wMLEliWi3mJ3u/kMEpW96Rk0rAwelw8HEB7X/BQTk5v+CTabAGyst49QsMDSZOZFSjPsVAAXe2OMNcvTdUAXox95DhfzY8G/RBiGOIqy6uZEiiUWYCpCSoMrHVqZ+mbMUPWbYyD9OCbbL5vWON2Kot6QwW6M8Z5mqTG31kjy0kCEBPEDKBIMSucA+JBFNQ9gi852S+GB1nJJgqqHhUFs+aJBB79zh2mnCfz8cZnvPYqWXl+XK7wIM2iHpv6PKunNnkfM73BxC2v+8PPiI7jvA4kKSmRRk2nzLFGIndtjIomRO0yM2jzMjy9KJMJPIUlStRFNiv4CCoK/NkOwpoD1Yg2ChSpyxjF69D/4Fn/tIpxC/iz/DbkgUF5xpsbiAqSjaGiwXXRLhZxt0se5Es+FNP5x1MZ+29S9KAvPnCZeEt6+Iu6fDwlsXHUiXd3V6ClPgE/QVi+K4dwQ6+m8W9Fki5dMzXXfLPfybE+PnBjhZcgoYAu6muFLtTQoXJzoYtvyad/L6VV5rjU+UqTkLfHaAhd1Nqkc2UiahH3wtW9wGsDmyyzCBCFkPwJO1oL92SUExym/K7OYOAMew7Tjc/+hI5q4syKXFuZEyeYuJjiVNSytMjsOayKKJywqZz12Yjz5tzburIPNyOv1phWmhPZOf8leSXa+3a32B+kh2RzoLW4gtK4huZyO7f+zmPmdeeYD9DsxZfe5JJ9Wy6lq3R4ET7J9gGX4rJw5phUhsHW3RFbJCjFho3a9So0LyCbnzfAXWCP2E4xXMSrKiDfhLle7Aj1kCTQ06plFlilEY/ojRaqq4L5vr3LKWntMX+n+zzifZ26UWJxeWVtPHqtdPKzrgPev6ENq9SL6I2Mb3VrNate+o4B/inrNOOMF7AbHIDVX8oVzQuaT+IRRFCuwXLmG4vN+ML65GQCk+EcorpdkYeHxQlb4fsK4XsGhcdo6/WQ141rKnTs+TwIPYxvClRtRygvcKJC1AlZ3x1K84ge7bU3SU53cK+lIVxt+2a/6ZGJ2a6a9XKdOSl9Yf/5nX4STpfEYLigRw/dnMhIrLxMDkJ/k3qqXGmGs0PMYhEx+WxzDA1VDiinEmR9B7i79P5Eo9FmoZ578hPZQbatyzwOzhD0n02HogqEpEpTp2DYQo8ZNTCtKIm7RE7Fq4BB+0G1gQLw3d6S20dOGD4RCII6/fYagU67onTXRfG25elA65v4VmF0WqqvZuWby8rLnQPRHnq2gCkekJpFoVR5l4LxljIkm7411/kBwVweGhHV+iEUg2ae7AoAOx41d22pSfTPVSriNipdf4RdbZ7JMUi7d/Ut0RdRySRz/NDF7D/YCkJU4ubfmyZqfBEF9eWDPXLTYWdFUwCZM1DoOR3WCoZbAZIM0S0wh1YW8jROxVW5sYARzPT16Oa3gqUPAwXucIJYpgKcrwpEql+otMqPr6B3t5lf/5uGOGMcSrII6m8vKwHB3mvoBylWNUZOFKGem6//bvm8bjCfWMEKFFPK6e3p5yeUEM+JItikF5uH0deZvP4vaDi9KcY8nLPoQtLtMbKS0u08835P+H+tK+JHuwYxOLrWnY06uKGgjCVPg1b/o1Rgh5rzG80ok45iR1RlXG+GqZApB1o3LRXqTKhV6/eZGdBlbm9OzIwL0t4lNfxmCww5WtT2qmLkLKiF/UCq3yJeBW2nhNNRXTZ6Vke15bUAzbMpPC/MDEUiqnEMm23sk4pimFly8a6SYbMvJu9zqjFaHUk94Hl4Jp87ZUT8poiwwcIsX6qgpLXBZkpZUeuuD4PD4+HJ/3L8ZxTVADm6msaAGYpGkHLSpkW0IKiAjyH2UDueszSFPs70qE8p2vd7AXrYC+AnUCnEZA6pNDCVRtG6TFDXgI99ZuJgUn7jI7+9fp1BaEsymihXEFRAZktmGgCmaGoQM5VMjRAzlJUQGdrGJpAZygqhZZ1KUUN13iApO6h6dhoigrUpKigrTyZeoFG8qQpKoCTIoGCSDzwrCbVFQDNZEpRVM2L5PS7IW5CUeXLePVV8VOv/FwBVxsdpWv/mvUlRdEMVxT3tcHlFBXgxUK+OvACRdXwytK99uOgqvIMlGWGISiq+qoLTdpKk64keQIlLxVp2g9NUensVIVHAbXOSkU9R/HTlJRXcLQm1cUaRdLOIhLVSlXWUCzNqNFikaICPn88nu6YCmy7Oy5m/29xe55sSkuTzamdaLQJsOgcE278/pH9R1Jj1Cwsh73nuhFMbWw+UyCqaqk8Su+8p5G97LTrYWrX8OTulWA071tSRFXTw4HjR6zTI52PjAV7fce+Z+X9vUqVN9TUK5hPfjKJTeh89qyGYg175hhEXkXAndzGM98S0d1PDrUM2c/6MgTcPokShHSmtJagxREPL2qP1v7GsXgCWuZHOuatbzOpcSOWSG3XpKNE6xYiozGlRcYBitktC0uEPjggS+qJeyk2PyXRuQW8ngQKOEDIpwxN/nCtaQ1IRe/cDd4y8FWG+pHc+DAL+TDhObG+G/ScAcqYVfNSGEMCdBPchtRiiRZ5Hs7L5dTkp3nlSydeBocHB/zAsa4f0KZzWNeSG1m6VAY/xgNqg6JMZwEZjT+3JAgU6dI79NfigI1nkqnzQB8jkVBWBTSGDGlr3T6hqqjQ6WfnO1/6+KHh8SpgfC07vBG4tWPd9lDRMNYPeGmseKiKaW7vNnVY28NG3B9IW9jIe6ahLjhOVyOYVVG4ulsMVr8Wjk2y3lNXUxVm9Q4Lkny16Tg9m0s2nuoFf+d5XrBr9pM7GMFkLAGkx6iEC5TPgPO2mQMt3AcsLiej/5imMo4YFo0of/ia53yxNbF8l+L1PH95x1rMYOG+srlywiC0r5RvNhs3Fw8apyK8FxAtwxnlDEJ2u3CxwLy7fXDY/WK92t05EKME//AHJs94q0SVd0/5kVEyRaADuFqC6CucHha7Z44f8HuXOM2sjRvoi74JaCqWtVhMbad9h7v8rFrIff1TZmmpPVqsX3X1blOt0550tRk562RNUHoFOl05a9p79LhDyNDs6v+1iGZgiS3ZHokChmeFMUnK6VlKSsE00VJhF/NCuiqyls6u8AA/22nNpqxZbE6E/zMSNtREgXY320HjsIkbgFN+/e3wUO99qlhmct/pUOsJWNls9zPBMvntVDFnfvuJFdY8Muf16IbjOeGw/OKrCcRlBHxrhcKyU1VwYPx4Vbtsp14swslvPc2l3/mT6x31OoNkEdenpfoQNLscSooj8QqEvIEL+SrDqOxhN4fjjCvHo+TA6Gt+sWZ1x9B1EXKCkN0tvESg30aOJ0TqWX1/30r+zVstP+3mseSGT43kVpIsTyuz1yebo/F8vWCNTyiD0LRtqyBKSgTeHhWD9qJRp+Nj/lYVfG+Kb9CrPPWXak3pkDScfBlxnz/3hFzCvhqWVaRNDEPF7o7NAz4Cf98a9P6GvHq1YxsrxGzyw9FRZUWIccoIobNVUSC0XWH7qVA/dpJwrZGHmc/HacOSHqouHCnzUD0lf4/Looe0mMociVtXeEcaVxSVlC1cYFMvtekRvXLoovLt/M3Ebf76D1ZWD5XM773C1cjk7TmAjxG2fbsJ0VeE3PzwV4i9q+e9waZNlaDaJCoNXPrg5iMhb2yaPbHUgHiRj9mONFP+HixVWt/RSuvIuyVt8bMrk7qIWu3zir2qXKAkqFGyBjX/xWuyWKK3n0286qSUbJMO500d1e9OAs5ftBK7TWpTdoudZW4QP3ZTAYSw+DHI2d01r72yLbXU7Ej0VGUCBdZtbFBWxpREA2rdbTr2Cq1Y45obf3UH0sS1tQ0oKatsQLbJ20BRm+mRADXKoKBruLUpaI1hnF46+RfDRc+EZ+4KRorg+xagi6kNHaZR15At4497pPNFvXBQ3Xq9+VJojX3/H1oIFM8= - + From 9099912e5db85906dcdf8f801be76637ab4edb21 Mon Sep 17 00:00:00 2001 From: Frank Celler <392005+fceller@users.noreply.github.com> Date: Fri, 17 Jun 2022 11:17:30 +0200 Subject: [PATCH 7/7] Set theme jekyll-theme-cayman --- docs/_config.yml | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/_config.yml diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 00000000..c4192631 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-cayman \ No newline at end of file