Allow the usage of more complex filter methods by Spatie\QueryBuilder

[bfiessinger]

currently sorting and filtering uses a pretty basic approach which will not always lead to the desired result.

For example you are searching a model named "Test"

{
	"filter": {
		"name": "Test"
	}
}

but this would also get the result for a model named "Testing" as the filter is fuzzy by default. But Spatie's Query Builder has multiple ways to enhance those queries. For example exact, scoped or even custom filters [link]

This PR adds support for this fine tuning.

Example:
Using an exact match filter for a model named "Test"

Model.php

<?php

use Spatie\QueryBuilder\AllowedFilter;

class Model {
    // public static array $allowedFilters = [
    //     'name'
    // ];

    public static function getAllowedFilters(): array
    {
        return [
            AllowedFilter::exact('name'),
        ];
    }
    ...
}

Congrats. Now only companies with the exact name of "Test" are shown.

Note:
The properties $allowedFields, $allowedSorts, $allowedFilters are still working.

[rupadana]

Thank you for your first contribution to this repository! 😄

maybe we have some contracts now like HasAllowedFields, HasAllowedSorts and others.

Can you into it?

[bfiessinger]

@rupadana sure I can get into it. One Concern I have would be that the naming might easily collide with other packages as allowed sorts, fields, and filters might apply to other things too besides an API.

What do you think about a naming like getAllowedApiFilters and HasAllowedApiFilters, etc.

[bfiessinger]

added Contracts in 736f6e2

I would personally suggest renaming as mentioned above and add another Contract named for example HasAllowedQueryModifiers or HasAllowedApiQueryModifiers which merges all these interfaces.

[rupadana]

added Contracts in 736f6e2

I would personally suggest renaming as mentioned above and add another Contract named for example HasAllowedQueryModifiers or HasAllowedApiQueryModifiers which merges all these interfaces.

Thank you for your suggestion, i think we still use HasAllowedFields, etc for v3. cause we will need more condition if we implemented here now.

I will bring it to v4 for better & clean code.