Several improvements for the 5.0.0 branch

Author: Wout Gevaert

src/Clauses/CallClause.php

@@ -36,17 +36,17 @@
  */
 class CallClause extends Clause
 {
-	use ErrorTrait;
+    use ErrorTrait;
 
     /**
      * @var Query|null The subquery to call, or NULL if no subquery has been set yet
      */
     private ?Query $subQuery = null;
 
-	/**
-	 * @var Variable[] The variables to include in the WITH clause (for correlated queries)
-	 */
-	private array $withVariables = [];
+    /**
+     * @var Variable[] The variables to include in the WITH clause (for correlated queries)
+     */
+    private array $withVariables = [];
 
     /**
      * Sets the query to call. This overwrites any previously set subquery.
@@ -61,27 +61,27 @@ public function withSubQuery(Query $subQuery): self
         return $this;
     }
 
-	/**
-	 * Sets the variables to include in the WITH clause. This overwrites any previously set variables.
-	 *
-	 * @param Variable[]|string[] $variables A list of variable objects, or strings to cast to variables
-	 * @return $this
-	 *
-	 * @see https://neo4j.com/docs/cypher-manual/current/clauses/call-subquery/#subquery-correlated-importing
-	 */
-	public function withVariables(array $variables): self
-	{
-		$res = [];
+    /**
+     * Sets the variables to include in the WITH clause. This overwrites any previously set variables.
+     *
+     * @param Variable[]|string[] $variables A list of variable objects, or strings to cast to variables
+     * @return $this
+     *
+     * @see https://neo4j.com/docs/cypher-manual/current/clauses/call-subquery/#subquery-correlated-importing
+     */
+    public function withVariables(array $variables): self
+    {
+        $res = [];
 
-		foreach ($variables as $variable) {
-			$this->assertClass('variables', [Variable::class, 'string'], $variable);
-			$res[] = is_string($variable) ? new Variable($variable) : $variable;
-		}
+        foreach ($variables as $variable) {
+            $this->assertClass('variables', [Variable::class, 'string'], $variable);
+            $res[] = is_string($variable) ? new Variable($variable) : $variable;
+        }
 
-		$this->withVariables = $res;
+        $this->withVariables = $res;
 
-		return $this;
-	}
+        return $this;
+    }
 
 	/**
 	 * Add a variable to include in the WITH clause.
@@ -129,23 +129,20 @@ protected function getSubject(): string
             return '';
         }
 
-		$subQuery = '';
-
-		if ($this->withVariables !== []) {
-			$withClause = new WithClause();
-			$withClause->setEntries($this->withVariables);
+        $subQuery = $this->subQuery->build();
 
-			$subQuery .= $withClause->toQuery();
-		}
+        if ($subQuery === '') {
+            return '';
+        }
 
-		if ($subQuery !== '') {
-			// Add some padding for the next structure
-			$subQuery .= ' ';
-		}
+        if ($this->withVariables !== []) {
+            $withClause = new WithClause();
+            $withClause->setEntries($this->withVariables);
 
-		$subQuery .= $this->subQuery->build();
+            $subQuery = $withClause->toQuery() . ' ' . $subQuery;
+        }
 
-		return sprintf('{ %s }', $subQuery);
+        return sprintf('{ %s }', $subQuery);
     }
 
     /**

src/Clauses/DeleteClause.php

@@ -21,9 +21,8 @@
 
 namespace WikibaseSolutions\CypherDSL\Clauses;
 
-use WikibaseSolutions\CypherDSL\Expressions\Variable;
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
-use WikibaseSolutions\CypherDSL\Types\StructuralTypes\NodeType;
+use WikibaseSolutions\CypherDSL\Types\StructuralTypes\StructuralType;
 
 /**
  * This class represents a DELETE clause.
@@ -41,14 +40,14 @@ class DeleteClause extends Clause
      */
     private bool $detach = false;
 
-	/**
-	 * @var NodeType[] The nodes to delete
-	 */
-	private array $nodes = [];
+    /**
+     * @var StructuralType[] The structures to delete
+     */
+    private array $structures = [];
 
-	/**
-     * Sets the clause to DETACH DELETE. Without DETACH DELETE, all relationships need to be explicitly
-     * deleted.
+    /**
+     * Sets the clause to DETACH DELETE. Without DETACH DELETE,
+     * all relationships connected to the nodes/paths need to be explicitly deleted.
      *
      * @param bool $detach Whether to use DETACH DELETE
      * @return $this
@@ -61,31 +60,31 @@ public function setDetach(bool $detach = true): self
     }
 
     /**
-     * Sets the variables to be deleted. This overwrites previous variables if they exist.
+     * Sets the structures to be deleted. This overwrites previous structures if they exist.
      *
-     * @param NodeType[] $nodes The nodes to delete
+     * @param StructuralType[] $structures The structures to delete
      * @return $this
      */
-    public function setNodes(array $nodes): self
+    public function setStructures(array $structures): self
     {
-        foreach ($nodes as $node) {
-            $this->assertClass('nodes', NodeType::class, $node);
+        foreach ($structures as $structure) {
+            $this->assertClass('structure', StructuralType::class, $structure);
         }
 
-        $this->nodes = $nodes;
+        $this->structures = $structures;
 
         return $this;
     }
 
     /**
-     * Add a node to be deleted.
+     * Add a structure to be deleted.
      *
-     * @param NodeType $node The node that should be deleted
+     * @param StructuralType $structure The structure that should be deleted
      * @return $this
      */
-    public function addNode(NodeType $node): self
+    public function addStructure(StructuralType $structure): self
     {
-        $this->nodes[] = $node;
+        $this->structures[] = $structure;
 
         return $this;
     }
@@ -101,13 +100,13 @@ public function detachesDeletion(): bool
     }
 
     /**
-     * Returns the nodes to delete.
+     * Returns the structures to delete.
      *
-     * @return NodeType[]
+     * @return StructuralType[]
      */
-    public function getNodes(): array
+    public function getStructures(): array
     {
-        return $this->nodes;
+        return $this->structures;
     }
 
     /**
@@ -129,7 +128,7 @@ protected function getSubject(): string
     {
         return implode(
             ", ",
-            array_map(fn (Variable $variable) => $variable->toQuery(), $this->nodes)
+            array_map(fn (StructuralType $structure) => $structure->toQuery(), $this->structures)
         );
     }
 }

src/Clauses/MatchClause.php

@@ -23,8 +23,6 @@
 
 use WikibaseSolutions\CypherDSL\Patterns\MatchablePattern;
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
-use WikibaseSolutions\CypherDSL\Types\StructuralTypes\NodeType;
-use WikibaseSolutions\CypherDSL\Types\StructuralTypes\PathType;
 
 /**
  * This class represents a MATCH clause.
@@ -36,12 +34,12 @@ class MatchClause extends Clause
     use ErrorTrait;
 
     /**
-     * @var PathType[]|NodeType[] List of patterns
+     * @var MatchablePattern[] List of patterns
      */
     private array $patterns = [];
 
     /**
-     * Sets the pattern of the MATCH clause. This overwrites any previously added patterns.
+     * Sets the patterns of the MATCH clause. This overwrites any previously added patterns.
      *
      * @param MatchablePattern[] $patterns
      * @return $this
@@ -70,7 +68,7 @@ public function addPattern(MatchablePattern ...$pattern): self
     /**
      * Returns the patterns to match.
      *
-     * @return PathType[]|NodeType[]
+     * @return MatchablePattern[]
      */
     public function getPatterns(): array
     {
@@ -92,7 +90,7 @@ protected function getSubject(): string
     {
         return implode(
             ", ",
-            array_map(fn ($pattern): string => $pattern->toQuery(), $this->patterns)
+            array_map(fn (MatchablePattern $pattern): string => $pattern->toQuery(), $this->patterns)
         );
     }
 }

src/Clauses/OptionalMatchClause.php

@@ -22,8 +22,7 @@
 namespace WikibaseSolutions\CypherDSL\Clauses;
 
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
-use WikibaseSolutions\CypherDSL\Types\StructuralTypes\NodeType;
-use WikibaseSolutions\CypherDSL\Types\StructuralTypes\PathType;
+use WikibaseSolutions\CypherDSL\Patterns\MatchablePattern;
 
 /**
  * This class represents an OPTIONAL MATCH clause.
@@ -35,14 +34,14 @@ class OptionalMatchClause extends Clause
     use ErrorTrait;
 
     /**
-     * @var (PathType|NodeType)[] List of patterns
+     * @var MatchablePattern[] List of patterns
      */
     private array $patterns = [];
 
     /**
      * Returns the patterns to optionally match.
      *
-     * @return (PathType|NodeType)[]
+     * @return MatchablePattern[]
      */
     public function getPatterns(): array
     {
@@ -52,13 +51,13 @@ public function getPatterns(): array
     /**
      * Sets the pattern of the OPTIONAL MATCH clause. This overwrites any previously added patterns.
      *
-     * @param (PathType|NodeType)[] $patterns
+     * @param MatchablePattern[] $patterns
      * @return $this
      */
     public function setPatterns(array $patterns): self
     {
         foreach ($patterns as $pattern) {
-            $this->assertClass('pattern', [PathType::class, NodeType::class], $pattern);
+            $this->assertClass('pattern', MatchablePattern::class, $pattern);
         }
 
         $this->patterns = $patterns;
@@ -69,12 +68,11 @@ public function setPatterns(array $patterns): self
     /**
      * Add a pattern to the OPTIONAL MATCH clause.
      *
-     * @param PathType|NodeType $pattern
-     * @return OptionalMatchClause
+     * @param MatchablePattern $pattern
+     * @return $this
      */
-    public function addPattern($pattern): self
+    public function addPattern(MatchablePattern $pattern): self
     {
-        $this->assertClass('pattern', [NodeType::class, PathType::class], $pattern);
         $this->patterns[] = $pattern;
 
         return $this;
@@ -95,7 +93,7 @@ protected function getSubject(): string
     {
         return implode(
             ", ",
-            array_map(fn ($pattern): string => $pattern->toQuery(), $this->patterns)
+            array_map(fn (MatchablePattern $pattern): string => $pattern->toQuery(), $this->patterns)
         );
     }
 }

src/Clauses/SetClause.php

@@ -41,12 +41,12 @@ class SetClause extends Clause
     private array $expressions = [];
 
     /**
-     * Sets the assignments of this SET clause. This will overwrite any previously added assignments.
+     * Sets the subjects of this SET clause. This will overwrite any previously added expressions.
      *
-     * @param (Assignment|Label)[] $expressions The assignments to execute
-     * @return SetClause
+     * @param (PropertyReplacement|Label)[] $expressions The expressions to set
+     * @return $this
      */
-    public function setAssignments(array $expressions): self
+    public function setExpressions(array $expressions): self
     {
         foreach ($expressions as $expression) {
             $this->assertClass('expressions', [PropertyReplacement::class, Label::class], $expression);
@@ -58,12 +58,12 @@ public function setAssignments(array $expressions): self
     }
 
     /**
-     * Add an assignment.
+     * Add an expression.
      *
-     * @param PropertyReplacement|Label $expression The assignment to execute
-     * @return SetClause
+     * @param PropertyReplacement|Label $expression The expression to add to this set clause
+     * @return $this
      */
-    public function addAssignment($expression): self
+    public function add($expression): self
     {
         $this->assertClass('expression', [PropertyReplacement::class, Label::class], $expression);
         $this->expressions[] = $expression;
@@ -74,7 +74,7 @@ public function addAssignment($expression): self
     /**
      * Returns the expressions to SET.
      *
-     * @return PropertyReplacement[]|Label[]
+     * @return (PropertyReplacement|Label)[]
      */
     public function getExpressions(): array
     {