Archived

forked from https://github.com/symfony/symfony

This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.

Go to file

Fabien Potencier 3c3ec5c677 merged branch tvlooy/GetSetMethodNormalizer (PR #3582 ) Commits ------- `039ff6f` allow more control on GetSetMethodNormalizer by using callback functions and an ignoreAttributes list Discussion ---------- allow more control on GetSetMethodNormalizer Here is an other attempt. You would use this as follows: $serializer = new \Symfony\Component\Serializer\Serializer( array(new \Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer()), array('json' => new \Symfony\Component\Serializer\Encoder\JsonEncoder()) ); $callbacks = array('books' => function ($books) { return NULL; }); return new Response( $serializer->serialize($paginator->getRows(), 'json', $callbacks), 200, array('Content-Type' => 'application/json') ); Besides of returning NULL, you could also do things like: $callbacks = array( 'books' => function ($books) { $ids = array(); foreach ($books as $book) { $ids[] = $book->getId(); } return $ids; }, 'author' => function ($author) { return $author->getId(); }, 'creationDate' => function ($creationDate) { return $creationDate->format('d/m/Y'); }, ); The commit is not complete yet. But at this point I am interested in your opinions. --------------------------------------------------------------------------- by lsmith77 at 2012-03-12T22:53:18Z in general i agree that using a callback is a good solution to provide more power without complicating the API or implementation in this case. please add a test case, this should also help illustrate how this can be used in practice. --------------------------------------------------------------------------- by schmittjoh at 2012-03-13T04:54:33Z Note that your change breaks the API defined by the interface, i.e. someone using this method needs to type-hint the serializer implementation, not the interface. It also adds a parameter to the public API of the serializer which will only work with one specific normalizer. What if another normalizer needs additional information, should another parameter be added to the serialize method? What about deserialization? Bottom line is, the serializer component was simply not designed for this kind of thing. I've tried to make it more flexible before creating the bundle, but some things simply cannot be fixed in a sane way. --------------------------------------------------------------------------- by tvlooy at 2012-03-13T06:07:45Z Would just adding a setCallbacks() to the GetSetMethodNormalizer be a better solution? That doesn't touch the API. I will try to write some tests this evening. --------------------------------------------------------------------------- by schmittjoh at 2012-03-13T16:22:50Z That would definitely be better. You would then need to retrieve the normalizer instance before calling ``serialize`` on the serializer which also leaves a stale taste, but I have no other solution for now. --------------------------------------------------------------------------- by tvlooy at 2012-03-13T21:32:26Z So, this should be it then. Yet an other usage example: $normalizer = new \Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer(); $normalizer->setCallbacks( array( 'books' => function ($books) { $ids = array(); foreach ($books as $book) { $ids[] = $book->getId(); } return $ids; }, ) ); $serializer = new \Symfony\Component\Serializer\Serializer( array($normalizer), array('json' => new \Symfony\Component\Serializer\Encoder\JsonEncoder()) ); return new Response( $serializer->serialize($paginator->getRows(), 'json'), 200, array('Content-Type' => 'application/json') ); --------------------------------------------------------------------------- by tvlooy at 2012-03-18T21:16:48Z Anything else needed for this to get pulled in? --------------------------------------------------------------------------- by tvlooy at 2012-03-19T18:33:58Z Hm, I like to keep it that way because I like the fact that not passing a callable will result in a warning instead of silently skipping it. You don't get that behaviour by treating it as null. --------------------------------------------------------------------------- by vicb at 2012-03-19T23:15:37Z I was unclear: the code should throw an exception when an element is not callable, this is why `null` will not be supported any more (it is not a callback as the `setCallbacks` indicate). They are several way to support the former behavior: * the cb can return a defined interface, * the cb can throw a defines exc, * by adding a `setIgnoredAttributes` method Please also squash your commits. --------------------------------------------------------------------------- by tvlooy at 2012-03-20T21:02:06Z Yes, I like the setIgnoredAttributes solution. I changed it and squashed the commits. --------------------------------------------------------------------------- by tvlooy at 2012-03-26T20:07:36Z some improvements and squashed the commits --------------------------------------------------------------------------- by stof at 2012-04-03T22:36:15Z @tvlooy Please rebase your branch. It conflicts with master because of the move of tests. --------------------------------------------------------------------------- by tvlooy at 2012-04-04T07:43:47Z @stof I will do it on saturday, if that is ok with you. --------------------------------------------------------------------------- by fabpot at 2012-04-10T18:29:30Z Is it mergeable now? ping @Seldaek, @schmittjoh. --------------------------------------------------------------------------- by tvlooy at 2012-04-10T18:55:04Z yes, it should be		2012-04-11 12:08:10 +02:00
src/Symfony	merged branch tvlooy/GetSetMethodNormalizer (PR #3582 )	2012-04-11 12:08:10 +02:00
.gitignore	added composer.lock to .gitignore	2012-04-06 22:15:14 -03:00
.travis.yml	also test PHP 5.3.2, since this is the official lowest supported PHP version	2011-12-26 01:15:21 +01:00
autoload.php.dist	Changed the test autoloading to use the new autoloader	2012-04-01 23:50:54 +02:00
CHANGELOG-2.0.md	updated CHANGELOG for 2.0.12	2012-03-19 00:56:33 +01:00
CHANGELOG-2.1.md	updated CHANGELOG	2012-04-11 11:51:04 +02:00
check_cs	moved component and bridge unit tests to the src/ directory	2012-03-29 08:37:22 +02:00
composer.json	fixed typos in composer file	2012-03-15 11:15:25 +01:00
CONTRIBUTORS.md	update CONTRIBUTORS for 2.0.12	2012-03-19 00:57:27 +01:00
LICENSE	Updated LICENSE files copyright	2012-02-22 10:10:37 +01:00
phpunit.xml.dist	moved component and bridge unit tests to the src/ directory	2012-03-29 08:37:22 +02:00
README.md	set travis-ci icon to master	2011-11-23 11:36:09 +01:00
UPGRADE-2.1.md	[Form] Simplified choice list API	2012-04-10 15:37:24 +02:00
vendors.php	updated license blocks	2012-03-31 18:00:32 -03:00

README.md

README

What is Symfony2?

Symfony2 is a PHP 5.3 full-stack web framework. It is written with speed and flexibility in mind. It allows developers to build better and easy to maintain websites with PHP.

Symfony can be used to develop all kind of websites, from your personal blog to high traffic ones like Dailymotion or Yahoo! Answers.

Requirements

Symfony2 is only supported on PHP 5.3.2 and up.

Installation

The best way to install Symfony2 is to download the Symfony Standard Edition available at http://symfony.com/download.

Documentation

The "Quick Tour" tutorial gives you a first feeling of the framework. If, like us, you think that Symfony2 can help speed up your development and take the quality of your work to the next level, read the official Symfony2 documentation.

Contributing

Symfony2 is an open source, community-driven project. If you'd like to contribute, please read the Contributing Code part of the documentation. If you're submitting a pull request, please follow the guidelines in the Submitting a Patch section.