CODEWITHSUNDEEP
symfonyserializationreferencecircular-dependencydepth
eronn
eronn

Reputation: 1840

A circular reference has been detected when serializing the object of class "App\Entity\User" (configured limit: 1)

I am faced with a problem that gives me this error:

A circular reference has been detected when serializing the object of class "App\Entity\User" (configured limit: 1)

I have an Enterprise entity that has mission orders, vehicles, and users.

An orders entity that has a relationship with a User, Company, and Vehicle.

And a User entity that has a relationship with orders and company.

So I have this: Entreprise.php

class Entreprise
{
    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;


    /**
     * @ORM\OneToMany(targetEntity="App\Entity\User", mappedBy="entreprise", orphanRemoval=true)
     */
    private $users;

    /**
     * @ORM\OneToMany(targetEntity="App\Entity\Vehicule", mappedBy="entreprise", orphanRemoval=true)
     */
    private $vehicules;

    /**
     * @ORM\OneToMany(targetEntity="App\Entity\OrdreMission", mappedBy="entreprise", orphanRemoval=true)
     */
    private $ordreMissions;

OrdreMission.php:

class OrdreMission
{

    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * Agent qui réalisera la mission
     * @ORM\ManyToOne(targetEntity="App\Entity\User", inversedBy="ordreMissions")
     * @ORM\JoinColumn(nullable=false)
     */
    private $user;


    /**
     * Immatriculation de la voiture de service
     * @ORM\ManyToOne(targetEntity="App\Entity\Vehicule")
     */
    private $vehicule;



    /**
     * @ORM\ManyToOne(targetEntity="App\Entity\Entreprise", inversedBy="ordreMissions")
     * @ORM\JoinColumn(nullable=false)
     */
    private $entreprise;

Vehicule.php:

class Vehicule
{
    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * Marque du véhicule
     * @ORM\Column(type="string", length=255)
     */
    private $marque;

    /**
     * Modèle du véhicule
     * @ORM\Column(type="string", length=255)
     */
    private $modele;

    /**
     * Immatriculation du véhicule
     * @ORM\Column(type="string", length=255)
     * @MaxDepth(2)
     */
    private $immatriculation;

    /**
     * @ORM\ManyToOne(targetEntity="App\Entity\Entreprise", inversedBy="vehicules")
     * @ORM\JoinColumn(nullable=false)
     * @MaxDepth(2)
     */
    private $entreprise;

User.php:

class User implements UserInterface, Serializable
{
    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * Adresse email de l'utilisateur
     * @ORM\Column(type="string", length=180, unique=true)
     * @Assert\NotBlank()
     * @Assert\Email(message="Veuillez renseigner un email valide")
     */
    private $email;

    /**
     * Rôles de l'utilisateur
     * @ORM\Column(type="json")
     */
    private $roles = [];


    /**
     * Ordres de mission de l'utilisateur
     * @ORM\OneToMany(targetEntity="App\Entity\OrdreMission", mappedBy="user")
     */
    private $ordreMissions;


    /**
     * @ORM\ManyToOne(targetEntity="App\Entity\Entreprise", inversedBy="users")
     * @ORM\JoinColumn(nullable=false)
     */
    private $entreprise;

/**
 * String representation of object
 * @link http://php.net/manual/en/serializable.serialize.php
 * @return string the string representation of the object or null
 */
public function serialize()
{
    return serialize([
        $this->id,
        $this->email,
        $this->password,
    ]);
}

/**
 * Constructs the object
 * @link http://php.net/manual/en/serializable.unserialize.php
 * @param string $serialized <p>
 * The string representation of the object.
 * </p>
 * @return void
 */
public function unserialize($serialized)
{
    list (
        $this->id,
        $this->email,
        $this->password,
        ) = unserialize($serialized);
}

When I want to add a new vehicle, I get the error:

A circular reference has been detected when serializing the object of class "App\Entity\User" (configured limit: 1)

I saw on the Internet that I had to do something with a "maxdepth", but I do not understand what I have to do and where exactly

This is the function controller that I use to add a Vehicle Object and send it:

