add node and relation variable to ToCypherHelper

Author: Syndesi

docs/helper.md

@@ -65,6 +65,10 @@ $node->addIdentifier(new PropertyName('id'));
 echo(ToCypherHelper::nodeToCypherString($node));
 // > (:Label {id: '1234', someKey: 'some value'})
 
+// print whole node with variable
+echo(ToCypherHelper::nodeToCypherString($node, nodeVariable: 'node'));
+// > (node:Label {id: '1234', someKey: 'some value'})
+
 // print node with only identifying properties
 echo(ToCypherHelper::nodeToCypherString($node, true));
 // > (:Label {id: '1234'})
@@ -112,6 +116,10 @@ $relation->addIdentifier(new PropertyName('id'));
 echo(ToCypherHelper::relationToCypherString($relation));
 // > (:StartNode {id: '1234'})-[:TYPE {id: '123', key: 'value'}]->(:EndNode {id: 4321})
 
+// print relation with all properties & nodes with variable
+echo(ToCypherHelper::relationToCypherString($relation, relationVariable: 'relation'));
+// > (:StartNode {id: '1234'})-[relation:TYPE {id: '123', key: 'value'}]->(:EndNode {id: 4321})
+
 // print relation with identifying properties & nodes
 echo(ToCypherHelper::relationToCypherString($relation, true));
 // > (:StartNode {id: '1234'})-[:TYPE {id: '123'}]->(:EndNode {id: 4321})

src/Helper/ToCypherHelper.php

@@ -88,7 +88,7 @@ public static function nodeLabelStorageToCypherLabelString(NodeLabelStorageInter
      * ones.
      * Return example: (:Label {property: 'value'}).
      */
-    public static function nodeToCypherString(?NodeInterface $node, bool $identifying = false): ?string
+    public static function nodeToCypherString(?NodeInterface $node, bool $identifying = false, ?string $nodeVariable = null): ?string
     {
         if (null === $node) {
             return null;
@@ -106,16 +106,19 @@ public static function nodeToCypherString(?NodeInterface $node, bool $identifyin
         if ('' !== $propertyString) {
             $parts[] = '{'.$propertyString.'}';
         }
+        if (!$nodeVariable) {
+            $nodeVariable = '';
+        }
 
-        return '('.implode(' ', $parts).')';
+        return '('.$nodeVariable.implode(' ', $parts).')';
     }
 
-    public static function nodeToIdentifyingCypherString(?NodeInterface $node): ?string
+    public static function nodeToIdentifyingCypherString(?NodeInterface $node, ?string $nodeVariable = null): ?string
     {
-        return self::nodeToCypherString($node, true);
+        return self::nodeToCypherString($node, true, $nodeVariable);
     }
 
-    public static function relationToCypherString(RelationInterface $relation, bool $identifying = false, bool $withNodes = true): string
+    public static function relationToCypherString(RelationInterface $relation, bool $identifying = false, bool $withNodes = true, ?string $relationVariable = null): string
     {
         $parts = [];
         if ($withNodes) {
@@ -124,8 +127,11 @@ public static function relationToCypherString(RelationInterface $relation, bool
 
         $relationParts = [];
         if ($relation->getRelationType()) {
+            if (!$relationVariable) {
+                $relationVariable = '';
+            }
             /** @psalm-suppress PossiblyNullReference */
-            $relationParts[] = ':'.$relation->getRelationType()->getRelationType();
+            $relationParts[] = $relationVariable.':'.$relation->getRelationType()->getRelationType();
         }
         $propertyStorage = $relation->getProperties();
         if ($identifying) {
@@ -148,9 +154,9 @@ public static function relationToCypherString(RelationInterface $relation, bool
         return implode('', $parts);
     }
 
-    public static function relationToIdentifyingCypherString(RelationInterface $relation, bool $withNodes = true): string
+    public static function relationToIdentifyingCypherString(RelationInterface $relation, bool $withNodes = true, ?string $relationVariable = null): string
     {
-        return self::relationToCypherString($relation, true, $withNodes);
+        return self::relationToCypherString($relation, true, $withNodes, $relationVariable);
     }
 
     /**

tests/Helper/ToCypherHelperTest.php

@@ -100,6 +100,8 @@ public function testNodeToCypherString(): void
         $node->addIdentifier(new PropertyName('propertyC'));
         $this->assertSame("(:SomeNode {propertyA: 'value A', propertyB: 'value B', propertyC: 'value C', propertyD: 'value D'})", ToCypherHelper::nodeToCypherString($node));
         $this->assertSame("(:SomeNode {propertyA: 'value A', propertyC: 'value C'})", ToCypherHelper::nodeToIdentifyingCypherString($node));
+        $this->assertSame("(node:SomeNode {propertyA: 'value A', propertyB: 'value B', propertyC: 'value C', propertyD: 'value D'})", ToCypherHelper::nodeToCypherString($node, nodeVariable: 'node'));
+        $this->assertSame("(node:SomeNode {propertyA: 'value A', propertyC: 'value C'})", ToCypherHelper::nodeToIdentifyingCypherString($node, nodeVariable: 'node'));
         $node->clearNodeLabels();
         $this->assertSame("({propertyA: 'value A', propertyB: 'value B', propertyC: 'value C', propertyD: 'value D'})", ToCypherHelper::nodeToCypherString($node));
         $this->assertSame("({propertyA: 'value A', propertyC: 'value C'})", ToCypherHelper::nodeToIdentifyingCypherString($node));
@@ -132,6 +134,8 @@ public function testRelationToCypherString(): void
 
         $this->assertSame("(:StartNode {id: '1234'})-[:SOME_TYPE {id: '123', somethingElse: 'some non id value'}]->(:EndNode {id: '4321'})", ToCypherHelper::relationToCypherString($relation));
         $this->assertSame("[:SOME_TYPE {id: '123', somethingElse: 'some non id value'}]", ToCypherHelper::relationToCypherString($relation, withNodes: false));
+        $this->assertSame("(:StartNode {id: '1234'})-[relation:SOME_TYPE {id: '123', somethingElse: 'some non id value'}]->(:EndNode {id: '4321'})", ToCypherHelper::relationToCypherString($relation, relationVariable: 'relation'));
+        $this->assertSame("[relation:SOME_TYPE {id: '123', somethingElse: 'some non id value'}]", ToCypherHelper::relationToCypherString($relation, withNodes: false, relationVariable: 'relation'));
         $this->assertSame("(:StartNode {id: '1234'})-[:SOME_TYPE {id: '123'}]->(:EndNode {id: '4321'})", ToCypherHelper::relationToIdentifyingCypherString($relation));
         $this->assertSame("[:SOME_TYPE {id: '123'}]", ToCypherHelper::relationToIdentifyingCypherString($relation, false));
         $this->assertSame("[:SOME_TYPE {id: '123'}]", ToCypherHelper::relationToIdentifyingCypherString($relation, false));