[11.x] Introduce where[Date,Time,Year,Month,Day]Between methods in query builder

src/Illuminate/Database/Query/Builder.php

@@ -4,6 +4,7 @@
 
 use BackedEnum;
 use Carbon\CarbonPeriod;
+use Carbon\Month;
 use Closure;
 use DateTimeInterface;
 use Illuminate\Contracts\Database\Query\Builder as BuilderContract;
@@ -1550,6 +1551,62 @@ public function orWhereDate($column, $operator, $value = null)
         return $this->whereDate($column, $operator, $value, 'or');
     }
 
+    /**
+     * Add a "where date between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|null>  $values
+     * @param  string  $boolean
+     * @param  bool  $not
+     * @return $this
+     */
+    public function whereDateBetween($column, iterable $values, $boolean = 'and', $not = false)
+    {
+        if ($values instanceof CarbonPeriod) {
+            $values = [$values->getStartDate(), $values->getEndDate()];
+        }
+
+        $values = array_slice(Arr::flatten($values), 0, 2);
+
+        $values = collect($values)
+            ->map(function ($value) {
+                if ($value instanceof DateTimeInterface) {
+                    return $value->format('Y-m-d');
+                }
+
+                return $value;
+            })
+            ->all();
+
+        return $this->addDateBasedWhereBetween('Date', $column, $values, $boolean, $not);
+    }
+
+    /**
+     * Add a "or where date between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|null>  $values
+     * @param  bool  $not
+     * @return $this
+     */
+    public function orWhereDateBetween($column, iterable $values, $not = false)
+    {
+        return $this->whereDateBetween($column, $values, 'or', $not);
+    }
+
+    /**
+     * Add a "where date not between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|null>  $values
+     * @param  string  $boolean
+     * @return $this
+     */
+    public function whereDateNotBetween($column, iterable $values, $boolean = 'or')
+    {
+        return $this->whereDateBetween($column, $values, $boolean, true);
+    }
+
     /**
      * Add a "where time" statement to the query.
      *
@@ -1581,6 +1638,62 @@ public function whereTime($column, $operator, $value = null, $boolean = 'and')
         return $this->addDateBasedWhere('Time', $column, $operator, $value, $boolean);
     }
 
+    /**
+     * Add a "where time between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|null>  $values
+     * @param  string  $boolean
+     * @param  bool  $not
+     * @return $this
+     */
+    public function whereTimeBetween($column, iterable $values, $boolean = 'and', $not = false)
+    {
+        if ($values instanceof CarbonPeriod) {
+            $values = [$values->getStartDate(), $values->getEndDate()];
+        }
+
+        $values = array_slice(Arr::flatten($values), 0, 2);
+
+        $values = collect($values)
+            ->map(function ($value) {
+                if ($value instanceof DateTimeInterface) {
+                    return $value->format('H:i:s');
+                }
+
+                return $value;
+            })
+            ->all();
+
+        return $this->addDateBasedWhereBetween('Time', $column, $values, $boolean, $not);
+    }
+
+    /**
+     * Add a "or where time between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|null>  $values
+     * @param  bool  $not
+     * @return $this
+     */
+    public function orWhereTimeBetween($column, iterable $values, $not = false)
+    {
+        return $this->whereTimeBetween($column, $values, 'or', $not);
+    }
+
+    /**
+     * Add a "where time not between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|null>  $values
+     * @param  string  $boolean
+     * @return $this
+     */
+    public function whereTimeNotBetween($column, iterable $values, $boolean = 'or')
+    {
+        return $this->whereTimeBetween($column, $values, $boolean, true);
+    }
+
     /**
      * Add an "or where time" statement to the query.
      *
@@ -1633,6 +1746,66 @@ public function whereDay($column, $operator, $value = null, $boolean = 'and')
         return $this->addDateBasedWhere('Day', $column, $operator, $value, $boolean);
     }
 
+    /**
+     * Add a "where day between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|int|null>  $values
+     * @param  string  $boolean
+     * @param  bool  $not
+     * @return $this
+     */
+    public function whereDayBetween($column, iterable $values, $boolean = 'and', $not = false)
+    {
+        if ($values instanceof CarbonPeriod) {
+            $values = [$values->getStartDate(), $values->getEndDate()];
+        }
+
+        $values = array_slice(Arr::flatten($values), 0, 2);
+
+        $values = collect($values)
+            ->map(function ($value) {
+                if ($value instanceof DateTimeInterface) {
+                    return $value->format('d');
+                }
+
+                if (! $value instanceof ExpressionContract) {
+                    return sprintf('%02d', $value);
+                }
+
+                return $value;
+            })
+            ->all();
+
+        return $this->addDateBasedWhereBetween('Day', $column, $values, $boolean, $not);
+    }
+
+    /**
+     * Add a "or where day between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|int|null>  $values
+     * @param  bool  $not
+     * @return $this
+     */
+    public function orWhereDayBetween($column, iterable $values, $not = false)
+    {
+        return $this->whereDayBetween($column, $values, 'or', $not);
+    }
+
+    /**
+     * Add a "where day not between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|int|null>  $values
+     * @param  string  $boolean
+     * @return $this
+     */
+    public function whereDayNotBetween($column, iterable $values, $boolean = 'or')
+    {
+        return $this->whereDayBetween($column, $values, $boolean, true);
+    }
+
     /**
      * Add an "or where day" statement to the query.
      *
@@ -1685,6 +1858,70 @@ public function whereMonth($column, $operator, $value = null, $boolean = 'and')
         return $this->addDateBasedWhere('Month', $column, $operator, $value, $boolean);
     }
 
+    /**
+     * Add a "where month between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|int|null>  $values
+     * @param  string  $boolean
+     * @param  bool  $not
+     * @return $this
+     */
+    public function whereMonthBetween($column, iterable $values, $boolean = 'and', $not = false)
+    {
+        if ($values instanceof CarbonPeriod) {
+            $values = [$values->getStartDate(), $values->getEndDate()];
+        }
+
+        $values = array_slice(Arr::flatten($values), 0, 2);
+
+        $values = collect($values)
+            ->map(function ($value) {
+                if ($value instanceof DateTimeInterface) {
+                    return $value->format('m');
+                }
+
+                if (class_exists(Month::class) && $value instanceof Month) {
+                    $value = $value->value;
+                }
+
+                if (! $value instanceof ExpressionContract) {
+                    return sprintf('%02d', $value);
+                }
+
+                return $value;
+            })
+            ->all();
+
+        return $this->addDateBasedWhereBetween('Month', $column, $values, $boolean, $not);
+    }
+
+    /**
+     * Add a "or where month between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|int|null>  $values
+     * @param  bool  $not
+     * @return $this
+     */
+    public function orWhereMonthBetween($column, iterable $values, $not = false)
+    {
+        return $this->whereMonthBetween($column, $values, 'or', $not);
+    }
+
+    /**
+     * Add a "where month not between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|int|null>  $values
+     * @param  string  $boolean
+     * @return $this
+     */
+    public function whereMonthNotBetween($column, iterable $values, $boolean = 'or')
+    {
+        return $this->whereMonthBetween($column, $values, $boolean, true);
+    }
+
     /**
      * Add an "or where month" statement to the query.
      *
@@ -1733,6 +1970,62 @@ public function whereYear($column, $operator, $value = null, $boolean = 'and')
         return $this->addDateBasedWhere('Year', $column, $operator, $value, $boolean);
     }
 
+    /**
+     * Add a "where year between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|int|null>  $values
+     * @param  string  $boolean
+     * @param  bool  $not
+     * @return $this
+     */
+    public function whereYearBetween($column, iterable $values, $boolean = 'and', $not = false)
+    {
+        if ($values instanceof CarbonPeriod) {
+            $values = [$values->getStartDate(), $values->getEndDate()];
+        }
+
+        $values = array_slice(Arr::flatten($values), 0, 2);
+
+        $values = collect($values)
+            ->map(function ($value) {
+                if ($value instanceof DateTimeInterface) {
+                    return $value->format('Y');
+                }
+
+                return $value;
+            })
+            ->all();
+
+        return $this->addDateBasedWhereBetween('Year', $column, $values, $boolean, $not);
+    }
+
+    /**
+     * Add a "or where year between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|int|null>  $values
+     * @param  bool  $not
+     * @return $this
+     */
+    public function orWhereYearBetween($column, iterable $values, $not = false)
+    {
+        return $this->whereYearBetween($column, $values, 'or', $not);
+    }
+
+    /**
+     * Add a "where year not between" statement to the query.
+     *
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  iterable<\DateTimeInterface|string|int|null>  $values
+     * @param  string  $boolean
+     * @return $this
+     */
+    public function whereYearNotBetween($column, iterable $values, $boolean = 'or')
+    {
+        return $this->whereYearBetween($column, $values, $boolean, true);
+    }
+
     /**
      * Add an "or where year" statement to the query.
      *
@@ -1771,6 +2064,27 @@ protected function addDateBasedWhere($type, $column, $operator, $value, $boolean
         return $this;
     }
 
+    /**
+     * Add a date based  (year, month, day, time) where between statement to the query.
+     *
+     * @param  string  $type
+     * @param  \Illuminate\Contracts\Database\Query\Expression|string  $column
+     * @param  string  $operator
+     * @param  mixed  $value
+     * @param  string  $boolean
+     * @return $this
+     */
+    protected function addDateBasedWhereBetween($type, $column, iterable $values, $boolean = 'and', $not = false)
+    {
+        $type = $type.'Between';
+
+        $this->wheres[] = compact('type', 'column', 'values', 'boolean', 'not');
+
+        $this->addBinding($this->cleanBindings($values), 'where');
+
+        return $this;
+    }
+
     /**
      * Add a nested where statement to the query.
      *