Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fidum/laravel-eloquent-morph-to-one
Adds MorphToOne relation to Laravel eloquent
https://github.com/fidum/laravel-eloquent-morph-to-one
eloquent eloquent-relations eloquent-relationships laravel laravel-framework
Last synced: 3 days ago
JSON representation
Adds MorphToOne relation to Laravel eloquent
- Host: GitHub
- URL: https://github.com/fidum/laravel-eloquent-morph-to-one
- Owner: fidum
- License: mit
- Created: 2020-06-23T13:00:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-13T13:43:26.000Z (7 months ago)
- Last Synced: 2024-09-25T21:48:13.225Z (8 days ago)
- Topics: eloquent, eloquent-relations, eloquent-relationships, laravel, laravel-framework
- Language: PHP
- Homepage:
- Size: 52.7 KB
- Stars: 27
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Adds MorphToOne relation to Laravel eloquent
[](https://packagist.org/packages/fidum/laravel-eloquent-morph-to-one)
[](https://github.com/fidum/laravel-eloquent-morph-to-one/actions?query=workflow%3Arun-tests+branch%3Amaster)
[](https://codecov.io/gh/fidum/laravel-eloquent-morph-to-one)
[](https://twitter.com/danmasonmp)
:mega: Shoutout to [Ankur Kumar](https://github.com/ankurk91) who wrote the original code for this relation in their package [Eloquent Relations](https://github.com/ankurk91/laravel-eloquent-relationships). I created this package as I needed to make a few tweaks to suit my needs. :raised_hands:
## Installation
You can install the package via composer:
```bash
composer require fidum/laravel-eloquent-morph-to-one
```
## Usage
The `MorphToOne` relation is uses Laravel's [MorphToMany](https://laravel.com/docs/7.x/eloquent-relationships#many-to-many-polymorphic-relations) under the hood. However, the difference is that it returns **one** model instead of a `Collection` of models.
If there is no related model in the database it will return `null` where `MorphToMany` would return an empty `Collection`.
Example:
```php
morphToOne(Image::class, 'imageable')
->wherePivot('featured', 1);
//->withDefault();
}
public function images(): MorphToMany
{
return $this->morphToMany(Image::class, 'imageable')
->withPivot('featured');
}
}
```
```php
morphedByMany(Post::class, 'imageable');
}
public function videos(): MorphToMany
{
return $this->morphedByMany(Video::class, 'imageable');
}
}
```
Now you can access the relationship like:
```php
first();
dump($post->featuredImage);
// lazy loading
$post->load('featuredImage');
```
Prefer using `sync` instead of `save` when updating your relation.
```php
$post->featuredImage()->sync([Image::find(123)]);
$post->featuredImage()->sync([Image::find(456)]);
$post->images->count(); // 1 row :)
```
:x: DO NOT use `save` it will follow `morphToMany` behaviour and create rather than update existing.
```php
$post->featuredImage()->save(Image::find(123));
$post->featuredImage()->save(Image::find(456));
$post->images->count(); // 2 rows :(
```
## Testing
``` bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Daniel Mason](https://github.com/fidum)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.