PHP code example of culturegr / filterer

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

culturegr / filterer example snippets

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Client extends Model
{
    protected $date = ['registered_at'];

    public function country()
    {
        return $this->belongsTo(Country::class);
    }

    public function orders()
    {
        return $this->hasMany(Order::class);
    }

    public function favoriteProducts()
    {
        return $this->belongsToMany(FavoriteProduct::class);
    }

}

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use CultureGr\Filterer\Filterable;

class Client extends Model
{
    use Filterable;
    ...
}

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use CultureGr\Filterer\Filterable;

class Client extends Model
{
    use Filterable;

    protected $filterable = ['age', 'country.name', 'orders.items', 'favoriteProducts.price'];

    protected $sortable = ['age', 'country.name', 'orders.items', 'favoriteProducts.price'];
    ...
}

Client::filter([
    'filter' => [
        [
            'column' => <FILTERABLE>,
            'operator' => <OPERATOR>,
            'query_1' => <VALUE>,
            'query_2' => null|<VALUE> // query_2 is 

Client::filter([
    'filters' => [
        [
            'column' => 'age',
            'operator' => 'between',
            'query_1' => '35',
            'query_2' => '40'
        ],
        [
            'column' => 'country.name',
            'operator' => 'equal_to',
            'query_1' => 'Greece',
            'query_2' => null
        ],
        [
            'column' => 'orders.shipped_at',
            'operator' => 'between_date',
            'query_1' => '2020-05-1',
            'query_2' => '2020-05-31'
        ],
        [
            'column' => 'favoriteProducts.price',
            'operator' => 'less_than',
            'query_1' => '10',
            'query_2' => null
        ],
    ],
])->get();

namespace App\CustomFilters;

use CultureGr\Filterer\Contracts\CustomFilterInterface;
use Illuminate\Database\Eloquent\Builder;

class ActiveClientsFilter implements CustomFilterInterface
{
    /**
     * Apply the custom filter to the query builder.
     *
     * @param Builder $builder The query builder instance
     * @param array<string, mixed> $filter The filter array
     *
     * @phpstan-param array{
     *      column: string,
     *      operator: string,
     *      query_1: string,
     *      query_2: string
     *  } $filter
     */
    public function apply(Builder $builder, $filter): Builder
    {
        // Your custom filter logic here...

        $queryValue = $filter['query_1']
        
        if ($queryValue === '1') {
            $builder->whereHas('orders', function($q) {
                $q->where('created_at', '>=', Carbon::now()->subDays(30));
            });
        } else {
            $builder->where(function($query) {
                $query->whereDoesntHave('orders')
                    ->orWhereHas('orders', function($q) {
                        $q->where('created_at', '<', Carbon::now()->subDays(30));
                    });
            });
        }
    }
}

use CultureGr\Filterer\Filterable;
use Illuminate\Database\Eloquent\Model;

class Client extends Model
{
    use Filterable;
    
    //...
    
    protected $customFilters = [
        'active' => ActiveClientsFilter::class,
    ];
    
    //...
}

Client::filter([
    'filters' => [
        [
            'column' => 'active',
            'operator' => 'equals',
            'query_1' => '1',
            'query_2' => null,
        ],
    ],
])->get();

Client::filter([
    'sort' => [
        [
            'column' => <SORTABLE>,
            'direction' => <asc|desc>,
        ],
        ...
    ]
])->get();

Client::filter([
    'sorts' => [
        [
            'column' => 'age',
            'direction' => 'asc',
        ],
        [
            'column' => 'country.name',
            'direction' => 'desc',
        ],
        [
            'column' => 'orders.items',
            'direction' => 'asc',
        ],
        [
            'column' => 'favoriteProducts.price',
            'direction' => 'desc',
        ],
    ]
])->get();

// From URL query parameters (Laravel's automatic page detection)
$clients = Client::filterPaginate(request()->query());

// From stored data like cookies (explicit page handling)
$clients = Client::filterPaginate(['page' => 2, 'limit' => 15, 'filters' => [...]]);

// Custom default limit
$clients = Client::filterPaginate($queryString, 25);

public function index()
{
    $filters = request()->query() ?:
               json_decode(request()->cookie('filters'), true) ?:
               [];

    $results = User::filterPaginate($filters);

    return response()->json($results)
        ->cookie('filters', json_encode(request()->query()), 15);
}

// ❌ Missing page in stored data
$stored = ['limit' => 20, 'filters' => [...]];

// ✅ Include page in stored data
$stored = ['page' => 2, 'limit' => 20, 'filters' => [...]];

// Simple pagination (no total count, more efficient)
$clients = Client::filterSimplePaginate([
    'filters' => [...],
    'sorts' => [...],
    'limit' => 20,
    'page' => 1,
]);

// Returns Illuminate\Pagination\Paginator (simple paginator)

// Get count of filtered results
$count = Client::filterCount([
    'filters' => [
        [
            'column' => 'status',
            'operator' => 'equal_to',
            'query_1' => 'active',
        ],
    ],
    // Note: sorts are ignored for counting (performance optimization)
]);

// Returns integer count

'pagination' => [
    'default_limit' => env('FILTERER_DEFAULT_LIMIT', 10),        // Default items per page
    'max_limit' => env('FILTERER_MAX_LIMIT'),                    // Maximum items per page (null = no limit)
    'page_name' => env('FILTERER_PAGE_NAME', 'page'),            // Query parameter name for pagination
],

'validation' => [
    'error_messages' => [         // Custom validation error messages (empty = use app translations)
        'limit.max' => 'The limit may not be greater than :max.',
        'filters.*.column.in' => 'The selected filter column is not allowed.',
        // ... other custom messages
    ],
],

'security' => [
    'allowed_operators' => [      // Restrict available operators globally
        'equal_to',
        'contains',
        // ... only allow specific operators (empty = allow all)
    ],
],

// Using filter (returns Builder)
Client::filter([
    'filters' => [...],
    'sorts' => [...],
])->paginate(); // explicitly call paginate() method on Builder instance

// Using filterPaginate (returns LengthAwarePaginator)
Client::filterPaginate([
    'filters' => [...],
    'sorts' => [...],
    'limit' => 15,
    'page' => 2,
]);

bash
php artisan vendor:publish --tag=filterer-config