Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goodwix/doctrine-json-odm
JSON Object-Document Mapping bundle for Symfony and Doctrine
https://github.com/goodwix/doctrine-json-odm
database doctrine json odm orm postgresql symfony symfony-bundle symfony4
Last synced: 26 days ago
JSON representation
JSON Object-Document Mapping bundle for Symfony and Doctrine
- Host: GitHub
- URL: https://github.com/goodwix/doctrine-json-odm
- Owner: goodwix
- License: mit
- Created: 2019-01-17T06:17:13.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-30T04:54:33.000Z (almost 2 years ago)
- Last Synced: 2024-09-29T16:40:29.770Z (about 1 month ago)
- Topics: database, doctrine, json, odm, orm, postgresql, symfony, symfony-bundle, symfony4
- Language: PHP
- Size: 85 KB
- Stars: 20
- Watchers: 4
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Doctrine JSON ODM library
[](https://packagist.org/packages/goodwix/doctrine-json-odm)
[](https://packagist.org/packages/goodwix/doctrine-json-odm)
[](https://packagist.org/packages/goodwix/doctrine-json-odm)
[](https://scrutinizer-ci.com/g/goodwix/doctrine-json-odm/build-status/master)
[](https://scrutinizer-ci.com/g/goodwix/doctrine-json-odm/?branch=master)
[](https://scrutinizer-ci.com/g/goodwix/doctrine-json-odm/?branch=master)
Inspired by
This is beta version of library. Main differences from Dunglas library:
* library does not store any metadata in json field;
* doctrine ODM type uses main Symfony serializer service (so you can easily extend serialization process by adding normalizers/denormalizers globally in dependency injection config);
* automatic registration of ODM types for Doctrine (using Symfony autowiring and autoconfigure features).
## Features
* Object-Document Mapping with database json types
* Doctrine 2.5+ support
* PostgreSQL 9.4+ support
* Symfony 5+ support (not tested with previous versions)
* MySQL support not tested
## Additional features
* Automatic registering normalizers for use with Java-like collections from [ramsey/collection](https://github.com/ramsey/collection) library
## Install
### Install with Symfony 4
To install the library, use [Composer](https://getcomposer.org/).
```bash
composer require goodwix/doctrine-json-odm
```
Add lines to `config/bundles.php` (no automatic configuration is available for beta version).
```php
['all' => true],
];
```
Create package config file `config/packages/doctrine-json-odm.yaml` with next content.
```yaml
doctrine_json_odm:
mapping:
paths:
- '%kernel.project_dir%/src/ODM'
```
there `src/ODM` is the root path for your ODM entities (like `src/Entity` for Doctrine).
## Usage
### Basic usage with automatic ODM types registration
Create entity class for ODM type in ODM-specific directory (like `src/ODM`) and mark it with `\Goodwix\DoctrineJsonOdm\Annotation\ODM` annotation.
```php
namespace App\ODM;
use Goodwix\DoctrineJsonOdm\Annotation\ODM;
/**
* @ODM()
*/
class Document
{
/** @var string */
public $title;
/** @var string */
public $description;
}
```
Create doctrine entity class with field type `App\ODM\Document`.
```php
namespace App\Entity;
use Doctrine\ORM\Mapping as ORM;
use App\ODM\Document;
/**
* @ORM\Entity()
*/
class DocumentStorage
{
/**
* @ORM\Column(type="integer")
* @ORM\Id
* @ORM\GeneratedValue(strategy="AUTO")
*
* @var int
*/
public $id;
/**
* @ORM\Column(type=Document::class, nullable=true)
*
* @var Document
*/
public $document;
}
```
Now you can easily manage your ORM entity with ODM class field
```php
$documentStorage = $entityManager->find(DocumentStorage::class, $id);
$documentStorage->document->title = 'ODM document title';
$documentStorage->document->description = 'ODM document description';
```
### Manual usage with Doctrine and Symfony Serializer component
To manually register Doctrine ODM types use [`ODMType::registerODMType()`](https://github.com/goodwix/doctrine-json-odm/blob/36860ddaddc10e9ea33b2986b17009db979a0026/src/Type/ODMType.php#L100) method.
```php
require_once __DIR__.'/../vendor/autoload.php';
use Goodwix\DoctrineJsonOdm\Type\ODMType;
use Symfony\Component\Serializer\SerializerInterface;
class Document { }
ODMType::registerODMType(
Document::class,
new class implements SerializerInterface
{
public function serialize($data, $format, array $context = []) { /* Implement serialize() method. */ }
public function deserialize($data, $type, $format, array $context = []) { /* Implement deserialize() method. */ }
}
);
```
### Examples with Symfony application
You can see example of Symfony 4 application with using ODM library in this [directory](https://github.com/goodwix/doctrine-json-odm/tree/master/tests/Resources/Symfony).
## Deal with abstract
As an `abstract` class could not be created as an instance, each concrete children have to be mapped into the abstract class.
Indeed, the `Symfony Serializer` must know the real type in this case through a discriminator field to determine the real object behind
the stored data. For that, it use `Symfony\Component\Serializer\Annotation\DiscriminatorMap`. More info is available [here](
Maybe this way : [Symfony serializer : discriminator](https://symfony.com/doc/current/components/serializer.html#serializing-)
For example, if we have an abstract and 2 children
```php
'App\Whatever\Child',
'myChild2TypeName' => 'App\Whatever\Child2',
]
)]
####> PHP8 Attribute ####
#### PHP < PHP8 ####
/**
* @DiscriminatorMap(typeProperty="type", mapping={
* "myChildTypeName"="App\Whatever\Child",
* "myChild2TypeName"="App\Whatever\Child2"
* })
*/
####> PHP < PHP8 ####
abstract class MyAbstract
{
}
class Child extends MyAbstract
{}
class Child2 extends MyAbstract
{}
```
## Contribution
You can run `composer lint` before pushing to repository to ensure that there are no code style errors.
Please remember to add some tests if you change library code.