Chapters

20 Chapters | 1:18:30 |

01

The Battle Resource

2:54
02

Designing (Testing) the Create Battle Endpoint

3:56
03

Saving Related Resources in a Form

4:44
04

Finishing the Battle

2:47
05

VirtualProperty: Add Crazy JSON Fields

4:50
06

Form Voodoo: property_path

2:26
07

Adding Battle Validation

3:28
08

EntityType Validation: Restrict Invalid programmerId

5:16
09

HATEOAS & Hypermedia: The Buzzwords Level

4:19
10

Link from Battle to Programmer

2:34
11

The Great Hateoas PHP Library

3:17
12

The HAL JSON Standard

3:53
13

Embedding Objects with Hal?

2:26
14

Customize how your Links Render

4:50
15

Customizing (making less ugly) Embeddeds!

3:44
16

Subordinate URL Structure

3:22
17

Coding the Subordinate Resource Endpoint

3:57
18

Rock-Solid, Consistent Collection Endpoints

4:10
19

Weird Endpoint: The tagline as a Resource?

5:47
20

Weird Endpoint: Command: Power-Up a Programmer

5:50

This tutorial has a new version, check it out!

> APIs > Symfony RESTful API: Hypermedia, Links & Bonuses (Course 5)

Buy Access to Course

19.

Weird Endpoint: The tagline as a Resource?

|

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 $12.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

5 Comments

Sort By

Login or Register to join the conversation

Vladimir Z. 8 years ago

Hi Ryan,

How does Doctrine know to query for the Programmer using the `nickname` value? Does it check that the nickname property is part of the Programmer class and then does findOneBy(array('nickname' => $nickname)), or does it need an existing method (findOneByNickname($nickname)) in ProgrammerRepository?

Thank you!

|

Victor SFCASTS Vladimir Z. 8 years ago edited

Hey, Vlad!

I can help you with it. This feature called <a href="http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html">ParamConverter</a> in Symfony. Actually, in this case triggered the <a href="http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html#doctrine-converter">Doctrine Converter</a>. This guy do all that magic:

Determine entity repository from typehinted entity class in method (Programmer in our case);
Then if route has '{id}' placeholder - ParamConverter calls find() method on its repository, otherwise it try to find entity by criteria using findOneBy()('{nickname}' in our case)
And inject found entity into the method or throw an NotFoundHttpException exception

So you don't need to have findOneByNickname() method in your entity repository class.

BTW, you can control mapping of route placeholders to the entity properties and even create your own converter.

Cheers!

|

Vladimir Z. Victor 8 years ago

Thank you for the explanation, Victor!
How do you control mapping of route placeholders to the entity properties and even create your own converter?

|

Victor SFCASTS Vladimir Z. 8 years ago edited

Hey, Vlad!

Actually, I don't create my own converters, for something complex I manually query an entity from database. It's more quickly than create a custom converter and is more obvious for complex code.

The simple mapping controlling looks like:


/**
 * @Route("/blog/{post_id}")
 * @ParamConverter("post", class="SensioBlogBundle:Post", options={"id" = "post_id"})
 */
public function showAction(Post $post)
{
}

You should explicitly use ParamConverter annotation. In this example we have an ID property for Post entity, but placeholder's name is post_id, so we need to use a custom mapping here (options={"id" = "post_id"}).

Search for 'mapping' on <a href="http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html#doctrine-converter">Doctrine Converter</a> page to find more mapping examples.

Cheers!

|

Vladimir Z. Victor 8 years ago

Thank you, Victor. I will make a not of that. Useful trick to have.

|

This tutorial uses an older version of Symfony. The concepts of Hypermedia & HATEOAS are still valid. But I recommend using API Platform in modern Symfony apps.

Symfony 3

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=5.5.9",
        "symfony/symfony": "3.0.*", // v3.0.3
        "doctrine/orm": "^2.5", // v2.5.4
        "doctrine/doctrine-bundle": "^1.6", // 1.6.2
        "doctrine/doctrine-cache-bundle": "^1.2", // 1.3.0
        "symfony/swiftmailer-bundle": "^2.3", // v2.3.11
        "symfony/monolog-bundle": "^2.8", // v2.10.0
        "sensio/distribution-bundle": "^5.0", // v5.0.4
        "sensio/framework-extra-bundle": "^3.0.2", // v3.0.14
        "incenteev/composer-parameter-handler": "~2.0", // v2.1.2
        "jms/serializer-bundle": "^1.1.0", // 1.1.0
        "white-october/pagerfanta-bundle": "^1.0", // v1.0.5
        "lexik/jwt-authentication-bundle": "^1.4", // v1.4.3
        "willdurand/hateoas-bundle": "^1.1" // 1.1.1
    },
    "require-dev": {
        "sensio/generator-bundle": "^3.0", // v3.0.6
        "symfony/phpunit-bridge": "^3.0", // v3.0.3
        "behat/behat": "~3.1@dev", // dev-master
        "behat/mink-extension": "~2.2.0", // v2.2
        "behat/mink-goutte-driver": "~1.2.0", // v1.2.1
        "behat/mink-selenium2-driver": "~1.3.0", // v1.3.1
        "phpunit/phpunit": "~4.6.0", // 4.6.10
        "doctrine/doctrine-fixtures-bundle": "^2.3" // 2.3.0
    }
}

Previous Chapter

Next Chapter