i-kadar/php-cypher-dsl

A query builder for the Cypher query language written in PHP

dev-main 2024-01-29 10:14 UTC

Requires

• php: >=7.4
• ext-ctype: *
• ext-openssl: *
• symfony/polyfill-php80: ^1.25
• symfony/polyfill-php81: ^1.25

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• infection/infection: ^0.25.5
• phpstan/phpstan: ^1.8
• phpunit/phpunit: ~9.0
• rregeer/phpunit-coverage-check: ^0.3.1

MIT

• Marijn van Wezel
• Wout Gevaert
• Ghlen Nagels
• Lars Akkermans

• DSL
• query
• graph
• neo4j
• builder
• querybuilder
• cypher

README

The php-cypher-dsl library provides a way to construct advanced Cypher queries in an object-oriented and type-safe manner.

Documentation

The documentation can be found on the wiki here.

Installation

Requirements

php-cypher-dsl requires PHP 7.4 or greater; using the latest version of PHP is highly recommended.

Installation through Composer

You can install php-cypher-dsl through composer by running the following command:

composer require "wikibase-solutions/php-cypher-dsl"

Contributing

Please refer to CONTRIBUTING.md for information on how to contribute to this project.

Example

To construct a query to find all of Tom Hanks' co-actors, you can use the following code:

use function WikibaseSolutions\CypherDSL\node;
use function WikibaseSolutions\CypherDSL\query;

$tom = node("Person")->withProperties(["name" => "Tom Hanks"]);
$coActors = node();

$statement = query()
    ->match($tom->relationshipTo(Query::node(), "ACTED_IN")->relationshipFrom($coActors, "ACTED_IN"))
    ->returning($coActors->property("name"))
    ->build();