Skip to content

[Serializer] Update custom_normalizer.rst #15150

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.

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

Open
wants to merge 1 commit into
base: 5.2
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions serializer/custom_normalizer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,26 @@ to customize the normalized data. To do that, leverage the ``ObjectNormalizer``:
}
}

If you're creating a REST api with a custom response, here's an example
of what you would have in the `normalize` function:

public function normalize($product, string $format = null, array $context = [])
Copy link
Contributor

Choose a reason for hiding this comment

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

What is different from the lines above in your example?

Copy link
Author

Choose a reason for hiding this comment

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

I wanted to specifically mention REST api since I spent a lot of time searching keywords before I found the custom normalizer

Copy link
Contributor

Choose a reason for hiding this comment

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

I think then that the example is not necessary since it seems to me identical to the previous one.
Maybe more a rewording to add this mentions.

Copy link
Author

Choose a reason for hiding this comment

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

I see. I thought the documentation in this part wasn't rich enough in examples since I had to do some extra googling before knowing how to return specific attributes (see lines 62 to 74).
Might be just me since I mainly work with node environments, but feel free to make some edits.

More details on why I made these changes.

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this is the correct place for it. It would be easier to use #[Groups] attribute on your Product class rather than building a custom normalizer for it.

{
$data = $this->normalizer->normalize($product, $format, $context);

// Here, add, edit, or delete your fields:
$data = [
'id' => $product->getId(),
'name' => $product->getName(),
'description' => $product->getDescription(),
'price' => $product->getPrice(),
'available' => $product->getAvailable(),
'category' => $product->getCategory()->getName(),
];
return $data;
}


Registering it in your Application
----------------------------------

Expand Down