graphaware / neo4j-common
Common Utilities library for Neo4j
Installs: 851 769
Dependents: 24
Suggesters: 0
Security: 0
Stars: 24
Watchers: 24
Forks: 10
Open Issues: 1
Requires
- myclabs/php-enum: ^1.4
Requires (Dev)
- phpunit/phpunit: ^4.0
- dev-master
- 3.5.0
- 3.4.0
- 3.3.1
- 3.3.0
- 3.2.1
- 3.2.0
- 3.1.1
- 3.1.0
- 3.0.x-dev
- 3.0.0
- 2.2.1
- 2.2.0
- 2.1.0
- 2.0.4
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 1.14.0
- 1.13.3
- 1.13.2
- 1.13.1
- 1.13.0
- 1.12.1
- 1.12.0
- 1.11.6
- 1.11.5
- 1.11.4
- 1.11.3
- 1.11.2
- 1.11.1
- 1.11.0
- 1.10.0
- 1.9.2
- 1.9.1
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- dev-collections
This package is not auto-updated.
Last update: 2024-09-28 18:26:38 UTC
README
Library with common utility classes for Neo4j
Installation
Require the dependencies in your application :
composer require graphaware/neo4j-common
Graph
Label
Object representation of a Node Label.
use GraphAware\Common\Graph\Label; $label = new Label("User"); echo $label->getName(); // Returns (string) "User" // or static construction $label = Label::label("User");
Node
Object Representation of a Node. The node object extends PropertyBag
.
use GraphAware\Common\Graph\Node; $node = new Node(1, array("User", "Person")); $node->getId(); // Returns (int) 1 $node->getLabels(); // Returns an array of \GraphAware\Common\Graph\Label objects
Relationship
Object Representation of a Relationship. The relationship object extends PropertyBag
.
use GraphAware\Common\Graph\Relationship; $rel = new Relationship(1, RelationshipType::withName("RELATES"), $node, $node2); echo $rel->getType(); // Returns (string) "RELATES" var_dump($rel->isType(RelationshipType::withName("RELATES"))); // Returns (bool) true
Direction (Enum) : representation of a Relationship Direction
use GraphAware\Common\Graph\Direction; $direction = new Direction(Direction::INCOMING); echo $direction; // Returns (string) "INCOMING" // Or static call construction $direction = Direction::OUTGOING; echo $direction; // Returns (string) "OUTGOING"
Valid values are INCOMING
, OUTGOING
and BOTH
.
RelationshipType
Object representation of a relationship type.
use GraphAware\Common\Graph\RelationshipType; $relType = RelationshipType::withName("FOLLOWS"); echo $relType->getName(); // Returns (string) "FOLLOWS" echo (string) $relType; // implements __toString method : Returns (string) "FOLLOWS"
Cypher
Statement and StatementCollection
Utility classes representing Cypher's statements. Both Statement
and StatementCollection
classes are
taggable
.
Contains also StatementInterface
and StatementCollectionInterface
used in most GraphAware's PHP libraries.
Statement
Represents a Cypher statement with a query and an array of parameters. Also the Statement accepts a tag
argument default to null;
use GraphAware\Common\Cypher\Statement; $statement = Statement::create("MATCH (n) WHERE id(n) = {id} RETURN n", array("id" => 324)); echo $statement->getQuery(); // Returns (string) "MATCH (n) WHERE id(n) = {id} RETURN n" echo count($statement->getParameters()); // Returns (int) 1
StatementCollection
Represents a collection of Statement
objects. Is also Taggable.
use GraphAware\Common\Cypher\Statement GraphAware\Common\Cypher\StatementCollection; $collection = new StatementCollection(); $collection->add(Statement::create("MATCH (n) RETURN count(n)")); print_r($collection->getStatements()); echo $collection->isEmpty();
License
Apache License 2.0
Copyright 2015 Graphaware Limited
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Support
Standard Community Support through the Github Issues and PR's workflow.
Enterprise support via your first level support contact.