Merge pull request #102 from neo4j-php/78-insert-parentheses-based-on-precedence

Insert parentheses based on precedence

Author: marijnvanwezel

CHANGELOG.md

@@ -13,6 +13,7 @@ The format is based on [Keep a Changelog], and this project adheres to
 - Changed the minimum required PHP version to 8.1.
 - Changed the signature of many functions to use PHP 8 union types.
 - Changed the `Relationship::DIR_*` to the `Direction` enum.
+- Remove `$insertParentheses` from all methods, and automatically insert them based on precedence.
 
 ### Removed
 

src/Expressions/Exists.php

@@ -34,22 +34,15 @@ final class Exists implements BooleanType
     private ?WhereClause $where;
 
     /**
-     * @var bool Whether to insert parentheses around the expression
-     */
-    private bool $insertParentheses;
-
-    /**
-     * @param MatchClause      $match             The MATCH part of the EXISTS expression
-     * @param null|WhereClause $where             The optional WHERE part of the EXISTS expression
-     * @param bool             $insertParentheses Whether to insert parentheses around the expression
+     * @param MatchClause      $match The MATCH part of the EXISTS expression
+     * @param null|WhereClause $where The optional WHERE part of the EXISTS expression
      *
      * @internal This function is not covered by the backwards compatibility guarantee of php-cypher-dsl
      */
-    public function __construct(MatchClause $match, ?WhereClause $where = null, bool $insertParentheses = false)
+    public function __construct(MatchClause $match, ?WhereClause $where = null)
     {
         $this->match = $match;
         $this->where = $where;
-        $this->insertParentheses = $insertParentheses;
     }
 
     /**
@@ -68,27 +61,19 @@ public function getWhere(): ?WhereClause
         return $this->where;
     }
 
-    /**
-     * Returns whether it inserts parentheses around the expression.
-     */
-    public function insertsParentheses(): bool
-    {
-        return $this->insertParentheses;
-    }
-
     /**
      * @inheritDoc
      */
     public function toQuery(): string
     {
         if (isset($this->where)) {
             return sprintf(
-                $this->insertParentheses ? "(EXISTS { %s %s })" : "EXISTS { %s %s }",
+                "EXISTS { %s %s }",
                 $this->match->toQuery(),
                 $this->where->toQuery()
             );
         }
 
-        return sprintf($this->insertParentheses ? "(EXISTS { %s })" : "EXISTS { %s }", $this->match->toQuery());
+        return sprintf("EXISTS { %s }", $this->match->toQuery());
     }
 }

src/Expressions/Operators/Addition.php

@@ -23,4 +23,12 @@ protected function getOperator(): string
     {
         return "+";
     }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getPrecedence(): Precedence
+    {
+        return Precedence::ADDITIVE;
+    }
 }

src/Expressions/Operators/BinaryOperator.php

@@ -27,15 +27,11 @@ abstract class BinaryOperator extends Operator
     private AnyType $right;
 
     /**
-     * @inheritDoc
-     *
      * @param AnyType $left  The left-hand of the expression
      * @param AnyType $right The right-hand of the expression
      */
-    public function __construct(AnyType $left, AnyType $right, bool $insertParentheses = true)
+    public function __construct(AnyType $left, AnyType $right)
     {
-        parent::__construct($insertParentheses);
-
         $this->left = $left;
         $this->right = $right;
     }
@@ -59,9 +55,17 @@ public function getRight(): AnyType
     /**
      * @inheritDoc
      */
-    protected function toInner(): string
+    public function toQuery(): string
     {
-        return sprintf("%s %s %s", $this->left->toQuery(), $this->getOperator(), $this->right->toQuery());
+        $left = $this->shouldInsertParentheses($this->left) ?
+            "({$this->left->toQuery()})" :
+            $this->left->toQuery();
+
+        $right = $this->shouldInsertParentheses($this->right) ?
+            "({$this->right->toQuery()})" :
+            $this->right->toQuery();
+
+        return sprintf("%s %s %s", $left, $this->getOperator(), $right);
     }
 
     /**

src/Expressions/Operators/BooleanBinaryOperator.php

@@ -31,8 +31,8 @@ abstract class BooleanBinaryOperator extends BinaryOperator implements BooleanTy
      * @param BooleanType $left  The left-hand of the boolean operator
      * @param BooleanType $right The right-hand of the boolean operator
      */
-    public function __construct(BooleanType $left, BooleanType $right, bool $insertParentheses = true)
+    public function __construct(BooleanType $left, BooleanType $right)
     {
-        parent::__construct($left, $right, $insertParentheses);
+        parent::__construct($left, $right);
     }
 }

src/Expressions/Operators/BooleanUnaryOperator.php

@@ -28,8 +28,8 @@ abstract class BooleanUnaryOperator extends UnaryOperator implements BooleanType
      *
      * @param BooleanType $expression The unary expression
      */
-    public function __construct(BooleanType $expression, bool $insertParentheses = true)
+    public function __construct(BooleanType $expression)
     {
-        parent::__construct($expression, $insertParentheses);
+        parent::__construct($expression);
     }
 }

src/Expressions/Operators/ComparisonBinaryOperator.php

@@ -41,8 +41,8 @@ abstract class ComparisonBinaryOperator extends BinaryOperator implements Boolea
      * @param AnyType $left  The left-hand of the comparison operator
      * @param AnyType $right The right-hand of the comparison operator
      */
-    public function __construct(AnyType $left, AnyType $right, bool $insertParentheses = true)
+    public function __construct(AnyType $left, AnyType $right)
     {
-        parent::__construct($left, $right, $insertParentheses);
+        parent::__construct($left, $right);
     }
 }

src/Expressions/Operators/ComparisonUnaryOperator.php

@@ -30,8 +30,8 @@ abstract class ComparisonUnaryOperator extends UnaryOperator implements BooleanT
      *
      * @param AnyType $expression The unary expression
      */
-    public function __construct(AnyType $expression, bool $insertParentheses = true)
+    public function __construct(AnyType $expression)
     {
-        parent::__construct($expression, $insertParentheses);
+        parent::__construct($expression);
     }
 }

src/Expressions/Operators/Conjunction.php

@@ -23,4 +23,12 @@ protected function getOperator(): string
     {
         return "AND";
     }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getPrecedence(): Precedence
+    {
+        return Precedence::CONJUNCTION;
+    }
 }

src/Expressions/Operators/Contains.php

@@ -23,4 +23,12 @@ protected function getOperator(): string
     {
         return "CONTAINS";
     }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getPrecedence(): Precedence
+    {
+        return Precedence::FUNCTIONAL;
+    }
 }