Chapters

10 Chapters | 50:47 |

01

Pagination Design and Test

6:20
02

Pagerfanta Pagination

6:29
03

Pagination Links

4:47
04

Reusable Pagination System

3:40
05

Filtering / Searching

4:14
06

Serialization Event Subscriber

4:20
07

Super Custom Serialization Fields

6:01
08

Adding Links via Annotations

6:22
09

Evaluating the Link Expression

3:23
10

Conditionally Serializing Fields with Groups

5:11

This tutorial has a new version, check it out!

> APIs > Symfony RESTful API: Basics++ (Course 3)

Buy Access to Course

07.

Super Custom Serialization Fields

|

Autoplay

Keep on Learning!

If you liked what you've learned so far, dive in! Subscribe to get
access to this tutorial plus video, code and script downloads.

Start your All-Access Pass

Buy just this tutorial for $10.00

Previous Chapter

Next Chapter

With a Subscription, click any sentence in the script to jump to that part of the video!

Login Subscribe

Login or register to check out the script

11 Comments

Sort By

Login or Register to join the conversation

Gregory 8 years ago edited

Hi,
I have just a little question about the LinkSerializer, Imagine you want to add the other field 'uri' in the second entity.
Do you make an other subscriber or do you update the first one to handle the 2 cases?
In the case you decide to manage with the same, is it correct to add a second array in the getSubscribedEvent ?


return [
            [
                'event'  => 'serializer.post_serialize',
                'method' => 'onPostSerialize',
                'format' => 'json',
                'class'  => 'AppBundle\Entity\Programmer',
            ],
            [
                'event'  => 'serializer.post_serialize',
                'method' => 'onPostSerialize',
                'format' => 'json',
                'class'  => 'AppBundle\Entity\OtherEntity',
            ],
        ];

thanks again for all your works

Cheers.

|

MolloKhan SFCASTS Gregory 8 years ago edited

Hey Gregory!

If you want to do it via a "subscriber" it would be better to create another one, because our LinkSerializer is coupled to the Programmer entity, but you may end up with a lot of subscribers if you keep repeating this pattern, so you might want to go with the other approach that Ryan showed at the end of the video. Creating a model class which maps all the fields you want to return

Cheers!

|

Gregory MolloKhan 8 years ago

Hi Diego,

Thanks for your answer, you're right it is an idea but Ryan shows us an other way in a future video.
Just need to remove the param "class" in the getSubscribedEvents

So next time, I'll waiting to finish all the videos before to ask ;)

Cheers

1 |

MolloKhan SFCASTS Gregory 8 years ago

Awesome, let's keep learning!

|

george 8 years ago

Hi I have a problem with the eventsubscriber , it seems that it never get fired so when I am running the tests I get the following error:

`Symfony\Component\PropertyAccess\Exception\AccessException: Error reading property "uri" from available keys (nickname, avatarNumber, tagLine, powerLevel)`

|

MolloKhan SFCASTS george 8 years ago edited

Hey George!

Let's check if your eventsubscriber is working fine, put a dump with wathever value you want inside your method "onPostSerialize()" and lets see if it's printed when you hit the API, if not, there can be 2 things wrong:

1) Something in your service.yml file is wrong (probably the tag field), it should look like this:


services:
    link_serialization_subscriber:
        class: AppBundle\Serializer\LinkSerializationSubscriber
        tags:
            - { name: jms_serializer.event_subscriber }

2) The "getSubscribedEvents" method, it should look like this:


return array(
            array(
                'event' => 'serializer.post_serialize',
                'method' => 'onPostSerialize',
                'format' => 'json',
                'class' => 'AppBundle\Entity\Programmer'
            )
        );

Have a nice day!

|

Jonathan Keen 8 years ago

Just a comment, because I've found this to be REALLY helpful when I'm getting some specific data about my Entities, including aggregate values which cause mixed results. I've been creating Data Transformer Objects (DTO) that I can use within my DQL queries to populate that new DTO with the data. Like you said in the video, the separation helps me a lot in thinking of exactly what I'm exposing to the world.

Within that DTO, we can do all sorts of transformations with the data before serialization, including adding those extra fields like we do with the Serialization Event Subscribers or how you did within the controller.

Can see the documentation on this here:
http://doctrine-orm.readthe...

When my head gets all foggy from thinking about how to arrange those mixed results the way I want them, this helps in getting rid of that issue...

Also, cause I know you're reading this Ryan (because you're a shining example of not only the best teacher, but a fantastic businessman who cares about his customers!), if you have any cautions or comments on what I'm doing, I'd love your feedback!

|

Alberto Castro Jonathan Keen 8 years ago

I am trying to understand this method. It seems to me, and please correct me if I am wrong that this is a way to specify a database view (as in CREATE VIEW ... in SQL) using the Doctrine ORM. I have a situation where that is exactly what I need but I want to keep the data in contained classes (which I think of models of the entities) instead of doing a lot of work in the controller. This seems to be exactly what I am looking for. Thank you Jonathan.

|

Jonathan Keen Alberto Castro 8 years ago

Alberto, glad to help. Yes, I basically create models based off the entities when I'm using this "NEW" operator. It allows me to create a specific VIEW to use. If you have any questions or want to see any of my implementations of it, let me know!

64 |

Alberto Castro Jonathan Keen 8 years ago

I'd love to see your implementation of this. Let me know how you want to share it. Thank you!

|

weaverryan SFCASTS Jonathan Keen 8 years ago

Hi Jonathan!

That "new" operator in DQL is rad - how did I not know about this???!!! And ha, I have no cautions to give you - this looks really cool, and I can't agree more about "removing the foggy" by using these DTO's. Obviously, keep your queries organized in your repositories... but that's all I can say about this.

Thanks for sharing!

|

This tutorial uses an older version of Symfony. The concepts of REST and serialization are still valid, but I recommend using API Platform in new Symfony apps.

Symfony 3

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=5.3.3",
        "symfony/symfony": "2.6.*", // v2.6.11
        "doctrine/orm": "~2.2,>=2.2.3,<2.5", // v2.4.7
        "doctrine/dbal": "<2.5", // v2.4.4
        "doctrine/doctrine-bundle": "~1.2", // v1.4.0
        "twig/extensions": "~1.0", // v1.2.0
        "symfony/assetic-bundle": "~2.3", // v2.6.1
        "symfony/swiftmailer-bundle": "~2.3", // v2.3.8
        "symfony/monolog-bundle": "~2.4", // v2.7.1
        "sensio/distribution-bundle": "~3.0,>=3.0.12", // v3.0.21
        "sensio/framework-extra-bundle": "~3.0,>=3.0.2", // v3.0.7
        "incenteev/composer-parameter-handler": "~2.0", // v2.1.0
        "hautelook/alice-bundle": "0.2.*", // 0.2
        "jms/serializer-bundle": "0.13.*", // 0.13.0
        "white-october/pagerfanta-bundle": "^1.0" // v1.2.4
    },
    "require-dev": {
        "sensio/generator-bundle": "~2.3", // v2.5.3
        "behat/behat": "~3.0", // v3.0.15
        "behat/mink-extension": "~2.0.1", // v2.0.1
        "behat/mink-goutte-driver": "~1.1.0", // v1.1.0
        "behat/mink-selenium2-driver": "~1.2.0", // v1.2.0
        "phpunit/phpunit": "~4.6.0" // 4.6.4
    }
}

Previous Chapter

Next Chapter