awstalib/filterable-qm

Filterable Query or model Package

2.0.1 2024-01-27 11:09 UTC

Requires

• php: >=7.2
• illuminate/support: ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0

MIT

• awstalib

• pagination
• query
• filterable
• laravel

README

FilterableQm is a Laravel package that provides traits for filtering and paginating Eloquent models seamlessly. It includes the FilterableQm trait for filtering models and the PaginateQm trait for easy pagination.

Installation

You can install the package via Composer. Run the following command:

composer require awstalib/filterable-qm 

Usage

FilterableQm Trait In your Eloquent model, use the FilterableQm trait:

use Awstalib\FilterableQm\FilterableQm;

class YourModel extends Model
{
    use FilterableQm;

    // Your model logic here
}

Use the applyFilters method on your model's query builder:

$filteredData = YourModel::query()->applyFilters($filters)->get();

PaginateQm Trait In your Eloquent model, use the PaginateQm trait:

use Awstalib\FilterableQm\PaginateQm;

class YourModel extends Model
{
    use PaginateQm;
    protected $filterItem=['col1','col2'];
     // Your model logic here
    //You can extend filter with your own filter
    public function extendedFilter($query, $filterItem, $value)
    {
        if ($filterItem === 'account_currency' && !empty($value)) {
            $query->whereHas('account', function ($query) use ($value) {
                $query->where('currency_id', $value);
            });
        }
        if($filterItem === 'account_number' && !empty($value)) {
            $query->whereHas('account', function ($query) use ($value) {
                $query->where('account_number', $value);
            });
        }
        return $query;
    }
   
}

Utilize the paginateModel method in your controller:

public function index(Request $request)
{
    $data = $this->paginateModel(new YourModel(), $request, false);
    return ApiResponse::success($data->data, 'Data retrieved successfully', null, $data->count);
}

Version History

1.0.0 (January 7, 2024)

• Initial release.
• Added FilterableQm and PaginateQm traits.
• Basic filtering and pagination functionality.

Contributing

Feel free to contribute to this project by forking it and creating a pull request.

License

This package is open-source and available under the MIT License.