https://github.com/jeidison/model-filtrable

Filter Eloquent Models and Relationships
https://github.com/jeidison/model-filtrable

eloquent filter filtrable laravel like model query relationship search sort with

Last synced: 1 day ago
JSON representation

Filter Eloquent Models and Relationships

• Host: GitHub
• URL: https://github.com/jeidison/model-filtrable
• Owner: jeidison
• Created: 2020-03-09T21:27:35.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-08T02:32:05.000Z (about 4 years ago)
• Last Synced: 2024-11-20T20:58:14.333Z (2 months ago)
• Topics: eloquent, filter, filtrable, laravel, like, model, query, relationship, search, sort, with
• Language: PHP
• Size: 41 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Model Filtrable

### Installation

```bash

$ composer require jeidison/model-filtrable

```

# Usage

#### Add Trait in model

```php

...

use Jeidison\Filtrable\Filtrable;

class Professional extends Model

{

    use Filtrable;

    ...

    protected $fillable = [

        //All fields filtrable;

    ];

    ...

    public function places()

    {

        return $this->belongsToMany(Place::class, 'prof_place', 'id_prof', 'id_place');

    }

    

    public function specialties()

    {

        return $this->belongsToMany(Specialty::class, 'prof_spec', 'id_prof', 'id_spec');

    }

}

```

#### Service

```php

...

use App\Models\Professional;

class ProfessionalService implements IProfessionalService

{

    public function filter()

    {

         return Professional::filter(request()->all())->get(); 

        // or

         return Professional::filter(['field_one' => 'value1'])->get();     

    }

}

```

## Querying at the API-endpoint

### Filtering:

Where

```

    /api/professionals?id_prof=1

    or

    /api/professionals?id_prof:==1

    or

    /api/professionals?id_prof:<>=1

    or

    /api/professionals?id_prof:!==1

    or

    /api/professionals?id_prof:>=1

    or

    /api/professionals?id_prof:<=1

    ...

```

WhereIn

```

    /api/professionals?id_prof:in=1,2

```

WhereNotIn

```

    /api/professionals?id_prof:notIn=1,2

```

WhereBetween

```

    /api/professionals?id_prof:between=1,2

    /api/professionals?updated_at:between=2020-03-10 14:00:27,2020-03-10 14:00:27

```

WhereNotBetween

```

    /api/professionals?id_prof:notBetween=1,2

    /api/professionals?updated_at:notBetween=2020-03-10 14:00:27,2020-03-10 14:00:27

```

WhereNull

```

    /api/professionals?id_prof:null=

```

WhereNotNull

```

    /api/professionals?id_prof:notNull=

```

Where Like

```

    /api/professionals?prof_name:like=Jeidison%

```

Where Date

```

    /api/professionals?created_at:whereDate=2020-03-10

```

orWhere

```

    /api/professionals?id_prof:>=100&prof_name:orWhere=Jeidison

```

With:

```

    /api/professionals?with=places,specialties

```

Has:

```

    /api/professionals?has=places

```

Relationship:

```

    /api/places->id_place=1

    /api/places->professionals->id_place=1

    /api/places->professionals->id_place:<>=1

    /api/places->professionals->id_place:<=1

    ...

```

Order By:

```

    /api/professionals?order=id_place

    or 

    /api/professionals?order=id_prof:desc

    or 

    /api/professionals?order=id_prof:asc

    or 

    /api/professionals?order=id_place,id_prof:desc

    or 

    /api/professionals?order=id_place:asc,id_prof:desc

```

Fields Response:

```

    /api/professionals?fields=id_place,prof_name,prof_phone,prof_email

```

Paginate:

```

    /api/professionals?paginate

    or

    /api/professionals?paginate&paginate:page=0

    or

    /api/professionals?paginate&paginate:perPage=10&paginate:page=0

    ...

```

## Credits

- [Jeidison Farias](https://github.com/jeidison)