#Create the filter

php artisan make:filter TestDateFilter -t date -f fieldname

this creates a filter class that extends DateFilter

<?php

namespace App\Models\Filters;

use Lacodix\LaravelModelFilter\Filters\DateFilter;

class TestDateFilter extends DateFilter
{
    protected string $field = 'fieldname';
}

A fieldname must be set, this will apply a where query to the model-query where fieldname equals the given value.

#Filter Modes

Default mode is EQUAL

<?php

namespace App\Models\Filters;

use Lacodix\LaravelModelFilter\Enums\FilterMode;
use Lacodix\LaravelModelFilter\Filters\DateFilter;

class TestDateFilter extends DateFilter
{
    public FilterMode $mode = FilterMode::LOWER;

    protected string $field = 'fieldname';
}

Allowed modes are

• FilterMode::LOWER
• FilterMode::GREATER
• FilterMode::LOWER_OR_EQUAL
• FilterMode::GREATER_OR_EQUAL
• FilterMode::EQUAL (default)
• FilterMode::BETWEEN
• FilterMode::BETWEEN_EXCLUSIVE
• FilterMode::NOT_BETWEEN
• FilterMode::NOT_BETWEEN_INCLUSIVE

#Modes with two values

For using the between and not between filters you have to provide two values to the filter. You can omit one of the values, if it shall not be applied. You can offer a between filter and only fill in the first or second value to get behaviour like a lower or greater filter.

For providing multiple values use the following query parameters

# For FilterMode::BETWEEN
# finds all between 2023-01-01 and 2023-01-10
https://.../posts?test_date_filter[]=2023-01-01&test_date_filter[]=2023-01-10
https://.../posts?test_date_filter[0]=2023-01-01&test_date_filter[1]=2023-01-10

# finds all greater or equal than 2023-01-01
https://.../posts?test_date_filter[0]=2023-01-01&test_date_filter[1]=

# finds all smaller or equal then 2023-01-10
https://.../posts?test_date_filter[0]=&test_date_filter[1]=2023-01-10

or programmatically

Post::filter(['created_at_filter' => ['2023-01-01', '2023-01-10']])->get();
Post::filter(['created_at_filter' => ['', '2023-01-10']])->get();

FilterMode::BETWEEN will include both days, FilterMode::BETWEEN_EXCLUSIVE will exclude both days.

FilterMode::NOT_BETWEEN will also exclude posts, that are created on one of both days,

FilterMode::NOT_BETWEEN_INCLUSIVE will include posts that are created on these days.