paulmozo/php-cypher-query-builder

A PHP library for generating Cypher queries to be used with Graph databases such as Neo4J

php-cypher-query-builder

A PHP library for generating Cypher queries to be used with Graph databases such as Neo4J, _(*1)

NOTES

• This is a work in progress and there is still a lot to be done

Making cypher queries easily using the query builder

$client = new Moozla\QueryBuilder\Client();

$client
  ->match('Person', 'person')
  ->match('LIKES')
  ->match('Movie', 'movie')
  ->where('movie', 'name', "=", 'Taxi Driver')
  ->return('movie');

echo (string)$client;

Will output the string:, _(*2)

MATCH (person:Person)-[:LIKES]-(movie:Movie) WHERE movie.name = "Taxi Driver" RETURN movie, _(*3)

This project makes walking a graph easy. One of the main benefits is that it automatically figures out whether it needs to match a Node or a Relationship., _(*4)

Running the tests

./vendor/bin/phpunit tests/, _(*5)

To do on this project

• Support more operators for the where clause
• ~Add more clauses such as "SET", "CREATE" and "DELETE"~
• ~Add Directional relationships support~
• More exceptions when invalid Cypher is detected
• ~Make this project available via packagist~

Examples

For a full list of examples look at the client tests found in tests/ClientTests/, _(*6)

Match Node-relation-Node and return all 3

$client = new Moozla\QueryBuilder\Client();

$client
  ->match('Person', 'person')
  ->match('LIKES', 'likes')
  ->match('Movie', 'movie')
  ->return('person')
  ->return('likes')
  ->return('movie');

echo (string)$client;

Will output the string:, _(*7)

MATCH (person:Person)-[likes:LIKES]-(movie:Movie) RETURN person, likes, movie, _(*8)

Match Node then add custom CYPHER to all clauses

$client = new Moozla\QueryBuilder\Client();

$client
  ->match('Person', 'person')
  ->appendToMatch('-[]->(:CustomMatch)')
  ->appendToWhere('(person)-[:KNOWS]-({name: 'Jeff'})')
  ->appendToReturn('count(person)');

echo (string)$client;

Will output the string:, _(*9)

MATCH (person:Person)-[]->(:CustomMatch) WHERE (person)-[:KNOWS]-({name: 'Jeff'}) RETURN count(person), _(*10)

Note: All of the 'appendTo' methods will simply append the given string to the specified clause allowing for CYPHER not directly supported through the other query builder methods, _(*11)

Multi Match

Sometimes with Cypher you need to match multiple parts of the graph before joining them. The query builder supports this, _(*12)

$client = new Moozla\QueryBuilder\Client();
$client
  ->match('Person', 'person')
  ->endMatch()
  ->match('Movie', 'movie')
  ->match('DIRECTED_BY')
  ->match('Director', 'director')
  ->where('director', 'name', '=', 'Ms Director')
  ->return('movie')
  ->return('person');

echo (string)$client;

Will output the following:, _(*13)

MATCH (person:Person) MATCH (movie:Movie)-[:DIRECTED_BY]-(director:Director) WHERE director.name = "Ms Director" RETURN movie, person, _(*14)