Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/korridor/laravel-has-many-sync
Allow sync method for Laravel Has Many Relationship.
https://github.com/korridor/laravel-has-many-sync
laravel laravel-eloquent laravel-package php
Last synced: 3 days ago
JSON representation
Allow sync method for Laravel Has Many Relationship.
- Host: GitHub
- URL: https://github.com/korridor/laravel-has-many-sync
- Owner: korridor
- License: mit
- Created: 2019-08-14T17:58:00.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-14T23:10:32.000Z (about 2 months ago)
- Last Synced: 2024-12-24T12:15:00.916Z (10 days ago)
- Topics: laravel, laravel-eloquent, laravel-package, php
- Language: PHP
- Homepage:
- Size: 37.1 KB
- Stars: 34
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: license.md
Awesome Lists containing this project
README
# Laravel HasMany Sync
[](https://packagist.org/packages/korridor/laravel-has-many-sync)
[](license.md)
[](https://github.com/korridor/laravel-has-many-sync/actions/workflows/lint.yml)
[](https://github.com/korridor/laravel-has-many-sync/actions/workflows/unittests.yml)
[](https://codecov.io/gh/korridor/laravel-has-many-sync)
Allow sync method for Laravel Has Many Relationship.
> [!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-sync
```
If you want to use this package with older Laravel/PHP version please install the 1.* version.
```bash
composer require korridor/laravel-has-many-merged "^1"
```
**Warning: The 1.\* versions use a different namespace!**
### Requirements
This package is tested for the following Laravel and PHP versions:
- 10.* (PHP 8.1, 8.2, 8.3)
- 11.* (PHP 8.2, 8.3)
## Usage
### Setup HasMany Relation
```php
class Customer extends Model
{
/**
* @return HasMany
*/
public function contacts(): HasMany
{
return $this->hasMany(CustomerContact::class);
}
}
```
You can access the sync method like this:
```php
$customer->contacts()->sync([
[
'id' => 1,
'name' => 'Alfa',
'phone_number' => '123',
],
[
'id' => null,
'name' => 'Adhitya',
'phone_number' => '234,
]
]);
```
The sync method accepts an array of data to place on the intermediate table. Any data that are not in the given array will be removed from the intermediate table. So, after this operation is complete, only the data in the given array will exist in the intermediate table.
#### Syncing without deleting
If you do not want to delete existing data, you may pass false value to the second parameter in the sync method.
```php
$customer->contacts()->sync([
[
'id' => 1,
'name' => 'Alfa',
'phone_number' => '123',
],
[
'id' => null,
'name' => 'Adhitya',
'phone_number' => '234,
]
], false);
```
#### Behaviour for IDs that are not part of the hasMany relation
If an ID in the related data does not exist or is not in the scope of the `hasMany` relation, the `sync` function will throw a `ModelNotFoundException`.
It is possible to modify this behavior with the `$throwOnIdNotInScope` attribute. Per default, this is set to `true`. If set to false, the `sync` function will ignore the Ids instead of throwing an exception.
```php
$customer->contacts()->sync([
[
'id' => 7, // ID that belongs to a different customer than `$customer`
'name' => 'Peter',
'phone_number' => '321',
],
[
'id' => 1000, // ID that does not exist
'name' => 'Alfa',
'phone_number' => '123',
],
[
'id' => null,
'name' => 'Adhitya',
'phone_number' => '234,
]
], throwOnIdNotInScope: false);
```
#### Example usage in the controller.
```php
class CustomersController extends Controller
{
/**
* Update the specified resource in storage.
*
* @param CustomerRequest $request
* @param Customer $customer
* @return \Illuminate\Http\Response
*/
public function update(CustomerRequest $request, Customer $customer)
{
DB::transaction(function () use ($customer, $request) {
$customer->update($request->all());
$customer->contacts()->sync($request->get('contacts', []));
});
return redirect()->route('customers.index');
}
}
```
## 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).
## Credits
This package is a fork of [alfa6661/laravel-hasmany-sync](https://github.com/alfa6661/laravel-hasmany-sync).
## License
This package is licensed under the MIT License (MIT). Please see [license file](license.md) for more information.