Use jms serializer php attributes

Sylius · Nov 4, 2024 · c0c5fd4 · c0c5fd4
1 parent 0c1261c
commit c0c5fd4
Show file tree

Hide file tree

Showing 31 changed files with 53 additions and 139 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -163,7 +163,7 @@ jobs:
                     composer remove --dev friendsofsymfony/rest-bundle willdurand/hateoas-bundle jms/serializer-bundle --no-scripts
                     (cd tests/Application && bin/console cache:clear --env=test_without_fosrest)
                     (cd tests/Application && bin/console lint:container --env=test_without_fosrest)
-                    composer require --dev friendsofsymfony/rest-bundle willdurand/hateoas-bundle jms/serializer-bundle --no-scripts
+                    composer require --dev friendsofsymfony/rest-bundle willdurand/hateoas-bundle "^2.0 || ^2.7@beta" jms/serializer-bundle --no-scripts
 
             -
                 name: Run lint container without winzou/state-machine-bundle package

diff --git a/composer.json b/composer.json
@@ -85,6 +85,7 @@
         "symfony/security-bundle": "^5.4 || ^6.4 || ^7.0",
         "twig/twig": "^3.0",
         "vimeo/psalm": "^5.20",
+        "willdurand/hateoas": "^3.1 || ^3.12@beta",
         "willdurand/hateoas-bundle": "^2.0 || ^2.7@beta",
         "winzou/state-machine-bundle": "^0.6.2"
     },

diff --git a/tests/Application/src/Entity/Author.php b/tests/Application/src/Entity/Author.php
@@ -16,25 +16,17 @@
 use Doctrine\ORM\Mapping as ORM;
 use JMS\Serializer\Annotation as Serializer;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[ORM\Embeddable]
 final class Author
 {
-    /**
-     * @Serializer\Expose
-     *
-     * @Serializer\Type("string")
-     */
+    #[Serializer\Expose]
+    #[Serializer\Type(name: 'string')]
     #[ORM\Column(name: 'first_name', length: 255)]
     private ?string $firstName = null;
 
-    /**
-     * @Serializer\Expose
-     *
-     * @Serializer\Type("string")
-     */
+    #[Serializer\Expose]
+    #[Serializer\Type(name: 'string')]
     #[ORM\Column(name: 'last_name', length: 255)]
     private ?string $lastName = null;
 

diff --git a/tests/Application/src/Entity/Book.php b/tests/Application/src/Entity/Book.php
@@ -19,9 +19,7 @@
 use Sylius\Resource\Model\TranslatableInterface;
 use Sylius\Resource\Model\TranslatableTrait;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[ORM\Entity]
 #[ORM\MappedSuperclass]
 #[ORM\Table(name: 'app_book')]
@@ -31,23 +29,16 @@ class Book implements ResourceInterface, TranslatableInterface
         __construct as private initializeTranslationsCollection;
     }
 
-    /**
-     * @Serializer\Expose
-     *
-     * @Serializer\Type("integer")
-     *
-     * @Serializer\XmlAttribute
-     */
+    #[Serializer\Expose]
+    #[Serializer\Type(name: 'integer')]
+    #[Serializer\XmlAttribute]
     #[ORM\Id]
     #[ORM\GeneratedValue]
     #[ORM\Column]
     private ?int $id = null;
 
-    /**
-     * @Serializer\Expose
-     *
-     * @Serializer\Type("string")
-     */
+    #[Serializer\Expose]
+    #[Serializer\Type(name: 'string')]
     #[ORM\Column(length: 255)]
     private ?string $author = null;
 
@@ -56,11 +47,8 @@ public function getId(): ?int
         return $this->id;
     }
 
