如何在Symfony 2的序列化程序配置中公开相关对象的属性？

Question

我在Web服务中将FOSRestBundle与JMSSerializerBundle结合使用。 这是我的动作控制器中的一个函数，该函数返回角色列表。 我不知道如何在此列表中返回“ parent_id”字段。

<?php

use FOS\RestBundle\Controller\FOSRestController;

class RoleController extends FOSRestController
{
    ...
    /**
     * List all roles.
     *
     * @Annotations\View()
     *
     * @return array
     */
    public function getRolesAction()
    {
        $roles = $this->repository->findRoles();
        $view = $this->view($roles, 200);
        return $this->handleView($view);
    }
    ...
}

这是我的角色实体。 它具有属性：id，name和parent。 父母是一个角色。

<?php

namespace AppBundle\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * Role
 *
 * @ORM\Table()
 * @ORM\Entity(repositoryClass="AppBundle\Entity\RoleRepository")
 */
class Role
{
    /**
     * @var integer
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * @ORM\ManyToOne(targetEntity="Role")
     * @ORM\JoinColumn(name="parent_id", referencedColumnName="id")
     */
    private $parent;

    /**
     * @var string
     *
     * @ORM\Column(name="name", type="string", length=255)
     */
    private $name;

    // + getters and setters
    ...
}

这是我的序列化器配置文件：

AppBundle\Entity\Role:
    exclusion_policy: ALL
    properties:
        id:
            expose: true
            type: integer
            xml_attribute: true
        name:
            expose: true
            type: string

现在，动作控制器中的getRolesAction将输出具有id和name属性的JSON。 如何将parent_id属性添加到序列化器输出？

Answer 1

您可以使用类似：

/**
 * @Serializer\VirtualProperty
 * @Serializer\Type("integer")
 * @Serializer\SerializedName("parent_id")
 *
 * @return integer
 */
public function getParentId()
{
    return $this->parent->getId();
}

我无法告诉您如何以配置（可能是YAML）格式传输注释，但是您将能够做到这一点。

重要

这仅适用于序列化-因此不要期望此属性在以后反序列化！

替代方案 ：

如果只想获得所需的结果，则可以将其添加到属性中：

/** 
 * @Accessor(getter="getParentId",setter="setParent") */
 * @Serializer\Type("integer")
 * @Serializer\SerializedName("parent_id")
 */
private $parent;

另外还有一个吸气剂：

/**
 *
 * @return integer
 */
public function getParentId()
{
    return $this->parent->getId();
}

使用访问器，您可以告诉JMS从哪个getter获取要序列化的结果，同时仍然可以使用setter进行反序列化。