railroad/doctrine-array-hydrator

An array to entity hydrator for Doctrine 2 entities

v3.0.0 2024-08-13 21:42 UTC

Requires

• php: ^8.2
• doctrine/annotations: ^2.0
• doctrine/orm: 2.19.*
• laravel/framework: ^11.9
• symfony/cache: ^6.0

Requires (Dev)

• orchestra/testbench: ^9.2
• phpunit/php-code-coverage: ^11.0.1
• phpunit/phpunit: ^11.0.1

MIT

• php
• doctrine
• array
• hydrator

README

Introduction

A hydrator for doctrine 2 that converts an array to the entity of your choice.

Installing via Composer

The recommended way to install is through Composer.

composer require pmill/doctrine-array-hydrator

Example

Given this doctrine entity:

<?php

namespace App\Entity;
    
use Doctrine\ORM\Mapping as ORM;
use Railroad\DoctrineArrayHydrator\Tests\Fixtures\Company;
use Railroad\DoctrineArrayHydrator\Tests\Fixtures\Permission;

/**
 * @ORM\Entity
 * @ORM\Table(name="users")
 */
class User
{
   /**
    * @ORM\Id 
    * @ORM\Column(type="integer") 
    * @ORM\GeneratedValue
    * 
    * @var int
    */
    protected $id;
    
    /**
     * @ORM\Column(type="string")
     * 
     * @var string
     */
    protected $name;
    
    /**
     * @ORM\Column(type="string")
     * 
     * @var string
     */
    protected $email;
    
    /**
     * @ManyToOne(targetEntity="Company")
     * 
     * @var Company
     */
    protected $company;
        
    /**
     * @OneToMany(targetEntity="Permission", mappedBy="product")
     * 
     * @var Permission[]
     */
    protected $permissions;
}

We can populate this object with an array, for example:

$data = [
    'name'        => 'Fred Jones',
    'email'       => '[e-mail]',
    'company'     => 2,
    'permissions' => [1, 2, 3, 4]
];

$hydrator = new \pmill\Doctrine\Hydrator\ArrayHydrator($entityManager);
$entity   = $hydrator->hydrate('App\Entity\User', $data);

We can populate user with JSON API resource data Documentation

$data = [
    'attributes'    => [
        'name'  => 'Fred Jones',
        'email' => '[e-mail]',
    ],
    'relationships' => [
        'company'     => [
            'data' => ['id' => 1, 'type' => 'company'],
        ],
        'permissions' => [
            'data' => [
                ['id' => 1, 'type' => 'permission'],
                ['id' => 2, 'type' => 'permission'],
                ['id' => 3, 'type' => 'permission'],
                ['id' => 4, 'type' => 'permission'],
                ['name' => 'New permission']
            ]
        ]
    ]
];
    
$hydrator = new \pmill\Doctrine\Hydrator\JsonApiHydrator($entityManager);
$entity   = $hydrator->hydrate('App\Entity\User', $data);

Copyright

Doctrine Array to Entity Hydrator Copyright (c) 2015 pmill ([e-mail]) All rights reserved.