Merge pull request #27 from transistive/quality-of-life

Quality of life improvements

Author: marijnvanwezel

src/Addition.php

@@ -36,9 +36,9 @@ class Addition extends BinaryOperator implements NumeralType
     /**
      * @inheritDoc
      */
-    public function __construct(NumeralType $left, NumeralType $right)
+    public function __construct(NumeralType $left, NumeralType $right, bool $insertParentheses = true)
     {
-        parent::__construct($left, $right);
+        parent::__construct($left, $right, $insertParentheses);
     }
 
     /**

src/AndOperator.php

@@ -36,9 +36,9 @@ class AndOperator extends BinaryOperator implements BooleanType
     /**
      * @inheritDoc
      */
-    public function __construct(BooleanType $left, BooleanType $right)
+    public function __construct(BooleanType $left, BooleanType $right, bool $insertParentheses = true)
     {
-        parent::__construct($left, $right);
+        parent::__construct($left, $right, $insertParentheses);
     }
 
     /**

src/Assignment.php

@@ -65,6 +65,16 @@ public function setMutate(bool $mutate = true): self
         return $this;
     }
 
+    /**
+     * Returns whether the assignment uses property mutation instead of replacement.
+     *
+     * @return bool
+     */
+    public function mutates(): bool
+    {
+        return $this->mutate;
+    }
+
     /**
      * @inheritDoc
      */

src/BinaryOperator.php

@@ -76,4 +76,34 @@ public function toQuery(): string
      * @return string
      */
     abstract protected function getOperator(): string;
+
+    /**
+     * Gets the left-hand of the expression.
+     *
+     * @return AnyType
+     */
+    public function getLeft(): AnyType
+    {
+        return $this->left;
+    }
+
+    /**
+     * Gets the right-hand of the expression.
+     *
+     * @return AnyType
+     */
+    public function getRight(): AnyType
+    {
+        return $this->right;
+    }
+
+    /**
+     * Returns whether or not the operator inserts parenthesis.
+     *
+     * @return bool
+     */
+    public function insertsParentheses(): bool
+    {
+        return $this->insertParentheses;
+    }
 }

src/Clauses/CallProcedureClause.php

@@ -37,7 +37,7 @@ class CallProcedureClause extends Clause
     /**
      * @var string|null The procedure to call
      */
-    private ?string $procedure;
+    private ?string $procedure = null;
 
     /**
      * @var AnyType[] The arguments passed to the procedure
@@ -66,6 +66,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

@@ -54,6 +54,16 @@ public function addPattern($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

@@ -35,7 +35,17 @@ class LimitClause extends Clause
      *
      * @var NumeralType|null $limit
      */
-    private ?NumeralType $limit;
+    private ?NumeralType $limit = null;
+
+    /**
+     * 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

@@ -39,6 +39,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

@@ -37,17 +37,47 @@ class MergeClause extends Clause
     /**
      * @var StructuralType|Assignment|null $pattern The pattern to merge
      */
-    private $pattern;
+    private $pattern = null;
 
     /**
      * @var Clause|null $createClause The clause to execute when the pattern is created
      */
-    private ?Clause $createClause;
+    private ?Clause $createClause = null;
 
     /**
      * @var Clause|null $matchClause The clause to execute when the pattern is matched
      */
-    private ?Clause $matchClause;
+    private ?Clause $matchClause = null;
+
+    /**
+     * 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.