feat!: Removed JMS Serializer annotation, AbstractAjaxController requ…

…ires a Symfony Serializer interface
roadiz · Dec 2, 2024 · 297df80 · 297df80
1 parent 760c030
commit 297df80
Show file tree

Hide file tree

Showing 10 changed files with 86 additions and 196 deletions.
diff --git a/src/Entity/Folder.php b/src/Entity/Folder.php
@@ -84,11 +84,6 @@ class Folder extends AbstractDateTimedPositioned implements FolderInterface, Lea
     /** @phpstan-ignore-next-line */
     protected Collection $documents;
 
-    /**
-     * @Serializer\Groups({"folder", "folder_color"})
-     *
-     * @Serializer\Type("string")
-     */
     #[ORM\Column(
         name: 'color',
         type: 'string',
@@ -99,6 +94,8 @@ class Folder extends AbstractDateTimedPositioned implements FolderInterface, Lea
     )]
     #[Assert\Length(max: 7)]
     #[SymfonySerializer\Groups(['folder', 'folder_color'])]
+    #[Serializer\Groups(['folder', 'folder_color'])]
+    #[Serializer\Type('string')]
     protected string $color = '#000000';
 
     #[ApiFilter(BaseFilter\SearchFilter::class, strategy: 'partial')]
@@ -219,12 +216,9 @@ public function getTranslatedFoldersByDefaultTranslation(): ?FolderTranslation
         });
     }
 
-    /**
-     * @Serializer\VirtualProperty
-     *
-     * @Serializer\Groups({"folder", "document_folders"})
-     */
     #[SymfonySerializer\Groups(['folder', 'document_folders'])]
+    #[Serializer\Groups(['folder', 'document_folders'])]
+    #[Serializer\VirtualProperty]
     public function getName(): ?string
     {
         return $this->getTranslatedFolders()->first() ?

diff --git a/src/Entity/Group.php b/src/Entity/Group.php
@@ -52,12 +52,9 @@ class Group extends AbstractEntity
     #[Serializer\Type("ArrayCollection<RZ\Roadiz\CoreBundle\Entity\Role>")]
     private Collection $roleEntities;
 
-    /**
-     * @Serializer\Groups({"group", "user"})
-     *
-     * @Serializer\Type("array<string>")
-     */
     #[SymfonySerializer\Groups(['group', 'user'])]
+    #[Serializer\Groups(['group', 'user'])]
+    #[Serializer\Type('array<string>')]
     private ?array $roles = null;
 
     public function __construct()

diff --git a/src/Entity/NodesSources.php b/src/Entity/NodesSources.php
@@ -456,15 +456,11 @@ public function setNoIndex(bool $noIndex): NodesSources
         return $this;
     }
 
-    /**
-     * @Serializer\VirtualProperty
-     *
-     * @Serializer\SerializedName("slug")
-     *
-     * @Serializer\Groups({"nodes_sources", "nodes_sources_base"})
-     */
     #[SymfonySerializer\SerializedName('slug')]
     #[SymfonySerializer\Groups(['nodes_sources', 'nodes_sources_base'])]
+    #[Serializer\SerializedName('slug')]
+    #[Serializer\VirtualProperty]
+    #[Serializer\Groups(['nodes_sources', 'nodes_sources_base'])]
     public function getIdentifier(): string
     {
         $urlAlias = $this->getUrlAliases()->first();
@@ -484,11 +480,10 @@ public function getUrlAliases(): Collection
     }
 
     /**
-     * Get parent node’ source based on the same translation.
-     *
-     * @Serializer\Exclude
+     * Get parent node source based on the same translation.
      */
     #[SymfonySerializer\Ignore]
+    #[Serializer\Exclude]
     public function getParent(): ?NodesSources
     {
         /** @var Node|null $parent */
@@ -538,15 +533,11 @@ public function setTranslation(TranslationInterface $translation): NodesSources
         return $this;
     }
 
-    /**
-     * @Serializer\VirtualProperty
-     *
-     * @Serializer\Groups({"nodes_sources", "nodes_sources_default"})
-     *
-     * @Serializer\SerializedName("@type")
-     */
     #[SymfonySerializer\Groups(['nodes_sources', 'nodes_sources_default'])]
     #[SymfonySerializer\SerializedName('@type')]
