web-dev-qa-db-ja.com

JMSシリアライザーを使用したエンティティリレーションのIDのみへのシリアル化

JMSシリアライザーでエンティティ関係をシリアル化しようとしています。

ここにエンティティがあります：

class Ad
{ 

    /**
     * @Type("string")
     * @Groups({"manage"})
     * 
     * @var string
     */
    private $description;

    /**
     * @Type("Acme\SearchBundle\Entity\Country")
     * @Groups({"manage"})
     * 
     * @var \Acme\SearchBundle\Entity\Country
     */
    private $country;

    /**
     * @Type("string")
     * @Groups({"manage"})
     * 
     * @var string
     */
    private $title;

    /**
     * Set description
     *
     * @param string $description
     * @return Ad
     */
    public function setDescription($description)
    {
        $this->description = $description;

        return $this;
    }

    /**
     * Get description
     *
     * @return string 
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * Set country
     *
     * @param \Acme\SearchBundle\Entity\Country $country
     * @return Ad
     */
    public function setCountry($country)
    {
        $this->country= $country;

        return $this;
    }

    /**
     * Get country
     *
     * @return string 
     */
    public function getCountry()
    {
        return $this->country;
    }

    /**
     * Set title
     *
     * @param string $title
     * @return Ad
     */
    public function setTituloanuncio($title)
    {
        $this->title = $title;

        return $this;
    }

    /**
     * Get title
     *
     * @return string 
     */
    public function getTitle()
    {
        return $this->title;
    }

}

そして関係の実体：

class Country
{

    /**
     * @Type("string")
     * @Groups("manage")
     * 
     * @var string
     */
    private $id;

    /**
     * @Type("string")
     * @Groups("admin")
     * 
     * @var string
     */
    private $description;

    /**
     * Set description
     * @Groups("")
     *
     * @param string $description
     * @return Country
     */
    public function setDescripcionpais($description)
    {
        $this->description = $description;

        return $this;
    }

    /**
     * Get description
     *
     * @return string 
     */
    public function getDescription()
    {
        return $this->description;
    }

    }

    /**
     * Get id
     *
     * @return string 
     */
    public function getId()
    {
        return $this->id;
    }
}

エンティティをシリアル化しましたが、国属性を単純なフィールドに変換する方法がわかりません。

私はjsonでこの結果を得ます：

{"description":"foo", "title":"bar", "country":{"id":"en"} }

しかし、私はこのような国のidフィールドを取得したいです：

{"description":"foo", "title":"bar", "country": "en" }

JMSシリアライザで可能ですか？

ありがとうございました。

[編集]

@VirtualPropertyは機能しません。

phpsymfonyjmsserializerbundle
26
escrichov

はい、@VirtualPropertyアノテーション：

/**
 * @VirtualProperty
 * @SerializedName("foo")
 */
public function bar()
{
    return $this->country->getCode();
}

ただし、逆シリアル化に関しては注意してください。

@VirtualPropertyこのアノテーションはメソッドで定義でき、メソッドから返されたデータがオブジェクトのプロパティのように見えることを示します。

>注：これはシリアライズでのみ機能し、デシリアライズ中は完全に無視されます。

お役に立てれば...

27
Jovan Perovic

答えられた質問に従うだけです：

関係ごとに1つのメソッドを作成したくない場合は、独自のハンドラーを作成してください。簡単です

_final class RelationsHandler
{
    /**
     * @var EntityManagerInterface
     */
    private $manager;

    /**
     * RelationsHandler constructor.
     *
     * @param EntityManagerInterface $manager
     */
    public function __construct(EntityManagerInterface $manager) { $this->manager = $manager; }


    public function serializeRelation(JsonSerializationVisitor $visitor, $relation, array $type, Context $context)
    {
        if ($relation instanceof \Traversable) {
            $relation = iterator_to_array($relation);
        }

        if (is_array($relation)) {
            return array_map([$this, 'getSingleEntityRelation'], $relation);
        }

        return $this->getSingleEntityRelation($relation);
    }

    /**
     * @param $relation
     *
     * @return array|mixed
     */
    protected function getSingleEntityRelation($relation)
    {
        $metadata = $this->manager->getClassMetadata(get_class($relation));

        $ids = $metadata->getIdentifierValues($relation);
        if (!$metadata->isIdentifierComposite) {
            $ids = array_shift($ids);
        }

        return $ids;
    }
}
_

ハンドラーを登録する

_  jms_serializer.handler.relation:
      class: MyBundle\RelationsHandler
      arguments:
      - "@doctrine.orm.entity_manager"
      tags:
      - { name: jms_serializer.handler, type: Relation, direction: serialization, format: json, method: serializeRelation}
      - { name: jms_serializer.handler, type: Relation, direction: deserialization, format: json, method: deserializeRelation}
      - { name: jms_serializer.handler, type: Relation<?>, direction: serialization, format: json, method: serializeRelation}
      - { name: jms_serializer.handler, type: Relation<?>, direction: deserialization, format: json, method: deserializeRelation}
