[Serializer] Groups annotation/attribute on class

[Brajk19]

Q	A
Branch?	6.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets
License	MIT
Doc PR	TODO

This change adds option to use Groups attribute on class. Doing that will add specified group to each property.

Example, this:

class MyEntity
{
    #[Groups('group1')]
    private $foo;
    #[Groups('group1')]
    private $bar;

// getters and setters...
}

can be replaced with this

#[Groups('group1')]
class MyEntity
{
    private $foo;
    private $bar;

// getters and setters...
}

It also works with promoted properties.
This:

class View
{
    public function __construct(
        #[Groups('group1')] public readonly string $foo,
        #[Groups('group1')] public readonly string $bar
    ){
    }
}

can be replaced with this:

#[Groups('group1')]
class View
{
    public function __construct(
        public readonly string $foo,
        public readonly string $bar
    ){
    }
}

[carsonbot]

Hey!

To help keep things organized, we don't allow "Draft" pull requests. Could you please click the "ready for review" button or close this PR and open a new one when you are done?

Note that a pull request does not have to be "perfect" or "ready for merge" when you first open it. We just want it to be ready for a first review.

Cheers!

Carsonbot

[carsonbot]

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

• Always add tests
• Keep backward compatibility (see https://symfony.com/bc).
• Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
• Features and deprecations must be submitted against the 6.3 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

[alexislefebvre]

I suggest to not support the annotation @Groups({"a"}), and only support the attribute #[Groups('a')].

See:

• [RFC] Deprecate most of or all annotations? #49369

[OskarStark]

Open to finish this PR?

[derrabus]

I suggest to not support the annotation @Groups({"a"}), and only support the attribute #[Groups('a')].

Because of the way we merge annotations and attributes on the reader level already, it might be more complicated to exclude Doctrine Annotations from this feature than to just support them.

[Brajk19]

I suggest to not support the annotation @Groups({"a"}), and only support the attribute #[Groups('a')].

Because of the way we merge annotations and attributes on the reader level already, it might be more complicated to exclude Doctrine Annotations from this feature than to just support them.

Agreed. I'll leave it as is then.

[fabpot]

Thank you @Brajk19.

[tacman]

This is great. Is there a way to exclude a property? For example, the password_hash on a User entity.