-    /**
-     * @Serializer\VirtualProperty()
-     *
-     * @Serializer\SerializedName("title")
-     */
+    #[Serializer\VirtualProperty]
+    #[Serializer\SerializedName(name: 'title')]
     public function getTitle(): ?string
     {
         return $this->getTranslation()->getTitle();

diff --git a/tests/Application/src/Entity/ComicBook.php b/tests/Application/src/Entity/ComicBook.php
@@ -18,39 +18,27 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Model\ResourceInterface;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[ORM\Entity(repositoryClass: ComicBookRepository::class)]
 #[ORM\MappedSuperclass]
 #[ORM\Table(name: 'app_comic_book')]
 class ComicBook implements ResourceInterface
 {
-    /**
-     * @Serializer\Expose
-     *
-     * @Serializer\Type("integer")
-     *
-     * @Serializer\XmlAttribute
-     */
+    #[Serializer\Expose]
+    #[Serializer\Type(name: 'integer')]
+    #[Serializer\XmlAttribute]
     #[ORM\Id]
     #[ORM\GeneratedValue]
     #[ORM\Column]
     private ?int $id = null;
 
-    /**
-     * @Serializer\Expose
-     *
-     * @Serializer\Until("1.1")
-     */
+    #[Serializer\Expose]
+    #[Serializer\Until(version: '1.1')]
     #[ORM\Embedded]
     private ?Author $author = null;
 
-    /**
-     * @Serializer\Expose
-     *
-     * @Serializer\Type("string")
-     */
+    #[Serializer\Expose]
+    #[Serializer\Type(name: 'string')]
     #[ORM\Column(length: 255)]
     private ?string $title = null;
 
@@ -69,21 +57,15 @@ public function setTitle(?string $title): void
         $this->title = $title;
     }
 
-    /**
-     * @Serializer\VirtualProperty()
-     *
-     * @Serializer\Since("1.1")
-     */
+    #[Serializer\VirtualProperty]
+    #[Serializer\Since(version: '1.1')]
     public function getAuthorFirstName(): ?string
     {
         return $this->author?->getFirstName();
     }
 
-    /**
-     * @Serializer\VirtualProperty()
-     *
-     * @Serializer\Since("1.1")
-     */
+    #[Serializer\VirtualProperty]
+    #[Serializer\Since(version: '1.1')]
     public function getAuthorLastName(): ?string
     {
         return $this->author?->getLastName();

diff --git a/tests/Application/src/Entity/CrudRoutes/BookWithAlias.php b/tests/Application/src/Entity/CrudRoutes/BookWithAlias.php
@@ -20,6 +20,7 @@
 /**
  * @Serializer\ExclusionPolicy("all")
  */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusCrudRoutes(
     alias: 'app.book',
 )]

diff --git a/tests/Application/src/Entity/CrudRoutes/BookWithCriteria.php b/tests/Application/src/Entity/CrudRoutes/BookWithCriteria.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusCrudRoutes;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusCrudRoutes(
     alias: 'app.book',
     section: 'criteria',

diff --git a/tests/Application/src/Entity/CrudRoutes/BookWithExcept.php b/tests/Application/src/Entity/CrudRoutes/BookWithExcept.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusCrudRoutes;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusCrudRoutes(
     alias: 'app.book',
     section: 'except',

diff --git a/tests/Application/src/Entity/CrudRoutes/BookWithGrid.php b/tests/Application/src/Entity/CrudRoutes/BookWithGrid.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusCrudRoutes;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusCrudRoutes(
     alias: 'app.book',
     section: 'grid',

diff --git a/tests/Application/src/Entity/CrudRoutes/BookWithLegacyAttribute.php b/tests/Application/src/Entity/CrudRoutes/BookWithLegacyAttribute.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Component\Resource\Annotation\SyliusCrudRoutes;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusCrudRoutes(
     alias: 'app.book',
     section: 'legacy_attribute',

diff --git a/tests/Application/src/Entity/CrudRoutes/BookWithOnly.php b/tests/Application/src/Entity/CrudRoutes/BookWithOnly.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusCrudRoutes;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusCrudRoutes(
     alias: 'app.book',
     section: 'only',

diff --git a/tests/Application/src/Entity/CrudRoutes/BookWithPermission.php b/tests/Application/src/Entity/CrudRoutes/BookWithPermission.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusCrudRoutes;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusCrudRoutes(
     alias: 'app.book',
     section: 'permission',

diff --git a/tests/Application/src/Entity/CrudRoutes/BookWithRedirect.php b/tests/Application/src/Entity/CrudRoutes/BookWithRedirect.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusCrudRoutes;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusCrudRoutes(
     alias: 'app.book',
     section: 'redirect',

diff --git a/tests/Application/src/Entity/CrudRoutes/BookWithSection.php b/tests/Application/src/Entity/CrudRoutes/BookWithSection.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusCrudRoutes;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusCrudRoutes(
     alias: 'app.book',
     section: 'admin',

diff --git a/tests/Application/src/Entity/CrudRoutes/BookWithTemplate.php b/tests/Application/src/Entity/CrudRoutes/BookWithTemplate.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusCrudRoutes;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusCrudRoutes(
     alias: 'app.book',
     section: 'template',

diff --git a/tests/Application/src/Entity/CrudRoutes/BookWithVars.php b/tests/Application/src/Entity/CrudRoutes/BookWithVars.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusCrudRoutes;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusCrudRoutes(
     alias: 'app.book',
     section: 'vars',

diff --git a/tests/Application/src/Entity/Route/PublishBook.php b/tests/Application/src/Entity/Route/PublishBook.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusRoute;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusRoute(
     name: 'publish_book',
     path: '/books/{id}',

diff --git a/tests/Application/src/Entity/Route/ShowBook.php b/tests/Application/src/Entity/Route/ShowBook.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusRoute;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusRoute(
     name: 'show_book',
     path: '/book/{id}',

diff --git a/tests/Application/src/Entity/Route/ShowBookWithCriteria.php b/tests/Application/src/Entity/Route/ShowBookWithCriteria.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusRoute;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusRoute(
     name: 'show_book_with_criteria',
     path: '/library/{libraryId}/book/{id}',

diff --git a/tests/Application/src/Entity/Route/ShowBookWithHost.php b/tests/Application/src/Entity/Route/ShowBookWithHost.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusRoute;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusRoute(
     name: 'show_book_with_host',
     path: '/book/{id}',

diff --git a/tests/Application/src/Entity/Route/ShowBookWithLegacyAttribute.php b/tests/Application/src/Entity/Route/ShowBookWithLegacyAttribute.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Component\Resource\Annotation\SyliusRoute;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusRoute(
     name: 'show_book_with_legacy_attribute',
     path: '/book/{id}',

diff --git a/tests/Application/src/Entity/Route/ShowBookWithMethods.php b/tests/Application/src/Entity/Route/ShowBookWithMethods.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusRoute;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusRoute(
     name: 'show_book_with_methods',
     path: '/book/{id}',

diff --git a/tests/Application/src/Entity/Route/ShowBookWithOptions.php b/tests/Application/src/Entity/Route/ShowBookWithOptions.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusRoute;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusRoute(
     name: 'show_book_with_options',
     path: '/book/{id}',

diff --git a/tests/Application/src/Entity/Route/ShowBookWithPriority.php b/tests/Application/src/Entity/Route/ShowBookWithPriority.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusRoute;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusRoute(
     name: 'show_book_without_priority',
     path: '/book/{id}',

diff --git a/tests/Application/src/Entity/Route/ShowBookWithRepository.php b/tests/Application/src/Entity/Route/ShowBookWithRepository.php
@@ -17,9 +17,7 @@
 use JMS\Serializer\Annotation as Serializer;
 use Sylius\Resource\Annotation\SyliusRoute;
 
-/**
- * @Serializer\ExclusionPolicy("all")
- */
+#[Serializer\ExclusionPolicy(policy: 'ALL')]
 #[SyliusRoute(
     name: 'show_book_with_repository',
     path: '/book/{id}',