hackeresq / filter-models

v0.1 2025-01-24 21:46 UTC

Requires

• php: ^8.2
• laravel/framework: ^11.9

Unknown License

Published on Packagist.org on 2025-01-30 13:03 UTC

README

use HackerEsq\FilterModels\FilterModels;

class PortfolioController extends ApiController
{
    public function index(FilterModels $filters)
    {
        $filters->setQuery(Portfolio::query());
        $filters->setScopes(['myPortfolios']);
        $filters->setEagerRelations(['users', 'transactions', 'holdings']);
        $filters->setFilterableRelations(['holdings' => 'symbol', 'transactions' => 'symbol']);
        $filters->setSearchableColumns(['title', 'notes']);

        return $filters->paginated();
    }
}

Using filter classes

1. Define a custom filter that extends the FilterModels class:

namespace App\Filters;

use HackerEsq\FilterModels\FilterModels;

class PortfolioFilter extends FilterModels
{
    public function apply(): void
    {
        $this->setModel(Portfolio::class);
        $this->setScopes(['myPortfolios']);
        $this->setEagerRelations(['users', 'transactions', 'holdings']);
        $this->setFilterableRelations(['holdings' => 'symbol', 'transactions' => 'symbol']);
        $this->setSearchableColumns(['title', 'notes']);
    }
}

1. Then use your custom filter like this:

use App\Filters\PortfolioFilters;

class PortfolioController extends ApiController
{
    public function index(PortfolioFilters $filters)
    {

        return $filters->paginated();
    }
}