rcbytes/fetch

fetch your eloquent models

Fetch

![Software License][ico-license], _(*1)

Query Eloquent models easily. it is ideal for who uses Laravel as an API, _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require rcbytes/fetch, <sub>(*4)</sub>

On `config/app.php` 

Service Provider:
```php 
rcbytes\fetch\FetchServiceProvider::class

Facade:, <sub>(*5)</sub>

'Fetch' => rcbytes\fetch\Fetch::class

Usage

Controller

``` php ..., <sub>(*6)</sub>

class UserController extends Controller, <sub>(*7)</sub>

public function index(Request $request)
{

    // your criteria will overwrite criteria from Request->where  
    $where = [ "account_id" => $request->user()->account_id ];
    return Fetch::all(App\User::query(), $where);

}

public function show($id)
{

    // third parameter $key defaults to "id"
    return Fetch::one(App\User::query(), $id);

}

..., <sub>(*8)</sub>

#### Model:

```php

class User implements AuthenticatableContract, CanResetPasswordContract
{
    ...
    public function friends()
    {

        return $this->hasMany(\App\User::class);

    }

    public function posts()
    {

        return $this->hasMany(\App\Model\Post::class);

    }
    ...
}

Request :

Get all Users with their Posts and Friends, <sub>(*9)</sub>

GET /user?with=["posts", "friends"]

Get Users with their Posts and Friends that age equals 30, <sub>(*10)</sub>

GET /user?with=["posts", "friends"]&where={age: 30}

Get Users with their Posts and their Comments and Friends that have at least one Friend with age greater than 30, <sub>(*11)</sub>

GET /user?with=["posts.comments", "friends"]&where={"friends.age":[ ">", 30]}

Get User of key = 1 with their Posts, Friends and Friends of Friends, <sub>(*12)</sub>

GET /user/1?with=["posts", "friends.friends"]

Parameters:

• array with: It expects the Models to have the relationship method. Accepts dot notation, both Models come when used. eg.: ?with:["posts.comments"]. User::posts and Post::comments methods must exist
• object|mixed where: It expects the Models to have the queried columns. Accepts dot notation, queries the relationship, if found at least one that matches the criteria, it returns the Model. eg.: ?where:{age: 30}, ?where:{age:[">", 30]}, ?where:{"friends.age":[">", 30]}
• integer take: takes this number of Models
• integer paginate: also known as per page
• integer page: page number

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*13)</sub>

Testing

bash $ to do, <sub>(*14)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*15)</sub>

Security

If you discover any security related issues, please email lab.rafamello@gmail.com instead of using the issue tracker., <sub>(*16)</sub>

Credits

• Rafael Mello Campanari

License

The MIT License (MIT). Please see License File for more information., <sub>(*17)</sub>