Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samaviam/model-filtration
Filtering the desired model records using query string in Laravel app
https://github.com/samaviam/model-filtration
laravel laravel-package php php-attributes php8
Last synced: 20 days ago
JSON representation
Filtering the desired model records using query string in Laravel app
- Host: GitHub
- URL: https://github.com/samaviam/model-filtration
- Owner: samaviam
- License: mit
- Created: 2023-01-30T17:14:40.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-06T18:08:35.000Z (almost 2 years ago)
- Last Synced: 2024-11-17T07:09:55.567Z (about 1 month ago)
- Topics: laravel, laravel-package, php, php-attributes, php8
- Language: PHP
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Filtering the desired model records using query string in Laravel app
[](https://packagist.org/packages/samavidev/model-filtration)
[](https://github.com/samavidev/model-filtration/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/samavidev/model-filtration/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/samavidev/model-filtration)
This package provides an annotation to retrieve records of a specific model filtered using a query string. Here's a quick example:
```php
namespace App\Models;
use Illuminate\Foundation\Auth\User as Authenticatable;
use SamaviDev\ModelFiltration\Attributes\Filter;
#[Filter(['name' => 'username'])]
class User extends Authenticatable
{
...
}
```
## Installation
You can install the package via composer:
```bash
composer require samavidev/model-filtration
```
## Usage
- The first argument is valid fields that can be used in the query string. which can be in the form of a string or an array, you can also use an association array to assign a query to a specific model.
- The second argument is the operator that is applied to the table fields (`and`, `or`, `like`, `like:or`). You can even use `with` for relationships. The default value is `and`.
for example:
```php
#[Filter(['name' => 'username', 'email' => 'useremail'], 'or')]
```
It can also be used multiple times.
```php
namespace App\Models;
use Illuminate\Foundation\Auth\User as Authenticatable;
use SamaviDev\ModelFiltration\Attributes\Filter;
#[Filter('id')]
#[Filter(['name' => 'username'])]
class User extends Authenticatable
{
...
}
```
##### Filter group definition:
You can also define an `Attribute` class to use as a group of filters for your models. For this, you must implement the `Group` interface.
```php
namespace App\Attributes;
use Attribute;
use SamaviDev\ModelFiltration\Contracts\Group;
#[Attribute]
class UsersFilter implements Group
{
public function props(): array
{
return [
'or' => ['attribute', ...]
'and' => ['attribute' => 'alias', ...],
...
];
}
}
```
And finally, you can use it in your model like this:
```php
namespace App\Models;
use Illuminate\Foundation\Auth\User as Authenticatable;
use App\Attributes\UsersFilter;
#[UsersFilter]
class User extends Authenticatable
{
...
}
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Mahdi Samavi](https://github.com/SamaviDev)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.