Proxied Filters

[taskinbirtan]

Hello dear Spatie community,

I have been building a Rest-API, trying not to let go of JSON-API standards being described https://jsonapi.org/

I have been using spatie/laravel-query-builder since the beginning because I know how much effort has been put into this great repository.

I have faced a different type of problem where I have double classes let's say:

Customer::class and CustomerArchive::class models. They are both the same models; one of them targets customer table, the other is customer_archive table with the same exact properties.

Actually, customer_archive table is the source of the soft_deleted data of customer table.

So one can say API_URL/api/v1/customer?filter[trashed]=only must return the customer_archive table data.

I have used a hack to make this work like a charm.

class FiltersProxy implements Filter
{
    public function __construct(
        protected $proxy
    )
    {

    }

    /** {@inheritdoc} */
    public function __invoke(Builder $query, $values, string $property = null)
    {
        $proxyModel = new ($this->proxy);
        $query->setModel($proxyModel);
        return;
    }

}
`

`QueryBuilder::for(Customer::class)->allowedFilters(AllowedFilter::custom('trashed', new FiltersProxy(CustomerArchive::class)))`

I know that this won't answer the filter[trashed]=with filter, but It might be done also. 

FiltersProxy will move the source model class to other if it is needed. Perhaps maybe can be applied for extreme purposes if Spatie needs such an option?

Regards. 

Birtan Taskin
Software Engineer