   /**
     * Pour créer un nouveau véhicule
     * 
     * @Route("/chef-service/ordres-mission/new/new-vehicule", name="vehicule_create")
     * @IsGranted({"ROLE_CHEF_SERVICE"})
     * @Method({"POST"})
     * @return Response
     */
    public function createVehicule(Request $request, EntityManagerInterface $manager)
    {
        $vehicule = new Vehicule();
        $vehicule->setEntreprise($this->adminService->getEntreprise());

        $form = $this->createForm(VehiculeType::class, $vehicule, [
            'action' => $this->generateUrl($request->get('_route'))
        ]);
        $form->handleRequest($request);

        if ($form->isSubmitted() && $form->isValid()) {

            $encoders = array(new XmlEncoder(), new JsonEncoder());
            $normalizers = array(new ObjectNormalizer());
            $serializer = new Serializer($normalizers, $encoders);
            $manager->persist($vehicule);
            $manager->flush();

            $result = $serializer->normalize(
                [
                    'code' => 200,
                    'message' => 'OK',
                    'vehicule' => $vehicule,
                ],
                null,
                [AbstractObjectNormalizer::ENABLE_MAX_DEPTH => true]
            );
            
            $jsonContent = $serializer->serialize(
                $result,
                'json'
            );
            return new Response($jsonContent);

        }

        return $this->render('ordre_mission/partials/newVehicule.html.twig', [
            'formVehicule' => $form->createView(),
        ]);
    }

Upvotes: 19

Views: 75322

Answers (10)

ELHASNAOUI Chamseddine
ELHASNAOUI Chamseddine

Reputation: 1

I had the same error

enter image description here

There is a solution

enter image description here

also in the function in our controller, you have to make some changes I change this line :

$dataArray[] = $this->serializer->normalize($typeDeclaration);

with this :

$dataArray[] = $this->serializer->normalize($typeDeclaration, null, ['groups' => 'type_declaration']);

and sorry for my bad eng XD, GL

Upvotes: 0

Szymon D.
Szymon D.

Reputation: 73

I discovered that you can pass circular reference limit to serialize() context, seems like that work since in error page I can see [...] (configured limit: 10). For example:

$yourNumber = 2;
$result = $serializer->normalize(
     [
        'code' => 200,
        'message' => 'OK',
        'vehicule' => $vehicule,
      ],
 null,
      [
         AbstractObjectNormalizer::ENABLE_MAX_DEPTH => true,
         AbstractNormalizer::CIRCULAR_REFERENCE_LIMIT => $yourNumber
        ]
);

Hope it helps you.

Upvotes: 3

Mina Amir
Mina Amir

Reputation: 51

The CIRCULAR_REFERENCE error, it's an error to prevent infinite loops when the serializer is calling the object serializer. This commonly happens with the Entities with Many to one and Many to many relations. To solve this problem we need to handle the custom context for the serializer by focusing on the object id.

so in your Controllers, it can be done as the next example:

return $this->json($data,Response::HTTP_OK,[],
[ObjectNormalizer::CIRCULAR_REFERENCE_HANDLER=>function ($obj){return $obj->getId();}]);

and for using the serializer

$encoder = new JsonEncoder();
$defaultContext = [
AbstractNormalizer::CIRCULAR_REFERENCE_HANDLER => function ($object, $format, $context) {
    return $object->getName();
},];
$normalizer = new ObjectNormalizer(null, null, null, null, null, null, $defaultContext);
$serializer = new Serializer([$normalizer], [$encoder]);

For more info please check the symfony docs https://symfony.com/doc/current/components/serializer.html#handling-circular-references

Upvotes: 5

Dorsaf AYED
Dorsaf AYED

Reputation: 21

for th error “Reference Circulaire”

you have to tag the annotation @Groups("post:read") in front of every attribut you want to show (in your entity ) and then dont forget the use statement "use Symfony\Component\Serializer\Annotation\Groups;" (in your controller)

Upvotes: 2

As Josvah
As Josvah

Reputation: 31

Maybe it's a Collection Type issue inside your Entity class.

It appears when you create a relation of the type ManyToOne, OneToMany or ManyToMany. To resolve this problem, you can try this code ;) :

Exemple :

<?php

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use App\Repository\ClientRepository;
use App\Entity\Client;
use Symfony\Component\HttpFoundation\Request;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\Serializer\SerializerInterface;
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;


class ClientController extends AbstractController
{
    /**
     * @Route("/api/client", methods="GET")
     */
    public function index(ClientRepository $repository, SerializerInterface $serializer): Response
    { 
        //For avoiding Collection issues of ManyToOne || OneToMany || ManyToMany
        //relationship between 2 entities
        return $this->json(
            json_decode(
                $serializer->serialize(
                    $repository->findAll(),
                    'json',
                    [AbstractNormalizer::IGNORED_ATTRIBUTES => ['commandes']]
                ),
                JSON_OBJECT_AS_ARRAY
            )
        );
    }
    ...
}

Upvotes: -1

Jakub O
Jakub O

Reputation: 101

If child entity has a parent and you do not want to get it as another "child" in serialization.. then you can try with Ignore use Symfony\Component\Serializer\Annotation\Ignore;

$user->messages(): // User has messages with relation oneToMany

then in Message add Ignore to $user:

class Message
// ...
/** @Ignore() */
$user;

Upvotes: 10

numediaweb
numediaweb

Reputation: 17030

For me, this error happens when I use API platform (maybe not related to this case but might help someone else) I had to follow this comment here:

It's because the Entity is not marked with @ApiResource, so it's not handled by the API Platform (it is by the Symfony one), and as there is a circular reference, an error is thrown. If this Entity where an API resource, the circular reference would be handled automatically. If you don't want to make it a resource, you need to register a circular reference handler by yourself: https://symfony.com/doc/current/components/serializer.html#handling-circular-references

Upvotes: 22

krachleur
krachleur

Reputation: 366

I took advantage of the ControllerTrait's method "json" :

return $this->json($result, Response::HTTP_OK, [], ['groups' => 'user','entreprise']);

It worked for me.

Upvotes: 0

Tomas
Tomas

Reputation: 1076

In my case I've fixed injecting the serializer service instead of creating a new Serializer instance in the controller method.

use Symfony\Component\Serializer\SerializerInterface;

//...
public function createOrder(Request $request, SerializerInterface $serializer)
{
    //...
    $json = $serializer->serialize($order, 'json', ['groups' => ['normal']]);
    //...
}

Upvotes: 10

Omar Ghorbel
Omar Ghorbel

Reputation: 730

Try to avoid circular reference by using Serialization Groups (work for both Symfony Serializer and jms Serializer). Example when your serialize "User" don't serialize "users" from other entity.

User

class User 
{

/**
 * @Groups("user")
 * @ORM\Id()
 * @ORM\GeneratedValue()
 * @ORM\Column(type="integer")
 */
private $id;

/**
 * @Groups("user")
 * @ORM\ManyToOne(targetEntity="App\Entity\Entreprise", inversedBy="users")
 * @ORM\JoinColumn(nullable=false)
 */
private $entreprise;
}

Entreprise

class Entreprise
{
/**
 * @Groups("entreprise")
 * @ORM\Id()
 * @ORM\GeneratedValue()
 * @ORM\Column(type="integer")
 */
private $id;


/**
 * @Groups("user_detail")
 * @ORM\OneToMany(targetEntity="App\Entity\User", mappedBy="entreprise", orphanRemoval=true)
 */
private $users;

And then 

$json = $serializer->serialize(
    $user,
    'json', ['groups' => ['user','entreprise' /* if you add "user_detail" here you get circular reference */]
);

However you have two more option either use Handling Circular References or use Handling Serialization Depth

Upvotes: 14

Related Questions