Support various time formats in whereTime

Author: GromNaN

src/Query/Builder.php

@@ -1273,11 +1273,21 @@ protected function compileWhereYear(array $where): array
      */
     protected function compileWhereTime(array $where): array
     {
+        if (! is_string($where['value']) || ! preg_match('/^[0-2][0-9](:[0-6][0-9](:[0-6][0-9])?)?$/', $where['value'], $matches)) {
+            throw new \InvalidArgumentException(sprintf('Invalid time format, expected HH:MM:SS, HH:MM or HH, got "%s"', is_string($where['value']) ? $where['value'] : get_debug_type($where['value'])));
+        }
+
+        $format = match (count($matches)) {
+            1 => '%H',
+            2 => '%H:%M',
+            3 => '%H:%M:%S',
+        };
+
         return [
             '$expr' => [
                 '$'.$where['operator'] => [
                     [
-                        '$dateToString' => ['date' => '$'.$where['column'], 'format' => '%H:%M:%S'],
+                        '$dateToString' => ['date' => '$'.$where['column'], 'format' => $format],
                     ],
                     $where['value'],
                 ],

tests/Query/BuilderTest.php

@@ -760,7 +760,7 @@ function (Builder $builder) {
             fn (Builder $builder) => $builder->whereYear('created_at', '>', '2023'),
         ];
 
-        yield 'where time' => [
+        yield 'where time HH:MM:SS' => [
             ['find' => [['$expr' => [
                 '$eq' => [
                     ['$dateToString' => ['date' => '$created_at', 'format' => '%H:%M:%S']],
@@ -770,6 +770,36 @@ function (Builder $builder) {
             fn (Builder $builder) => $builder->whereTime('created_at', '10:11:12'),
         ];
 
+        yield 'where time HH:MM' => [
+            ['find' => [['$expr' => [
+                '$eq' => [
+                    ['$dateToString' => ['date' => '$created_at', 'format' => '%H:%M']],
+                    '10:11',
+                ],
+            ]], []]],
+            fn (Builder $builder) => $builder->whereTime('created_at', '10:11'),
+        ];
+
+        yield 'where time HH' => [
+            ['find' => [['$expr' => [
+                '$eq' => [
+                    ['$dateToString' => ['date' => '$created_at', 'format' => '%H']],
+                    '10',
+                ],
+            ]], []]],
+            fn (Builder $builder) => $builder->whereTime('created_at', '10'),
+        ];
+
+        yield 'where time DateTime' => [
+            ['find' => [['$expr' => [
+                '$eq' => [
+                    ['$dateToString' => ['date' => '$created_at', 'format' => '%H:%M:%S']],
+                    '10:11:12',
+                ],
+            ]], []]],
+            fn (Builder $builder) => $builder->whereTime('created_at', new \DateTimeImmutable('2023-08-22 10:11:12')),
+        ];
+
         yield 'where time >' => [
             ['find' => [['$expr' => [
                 '$gt' => [
@@ -908,6 +938,24 @@ public static function provideExceptions(): iterable
             'Missing expected ending delimiter "/" in regular expression "/foo#bar"',
             fn (Builder $builder) => $builder->where('name', 'regex', '/foo#bar'),
         ];
+
+        yield 'whereTime with invalid time' => [
+            \InvalidArgumentException::class,
+            'Invalid time format, expected HH:MM:SS, HH:MM or HH, got "10:11:12:13"',
+            fn (Builder $builder) => $builder->whereTime('created_at', '10:11:12:13'),
+        ];
+
+        yield 'whereTime out of range' => [
+            \InvalidArgumentException::class,
+            'Invalid time format, expected HH:MM:SS, HH:MM or HH, got "23:70"',
+            fn (Builder $builder) => $builder->whereTime('created_at', '23:70'),
+        ];
+
+        yield 'whereTime invalid type' => [
+            \InvalidArgumentException::class,
+            'Invalid time format, expected HH:MM:SS, HH:MM or HH, got "stdClass"',
+            fn (Builder $builder) => $builder->whereTime('created_at', new \stdClass()),
+        ];
     }
 
     /** @dataProvider getEloquentMethodsNotSupported */

tests/QueryTest.php

@@ -270,6 +270,12 @@ public function testWhereTime(): void
         $time = Birthday::whereTime('birthday', '10:53:11')->get();
         $this->assertCount(1, $time);
 
+        $time = Birthday::whereTime('birthday', '10:53')->get();
+        $this->assertCount(6, $time);
+
+        $time = Birthday::whereTime('birthday', '10')->get();
+        $this->assertCount(6, $time);
+
         $time = Birthday::whereTime('birthday', '>=', '10:53:14')->get();
         $this->assertCount(3, $time);