danilovl / object-to-array-transform-bundle
Symfony bundle provides convert object to an array by configuration fields.
Package info
github.com/danilovl/object-to-array-transform-bundle
Type:symfony-bundle
pkg:composer/danilovl/object-to-array-transform-bundle
Requires
- php: ^8.5
- danilovl/parameter-bundle: ^5.0.0
- symfony/framework-bundle: ^8.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.92.5
- phpstan/extension-installer: ^1.4.3
- phpstan/phpstan: ^2.1.33
- phpstan/phpstan-symfony: ^2.0.9
- phpunit/phpunit: ^12.5.6
Suggests
None
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-14 10:46:15 UTC
README
ObjectToArrayTransformBundle
About
Symfony bundle provides convert object to an array by configuration fields.
Requirements
- PHP 8.5 or higher
- Symfony 8.0 or higher
- ParameterBundle 5.0 or higher
1. Installation
Install danilovl/object-to-array-transform-bundle package by Composer:
composer require danilovl/object-to-array-transform-bundle
Add the ObjectToArrayTransformBundle to your application's bundles if does not add automatically:
<?php // config/bundles.php return [ // ... Danilovl\ObjectToArrayTransformBundle\ObjectToArrayTransformBundle::class => ['all' => true] ];
2. Configuration
Configuration is grouped by source (for example api_fields.default). Inside the source each key is the short class name of the object (Shop, City) and contains the list of fields to export.
For each field the value is resolved in the following order:
- method with the same name as the field (
name()); - method from the field
methodparameter or thegetmethod (getName()); - public property or a property available through
__get/__isset.
If none of them exists, RuntimeException is thrown.
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 - cities
Objects whose class is configured in the source are transformed recursively with their own fields.
To change fields for a nested object or for the items of a collection, define them directly on the field.
You can specify the format for DateTimeInterface values.
# 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'
2.1 Transformation rules
- Date format for
DateTimeInterfacevalues is chosen in the following order:- field parameter
format; - source parameter
date_format; - default
Y-m-d H:i:s.
- field parameter
- Collections (any
Traversable, for example DoctrineCollection) are transformed to a list:- an empty collection is returned as an empty array
[]; - objects are transformed by their configuration;
- scalar values are returned as is.
- an empty collection is returned as an empty array
- Circular references (for example
Product → Category → products → Product) throwRuntimeExceptionwith messageCircular reference detected for class "...". The same object in different branches (for example twice in one collection) is not a circular reference. - Maximum depth of nested objects is
32. Deeper nesting throwsRuntimeException. - If the object is passed as a class name string and the class does not exist,
RuntimeExceptionis thrown.
2.2 Usage
Transform objects in controller.
<?php declare(strict_types=1); namespace App\Controller\Api; use App\Facade\CountryFacade; use Danilovl\ObjectToArrayTransformBundle\Interfaces\ObjectToArrayTransformServiceInterface; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\HttpFoundation\JsonResponse; class CountryController extends AbstractController { public function __construct( private readonly CountryFacade $countryFacade, private readonly ObjectToArrayTransformServiceInterface $objectToArrayTransformService ) {} public function getMethod(): JsonResponse { $countries = $this->countryFacade->getAll(); $result = []; foreach ($countries as $country) { $transformer = $this->objectToArrayTransformService->transform('api_fields.default', $country); $result[] = $transformer; } return new JsonResponse($result); } }
License
The ObjectToArrayTransformBundle is open-sourced software licensed under the MIT license.