Constants

ReturnTypeNode

ReturnTypeNode

ReturnTypeRelationship

ReturnTypeRelationship

ReturnTypePath

ReturnTypePath

ReturnTypeFullPath

ReturnTypeFullPath

OrderDepthFirst

OrderDepthFirst

OrderBreadthFirst

OrderBreadthFirst

UniquenessNone

UniquenessNone

UniquenessNodeGlobal

UniquenessNodeGlobal

UniquenessRelationshipGlobal

UniquenessRelationshipGlobal

UniquenessNodePath

UniquenessNodePath

UniquenessRelationshipPath

UniquenessRelationshipPath

Builtin

Builtin

PruneNone

PruneNone

ReturnAll

ReturnAll

ReturnAllButStart

ReturnAllButStart

Properties

$client

$client : 

Type

$order

$order : 

Type

$uniqueness

$uniqueness : 

Type

$maxDepth

$maxDepth : 

Type

$relationships

$relationships : 

Type

$pruneEvaluator

$pruneEvaluator : 

Type

$returnFilter

$returnFilter : 

Type

Methods

__construct()

__construct(\Everyman\Neo4j\Client $client)

Build the traversal and set its client

Parameters

\Everyman\Neo4j\Client $client

addRelationship()

addRelationship(string $type, string $direction) : \Everyman\Neo4j\Traversal

Add a relationship type and direction

Parameters

string $type
string $direction

Returns

\Everyman\Neo4j\Traversal

getMaxDepth()

getMaxDepth() : integer

Get the maximum allowed path length

Returns

integer

getOrder()

getOrder() : string

Return the order in which to traverse

Returns

string

getPruneEvaluator()

getPruneEvaluator() : array

Get the prune evaluator

Returns

array —

('language'=>..., 'body'=>...)

getRelationships()

getRelationships() : array

Get the relationship type and description

Returns

array —

('type'=>..., 'direction'=>...)

getResults()

getResults(\Everyman\Neo4j\Node $startNode, string $returnType) : array

Run the traversal, and return the results

Parameters

\Everyman\Neo4j\Node $startNode
string $returnType

Returns

array

getReturnFilter()

getReturnFilter() : array

Get the return filter

Returns

array —

('language'=>..., 'body'=>...)

getSingleResult()

getSingleResult(\Everyman\Neo4j\Node $startNode, string $returnType) : mixed

Run the traversal, and return the first result

Parameters

\Everyman\Neo4j\Node $startNode
string $returnType

Returns

mixed

getUniqueness()

getUniqueness() : string

Return the uniqueness of the traversal

Returns

string

setMaxDepth()

setMaxDepth(integer $max) : \Everyman\Neo4j\Traversal

Set the maximum allowed path length

Parameters

integer $max

Returns

\Everyman\Neo4j\Traversal

setOrder()

setOrder(string $order) : \Everyman\Neo4j\Traversal

Set the order in which to traverse

Parameters

string $order

Returns

\Everyman\Neo4j\Traversal

setPruneEvaluator()

setPruneEvaluator(string $language, string $body) : \Everyman\Neo4j\Traversal

Set the prune evaluator If language is one of the special builtin self::Prune* constants, the evaluator language will be set to 'builtin' and the body will be set to the value of the constant.

Parameters

string $language
string $body

Returns

\Everyman\Neo4j\Traversal

setReturnFilter()

setReturnFilter(string $language, string $body) : \Everyman\Neo4j\Traversal

Set the return filter If language is one of the special builtin self::Return* constants, the filter language will be set to 'builtin' and the body will be set to the value of the constant.

Parameters

string $language
string $body

Returns

\Everyman\Neo4j\Traversal

setUniqueness()

setUniqueness(string $uniqueness) : \Everyman\Neo4j\Traversal

Set the uniquenss

Parameters

string $uniqueness

Returns

\Everyman\Neo4j\Traversal