[6.x] Add default values for filters

[johannesMEGABAD]

⚡ PowerGrid - Pull Request

• Bug fix
• Enhancement
• New feature
• Breaking change

Description

This pull-request adds the functionality of setting default values for filters.

Usage

Simply chain ->default() to any filter with the appropriate value for that filter type:

public function filters(): array
{
    return [
        // Select filter - single value
        Filter::select('status', 'status')
            ->dataSource([...])
            ->default('active'),

        // Multi-select filter - array of values
        Filter::multiSelect('category_id', 'category_id')
            ->dataSource(Category::all())
            ->optionValue('id')
            ->optionLabel('name')
            ->default([1, 2, 3]),

        // Boolean filter - bool true, false, or string 'all'
        Filter::boolean('is_active', 'is_active')
            ->default(true),

        // Input text filter - string or array with no operators
        Filter::inputText('name', 'name')
            ->operators(),
            ->default('laptop'),

        // Input text with operator
        Filter::inputText('sku', 'sku')
            ->operators(['contains', 'starts_with'])
            ->default([
                'value' => 'PRD',
                'operator' => 'starts_with',
            ]),

        // Number filter - single value or range
        Filter::number('price', 'price')
            ->default(50), // minimum price

        // Number filter - range
        Filter::number('stock', 'stock')
            ->default([
                'start' => 10,
                'end' => 1000,
            ]),

        // Date filter - just start and end dates
        Filter::datepicker('created_at', 'created_at')
            ->default([
                'start' => '2025-01-01',
                'end' => '2025-12-31',
                'formatted' => '01.01.2023 bis 01.01.2025',
            ]),
    ];
}

Related Issue(s):

Documentation

This PR requires Documentation update?

• Yes
• No
• I have already submitted a Documentation pull request.

[johannesMEGABAD]

@luanfreitasdev Here is my PR for the functionality to add default values to filters.. I hope I did not miss anything.. when testing everything worked fine for me. Probably it would be good to also add this to the documentation.

Also probably need to write/rewrite some test cases.. I am looking into that.
Failing tests seem to be all from FilterDatePickerTest.php:151 .. tho clearing the filter from the UI works fine.. looking into it

[johannesMEGABAD]

Ok I found the issue with the failing test cases and fixed it

[MrYamous]

I think is_null check is redundant here

[johannesMEGABAD]

Yup you are correct. Fixing it.

[luanfreitasdev]

@johannesMEGABAD. Thanks you for this PR!

Can you add any test ?

[luanfreitasdev]

Suggestion:

$columnsByField = collect($this->columns)
  ->mapWithKeys(fn (Column $column) => [
      filled($column->field) ?? filled($column->dataField) => $column,
  ]);

collect($this->filters())
    ->filter(fn ($filter) => filled($filter->defaultValue))
    ->each(function (FilterBase $filter) use (&$defaultFiltersApplied, $columnsByField) {
        $field = $filter->field;
        $column = $filter->column;
        $key = $filter->key;
        $defaultValue = $filter->defaultValue;

        $columnData = $columnsByField->get($column);
        $label = data_get($columnData, 'title', $field);

        switch ($key) {
            case 'select':
                data_set($this->filters, "select.{$field}", $defaultValue);
                $this->addEnabledFilters($field, $label);
                $defaultFiltersApplied = true;
                break;

            case 'multi_select':
                $values = is_array($defaultValue) ? $defaultValue : [$defaultValue];
                data_set($this->filters, "multi_select.{$field}", $values);
                $this->addEnabledFilters($field, $label);
                $defaultFiltersApplied = true;
                break;

            case 'boolean':
                data_set($this->filters, "boolean.{$field}", $defaultValue);
                $this->addEnabledFilters($field, $label);
                $defaultFiltersApplied = true;
                break;

            case 'input_text':
                if (is_array($defaultValue)) {
                    // Support for both value and operator
                    data_set($this->filters, "input_text.{$field}", $defaultValue['value'] ?? '');
                    if (isset($defaultValue['operator'])) {
                        data_set($this->filters, "input_text_options.{$field}", $defaultValue['operator']);
                    }
                } else {
                    data_set($this->filters, "input_text.{$field}", $defaultValue);
                }
                $this->addEnabledFilters($field, $label);
                $defaultFiltersApplied = true;
                break;

            case 'number':
                if (is_array($defaultValue)) {
                    if (isset($defaultValue['start'])) {
                        data_set($this->filters, "number.{$field}.start", $defaultValue['start']);
                    }
                    if (isset($defaultValue['end'])) {
                        data_set($this->filters, "number.{$field}.end", $defaultValue['end']);
                    }
                } else {
                    data_set($this->filters, "number.{$field}.start", $defaultValue);
                }
                $this->addEnabledFilters($field, $label);
                $defaultFiltersApplied = true;
                break;

            case 'date':
            case 'datetime':
                if (is_array($defaultValue) && isset($defaultValue['start']) && isset($defaultValue['end'])) {
                    $this->filters[$key][$field] = [
                        'start' => $defaultValue['start'],
                        'end' => $defaultValue['end'],
                        'formatted' => $defaultValue['formatted'] ?? '',
                    ];
                    $this->addEnabledFilters($field, $label);
                    $defaultFiltersApplied = true;
                }
                break;
        }
    });

if ($defaultFiltersApplied) {
    $this->persistState('filters');
}

[johannesMEGABAD]

@johannesMEGABAD. Thanks you for this PR!

Can you add any test ?

Yup, will do.

[johannesMEGABAD]

@luanfreitasdev Sorry it takes so long! Some stuff got in the way. Will do it this week.

[luanfreitasdev]

#2076