salamwaddah/laravel-relation-parser

Easily load model relations from frontend without changing your API

v1.2.0 2024-04-02 12:38 UTC

Requires

• php: >=8.1
• illuminate/database: ^10.0 || ^11.0
• illuminate/http: ^10.0 || ^11.0

Requires (Dev)

• orchestra/testbench: ^8.5
• phpunit/phpunit: ^10.0

MIT

• Salam Waddah

• laravel
• model relations
• relation loader

README

Installation

composer require salamwaddah/laravel-relation-parser

Usage

Allow your application to load any model relation in the response without the need of changing your API controllers.

Pass a comma separated relations to your http request.

Loading relations

Add a with param to your HTTP request

/users?with=orders,posts,anyOtherRelation

Loading relation counts

Add a with_count param to your HTTP request

/users?with_count=orders,anyOtherRelation,anotherRelationToCount,blaBlaBla

Loading relations and counts

/users?with=orders&with_count=orders

In your controller

use SalamWaddah\RelationParser\LoadsRelations;
use Illuminate\Http\Request;

class UsersController extends Controller
{
    use LoadsRelations;
    
    public function index(Request $request)
    {
            $users = User::query()
                // .. your query logic here
                ->get();
    
            // this line adds the relations/counts
            $this->loadRelations($users, $request);
    
            // return your results however you like
            return response()->json($users);
        }
    }

Response example

[
  {
    "id": 1,
    "name": "Salam",
    "orders_count": 2,
    "orders": [
      {
        "id": 2,
        "product": "something",
        "price": 100
      },
      {
        "id": 1,
        "product": "something else",
        "price": 150
      }
    ]
  },
  {
    "id": 2,
    "name": "Naren",
    "orders_count": 1,
    "orders": [
      {
        "id": 3,
        "product": "something",
        "price": 100
      }
    ]
  }
]

Customize

If with or with_count params are used for something else in your application then you can customize those params in loadRelations() method.

$this->loadRelations($users, $request, 'customWithParam', 'custom_with_count_param');

Testing

composer test