feat: adding serialization groups

README.md

@@ -66,6 +66,26 @@ class SomeClass
 }
 ```
 
+### Serialization groups
+
+```php
+class SomeClass
+{
+    #[SerializerContext(groups: ['group1'])]
+    public string $property1;
+
+    // Has implicit group 'default'
+    public string $property2;
+}
+
+
+$serializer = new Serializer();
+$object = new SomeClass();
+$object->property1 = 'value1';
+$object->property2 = 'value2';
+$serializer->serialize($object, attributes: [SerializerInterface::ATTRIBUTE_GROUPS => ['group1']]); // {"property1":"value1"}
+```
+
 ### Custom date format
 
 Per property:

src/Attribute/SerializerContext.php

@@ -8,12 +8,14 @@
 class SerializerContext
 {
     /**
-     * @param array<string, array<string, class-string>> $typeMap
+     * @param array<string, array<string, class-string>>|null $typeMap
+     * @param array<string> $groups
      * @param array<string, string|int|float|bool> $attributes
      */
     public function __construct(
         public ?string $name = null,
         public ?array $typeMap = null,
+        public array $groups = [],
         public array $attributes = [],
     ) {}
 }

src/Denormalizer.php

@@ -11,7 +11,7 @@
 {
     /**
      * @param array<DenormalizerInterface> $denormalizers
-     * @param array<string, string|int|float|bool> $attributes
+     * @param array<string, scalar|string[]> $attributes
      */
     public function __construct(
         private array $denormalizers,

src/Metadata/DataType.php

@@ -14,7 +14,7 @@ class DataType
      * @param class-string|null $className
      * @param array<DataType> $listType
      * @param array<string, array<string, class-string>> $typeMap
-     * @param array<string, string|int|float|bool> $attributes
+     * @param array<string, scalar|string[]> $attributes
      */
     public function __construct(
         public BuiltInType $type,

src/Metadata/MetadataExtractor.php

@@ -108,6 +108,7 @@ private function extractPropertyMetadata(
                 $propertyName,
                 $serializerContext,
             ),
+            groups: [] === $serializerContext->groups ? ['default'] : $serializerContext->groups,
             attributes: $serializerContext->attributes,
             readAccess: $this->getPropertyReadAccess($reflectionProperty),
             writeAccess: $this->getPropertyWriteAccess($reflectionProperty),

src/Metadata/PropertyMetadata.php

@@ -11,12 +11,14 @@ class PropertyMetadata
 
     /**
      * @param DataType[] $types
+     * @param string[] $groups
      * @param array<string, string|int|float|bool> $attributes
      */
     public function __construct(
         public string $name,
         public string $serializedName,
         public array $types,
+        public array $groups,
         public array $attributes,
         public ReadAccess $readAccess,
         public WriteAccess $writeAccess,

src/Normalizer.php

@@ -10,7 +10,7 @@
 {
     /**
      * @param array<NormalizerInterface> $normalizers
-     * @param array<string, string|int|float|bool> $attributes
+     * @param array<string, scalar|string[]> $attributes
      */
     public function __construct(
         private array $normalizers,
@@ -19,7 +19,7 @@ public function __construct(
     ) {}
 
     /**
-     * @param array<string, string|int|float|bool> $attributes
+     * @param array<string, scalar|string[]> $attributes
      *
      * @throws SerializerException
      */

src/Normalizer/ObjectNormalizer.php

@@ -17,12 +17,18 @@ public function normalize(mixed $data, Normalizer $normalizer, array $attributes
 
         $classMetadata = $normalizer->getMetadataExtractor()->extractClassMetadata($data::class);
         $normalizedData = [];
+        /** @var null|string[] $groups */
+        $groups = $attributes[SerializerInterface::ATTRIBUTE_GROUPS] ?? null;
 
         foreach ($classMetadata->properties as $name => $propertyMetadata) {
             if (ReadAccess::NONE === $propertyMetadata->readAccess) {
                 continue;
             }
 
+            if (null !== $groups && [] === array_intersect($groups, $propertyMetadata->groups)) {
+                continue;
+            }
+
             if (ReadAccess::DIRECT === $propertyMetadata->readAccess) {
                 /** @var scalar|null|object|array $value */
                 $value = $data->{$name};

src/NormalizerInterface.php

@@ -9,7 +9,7 @@ interface NormalizerInterface
     /**
      * @template T of object|array|scalar|null
      *
-     * @param array<string, string|int|float|bool> $attributes
+     * @param array<string, scalar|string[]> $attributes
      *
      * @return T|T[]
      * @throws SerializerException

src/Serializer.php

@@ -30,7 +30,7 @@ class Serializer implements SerializerInterface
     /**
      * @param array<NormalizerInterface> $normalizers
      * @param array<DenormalizerInterface> $denormalizers
-     * @param array<string, string|int|float|bool> $attributes
+     * @param array<string, scalar|string[]> $attributes
      */
     public function __construct(
         array $normalizers = [],
@@ -75,9 +75,9 @@ public function __construct(
         );
     }
 
-    public function serialize(mixed $data): string
+    public function serialize(mixed $data, array $attributes = []): string
     {
-        $normalizedData = $this->normalize($data);
+        $normalizedData = $this->normalize($data, $attributes);
 
         try {
             return json_encode($normalizedData, JSON_THROW_ON_ERROR | JSON_PRESERVE_ZERO_FRACTION);
@@ -99,11 +99,13 @@ public function deserialize(string $data, ?string $type = null): mixed
     }
 
     /**
+     * @param array<string, scalar|string[]> $attributes
+     *
      * @throws SerializerException
      */
-    public function normalize(mixed $data): mixed
+    public function normalize(mixed $data, array $attributes): mixed
     {
-        return $this->normalizer->normalize($data, []);
+        return $this->normalizer->normalize($data, $attributes);
     }
 
     /**

src/SerializerInterface.php

@@ -8,13 +8,16 @@ interface SerializerInterface
 {
     public const string ATTRIBUTE_DATETIME_FORMAT = 'datetime-format';
     public const string ATTRIBUTE_SKIP_NULL_VALUES = 'skip-null-values';
+    public const string ATTRIBUTE_GROUPS = 'groups';
 
     /**
      * Serializes data into a string.
      *
+     * @param array<string, scalar|string[]> $attributes
+     *
      * @throws SerializerException
      */
-    public function serialize(mixed $data): string;
+    public function serialize(mixed $data, array $attributes = []): string;
 
     /**
      * Deserializes data into the given type.

tests/Datasets/Group/SubLevel1.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vuryss\Serializer\Tests\Datasets\Group;
+
+use Vuryss\Serializer\Attribute\SerializerContext;
+
+class SubLevel1
+{
+    #[SerializerContext(groups: ['group1'])]
+    public SubLevel2 $nestedPropGroup1;
+
+    #[SerializerContext(groups: ['group2'])]
+    public SubLevel2 $nestedPropGroup2;
+
+    #[SerializerContext(groups: ['group1', 'group2'])]
+    public SubLevel2 $nestedPropGroup1And2;
+
+    public SubLevel2 $nestedPropNoGroup;
+
+    #[SerializerContext(groups: ['group1'])]
+    public string $propGroup1;
+
+    #[SerializerContext(groups: ['group2'])]
+    public string $propGroup2;
+
+    #[SerializerContext(groups: ['group1', 'group2'])]
+    public string $propGroup1And2;
+
+    public string $propNoGroup;
+}

tests/Datasets/Group/SubLevel2.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vuryss\Serializer\Tests\Datasets\Group;
+
+use Vuryss\Serializer\Attribute\SerializerContext;
+
+class SubLevel2
+{
+    #[SerializerContext(groups: ['group1'])]
+    public string $propGroup1;
+
+    #[SerializerContext(groups: ['group2'])]
+    public string $propGroup2;
+
+    #[SerializerContext(groups: ['group1', 'group2'])]
+    public string $propGroup1And2;
+
+    public string $propNoGroup;
+}

tests/Datasets/Group/TopLevelClass.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vuryss\Serializer\Tests\Datasets\Group;
+
+use Vuryss\Serializer\Attribute\SerializerContext;
+
+class TopLevelClass
+{
+    #[SerializerContext(groups: ['group1'])]
+    public SubLevel1 $nestedPropGroup1;
+
+    #[SerializerContext(groups: ['group2'])]
+    public SubLevel1 $nestedPropGroup2;
+
+    #[SerializerContext(groups: ['group1', 'group2'])]
+    public SubLevel1 $nestedPropGroup1And2;
+
+    public SubLevel1 $nestedPropNoGroup;
+
+    #[SerializerContext(groups: ['group1'])]
+    public string $propGroup1;
+
+    #[SerializerContext(groups: ['group2'])]
+    public string $propGroup2;
+
+    #[SerializerContext(groups: ['group1', 'group2'])]
+    public string $propGroup1And2;
+
+    public string $propNoGroup;
+}