+    #[Serializer\Groups(['nodes_sources', 'nodes_sources_default'])]
+    #[Serializer\SerializedName('@type')]
+    #[Serializer\VirtualProperty]
     public function getNodeTypeName(): string
     {
         return 'NodesSources';

diff --git a/src/Entity/Realm.php b/src/Entity/Realm.php
@@ -61,11 +61,9 @@ class Realm extends AbstractEntity implements RealmInterface
     #[Assert\Regex('#^[\w\s]+$#u')]
     private string $name = '';
 
-    /**
-     * @Serializer\Exclude()
-     */
     #[ORM\Column(name: 'plain_password', type: 'string', length: 255, unique: false, nullable: true)]
     #[SymfonySerializer\Ignore]
+    #[Serializer\Exclude]
     #[Assert\Length(max: 255)]
     private ?string $plainPassword = null;
 

diff --git a/src/Entity/Role.php b/src/Entity/Role.php
@@ -163,10 +163,9 @@ public function removeGroup(Group $group): Role
      * Get a classified version of current role name.
      *
      * It replaces underscores by dashes and lowercase.
-     *
-     * @Serializer\Groups({"role"})
      */
     #[SymfonySerializer\Groups(['role'])]
+    #[Serializer\Groups(['role'])]
     public function getClassName(): string
     {
         return str_replace('_', '-', \mb_strtolower($this->getRole()));

diff --git a/src/Entity/Tag.php b/src/Entity/Tag.php
@@ -393,14 +393,10 @@ public function __toString(): string
         return (string) $this->getId();
     }
 
-    /**
-     * @Serializer\Groups({"tag", "tag_base", "node", "nodes_sources"})
-     *
-     * @Serializer\VirtualProperty
-     *
-     * @Serializer\Type("string|null")
-     */
     #[SymfonySerializer\Ignore]
+    #[Serializer\Groups(['tag', 'tag_base', 'node', 'nodes_sources'])]
+    #[Serializer\VirtualProperty]
+    #[Serializer\Type('string|null')]
     public function getName(): ?string
     {
         return $this->getTranslatedTags()->first() ?
@@ -432,29 +428,21 @@ public function setTranslatedTags(Collection $translatedTags): static
         return $this;
     }
 
-    /**
-     * @Serializer\Groups({"tag", "node", "nodes_sources"})
-     *
-     * @Serializer\VirtualProperty
-     *
-     * @Serializer\Type("string|null")
-     */
     #[SymfonySerializer\Ignore]
+    #[Serializer\VirtualProperty]
+    #[Serializer\Groups(['tag', 'node', 'nodes_sources'])]
+    #[Serializer\Type('string|null')]
     public function getDescription(): ?string
     {
         return $this->getTranslatedTags()->first() ?
             $this->getTranslatedTags()->first()->getDescription() :
             '';
     }
 
-    /**
-     * @Serializer\Groups({"tag", "node", "nodes_sources"})
-     *
-     * @Serializer\VirtualProperty
-     *
-     * @Serializer\Type("array<RZ\Roadiz\CoreBundle\Entity\Document>")
-     */
     #[SymfonySerializer\Ignore]
+    #[Serializer\VirtualProperty]
+    #[Serializer\Groups(['tag', 'node', 'nodes_sources'])]
+    #[Serializer\Type('array<RZ\Roadiz\CoreBundle\Entity\Document>')]
     public function getDocuments(): array
     {
         return $this->getTranslatedTags()->first() ?

diff --git a/src/Entity/TagTranslation.php b/src/Entity/TagTranslation.php
@@ -58,8 +58,6 @@ class TagTranslation extends AbstractEntity
 
     /**
      * @var Collection<int, TagTranslationDocuments>
-     *
-     * @Serializer\Exclude
      */
     #[ORM\OneToMany(
         mappedBy: 'tagTranslation',
@@ -69,6 +67,7 @@ class TagTranslation extends AbstractEntity
     )]
     #[ORM\OrderBy(['position' => 'ASC'])]
     #[SymfonySerializer\Ignore]
+    #[Serializer\Exclude]
     protected Collection $tagTranslationDocuments;
 
     /**
@@ -151,14 +150,10 @@ public function __clone()
         }
     }
 
-    /**
-     * @Serializer\Groups({"tag"})
-     *
-     * @Serializer\VirtualProperty
-     *
-     * @Serializer\Type("array<RZ\Roadiz\CoreBundle\Entity\Document>")
-     */
     #[SymfonySerializer\Groups(['tag'])]
+    #[Serializer\Groups(['tag'])]
+    #[Serializer\VirtualProperty]
+    #[Serializer\Type('array<RZ\Roadiz\CoreBundle\Entity\Document>')]
     public function getDocuments(): array
     {
         return array_map(function (TagTranslationDocuments $tagTranslationDocument) {

diff --git a/src/Entity/Translation.php b/src/Entity/Translation.php
@@ -549,13 +549,10 @@ class Translation extends AbstractDateTimed implements TranslationInterface
      * fr or en for example
      *
      * @see https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
-     *
-     * @Serializer\Groups({"translation", "document", "nodes_sources", "tag", "attribute", "folder", "log_sources"})
-     *
-     * @Serializer\Type("string")
      */
     #[ORM\Column(type: 'string', length: 10, unique: true, nullable: false)]
     #[SymfonySerializer\Ignore]
+    #[Serializer\Exclude]
     #[Assert\NotBlank]
     #[Assert\NotNull]
     #[Assert\Length(max: 10)]
@@ -565,27 +562,20 @@ class Translation extends AbstractDateTimed implements TranslationInterface
     )]
     private string $locale = '';
 
-    /**
-     * @Serializer\Groups({"translation", "document", "nodes_sources", "tag", "attribute", "folder"})
-     *
-     * @Serializer\Type("string")
-     */
     #[ORM\Column(name: 'override_locale', type: 'string', length: 10, unique: true, nullable: true)]
     #[SymfonySerializer\Ignore]
+    #[Serializer\Exclude]
     #[Assert\Length(max: 10)]
     #[ApiProperty(
         description: 'Override standard locale with an other one (for example, `uk` instead of `en`)',
         example: 'uk',
     )]
     private ?string $overrideLocale = null;
 
-    /**
-     * @Serializer\Groups({"translation", "translation_base"})
-     *
-     * @Serializer\Type("string")
-     */
     #[ORM\Column(type: 'string', length: 250, unique: true)]
     #[SymfonySerializer\Groups(['translation', 'translation_base'])]
+    #[Serializer\Groups(['translation', 'translation_base'])]
+    #[Serializer\Type('string')]
     #[Assert\NotNull]
     #[Assert\NotBlank]
     #[Assert\Length(max: 250)]
@@ -595,26 +585,20 @@ class Translation extends AbstractDateTimed implements TranslationInterface
     )]
     private string $name = '';
 
-    /**
-     * @Serializer\Groups({"translation", "translation_base"})
-     *
-     * @Serializer\Type("bool")
-     */
     #[ORM\Column(name: 'default_translation', type: 'boolean', nullable: false, options: ['default' => false])]
     #[SymfonySerializer\Groups(['translation', 'translation_base'])]
+    #[Serializer\Groups(['translation', 'translation_base'])]
+    #[Serializer\Type('bool')]
     #[ApiProperty(
         description: 'Is translation default one?',
         example: 'true',
     )]
     private bool $defaultTranslation = false;
 
-    /**
-     * @Serializer\Groups({"translation", "translation_base"})
-     *
-     * @Serializer\Type("bool")
-     */
     #[ORM\Column(type: 'boolean', nullable: false, options: ['default' => true])]
     #[SymfonySerializer\Groups(['translation', 'translation_base'])]
+    #[Serializer\Groups(['translation', 'translation_base'])]
+    #[Serializer\Type('bool')]
     #[ApiProperty(
         description: 'Is translation available publicly?',
         example: 'true',
@@ -778,6 +762,8 @@ public function setOverrideLocale(?string $overrideLocale): Translation
      */
     #[SymfonySerializer\SerializedName('locale')]
     #[SymfonySerializer\Groups(['translation_base'])]
+    #[Serializer\SerializedName('locale')]
+    #[Serializer\Groups(['translation_base'])]
     #[ApiProperty(
         description: 'Translation ISO 639-1 locale. See https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes',
         example: 'fr',