Merge branch '5.2' into 5.x

javiereguiluz · javiereguiluz · commit 8190b74c1556 · 2021-03-31T13:25:41.000+02:00
* 5.2:
  [Serializer] Add PHP Attributes to serializer examples
diff --git a/components/serializer.rst b/components/serializer.rst
@@ -315,6 +315,26 @@ Then, create your groups definition:
             // ...
         }
 
+    .. code-block:: php-attributes
+
+        namespace Acme;
+
+        use Symfony\Component\Serializer\Annotation\Groups;
+
+        class MyObj
+        {
+            #[Groups(['group1', 'group2'])]
+            public $foo;
+
+            #[Groups(['group3'])]
+            public function getBar() // is* methods are also supported
+            {
+                return $this->bar;
+            }
+
+            // ...
+        }
+
     .. code-block:: yaml
 
         Acme\MyObj:
@@ -437,6 +457,20 @@ Option 1: Using ``@Ignore`` Annotation
             public $bar;
         }
 
+    .. code-block:: php-attributes
+
+        namespace App\Model;
+
+        use Symfony\Component\Serializer\Annotation\Ignore;
+
+        class MyClass
+        {
+            public $foo;
+
+            #[Ignore]
+            public $bar;
+        }
+
     .. code-block:: yaml
 
         App\Model\MyClass:
@@ -658,6 +692,25 @@ defines a ``Person`` entity with a ``firstName`` property:
             // ...
         }
 
+    .. code-block:: php-attributes
+
+        namespace App\Entity;
+
+        use Symfony\Component\Serializer\Annotation\SerializedName;
+
+        class Person
+        {
+            #[SerializedName('customer_name')]
+            private $firstName;
+
+            public function __construct($firstName)
+            {
+                $this->firstName = $firstName;
+            }
+
+            // ...
+        }
+
     .. code-block:: yaml
 
         App\Entity\Person:
@@ -1218,6 +1271,20 @@ Here, we set it to 2 for the ``$child`` property:
             // ...
         }
 
+    .. code-block:: php-attributes
+
+        namespace Acme;
+
+        use Symfony\Component\Serializer\Annotation\MaxDepth;
+
+        class MyObj
+        {
+            #[MaxDepth(2)]
+            public $child;
+
+            // ...
+        }
+
     .. code-block:: yaml
 
         Acme\MyObj:
@@ -1528,6 +1595,23 @@ and ``BitBucketCodeRepository`` classes:
             // ...
         }
 
+    .. code-block:: php-attributes
+
+        namespace App;
+
+        use App\BitBucketCodeRepository;
+        use App\GitHubCodeRepository;
+        use Symfony\Component\Serializer\Annotation\DiscriminatorMap;
+
+        #[DiscriminatorMap(typeProperty: 'type', mapping: [
+            'github' => GitHubCodeRepository::class,
+            'bitbucket' => BitBucketCodeRepository::class,
+        ])]
+        interface CodeRepository
+        {
+            // ...
+        }
+
     .. code-block:: yaml
 
         App\CodeRepository:
