Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mathieutu/laravel-json-syncer
A Json importer and exporter for Laravel.
https://github.com/mathieutu/laravel-json-syncer
database eloquent exporter importer json laravel php syncer
Last synced: about 8 hours ago
JSON representation
A Json importer and exporter for Laravel.
- Host: GitHub
- URL: https://github.com/mathieutu/laravel-json-syncer
- Owner: mathieutu
- License: mit
- Created: 2017-08-06T16:49:34.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-07-10T04:16:18.000Z (6 months ago)
- Last Synced: 2024-12-16T14:48:28.004Z (7 days ago)
- Topics: database, eloquent, exporter, importer, json, laravel, php, syncer
- Language: PHP
- Size: 70.3 KB
- Stars: 28
- Watchers: 4
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Json Syncer: Json importer and exporter for Laravel
[](https://github.com/mathieutu/laravel-json-syncer/actions)
[](https://scrutinizer-ci.com/g/mathieutu/laravel-json-syncer/?branch=main)
[](https://scrutinizer-ci.com/g/mathieutu/laravel-json-syncer/?branch=main)
[](https://packagist.org/packages/mathieutu/laravel-json-syncer)
[](https://packagist.org/packages/mathieutu/laravel-json-syncer)
## Installation
Require this package in your composer.json and update composer.
```bash
composer require mathieutu/laravel-json-syncer
```
Add the `JsonExportable` and/or `JsonImportable` interfaces and `JsonExporter` and/or `JsonImporter` traits to your models.
```php
namespace App\Models;
//...
use MathieuTu\JsonSyncer\Contracts\JsonExportable;
use MathieuTu\JsonSyncer\Traits\JsonExporter;
// or/and
use MathieuTu\JsonSyncer\Contracts\JsonImportable;
use MathieuTu\JsonSyncer\Traits\JsonImporter;
class User extends Model implements JsonExportable, JsonImportable
{
use JsonExporter;
use JsonImporter;
// ...
}
```
## Configuration
Out of the box, the Importer and Exporter will automatically guess what attributes and relations to handle, but you can customize everything:
- JsonExporter:
By default, it will export all the attributes in the `$fillable` properties, except those with `*_id` pattern, and all the `HasOneOrMany` relations of your model.
You can change that by setting the `$jsonExportableAttributes` and `$jsonExportableRelations` properties or overwriting the `getJsonExportableAttributes()` and `getJsonExportableRelations()` methods.
- JsonImporter:
By default, it will import all the attributes which are in the `$fillable` properties and all the `HasOneOrMany` relations of your model.
You can change that by setting the `$jsonImportableAttributes` and `$jsonImportableRelations` properties or overwriting the `getJsonImportableAttributes()` and `getJsonImportableRelations()` methods.
## Usage
Use the `$model->exportToJson($jsonOptions = 0)` to export the object, all its attributes and its children (via its relations).
Use `Model::importFromJson($objectsToCreate)` to import a json string or its array version.
### Examples
_(You can find all this examples in package tests)_
#### How to export
If we consider this dataset in database :
```json
{
"foos (Foo models)": [{
"id": 1,
"author": "Mathieu TUDISCO",
"username": "@mathieutu",
"bars (HasMany relation with Bar models)": [
{
"id": 1,
"name": "bar1",
"foo_id": "1",
"baz (HasOne relation with Baz model)": {
"id": 1,
"name": "bar1_baz",
"bar_id": "1"
}
},
{
"id": 2,
"name": "bar2",
"foo_id": "1",
"baz (HasOne relation with Baz model)": {
"id": 2,
"name": "bar2_baz",
"bar_id": "2"
}
}
]
}]
}
```
We can export it by:
```php
Foo::first()->exportToJson(JSON_PRETTY_PRINT);
```
It will return:
```json
{
"author": "Mathieu TUDISCO",
"username": "@mathieutu",
"bars": [
{
"name": "bar1",
"baz": {
"name": "bar1_baz"
}
},
{
"name": "bar2",
"baz": {
"name": "bar2_baz"
}
}
]
}
```
#### How to import
And exactly the same for the opposite. We can import the json returned by the previous method, or another one.
For the exact same app If we want to import this new very simple set of data:
```json
{
"username": "@mathieutu",
"bars": {
"name": "my unique simple bar!"
}
}
```
We can import it with:
```php
Foo::importFromJson($json);
```
And it will create all the entities in database:
```php
dd(Foo::with('bars.baz')->first()->toArray());
/*
array:4 [
"id" => 1
"author" => null
"username" => "@mathieutu"
"bars" => array:1 [
0 => array:4 [
"id" => 1
"name" => "my unique simple bar!"
"foo_id" => "1"
"baz" => null
]
]
]
*/
```
### License
This JSON Syncer for Laravel is an open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
### Contributing
Issues and PRs are obviously welcomed, as well for new features than documentation.
Each piece of code added should be fully tested, but we can do that all together, so please don't be afraid by that.