Suggestion to the Filterable Package

[khaledhatahet]

Hi Contributors,

I hope this message finds you well.

I’m working on a large project that heavily relies on filters, and during my search for a suitable package, I came across yours. After testing it, I must say that it is both extremely helpful and well-structured—great job!

However, I encountered an issue when trying to create a base model and applying the Filterable trait to it, intending to extend it across all my models. The problem arises when a model doesn't have a corresponding filter class, causing the project to break.

To address this, I made a small modification to the code that resolves the issue. I was wondering if you could consider incorporating this change into the package. I’d be happy to share the modification if needed.

change the scope on this line :

EloquentFilter/src/Filterable.php

Line 22 in f265b78

public function scopeFilter($query, array $input = [], $filter = null)

to this :

public function scopeFilter($query, array $input = [], $filter = null)
    {
        if ($filter === null) {

            if (class_exists($this->getModelFilterClass())) {
                $filter = $this->getModelFilterClass();

                $modelFilter = new $filter($query, $input);

                // Set the input that was used in the filter (this will exclude empty strings)
                $this->filtered = $modelFilter->input();

                // Return the filter query
                return $modelFilter->handle();
            }
        }

        // Create the model filter instance

        return $query;
    }

Thank you for your great work, and I look forward to hearing from you!

Best regards

[Tucker-Eric]

@khaledhatahet Appreciate bringing this up! Ya, we'd definitely be able to support this if you wanted to create a PR to add?

[khaledhatahet]

@Tucker-Eric
Yes, sure! I'd be happy to send a PR for this. I actually tried already, but I think the repo is closed for contributions. Could you please give me access? I'll push it tomorrow morning.

[Tucker-Eric]

@khaledhatahet it should be open for PRs. You're gonna have to fork the repo first and then send the PR back after updating.

[khaledhatahet]

@Tucker-Eric
Ok, thank you
I went ahead and fork the project—just submitted the PR with the update.

[Tucker-Eric]

@khaledhatahet released in 3.5.1

[Tucker-Eric]

@khaledhatahet I have to revert this as it breaks dynamic filters

Looking at your initial issue, it sounds like you could add a modelFilter method to your base class that everything extends that will fix the issue you're seeing.

<?

public function modelFilter()
{
    return My\Base\ModelFilter::class
}