\Everyman\Neo4jClient

__construct()

__construct(mixed $transport, integer $port)

Initialize the client

Parameters

addToIndex()

addToIndex(\Everyman\Neo4j\Index $index, \Everyman\Neo4j\PropertyContainer $entity, string $key, string $value) : boolean

Add an entity to an index

Parameters

Returns

commitBatch()

commitBatch(\Everyman\Neo4j\Batch $batch) : boolean

Commit a batch of operations

Parameters

Returns

true on success

deleteIndex()

deleteIndex(\Everyman\Neo4j\Index $index) : boolean

Delete the given index

Parameters

Returns

deleteNode()

deleteNode(\Everyman\Neo4j\Node $node) : boolean

Delete the given node

Parameters

Returns

deleteRelationship()

deleteRelationship(\Everyman\Neo4j\Relationship $relationship) : boolean

Delete the given relationship

Parameters

Returns

endBatch()

endBatch() : \Everyman\Neo4j\Client

Detach the current open batch.

The batch can still be committed via the batch returned by Client::startBatch()

Returns

executeCypherQuery()

executeCypherQuery(\Everyman\Neo4j\Cypher\Query $query) : \Everyman\Neo4j\Query\ResultSet

Execute the given Cypher query and return the result

Parameters

Returns

executeGremlinQuery()

executeGremlinQuery(\Everyman\Neo4j\Gremlin\Query $query) : \Everyman\Neo4j\Query\ResultSet

Execute the given Gremlin query and return the result

Parameters

Returns

executePagedTraversal()

executePagedTraversal(\Everyman\Neo4j\Pager $pager) : array

Execute a paged traversal and return the result

Parameters

Returns

executeTraversal()

executeTraversal(\Everyman\Neo4j\Traversal $traversal, \Everyman\Neo4j\Node $startNode, string $returnType) : array

Execute the given traversal and return the result

Parameters

Returns

getEntityCache()

getEntityCache() : \Everyman\Neo4j\Cache\EntityCache

Get the cache

Returns

getEntityMapper()

getEntityMapper() : \Everyman\Neo4j\EntityMapper

Get the entity mapper

Returns

getIndexes()

getIndexes(string $type) : mixed

Get all indexes of the given type

Parameters

Returns

false on error, else an array of Index objects

getNode()

getNode(integer $id, boolean $force) : \Everyman\Neo4j\Node

Get the requested node Using the $force option disables the check of whether or not the node exists and will return a Node with the given id even if it does not.

Parameters

Returns

getNodeRelationships()

getNodeRelationships(\Everyman\Neo4j\Node $node, mixed $types, string $dir) : mixed

Get all relationships on a node matching the criteria

Parameters

Returns

false on error, else an array of Relationship objects

getPaths()

getPaths(\Everyman\Neo4j\PathFinder $finder) : array

Get an array of paths matching the finder's criteria

Parameters

Returns

getReferenceNode()

getReferenceNode() : \Everyman\Neo4j\Node

Retrieve the reference node (id: 0) from the server

Returns

getRelationship()

getRelationship(integer $id, boolean $force) : \Everyman\Neo4j\Relationship

Get the requested relationship Using the $force option disables the check of whether or not the relationship exists and will return a Relationship with the given id even if it does not.

Parameters

Returns

getRelationshipTypes()

getRelationshipTypes() : array

Get a list of all relationship types on the server

Returns

getServerInfo()

getServerInfo(boolean $force) : array

Retrieve information about the server

Parameters

Returns

getTransport()

getTransport() : \Everyman\Neo4j\Transport

Get the transport

Returns

loadNode()

loadNode(\Everyman\Neo4j\Node $node) : boolean

Load the given node with data from the server

Parameters

Returns

loadRelationship()

loadRelationship(\Everyman\Neo4j\Relationship $rel) : boolean

Load the given relationship with data from the server

Parameters

Returns

makeNode()

makeNode() : \Everyman\Neo4j\Node

Create a new node object bound to this client

Returns

makeRelationship()

makeRelationship() : \Everyman\Neo4j\Relationship

Create a new relationship object bound to this client

Returns

queryIndex()

queryIndex(\Everyman\Neo4j\Index $index, string $query) : array

Query an index using a query string.

The default query language in Neo4j is Lucene

Parameters

Returns

removeFromIndex()

removeFromIndex(\Everyman\Neo4j\Index $index, \Everyman\Neo4j\PropertyContainer $entity, string $key, string $value) : boolean

Remove an entity from an index If $value is not given, all reference of the entity for the key are removed.

If $key is not given, all reference of the entity are removed.

Parameters

Returns

saveIndex()

saveIndex(\Everyman\Neo4j\Index $index) : boolean

Save the given index

Parameters

Returns

saveNode()

saveNode(\Everyman\Neo4j\Node $node) : boolean

Save the given node

Parameters

Returns

saveRelationship()

saveRelationship(\Everyman\Neo4j\Relationship $rel) : boolean

Save the given relationship

Parameters

Returns

searchIndex()

searchIndex(\Everyman\Neo4j\Index $index, string $key, string $value) : array

Search an index for matching entities

Parameters

Returns

setEntityCache()

setEntityCache(\Everyman\Neo4j\Cache\EntityCache $cache)

Set the cache to use

Parameters

setEntityMapper()

setEntityMapper(\Everyman\Neo4j\EntityMapper $mapper)

Set the entity mapper to use

Parameters

setTransport()

setTransport(\Everyman\Neo4j\Transport $transport)

Set the transport to use

Parameters

startBatch()

startBatch() : \Everyman\Neo4j\Batch

Start an implicit batch

Any data manipulation calls that occur between this call and the subsequent Client::commitBatch() call will be wrapped in a batch operation.

Returns

runCommand()

runCommand(\Everyman\Neo4j\Command $command) : mixed

Run a command that will talk to the transport

Parameters

Returns