base on Laravel Eloquent JoinWith Relationships # Laravel Eloquent JoinWith Laravel Eloquent Join With is a package that simplifies performing efficient database joins on existing Eloquent relationships of type `HasOne` and `BelongsTo`. By utilizing these relationships, JoinWith optimizes performance by executing a single query instead of the two separate queries typically required with the standard `with` method. This translates to faster and more efficient data retrieval. ## Installation You can install the package via composer: ```console composer require msafadi/laravel-eloquent-join-with ``` ## Usage There are two ways to use Laravel JoinWith in your application models: ### 1. Use `JoinWith` Trait Include the `JoinWith` trait provided by the package in your application models: ```php <?php namespace App\Models; use Illuminate\Database\Eloquent\Model; use Safadi\EloquentJoinWith\Database\Concerns\JoinWith; class User extends Model { use JoinWith; // ... other model properties and methods } ``` With the trait included, you can then use the `joinWith` method directly on your model queries. ### 2. Extend the Model Class Alternatively, you can extend your model classes with `Safadi\EloquentJoinWith\Database\Eloquent\Model`: ```php <?php namespace App\Models; use Illuminate\Database\Eloquent\Model; use Safadi\EloquentJoinWith\Database\Eloquent\Model as JoinWithModel; class User extends JoinWithModel { // ... other model properties and methods } ``` This approach also grants access to the `joinWith` method on your model queries. ### Usage Examples Once you've integrated Laravel JoinWith into your models, you can use the `joinWith` method on your Eloquent model queries. The defintion and usage of `joinWith` is exactly the same as using the standard `with` method. But it will execute a single query joining the parent model and the realted model tables instead of fetching realted models with executing an extra database query. Here's an example: ```php $user = User::joinWith('profile') ->select('users.id', 'users.name') ->first(); // This will execute a single query joining the users and profiles tables // based on the defined HasOne relationship between User and Profile models. ``` This code retrieves the user information along with the associated profile's avatar in a single query. As the standard `with` method, you can also use nested relations: ```php $user = User::joinWith('profile.country') ->first(); // This will execute a single query joining the users, profiles, and countries tables // based on the defined HasOne relationship between User and Profile and between Profile and Country models. ``` For more complex scenarios, you can pass a closure to the `joinWith` method to customize the join conditions, similar to the standard `with` method: ```php $orders = Orders::joinWith(['user' => function ($query) { $query->where('users.status', '=', 'verified'); }]) ->get(); // This will execute a single query joining orders and users tables // based on the BelongsTo relationship and the additional where clause. ``` This example retrieves orders that belongs to a verified user, combining the user and order information in a single query. ## Limitations - Laravel JoinWith currently works with `HasOne` and `BelongsTo` relationships. Support for other relationship types might be added in future versions. - Specifying which columns of the relationship you would like to retrieve is not supported yet but might be added in future versions. ## Contributing We welcome contributions to this package! If you'd like to contribute, please feel free to open a pull request. ## License This package is distributed under the MIT License. Please see the LICENSE file for more information. ", Assign "at most 3 tags" to the expected json: {"id":"10620","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"