如何在 Symfony 2 的序列化器配置中公开相关 object 的 属性?

How to expose a property of related object in serializer configuration in Symfony 2?

我在我的 Web 服务中使用 FOSRestBundle 和 JMSSerializerBundle。 这是我的动作控制器中的一个函数,它 return 是一个角色列表。我不知道如何 return 此列表中的 "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。 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 将输出 JSON 以及 id 和 name 属性。如何将 parent_id 属性 添加到序列化器输出?

您可以使用类似的东西:

/**
 * @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;

还有另一个 getter:

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

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