[9.x] Iterable value type for whereBetween (#36933)

hebinet · web-flow · commit f7cd47a6f3f5 · 2021-04-11T11:14:45.000-05:00
* Added CarbonPeriod value type to Query\Builder-&gt;whereBetween

* Removed CarbonPeriod typehint and replaced it with native iterable type
diff --git a/src/Illuminate/Database/Query/Builder.php b/src/Illuminate/Database/Query/Builder.php
@@ -1110,12 +1110,12 @@ public function whereNotNull($columns, $boolean = 'and')
      * Add a where between statement to the query.
      *
      * @param  string|\Illuminate\Database\Query\Expression  $column
-     * @param  array  $values
+     * @param  iterable  $values
      * @param  string  $boolean
      * @param  bool  $not
      * @return $this
      */
-    public function whereBetween($column, array $values, $boolean = 'and', $not = false)
+    public function whereBetween($column, iterable $values, $boolean = 'and', $not = false)
     {
         $type = 'between';
 
@@ -1148,10 +1148,10 @@ public function whereBetweenColumns($column, array $values, $boolean = 'and', $n
      * Add an or where between statement to the query.
      *
      * @param  string  $column
-     * @param  array  $values
+     * @param  iterable  $values
      * @return $this
      */
-    public function orWhereBetween($column, array $values)
+    public function orWhereBetween($column, iterable $values)
     {
         return $this->whereBetween($column, $values, 'or');
     }
@@ -1172,11 +1172,11 @@ public function orWhereBetweenColumns($column, array $values)
      * Add a where not between statement to the query.
      *
      * @param  string  $column
-     * @param  array  $values
+     * @param  iterable  $values
      * @param  string  $boolean
      * @return $this
      */
-    public function whereNotBetween($column, array $values, $boolean = 'and')
+    public function whereNotBetween($column, iterable $values, $boolean = 'and')
     {
         return $this->whereBetween($column, $values, $boolean, true);
     }
@@ -1198,10 +1198,10 @@ public function whereNotBetweenColumns($column, array $values, $boolean = 'and')
      * Add an or where not between statement to the query.
      *
      * @param  string  $column
-     * @param  array  $values
+     * @param  iterable  $values
      * @return $this
      */
-    public function orWhereNotBetween($column, array $values)
+    public function orWhereNotBetween($column, iterable $values)
     {
         return $this->whereNotBetween($column, $values, 'or');
     }
diff --git a/tests/Database/DatabaseQueryBuilderTest.php b/tests/Database/DatabaseQueryBuilderTest.php
@@ -673,6 +673,17 @@ public function testWhereBetweens()
         $builder->select('*')->from('users')->whereBetween('id', [new Raw(1), new Raw(2)]);
         $this->assertSame('select * from "users" where "id" between 1 and 2', $builder->toSql());
         $this->assertEquals([], $builder->getBindings());
+
+        $builder = $this->getBuilder();
+        $period = now()->toPeriod(now()->addDay());
+        $builder->select('*')->from('users')->whereBetween('created_at', $period);
+        $this->assertSame('select * from "users" where "created_at" between ? and ?', $builder->toSql());
+        $this->assertEquals($period->toArray(), $builder->getBindings());
+
+        $builder = $this->getBuilder();
+        $builder->select('*')->from('users')->whereBetween('id', collect([1, 2]));
+        $this->assertSame('select * from "users" where "id" between ? and ?', $builder->toSql());
+        $this->assertEquals([0 => 1, 1 => 2], $builder->getBindings());
     }
 
     public function testWhereBetweenColumns()

Original file line number	Diff line number	Diff line change
`@@ -1110,12 +1110,12 @@ public function whereNotNull($columns, $boolean = 'and')`
`1110`	`1110`	`* Add a where between statement to the query.`
`1111`	`1111`	`*`
`1112`	`1112`	`* @param string\|\Illuminate\Database\Query\Expression $column`
`1113`		`- * @param array $values`
	`1113`	`+ * @param iterable $values`
`1114`	`1114`	`* @param string $boolean`
`1115`	`1115`	`* @param bool $not`
`1116`	`1116`	`* @return $this`
`1117`	`1117`	`*/`
`1118`		`- public function whereBetween($column, array $values, $boolean = 'and', $not = false)`
	`1118`	`+ public function whereBetween($column, iterable $values, $boolean = 'and', $not = false)`
`1119`	`1119`	`{`
`1120`	`1120`	`$type = 'between';`
`1121`	`1121`
`@@ -1148,10 +1148,10 @@ public function whereBetweenColumns($column, array $values, $boolean = 'and', $n`
`1148`	`1148`	`* Add an or where between statement to the query.`
`1149`	`1149`	`*`
`1150`	`1150`	`* @param string $column`
`1151`		`- * @param array $values`
	`1151`	`+ * @param iterable $values`
`1152`	`1152`	`* @return $this`
`1153`	`1153`	`*/`
`1154`		`- public function orWhereBetween($column, array $values)`
	`1154`	`+ public function orWhereBetween($column, iterable $values)`
`1155`	`1155`	`{`
`1156`	`1156`	`return $this->whereBetween($column, $values, 'or');`
`1157`	`1157`	`}`
`@@ -1172,11 +1172,11 @@ public function orWhereBetweenColumns($column, array $values)`
`1172`	`1172`	`* Add a where not between statement to the query.`
`1173`	`1173`	`*`
`1174`	`1174`	`* @param string $column`
`1175`		`- * @param array $values`
	`1175`	`+ * @param iterable $values`
`1176`	`1176`	`* @param string $boolean`
`1177`	`1177`	`* @return $this`
`1178`	`1178`	`*/`
`1179`		`- public function whereNotBetween($column, array $values, $boolean = 'and')`
	`1179`	`+ public function whereNotBetween($column, iterable $values, $boolean = 'and')`
`1180`	`1180`	`{`
`1181`	`1181`	`return $this->whereBetween($column, $values, $boolean, true);`
`1182`	`1182`	`}`
`@@ -1198,10 +1198,10 @@ public function whereNotBetweenColumns($column, array $values, $boolean = 'and')`
`1198`	`1198`	`* Add an or where not between statement to the query.`
`1199`	`1199`	`*`
`1200`	`1200`	`* @param string $column`
`1201`		`- * @param array $values`
	`1201`	`+ * @param iterable $values`
`1202`	`1202`	`* @return $this`
`1203`	`1203`	`*/`
`1204`		`- public function orWhereNotBetween($column, array $values)`
	`1204`	`+ public function orWhereNotBetween($column, iterable $values)`
`1205`	`1205`	`{`
`1206`	`1206`	`return $this->whereNotBetween($column, $values, 'or');`
`1207`	`1207`	`}`