added getters to Clauses

Author: transistive

src/Clauses/CallProcedureClause.php

@@ -64,6 +64,36 @@ public function setProcedure(string $procedure): self
         return $this;
     }
 
+    /**
+     * Returns the variables to yield.
+     *
+     * @return Variable[]
+     */
+    public function getYieldVariables(): array
+    {
+        return $this->yieldVariables;
+    }
+
+    /**
+     * Returns the procedure to call.
+     *
+     * @return string|null
+     */
+    public function getProcedure(): ?string
+    {
+        return $this->procedure;
+    }
+
+    /**
+     * Returns the arguments of the procedure.
+     *
+     * @return AnyType[]
+     */
+    public function getArguments(): array
+    {
+        return $this->arguments;
+    }
+
     /**
      * Sets the arguments to pass to this procedure call. This overwrites any previously passed
      * arguments.

src/Clauses/CreateClause.php

@@ -48,6 +48,16 @@ public function addPattern(StructuralType $pattern): self
         return $this;
     }
 
+    /**
+     * Returns the patterns of the create clause.
+     *
+     * @return StructuralType[]
+     */
+    public function getPatterns(): array
+    {
+        return $this->patterns;
+    }
+
     /**
      * @inheritDoc
      */

src/Clauses/DeleteClause.php

@@ -72,6 +72,26 @@ public function addNode(NodeType $node): self
         return $this;
     }
 
+    /**
+     * Returns whether the deletion detaches the relationships.
+     *
+     * @return bool
+     */
+    public function detachesDeletion(): bool
+    {
+        return $this->detach;
+    }
+
+    /**
+     * Returns the nodes to delete.
+     *
+     * @return AnyType[]
+     */
+    public function getNodes(): array
+    {
+        return $this->nodes;
+    }
+
     /**
      * @inheritDoc
      */

src/Clauses/LimitClause.php

@@ -37,6 +37,16 @@ class LimitClause extends Clause
      */
     private ?NumeralType $limit;
 
+    /**
+     * Returns the actual limit of the clause.
+     *
+     * @return NumeralType|null
+     */
+    public function getLimit(): ?NumeralType
+    {
+        return $this->limit;
+    }
+
     /**
      * Sets the expression that returns the limit.
      *

src/Clauses/MatchClause.php

@@ -35,6 +35,16 @@ class MatchClause extends Clause
      */
     private array $patterns = [];
 
+    /**
+     * Returns the patterns to match.
+     *
+     * @return StructuralType[]
+     */
+    public function getPatterns(): array
+    {
+        return $this->patterns;
+    }
+
     /**
      * Add a pattern to the match clause.
      *

src/Clauses/MergeClause.php

@@ -45,6 +45,36 @@ class MergeClause extends Clause
      */
     private ?Clause $matchClause;
 
+    /**
+     * Returns the clause to execute when the pattern is matched.
+     *
+     * @return Clause|null
+     */
+    public function getOnCreateClause(): ?Clause
+    {
+        return $this->createClause;
+    }
+
+    /**
+     * Returns the clause to execute when the pattern is matched.
+     *
+     * @return Clause|null
+     */
+    public function getOnMatchClause(): ?Clause
+    {
+        return $this->matchClause;
+    }
+
+    /**
+     * Returns the pattern to MERGE.
+     *
+     * @return StructuralType|null
+     */
+    public function getPattern(): ?StructuralType
+    {
+        return $this->pattern;
+    }
+
     /**
      * Sets the pattern to merge.
      *

src/Clauses/OptionalMatchClause.php

@@ -35,6 +35,16 @@ class OptionalMatchClause extends Clause
      */
     private array $patterns = [];
 
+    /**
+     * Returns the patterns to optionally match.
+     *
+     * @return StructuralType[]
+     */
+    public function getPatterns(): array
+    {
+        return $this->patterns;
+    }
+
     /**
      * Add a pattern to the optional match clause.
      *

src/Clauses/OrderByClause.php

@@ -57,6 +57,26 @@ public function addProperty(Property $property): self
         return $this;
     }
 
+    /**
+     * Returns the properties to order.
+     *
+     * @return Property[]
+     */
+    public function getProperties(): array
+    {
+        return $this->properties;
+    }
+
+    /**
+     * Returns whether the ordering is in descending order.
+     *
+     * @return bool
+     */
+    public function isDescending(): bool
+    {
+        return $this->descending;
+    }
+
     /**
      * Set to sort in a DESCENDING order.
      *

src/Clauses/RemoveClause.php

@@ -38,6 +38,16 @@ class RemoveClause extends Clause
      */
     private array $expressions = [];
 
+    /**
+     * Returns the expressions in the REMOVE clause.
+     *
+     * @return Label[]|Property[]
+     */
+    public function getExpressions(): array
+    {
+        return $this->expressions;
+    }
+
     /**
      * Add an expression to the REMOVE clause. This expression usually returns a property (a.b) or a label (a:b).
      *

src/Clauses/ReturnClause.php

@@ -39,7 +39,7 @@ class ReturnClause extends Clause
     private bool $distinct = false;
 
     /**
-     * @var array The expressions to return
+     * @var AnyType[] The expressions to return
      */
     private array $columns = [];
 
@@ -57,6 +57,26 @@ public function setDistinct(bool $distinct = true): self
         return $this;
     }
 
+    /**
+     * Returns the columns to return. Aliased columns have string keys instead of integers.
+     *
+     * @return AnyType[]
+     */
+    public function getColumns(): array
+    {
+        return $this->columns;
+    }
+
+    /**
+     * Returns whether the returned results are distinct.
+     *
+     * @return bool
+     */
+    public function isDistinct(): bool
+    {
+        return $this->distinct;
+    }
+
     /**
      * Add a new column to this RETURN clause.
      *