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

08.

Adding Links via Annotations

|

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

10 Comments

Sort By

Login or Register to join the conversation

Shaun T. 7 years ago

Hey guys,

Great content as always, this course has helped me immensely!

In my app I have 2 directories for controllers:

/web - for all routes for the web app i.e. app/posts retrieves the html and javascript templates for the post page template
/api - all api routes - for examples api/posts returns the JSON data for all posts

So with regards to links, I have a problem. If I want to link to a post then the web link (/app/posts/123) works great. However, if I want to edit a post then this is done via an AJAX call, and the route is different (PATCH: /api/posts/123).

Is it possible that the links annotation can be updated to have a web and an api link? Is this good practice, or is there a better way to do this?

|

MolloKhan SFCASTS Shaun T. 7 years ago edited

Hey Shaun T.!

You can make your controller's action to serve 2 different routes by specifying another "@Route" annotation, but I don't think is a good idea for your case. What you can do is to use the "edit" API endpoint in your web AJAX calls

Cheers!

|

bblue 8 years ago

This tutorial really opened up the world of annotations for me. But, should I worry about caching? Does the doctrine annotation reader automatically cache the annotations for me?

|

weaverryan SFCASTS bblue 8 years ago edited

Yo bblue

Great question! The answer is, yes! Well, actually, the answer is: "it depends", but in this case yes. So, the Doctrine library exposes some classes that help read annotations. If you use them directly, it's possible to read annotations and *not* cache them. But, when you're in Symfony, Symfony has pre-configured the annotation_reader service to cache things, and all systems that read annotations use this service. So, in Symfony, yep, it's all cached. It may depend on your Symfony version, but in our app, these are cached via the filesystem to one of the directories in var/cache/dev/pools.

Cheers!

1 |

Vladimir Z. 8 years ago edited

Hi Ryan,
In my case, forward slashes in _links are escaped with a backslash:


"_links": {
        "self": "\/app_test.php\/api\/programmers\/CowboyCoder"
    }

.
Any idea why this might be happening?
Thank you!

|

Vladimir Z. Vladimir Z. 8 years ago edited

Found a solution: https://github.com/schmittjoh/JMSSerializerBundle/issues/289
added the following options to config.yml:


jms_serializer:
    visitors:
        json:
            options: [JSON_UNESCAPED_SLASHES, JSON_UNESCAPED_UNICODE]

|

Vladimir Z. Vladimir Z. 8 years ago edited

Well, it works when I run it in Terminal, but not in the browser.
Also tried (to no avail):


$visitor->setOptions([JSON_UNESCAPED_SLASHES, JSON_UNESCAPED_UNICODE]);

|

weaverryan SFCASTS Vladimir Z. 8 years ago

Hey Vlad!

Setting these options works when you run it in your terminal (do you mean, like running unit tests?) but not in the browser? That by itself looks weird to me! Tell me more about that. From what I can see, you're doing the right types of things - the JsonSerializationVisitor uses those options in json_encode(). I'd add some temporary breakpoints or dump code in that class to see if your options are making it there.

Btw - what's wrong with the slash escaping? Just looking kinda ugly (it is a bit ugly)?

Cheers!

|

Vladimir Z. weaverryan 8 years ago

Hi Ryan,
Yes, it works when I run unit tests, but not when I load it in the browser.
I'll follow your suggestion to set breakpoints or dump() to see what's going on.
Do you think there might be a PHP ini setting that does that? I noticed, you don't get slashes escaped.
Nothing wrong in the slash escaping, it is just not required by JSON. But if I can't figure it, I'll leave it as is. No big deal.
Thank you!

|

weaverryan SFCASTS Vladimir Z. 8 years ago

Hi Vlad!

Wow, that *is* weird! I don't initially see any php.ini setting for this (but I have never really looked into this too far), but it could still be the cause. Or, something more subtle is happening!

And btw, at the end of this video when I load the JSON in the browser, I DO also have the escaped slashes. My JsonView Chrome extension is cleaning this up for me - if you look at the actual dumped source, the slashes are escaped.

If you end up figuring it out - let me know, I'm also curious :).

Cheers!

|

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