feat: add support for BackedEnums in query params (#171)

simPod · Aug 15, 2022 · 8a9beee · 8a9beee
1 parent 77922e4
commit 8a9beee
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 0 deletions.
diff --git a/src/Sql/ValueFormatter.php b/src/Sql/ValueFormatter.php
@@ -4,6 +4,7 @@
 
 namespace SimPod\ClickHouseClient\Sql;
 
+use BackedEnum;
 use DateTimeImmutable;
 use DateTimeZone;
 use SimPod\ClickHouseClient\Exception\UnsupportedValue;
@@ -57,6 +58,12 @@ public function format(mixed $value, string|null $paramName = null, string|null
             return 'NULL';
         }
 
+        if ($value instanceof BackedEnum) {
+            return is_string($value->value)
+                ? "'" . Escaper::escape($value->value) . "'"
+                : (string) $value->value;
+        }
+
         if ($value instanceof DateTimeImmutable) {
             if ($this->dateTimeZone !== null) {
                 $value = $value->setTimezone($this->dateTimeZone);

diff --git a/tests/Sql/Fixture/BackedIntEnum.php b/tests/Sql/Fixture/BackedIntEnum.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimPod\ClickHouseClient\Tests\Sql\Fixture;
+
+enum BackedIntEnum: int
+{
+    case A = 0;
+}
diff --git a/tests/Sql/Fixture/BackedStringEnum.php b/tests/Sql/Fixture/BackedStringEnum.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimPod\ClickHouseClient\Tests\Sql\Fixture;
+
+enum BackedStringEnum: string
+{
+    case A = 'a';
+}
diff --git a/tests/Sql/ValueFormatterTest.php b/tests/Sql/ValueFormatterTest.php
@@ -9,6 +9,8 @@
 use SimPod\ClickHouseClient\Exception\UnsupportedValue;
 use SimPod\ClickHouseClient\Sql\Expression;
 use SimPod\ClickHouseClient\Sql\ValueFormatter;
+use SimPod\ClickHouseClient\Tests\Sql\Fixture\BackedIntEnum;
+use SimPod\ClickHouseClient\Tests\Sql\Fixture\BackedStringEnum;
 use SimPod\ClickHouseClient\Tests\TestCaseBase;
 use stdClass;
 
@@ -94,6 +96,16 @@ public function __toString(): string
                 }
             },
         ];
+
+        yield 'String backed enum' => [
+            "'a'",
+            BackedStringEnum::A,
+        ];
+
+        yield 'Int backed enum' => [
+            '0',
+            BackedIntEnum::A,
+        ];
     }
 
     /**