_

これにより、仮想ゲッターメソッドを `Type（" Relation "）に置き換えることができます。

リレーションをデシリアライズしたくない場合は、各@Type("Relation")にデシリアライズするクラス名（@Type("Relation<FQCN>")）を通知するか、メタデータドライバーをそれを行うものでラップする必要があります。

_    public function deserializeRelation(JsonDeserializationVisitor $visitor, $relation, array $type, Context $context)
    {
        $className = isset($type['params'][0]['name']) ? $type['params'][0]['name'] : null;

        if (!class_exists($className, false)) {
            throw new \InvalidArgumentException('Class name should be explicitly set for deserialization');
        }

        $metadata = $this->manager->getClassMetadata($className);

        if (!is_array($relation)) {
            return $this->manager->getReference($className, $relation);
        }

        $single = false;
        if ($metadata->isIdentifierComposite) {
            $single = true;
            foreach ($metadata->getIdentifierFieldNames() as $idName) {
                $single = $single && array_key_exists($idName, $relation);
            }
        }

        if ($single) {
            return $this->manager->getReference($className, $relation);
        }

        $objects = [];
        foreach ($relation as $idSet) {
            $objects[] = $this->manager->getReference($className, $idSet);
        }

        return $objects;
    }
_
18
ScayTrase

これはすでに回答済みですが、@ Accessorを使用することもできます。これはおそらく（確信が持てないかもしれませんが）逆シリアル化でも機能します。

/**
 * @Type("Acme\SearchBundle\Entity\Country")
 * @Groups({"manage"})
 * 
 * @var \Acme\SearchBundle\Entity\Country
 *
 * @Serializer\Accessor(getter="getCountryMinusId",setter="setCountryWithId")
 */
private $country;

/**
 * @return string|null
 */
public function getCountryMinusId()
{
    if (is_array($this->country) && isset($this->country['id'])) {
        return $this->country['id'];
    }

    return null;
}

/**
 * @param string $country
 * @return $this
 */
public function setCountryWithId($country)
{
    if (!is_array($this->country)) {
        $this->country = array();
    )

    $this->country['id'] = $country;

    return $this;
}
9
qooplmao

@Typeおよび@Accessorアノテーションを使用できます。

/**
 * @Type("string") 
 * @Accessor(getter="serializeType",setter="setType") 
 */
protected $type;
public function serializeType()
{   
  return $this->type->getId();
}
8
Александр Братко

著者はプロパティ名を保持したいと考えていますが、これは受け入れられた回答には適用されません。私が理解している限り、ScayTraseによる回答は元のプロパティ名を保持しますが、コメントによると別の欠点があります：Doctrine ORM @ManyToOneを使用している場合、関連するオブジェクトがフェッチされるため、減少パフォーマンス。

元のプロパティ名を保持する場合は、クラスレベルで@VirtualPropertyを定義し、元のプロパティを@Excludeで定義する必要があります。それ以外の場合、シリアル化されたプロパティ名は、getterメソッド（この場合はcountryId）から派生します。

/**
 * @Serializer\VirtualProperty(
 *     "country",
 *     exp="object.getCountryId()",
 *     options={@Serializer\SerializedName("country")}
 * )
 */
class Ad {
    /**
     * @Serializer\Exclude
     */
    private $country;

    public function getCountryId() {
        return $this->country === null ? null : $this->country->getId();
    }
}
1
fishbone

または、_@inline_ _$country_を使用して、プロパティを親リレーションにシリアル化できます。次に、_@Expose_国_$id_を使用して、その_@SerializedName_を_"country"_に設定できます。仮想プロパティとは異なり、直列化と非直列化の両方がインラインプロパティに対して機能します。

これを機能させるには、各クラスで@ExclusionPolicy("All")を使用し、グループ内で必要なプロパティを慎重に_@Expose_使用する必要があります。 とにかくこれはより安全なポリシーです 。

_/**
 * @ExclusionPolicy("All")
 */
class Ad
{ 

    //...


    /**
     * @Type("Acme\SearchBundle\Entity\Country")
     * 
     * @Expose()
     * @Inline()
     * @Groups({"manage"})
     *
     * @var \Acme\SearchBundle\Entity\Country
     */
    private $country;


    //...

}
_
_/**
 * @ExclusionPolicy("All")
 */
class Country
{

    //...

    /**
     * Get id
     *
     * @Expose()
     * @Groups({"manage"})
     * @SerializedName("country")
     * @return string 
     */
    public function getId()
    {
        return $this->id;
    }
}
_
0
Eric Amshukov