Refactor query filter parser

Author: stevebauman

src/Query/Filter/AndGroup.php

@@ -2,7 +2,7 @@
 
 namespace LdapRecord\Query\Filter;
 
-class AndGroup implements Filter
+class AndGroup implements GroupFilter
 {
     /**
      * The filters in the group.
@@ -29,6 +29,22 @@ public function getFilters(): array
         return $this->filters;
     }
 
+    /**
+     * Get the group's operator.
+     */
+    public function getOperator(): string
+    {
+        return '&';
+    }
+
+    /**
+     * Get the raw filter string (without outer parentheses).
+     */
+    public function getRaw(): string
+    {
+        return '&'.implode('', array_map(fn (Filter $filter) => (string) $filter, $this->filters));
+    }
+
     /**
      * Compile the filter to its LDAP string representation.
      */
@@ -38,6 +54,6 @@ public function __toString(): string
             return '';
         }
 
-        return '(&'.implode('', array_map(fn (Filter $filter) => (string) $filter, $this->filters)).')';
+        return '('.$this->getRaw().')';
     }
 }

src/Query/Filter/ApproximatelyEquals.php

@@ -2,7 +2,7 @@
 
 namespace LdapRecord\Query\Filter;
 
-class ApproximatelyEquals implements Filter
+class ApproximatelyEquals implements ConditionFilter
 {
     /**
      * Create a new approximately equals filter.
@@ -12,11 +12,43 @@ public function __construct(
         protected string $value
     ) {}
 
+    /**
+     * Get the filter's attribute.
+     */
+    public function getAttribute(): string
+    {
+        return $this->attribute;
+    }
+
+    /**
+     * Get the filter's operator.
+     */
+    public function getOperator(): string
+    {
+        return '~=';
+    }
+
+    /**
+     * Get the filter's value.
+     */
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+
+    /**
+     * Get the raw filter string (without parentheses).
+     */
+    public function getRaw(): string
+    {
+        return "{$this->attribute}~={$this->value}";
+    }
+
     /**
      * Compile the filter to its LDAP string representation.
      */
     public function __toString(): string
     {
-        return "({$this->attribute}~={$this->value})";
+        return "({$this->getRaw()})";
     }
 }

src/Query/Filter/ConditionFilter.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace LdapRecord\Query\Filter;
+
+interface ConditionFilter extends Filter
+{
+    /**
+     * Get the filter's attribute.
+     */
+    public function getAttribute(): string;
+
+    /**
+     * Get the filter's operator.
+     */
+    public function getOperator(): string;
+
+    /**
+     * Get the filter's value.
+     */
+    public function getValue(): ?string;
+
+    /**
+     * Get the raw filter string (without parentheses).
+     */
+    public function getRaw(): string;
+}
+

src/Query/Filter/ConditionNode.php

@@ -2,7 +2,7 @@
 
 namespace LdapRecord\Query\Filter;
 
-class Contains implements Filter
+class Contains implements ConditionFilter
 {
     /**
      * Create a new contains filter.
@@ -12,11 +12,43 @@ public function __construct(
         protected string $value
     ) {}
 
+    /**
+     * Get the filter's attribute.
+     */
+    public function getAttribute(): string
+    {
+        return $this->attribute;
+    }
+
+    /**
+     * Get the filter's operator.
+     */
+    public function getOperator(): string
+    {
+        return '=';
+    }
+
+    /**
+     * Get the filter's value.
+     */
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+
+    /**
+     * Get the raw filter string (without parentheses).
+     */
+    public function getRaw(): string
+    {
+        return "{$this->attribute}=*{$this->value}*";
+    }
+
     /**
      * Compile the filter to its LDAP string representation.
      */
     public function __toString(): string
     {
-        return "({$this->attribute}=*{$this->value}*)";
+        return "({$this->getRaw()})";
     }
 }

src/Query/Filter/Contains.php

@@ -2,7 +2,7 @@
 
 namespace LdapRecord\Query\Filter;
 
-class EndsWith implements Filter
+class EndsWith implements ConditionFilter
 {
     /**
      * Create a new ends with filter.
@@ -12,11 +12,43 @@ public function __construct(
         protected string $value
     ) {}
 
+    /**
+     * Get the filter's attribute.
+     */
+    public function getAttribute(): string
+    {
+        return $this->attribute;
+    }
+
+    /**
+     * Get the filter's operator.
+     */
+    public function getOperator(): string
+    {
+        return '=';
+    }
+
+    /**
+     * Get the filter's value.
+     */
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+
+    /**
+     * Get the raw filter string (without parentheses).
+     */
+    public function getRaw(): string
+    {
+        return "{$this->attribute}=*{$this->value}";
+    }
+
     /**
      * Compile the filter to its LDAP string representation.
      */
     public function __toString(): string
     {
-        return "({$this->attribute}=*{$this->value})";
+        return "({$this->getRaw()})";
     }
 }

src/Query/Filter/EndsWith.php

@@ -2,7 +2,7 @@
 
 namespace LdapRecord\Query\Filter;
 
-class Equals implements Filter
+class Equals implements ConditionFilter
 {
     /**
      * Create a new equals filter.
@@ -12,11 +12,43 @@ public function __construct(
         protected string $value
     ) {}
 
+    /**
+     * Get the filter's attribute.
+     */
+    public function getAttribute(): string
+    {
+        return $this->attribute;
+    }
+
+    /**
+     * Get the filter's operator.
+     */
+    public function getOperator(): string
+    {
+        return '=';
+    }
+
+    /**
+     * Get the filter's value.
+     */
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+
+    /**
+     * Get the raw filter string (without parentheses).
+     */
+    public function getRaw(): string
+    {
+        return "{$this->attribute}={$this->value}";
+    }
+
     /**
      * Compile the filter to its LDAP string representation.
      */
     public function __toString(): string
     {
-        return "({$this->attribute}={$this->value})";
+        return "({$this->getRaw()})";
     }
 }