Provides graph traversal
A Traversal object is used to execute a graph traversal on the server side.
The object requires the connection object, the startVertex, the edgeCollection and the optional parameters.
| link | https://docs.arangodb.com/HTTP/Traversal/index.html |
|---|---|
| package | ArangoDBClient |
| since | 1.4 |
__construct(\ArangoDBClient\Connection $connection, string $startVertex, string $edgeCollection, array $options = null)
\ArangoDBClient\Connectionstringstringarray
\ArangoDBClient\ClientException |
|---|
__get(string $key) : mixed
This function is mapped to get() internally.
| magic |
|---|
stringmixed- value of attribute, NULL if attribute is not set__isset(string $key) : boolean
stringbooleanreturns true or false (set or not set)__set(string $key, mixed $value) : void
This is a magic method that allows the object to be used without declaring all attributes first.
| magic |
|---|
stringmixed\ArangoDBClient\ClientException |
|---|
__toString() : string
| magic |
|---|
string- the current action stringget(string $key) : mixed
| magic |
|---|
stringmixed- value of attribute, NULL if attribute is not setgetEdgeCollection() : string
stringnamegetResult() : array
\ArangoDBClient\Exception |
|
|---|---|
\ArangoDBClient\ClientException |
array$responseArraygetStartVertex() : string
stringnameset($key, $value)
\ArangoDBClient\ClientException |
|---|
setEdgeCollection(string $value)
string
\ArangoDBClient\ClientException |
|---|
setStartVertex(string $value)
correct: 'myNamespace:myFunction' 'myRootNamespace:mySubNamespace:myFunction'
wrong: 'myFunction'
string
\ArangoDBClient\ClientException |
|---|
getConnection() : \ArangoDBClient\Connection
\ArangoDBClient\Connection- the connection object$_action :
$attributes : array
array()$_connection : \ArangoDBClient\Connection
ENTRY_EDGECOLLECTION = 'edgeCollection'
ENTRY_STARTVERTEX = 'startVertex'
OPTION_FIELDS = 'fields'