Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/korridor/laravel-has-many-merged
Custom relationship for Eloquent that merges/combines multiple one-to-may (hasMany) relationships
https://github.com/korridor/laravel-has-many-merged
eloquent laravel laravel-eloquent laravel-package php
Last synced: 3 days ago
JSON representation
Custom relationship for Eloquent that merges/combines multiple one-to-may (hasMany) relationships
- Host: GitHub
- URL: https://github.com/korridor/laravel-has-many-merged
- Owner: korridor
- License: mit
- Created: 2021-02-15T10:32:45.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T08:48:57.000Z (5 months ago)
- Last Synced: 2024-09-21T13:57:02.784Z (12 days ago)
- Topics: eloquent, laravel, laravel-eloquent, laravel-package, php
- Language: PHP
- Homepage:
- Size: 30.3 KB
- Stars: 75
- Watchers: 4
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# Laravel has many merged
[](https://packagist.org/packages/korridor/laravel-has-many-merged)
[](license.md)
[](https://github.com/korridor/laravel-has-many-merged/actions/workflows/lint.yml)
[](https://github.com/korridor/laravel-has-many-merged/actions/workflows/unittests.yml)
[](https://codecov.io/gh/korridor/laravel-has-many-merged)
Custom relationship for Eloquent that merges/combines multiple one-to-may (hasMany) relationships.
This relation fully supports lazy and eager loading.
> [!NOTE]
> Check out **solidtime - The modern Open Source Time-Tracker** at [solidtime.io](https://www.solidtime.io)
## Installation
You can install the package via composer with following command:
```bash
composer require korridor/laravel-has-many-merged
```
If you want to use this package with older Laravel/PHP version please install the 0.* version.
```bash
composer require korridor/laravel-has-many-merged "^0"
```
### Requirements
This package is tested for the following Laravel versions:
- 10.* (PHP 8.1, 8.2, 8.3)
- 11.* (PHP 8.2, 8.3)
## Usage examples
In the following example there are two models User and Message.
Each message has a sender and a receiver.
The User model has two hasMany relations - one for the sent messages and the other for the received ones.
With this plugin you can add a relation that contains sent and received messages of a user.
```php
use Korridor\LaravelHasManyMerged\HasManyMerged;
use Korridor\LaravelHasManyMerged\HasManyMergedRelation;
class User extends Model
{
use HasManyMergedRelation;
// ...
/**
* @return HasManyMerged
*/
public function messages(): HasManyMerged
{
return $this->hasManyMerged(Message::class, ['sender_user_id', 'receiver_user_id']);
}
/**
* @return HasMany
*/
public function sentMessages(): HasMany
{
return $this->hasMany(Message::class, 'sender_user_id');
}
/**
* @return HasMany
*/
public function receivedMessages(): HasMany
{
return $this->hasMany(Message::class, 'receiver_user_id');
}
}
```
## Contributing
I am open for suggestions and contributions. Just create an issue or a pull request.
### Local docker environment
The `docker` folder contains a local docker environment for development.
The docker workspace has composer and xdebug installed.
```bash
docker-compose run workspace bash
```
### Testing
The `composer test` command runs all tests with [phpunit](https://phpunit.de/).
The `composer test-coverage` command runs all tests with phpunit and creates a coverage report into the `coverage` folder.
### Codeformatting/Linting
The `composer fix` command formats the code with [php-cs-fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
The `composer lint` command checks the code with [phpcs](https://github.com/squizlabs/PHP_CodeSniffer).
## License
This package is licensed under the MIT License (MIT). Please see [license file](license.md) for more information.