8000 [Serializer] Allow to specify a single value in @Groups by dunglas · Pull Request #20509 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Serializer] Allow to specify a single value in @Groups #20509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

[Serializer] Allow to specify a single value in @Groups #20509

wants to merge 2 commits into from

Conversation

@dunglas
8000
Copy link
Member
@dunglas dunglas commented Nov 13, 2016 •
edited
Loading
Q A
Branch? master
Bug fix? no
New feature? yes
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets #19374 (comment)
License MIT
Doc PR symfony/symfony-docs#10314

Tiny DX improvement:

Before:

use Symfony\Component\Serializer\Annotation\Groups;

class Product
{
    /**
     * @Groups({"admins"})
     */
    public $itemsSold;
}

Now allowed:

use Symfony\Component\Serializer\Annotation\Groups;

class Product
{
    /**
     * @Groups("admins")
     */
    public $itemsSold;
}

@dunglas dunglas added DX DX = Developer eXperience (anything that improves the experience of using Symfony) Serializer labels Nov 13, 2016
@dunglas
Copy link
Member Author
dunglas commented Nov 13, 2016

Travis error not related.

GuilhemN
GuilhemN reviewed Nov 13, 2016
View reviewed changes
src/Symfony/Component/Serializer/Annotation/Groups.php Outdated
$value = (array) $data['value'];
foreach ($value as $group) {
if (!is_string($group)) {
throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be an array of strings.', get_class($this)));
Copy link
Contributor
@GuilhemN GuilhemN Nov 13, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this message be adapted accordingly?

@ogizanagi
Copy link
Contributor
ogizanagi commented Nov 14, 2016

👍

Status: Reviewed

@xabbuh
Copy link
Member
xabbuh commented Nov 17, 2016

👍

@xabbuh xabbuh added this to the 3.3 milestone Nov 17, 2016
@fabpot
Copy link
Member
fabpot commented Dec 2, 2016

Thank you @dunglas.

@fabpot fabpot closed this Dec 2, 2016
fabpot added a commit that referenced this pull request Dec 2, 2016
@fabpot
feature #20509 [Serializer] Allow to specify a single value in @groups …
fe454e4 
…(dunglas)

This PR was squashed before being merged into the 3.3-dev branch (closes #20509).

Discussion
----------

[Serializer] Allow to specify a single value in @groups

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #19374 (comment)
| License       | MIT
| Doc PR        | todo

Tiny DX improvement:

Before:

```php
use Symfony\Component\Serializer\Annotation\Groups;

class Product
{
    /**
     * @groups({"admins"})
     */
    public $itemsSold;
}
```

Now allowed:

```php
use Symfony\Component\Serializer\Annotation\Groups;

class Product
{
    /**
     * @groups("admins")
     */
    public $itemsSold;
}
```

Commits
-------

926aa48 [Serializer] Allow to specify a single value in @groups
@nicolas-grekas nicolas-grekas modified the milestones: 3.x, 3.3 Mar 24, 2017
@fabpot fabpot mentioned this pull request May 1, 2017
Merged
@dunglas dunglas mentioned this pull request Jun 5, 2018
Merged
@dunglas dunglas deleted the single_group branch June 5, 2018 09:45
nicolas-grekas added a commit that referenced this pull request Jul 1, 2018
@nicolas-grekas
feature #27503 [Serializer] Allow to pass a single value for the grou…
80aa8df 
…ps opt (dunglas)

This PR was merged into the 4.2-dev branch.

Discussion
----------

[Serializer] Allow to pass a single value for the groups opt

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | yes <!-- don't forget to update src/**/CHANGELOG.md files -->
| BC breaks?    | no     <!-- see https://symfony.com/bc -->
| Deprecations? | no <!-- don't forget to update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tests pass?   | yes    <!-- please add some, will be required by reviewers -->
| Fixed tickets |  n/a
| License       | MIT
| Doc PR        | todo

Shortcut syntax similar to #20509 but for the context: allows to pass a string instead of an array of string in the serialization context when only one group if used.

Before:

```php
$serializer->serialize($foo, 'json', ['groups' => ['myGroup']];

/** @ApiResource(normalizationContext={"groups"={"myGroup"}}) */
```

After:

```php
$serializer->serialize($foo, 'json', ['groups' => 'myGroup'];

/** @ApiResource(normalizationContext={"groups"="myGroup") */
```

Commits
-------

5b39203 [Serializer] Allow to pass a single value for the groups opt
@dunglas dunglas mentioned this pull request Sep 10, 2018
Merged
javiereguiluz added a commit to symfony/symfony-docs that referenced this pull request Sep 10, 2018
@javiereguiluz
minor #10314 [Serializer] Allow to specify a single value in @groups …
b10ea35 
…(dunglas)

This PR was merged into the 3.4 branch.

Discussion
----------

[Serializer] Allow to specify a single value in @groups

symfony/symfony#20509

Commits
-------

99df65f [Serializer] Allow to specify a single value in @groups
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@GuilhemN GuilhemN GuilhemN left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

DX DX = Developer eXperience (anything that improves the experience of using Symfony) Feature Serializer Status: Reviewed

Projects

None yet

Milestone

3.3

Development

Successfully merging this pull request may close these issues.

7 participants

@dunglas @ogizanagi @xabbuh @fabpot @GuilhemN @nicolas-grekas @carsonbot
0