Convert Relation to Enum.

Author: byjg

src/Enum/Relation.php

@@ -7,56 +7,16 @@
  *
  * Use this in AddRelation method.
  */
-class Relation
+enum Relation
 {
-
-    /**
-     * "Equal" relational operator
-     */
-    const EQUAL = 0;
-
-    /**
-     * "Less than" relational operator
-     */
-    const LESS_THAN = 1;
-
-    /**
-     * "Greater than" relational operator
-     */
-    const GREATER_THAN = 2;
-
-    /**
-     * "Less or Equal Than" relational operator
-     */
-    const LESS_OR_EQUAL_THAN = 3;
-
-    /**
-     * "Greater or equal than" relational operator
-     */
-    const GREATER_OR_EQUAL_THAN = 4;
-
-    /**
-     * "Not equal" relational operator
-     */
-    const NOT_EQUAL = 5;
-
-    /**
-     * "Starts with" unary comparator
-     */
-    const STARTS_WITH = 6;
-
-    /**
-     * "Contains" unary comparator
-     */
-    const CONTAINS = 7;
-
-    /**
-     * "In" unary comparator
-     */
-    const IN = 8;
-
-    /**
-     * "Not In" unary comparator
-     */
-    const NOT_IN = 9;
-}
+    case EQUAL;
+    case LESS_THAN;
+    case GREATER_THAN;
+    case LESS_OR_EQUAL_THAN;
+    case GREATER_OR_EQUAL_THAN;
+    case NOT_EQUAL;
+    case STARTS_WITH;
+    case CONTAINS;
+    case IN;
+    case NOT_IN;
+}

src/IteratorFilter.php

@@ -107,25 +107,25 @@ private function evalString(Row $singleRow): bool
 
     /**
      * @param string $name Field name
-     * @param int $relation Relation enum
-     * @param array|string $value Field string value
+     * @param Relation $relation Relation enum
+     * @param mixed $value Field string value
      * @return static
      * @desc Add a single string comparison to filter.
      */
-    public function addRelation(string $name, int $relation, mixed $value): static
+    public function addRelation(string $name, Relation $relation, mixed $value): static
     {
         $this->filters[] = [" and ", $name, $relation, $value];
         return $this;
     }
 
     /**
      * @param string $name Field name
-     * @param int $relation Relation enum
-     * @param array|string $value Field string value
+     * @param Relation $relation Relation enum
+     * @param mixed $value Field string value
      * @return static
      * @desc Add a single string comparison to filter. This comparison use the OR operator.
      */
-    public function addRelationOr(string $name, int $relation, mixed $value): static
+    public function addRelationOr(string $name, Relation $relation, mixed $value): static
     {
         $this->filters[] = [" or ", $name, $relation, $value];
         return $this;

src/IteratorFilterFormatter.php

@@ -2,19 +2,21 @@
 
 namespace ByJG\AnyDataset\Core;
 
+use ByJG\AnyDataset\Core\Enum\Relation;
+
 abstract class IteratorFilterFormatter
 {
 
     /**
      * Get Relation
      *
      * @param string $name
-     * @param string $relation
+     * @param Relation $relation
      * @param array|string $value
      * @param array $param
      * @return string
      */
-    abstract public function getRelation(string $name, string $relation, mixed $value, array &$param): string;
+    abstract public function getRelation(string $name, Relation $relation, mixed $value, array &$param): string;
 
     /**
      * Get formatted field

src/IteratorFilterXPathFormatter.php

@@ -24,7 +24,7 @@ public function format(array $filters, string $tableName = null, array &$params
      /**
       * @inheritDoc
       */
-    public function getRelation(string $name, string $relation, mixed $value, array &$param): string
+    public function getRelation(string $name, Relation $relation, mixed $value, array &$param): string
     {
           $str = is_numeric($value) ? "" : "'";
           $field = "field[@name='" . $name . "'] ";