ankurk91 / laravel-eloquent-relationships
Add missing eloquent relationships to Laravel php framework.
Installs: 388 639
Dependents: 4
Suggesters: 0
Security: 0
Stars: 57
Watchers: 3
Forks: 8
Open Issues: 0
Requires
- php: ^8.1
- illuminate/database: ^9.34 || ^10 || ^11
- illuminate/support: ^9.34 || ^10 || ^11
Requires (Dev)
- phpunit/phpunit: ^9.5.7
README
This package adds some missing relationships to Eloquent in Laravel
Installation
You can install the package via composer:
composer require ankurk91/laravel-eloquent-relationships
Usage
BelongsToOne
BelongsToOne relation is almost identical to
standard BelongsToMany except it returns one model
instead of Collection of models and null
if there is no related model in DB (BelongsToMany returns empty Collection in
this case). Example:
<?php namespace App\Models; use Illuminate\Database\Eloquent\Model; use Ankurk91\Eloquent\HasBelongsToOne; use Ankurk91\Eloquent\Relations\BelongsToOne; use Illuminate\Database\Eloquent\Relations\BelongsToMany; class Restaurant extends Model { use HasBelongsToOne; /** * Each restaurant has only one operator. */ public function operator(): BelongsToOne { return $this->belongsToOne(User::class) ->wherePivot('is_operator', true); //->withDefault(); } /** * Get all employees including the operator. */ public function employees(): BelongsToMany { return $this->belongsToMany(User::class) ->withPivot('is_operator'); } }
Now you can access the relationship like:
<?php // eager loading $restaurant = Restaurant::with('operator')->first(); dump($restaurant->operator); // lazy loading $restaurant->load('operator'); // load nested relation $restaurant->load('operator.profile'); // Perform operations $restaurant->operator()->update([ 'name'=> 'Taylor' ]);
MorphToOne
MorphToOne relation is almost identical to
standard MorphToMany except it
returns one model instead of Collection of models and null
if there is no related model in DB (MorphToMany returns
empty Collection in this case). Example:
<?php namespace App\Models; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\MorphToMany; class Image extends Model { public function posts(): MorphToMany { return $this->morphedByMany(Post::class, 'imageable'); } public function videos(): MorphToMany { return $this->morphedByMany(Video::class, 'imageable'); } }
<?php namespace App\Models; use Illuminate\Database\Eloquent\Model; use Ankurk91\Eloquent\HasMorphToOne; use Illuminate\Database\Eloquent\Relations\MorphToMany; use Ankurk91\Eloquent\Relations\MorphToOne; class Post extends Model { use HasMorphToOne; /** * Each post may have one featured image. */ public function featuredImage(): MorphToOne { return $this->morphToOne(Image::class, 'imageable') ->wherePivot('featured', 1); //->withDefault(); } /** * Get all images including the featured. */ public function images(): MorphToMany { return $this->morphToMany(Image::class, 'imageable') ->withPivot('featured'); } }
Now you can access the relationship like:
<?php // eager loading $post = Post::with('featuredImage')->first(); dump($post->featuredImage); // lazy loading $post->load('featuredImage');
Testing
composer test
Security
If you discover any security issues, please email pro.ankurk1[at]gmail[dot]com
instead of using the issue tracker.
Attribution
- Most of the code is taken from this PR
- Similar package fidum/laravel-eloquent-morph-to-one
License
The MIT License.