How to deal with SoftDeletes?

[tantchen]

All my models have the SoftDeletes trait. How can I automatically set the withTrashed method on the builder if my filters have the deleted_at column set?

[tantchen]

Ok for the moment i found a solution for me. With a custom defaultFilterResolverClass.

Replaced Trait:

<?php

namespace App\Models\Traits;

use Abbasudo\Purity\Traits\Filterable;
use App\Filters\SoftDeletes\Resolve;
use Illuminate\Database\Eloquent\SoftDeletes;

trait FilterableSoftDeletes {

    use Filterable;

    public function initializeFilterableSoftDeletes(): void
    {
        $traits = get_declared_traits();
        if(!in_array(SoftDeletes::class,$traits)){
            return;
        }
        $this->defaultFilterResolverClass = Resolve::class;
    }
}

The Filter Resolver

<?php

namespace App\Filters\SoftDeletes;

use Abbasudo\Purity\Filters\FilterList;
use Abbasudo\Purity\Filters\Resolve as AbbasudoResolve;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class Resolve extends AbbasudoResolve
{
    private Model $model;

    public function __construct(FilterList $filterList, Model $model)
    {
        parent::__construct($filterList, $model);
        $this->model = $model;
    }

    public function apply(Builder $query, string $field, array|string $values): void
    {
        if ($field === $this->model->getDeletedAtColumn()) {
            $query->withTrashed();
        }
        parent::apply($query, $field, $values);
    }
}

$aircraft = new App\Models\Aircraft();
$builder = $aircraft->query()->filter(['deleted_at' => ['$gte' => '2021-01-01T00:00:00Z']]);
echo $builder->toRawSql().PHP_EOL;
// select * from `aircraft` where `deleted_at` >= '2021-01-01T00:00:00Z'
$builder = $aircraft->query()->filter(['updated_at' => ['$gte' => '2021-01-01T00:00:00Z']]);
echo $builder->toRawSql().PHP_EOL;
// select * from `aircraft` where `updated_at` >= '2021-01-01T00:00:00Z' and `aircraft`.`deleted_at` is null

[abbasudo]

Hey @tantchen.
Nice solution. however , i suggest creating a new filter using make:filter command as described in docs

class TrashedFilter extends Filter
{
    /**
     * Operator to detect in the query params.
     *
     * @var string
     */
    protected static string $operator = '$wt';

    /**
     * Apply filter logic to $query.
     *
     * @return Closure
     */
    public function apply(): Closure
    {
        return function ($query) {
            if ($this->value) {
                $query->withTrashed();
            }
        };
    }
}

This way end users have more control over results.

[abbasudo]

Feel free to make a PR adding a new trashed filter with tests. or any solution to this problem.

[tantchen]

Thanks @abbasudo,

your solution is better than mine, that does not work at all because the custom Resolve is not available anymore under $or/$and filter scopes.