Constants

AlgoShortest

AlgoShortest

AlgoAll

AlgoAll

AlgoAllSimple

AlgoAllSimple

AlgoDijkstra

AlgoDijkstra

Properties

$client

$client : 

Type

$start

$start : 

Type

$end

$end : 

Type

$type

$type : 

Type

$maxDepth

$maxDepth : 

Type

$dir

$dir : 

Type

$algo

$algo : 

Type

$costProperty

$costProperty : 

Type

$defaultCost

$defaultCost : 

Type

Methods

__construct()

__construct(\Everyman\Neo4j\Client $client)

Build the finder and set its client

Parameters

\Everyman\Neo4j\Client $client

getAlgorithm()

getAlgorithm() : string

Get the current path finding algorithm

Returns

string

getCostProperty()

getCostProperty() : string

Get the cost property name for the Dijkstra search

Returns

string

getDefaultCost()

getDefaultCost() : \Everyman\Neo4j\numeric

Get the default relationship cost for the Dijkstra search

Returns

\Everyman\Neo4j\numeric

getDirection()

getDirection() : string

Get the path direction type

Returns

string

getMaxDepth()

getMaxDepth() : integer

Get the maximum allowed path length

Returns

integer

getPaths()

getPaths() : array

Find paths

Returns

array —

of Path

getSinglePath()

getSinglePath() : \Everyman\Neo4j\Path

Get a single path

Returns

\Everyman\Neo4j\Path

getStartNode()

getStartNode() : \Everyman\Neo4j\Node

Get the start node

Returns

\Everyman\Neo4j\Node

getType()

getType() : string

Get the relationship type

Returns

string

setAlgorithm()

setAlgorithm(string $algo) : \Everyman\Neo4j\PathFinder

Set the algorithm to use

Parameters

string $algo

Returns

\Everyman\Neo4j\PathFinder

setCostProperty()

setCostProperty(string $property) : \Everyman\Neo4j\PathFinder

Set the cost property name for the Dijkstra search

Parameters

string $property

Returns

\Everyman\Neo4j\PathFinder

setDefaultCost()

setDefaultCost(\Everyman\Neo4j\numeric $cost) : \Everyman\Neo4j\PathFinder

Set the default relationship cost for the Dijkstra search

Parameters

\Everyman\Neo4j\numeric $cost

Returns

\Everyman\Neo4j\PathFinder

setDirection()

setDirection(string $dir) : \Everyman\Neo4j\PathFinder

Set the direction of the path

Parameters

string $dir

Returns

\Everyman\Neo4j\PathFinder

setMaxDepth()

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

Set the maximum allowed path length

Parameters

integer $max

Returns

\Everyman\Neo4j\PathFinder

setType()

setType(string $type) : \Everyman\Neo4j\PathFinder

Set the type

Parameters

string $type

Returns

\Everyman\Neo4j\PathFinder