Symfony bundle provides convert object to an array by configuration fields.
- PHP 8.3 or higher
- Symfony 7.0 or higher
- ParameterBundle 4.3 or higher
Install danilovl/object-to-array-transform-bundle package by Composer:
composer require danilovl/object-to-array-transform-bundleAdd the ObjectToArrayTransformBundle to your application's bundles if does not add automatically:
<?php
// config/bundles.php
return [
// ...
Danilovl\ObjectToArrayTransformBundle\ObjectToArrayTransformBundle::class => ['all' => true]
];Each object must have declare get method for field defined in parameters.
Each field defined in parameters must match the name of the object.
For example:
Shop entity.
<?php declare(strict_types=1);
namespace App\Entity;
use App\Entity\Traits\{
IdTrait,
LocationTrait
};
use Doctrine\ORM\Mapping as ORM;
/**
* @ORM\Table(name="shop")
* @ORM\Entity(repositoryClass="App\Entity\Repository\ShopRepository")
*/
class Shop
{
use IdTrait;
use LocationTrait;
/**
* @ORM\Column(name="name", type="string", length=255, nullable=false)
*/
private ?string $name = null;
/**
* @ORM\ManyToOne(targetEntity="App\Entity\City", inversedBy="shops")
* @ORM\JoinColumns({
* @ORM\JoinColumn(name="id_city", referencedColumnName="id", nullable=false)
* })
*/
private ?City $city = null;
public function getName(): ?string
{
return $this->name;
}
public function getCity(): ?City
{
return $this->city;
}
}City entity.
<?php declare(strict_types=1);
namespace App\Entity;
use App\Constant\TranslationConstant;
use App\Entity\Traits\{
IdTrait,
LocationTrait,
TimestampAbleTrait
};
use Doctrine\ORM\Mapping as ORM;
/**
* @ORM\Table(name="city")
* @ORM\Entity(repositoryClass="App\Entity\Repository\CityRepository")
* @ORM\HasLifecycleCallbacks()
*/
class City
{
use IdTrait;
use TimestampAbleTrait;
use LocationTrait;
/**
* @ORM\Column(name="name", type="string", nullable=false)
*/
protected ?string $name = null;
public function getName(): ?string
{
return $this->name;
}
}Country entity.
<?php declare(strict_types=1);
namespace App\Entity;
use App\Constant\TranslationConstant;
use App\Entity\Traits\{
IdTrait,
TimestampAbleTrait
};
use Doctrine\Common\Collections\{
Collection,
ArrayCollection
};
use Doctrine\ORM\Mapping as ORM;
/**
* @ORM\Table(name="country")
* @ORM\Entity(repositoryClass="App\Entity\Repository\CountryRepository")
* @ORM\HasLifecycleCallbacks()
*/
class Country
{
use IdTrait;
use TimestampAbleTrait;
/**
* @ORM\Column(name="name", type="string", nullable=false)
*/
protected ?string $name = null;
/**
* @ORM\Column(name="code", type="string", nullable=false)
*/
protected ?string $code = null;
/**
* @ORM\OneToMany(targetEntity="App\Entity\City", mappedBy="country")
*/
protected Collection $cities;
public function getName(): ?string
{
return $this->name;
}
public function getCode(): ?string
{
return $this->code;
}
public function getCities(): Collection
{
return $this->cities;
}
}Simple configuration.
# config/services.yaml
parameters:
api_fields:
default:
Shop:
fields:
- id
- name
- city:
City:
fields:
- id
- name
- latitude
- longitude
Country:
fields:
- id
- name
- code
- citiesIf necessary to change fields for cities.
You can specify the format for DateTime.
# config/services.yaml
parameters:
api_fields:
default:
parameters:
date_format: 'Y-m-d H:i:s'
Shop:
fields:
- id
- name
- city
- active:
parameters:
method: 'isActive'
City:
fields:
- id
- name
- latitude
- longitude
Country:
fields:
- id
- name
- code
- cities
fields:
- id
- name
- createdAt:
parameters:
format: 'Y-m-d'Transform objects in controller.
<?php declare(strict_types=1);
namespace App\Controller\Api;
use Danilovl\ObjectToArrayTransformBundle\Interfaces\ObjectToArrayTransformServiceInterface;
use Knp\Component\Pager\Pagination\PaginationInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
class CountryController extends AbstractController
{
public function __construct(private ObjectToArrayTransformServiceInterface $objectToArrayTransformService)
{
}
public function getMethod(): JsonResponse
{
$countries = $this->get('app.facade.country')
->getAll();
$result = [];
foreach ($countries as $country) {
$transformer = $this->objectToArrayTransformService->transform('api_fields.default', $country);
$result[] = $transformer;
}
return new JsonResponse($result);
}
}The ObjectToArrayTransformBundle is open-sourced software licensed under the MIT license.
