Chapters

48 Chapters | 5:13:28 |

01

App & Test Setup

7:44
02

Data Persister Decoration

6:48
03

Decorating Data Persisters vs Context Builders

8:54
04

Custom Logic Only for some Operations

5:02
05

Publishing a Listing

6:02
06

Detecting the "Published" State Change

9:08
07

Validating Who/When Can Publish

8:22
08

Publish State Change Validator Logic

8:26
09

Completely Custom Field via a Data Provider

9:19
10

Leveraging the Doctrine Data Provider

5:27
11

Adding & Populating the Custom Field

5:10
12

Custom Item Data Provider

6:57
13

Setting a Custom Field Via a Listener

5:32
14

Core Listeners & Accessing the "Resource" Objects

4:37
15

Doctrine postLoad Listener

8:03
16

Completely Custom Resource

5:25
17

Custom Resource Data Provider

6:40
18

Property Metadata

6:20
19

Why/When a Many Relation is IRI Strings vs Embedded

5:19
20

Collection "Types" and readableLink

7:12
21

Custom Resource GET Item

5:50
22

Custom Paginator

7:04
23

Pagination Context

7:09
24

Custom Resource PUT Operation

5:19
25

Custom Filter, getDescription() & properties

7:09
26

Custom Filter Logic for Entities

8:25
27

Custom Filter for Custom Resources

7:49
28

Custom Filter apply()

8:15
29

Filter Class Arguments

4:26
30

Filter Autowiring

5:46
31

Output DTO Class

4:40
32

DTO Data Transformer

5:31
33

Output Properties & Metadata

7:14
34

DTO Quirks

5:23
35

DTO Quirks: Embedded Objects

6:37
36

Input DTO Class

7:16
37

Input DTO: Denormalizing IRI Strings

5:33
38

Input Data Transformer

4:24
39

Input DTO Update Problems

6:38
40

DTO Input "Initializer"

6:41
41

DTO Input Initializer Logic

6:19
42

DTO Class Organization

5:12
43

Type Validation

7:29
44

Input DTO Validation

5:43
45

UUID's

7:29
46

UUID as a API Identifier

5:16
47

Setting the UUID on POST

5:15
48

UUID Quirk with "id" Name

7:09

This tutorial has a new version, check it out!

> Symfony 5 > API Platform 2 Part 3: Custom Resources

Buy Access to Course

09.

Completely Custom Field via a Data Provider

|

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

10 Comments

Sort By

Login or Register to join the conversation

Pisar 3 years ago edited

Hi,
In Api Platform 3 there is no

ApiPlatform\Core\DataProvider\CollectionDataProviderInterface;
ApiPlatform\Core\DataProvider\ContextAwareCollectionDataProviderInterface;
ApiPlatform\Core\DataProvider\DenormalizedIdentifiersAwareItemDataProviderInterface;
ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;

How to handle this Custom Field via Data Provider?

|

patrick Pisar 3 years ago

The way I see it, in Api Platform 3 you are supposed to use StateProvider, implementing ProviderInterface. See https://api-platform.com/docs/core/state-providers/ for more. As I am trying to learn things myself, this might not be correct.

|

weaverryan SFCASTS patrick 3 years ago

Hey Patrick!

I'm actually not sure myself - sorry I can't be of more assistance! Updating the tutorials for API Platform 3 is my December project right after SymfonyCon :). But yes, I believe you are correct. In fact, if you try to go to https://api-platform.com/docs/core/data-providers/ it redirects you to the page about state-providers :).

Cheers!

|

Petru L. 5 years ago

Hello,

I have a custom field in my File entity which i set in my DataProvider. This field can only be read and by default it is null and while it does show correctly on my File resource, it doesn't show in a response of a different resource that has a relation to the File entity. For example, the File entity is a OneToMany to a ProductFile join table which also has a relation of ManyToOne to Product Entity. When i make a GET request to Product resource i get a list of products each with a productFiles array of files objects and in this object the custom field is missing. After some debugging it looks like is missing because apiplatform doesn't display null properties by default, so the problem is that my custom field isn't set.. actually the File data provider isn't used when the file is a sub resource of a another resource. Any ideas?

|

weaverryan SFCASTS Petru L. 5 years ago edited

Hey Petru L. !

Sorry for my VERY late reply - your question was left for me and I've been deep in tutorial land :).

Ok, I think I can answer this :). Here's the key:

custom field in my File entity which i set in my DataProvider ... while it does show correctly on my File resource, it doesn't show in a response of a different resource that has a relation to the File entity

The "data provider" system is only called ONCE per request for the TOP level resource only. So when you request directly for a "File" resource, it's called and everyone is happy :). But if you request to a Product resource, in order to get the "productFiles" field, API Platform simply calls $product->getProductFiles(), which uses 100% Doctrine logic. Then, for each related file, it does the same thing, calling $productFile->getFile(), once again using normal Doctrine logic and NOT the data provider.

This is definitely a gotcha... but I can't remember if I mention in it in the tutorial or not (I hope I do somewhere!).

Anyways, the fix - if you need it to show up in these embedded situations as well - is probably to use a Doctrine listener - like we do here - https://symfonycasts.com/screencast/api-platform-extending/post-load-listener. Other solutions involve adding a listener - https://symfonycasts.com/screencast/api-platform-extending/set-via-listener - or other data provider to set this. But in both of those situations, you would need to have some logic that says "Oh! The main object is a Product. I know that this will include a File, so let me loop over the $product->getProductFiles(), then get each File object, and then set the property". That's not a huge deal - but if you ever had a File that was included as an embedded resource in yet another resource, you'd need to update the logic to handle THAT spot too.

Let me know what you think :). I tend to limit my "resource embedding" to avoid this sort of issue. But obviously, sometimes embedding data is exactly what you want in your API. And we CAN make this work.

Cheers!

|

Petru L. weaverryan 5 years ago edited

Hey weaverryan, no worries, thank you for the reply.
I do get what your saying and in the meantime i end up using an output dto which works for embedded data, haven't tried with more than 1 level though. So i guess i'll just leave it like that until i face another complication.

Also, this Disqus comment system has some real problems lately... issues with suggestions where it keeps the pre suggestion string along with the completion, tags that are not correctly rendered...

|

MolloKhan SFCASTS Petru L. 5 years ago edited

Hey Petru L.

Thanks for your input about Disqus. We're aware of it's far from perfect, and it's on our goal to switch to a different system but I can't give any estimation about it

Cheers!

|

kakhaber 5 years ago edited

Hi All

When I am testing, always shows

<blockquote>
{"error":"Invalid credentials."}
</blockquote>

And I cannot test, just watching videos as demo

I did copy and paste all code but no result


[kakhaber@localhost code-api-platform-extending]$ php bin/phpunit --filter=testGetUser
PHPUnit 8.2.5 by Sebastian Bergmann and contributors.


Testing Project Test Suite
F                                                                   1 / 1 (100%)


Time: 2.29 seconds, Memory: 30.00 MB


There was 1 failure:


1) App\Tests\Functional\UserResourceTest::testGetUser
Failed asserting that the Response status code is 204.
HTTP/1.1 401 Unauthorized
Cache-Control: max-age=0, must-revalidate, private
Content-Type:  application/json
Date:          Wed, 17 Feb 2021 15:08:48 GMT
Expires:       Wed, 17 Feb 2021 15:08:48 GMT
Link:          <http://example.com/api/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"
X-Robots-Tag:  noindex


{"error":"Invalid credentials."}


/home/kakhaber/Projects/symfonycasts/code-api-platform-extending/vendor/api-platform/core/src/Bridge/Symfony/Bundle/Test/BrowserKitAssertionsTrait.php:38
/home/kakhaber/Projects/symfonycasts/code-api-platform-extending/src/Test/CustomApiTestCase.php:56
/home/kakhaber/Projects/symfonycasts/code-api-platform-extending/tests/Functional/UserResourceTest.php:54


FAILURES!
Tests: 1, Assertions: 1, Failures: 1.

|

MolloKhan SFCASTS kakhaber 5 years ago edited

Hey Kakha K.

That's a bit odd. I believe your requests are been processed in the "dev" environment. If you're using Symfony CLI to spin-up your web server, then start it in this way and give it a try
APP_ENV=test symfony serve -d

Cheers!

|

This tutorial also works great with API Platform 2.6.

Api Platform 2.5 Symfony 5

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=8.2",
        "ext-ctype": "*",
        "ext-iconv": "*",
        "api-platform/core": "^2.1", // v2.5.10
        "composer/package-versions-deprecated": "^1.11", // 1.11.99
        "doctrine/annotations": "^1.0", // 1.12.1
        "doctrine/doctrine-bundle": "^2.0", // 2.1.2
        "doctrine/doctrine-migrations-bundle": "^3.0", // 3.0.2
        "doctrine/orm": "^2.4.5", // 2.8.2
        "nelmio/cors-bundle": "^2.1", // 2.1.0
        "nesbot/carbon": "^2.17", // 2.39.1
        "phpdocumentor/reflection-docblock": "^3.0 || ^4.0 || ^5.0", // 5.2.2
        "ramsey/uuid-doctrine": "^1.6", // 1.6.0
        "symfony/asset": "5.1.*", // v5.1.5
        "symfony/console": "5.1.*", // v5.1.5
        "symfony/debug-bundle": "5.1.*", // v5.1.5
        "symfony/dotenv": "5.1.*", // v5.1.5
        "symfony/expression-language": "5.1.*", // v5.1.5
        "symfony/flex": "^1.1", // v1.21.6
        "symfony/framework-bundle": "5.1.*", // v5.1.5
        "symfony/http-client": "5.1.*", // v5.1.5
        "symfony/monolog-bundle": "^3.4", // v3.5.0
        "symfony/security-bundle": "5.1.*", // v5.1.5
        "symfony/twig-bundle": "5.1.*", // v5.1.5
        "symfony/validator": "5.1.*", // v5.1.5
        "symfony/webpack-encore-bundle": "^1.6", // v1.8.0
        "symfony/yaml": "5.1.*" // v5.1.5
    },
    "require-dev": {
        "doctrine/doctrine-fixtures-bundle": "^3.3", // 3.3.2
        "symfony/browser-kit": "5.1.*", // v5.1.5
        "symfony/css-selector": "5.1.*", // v5.1.5
        "symfony/maker-bundle": "^1.11", // v1.23.0
        "symfony/phpunit-bridge": "5.1.*", // v5.1.5
        "symfony/stopwatch": "5.1.*", // v5.1.5
        "symfony/twig-bundle": "5.1.*", // v5.1.5
        "symfony/web-profiler-bundle": "5.1.*", // v5.1.5
        "zenstruck/foundry": "^1.1" // v1.8.0
    }
}

Previous Chapter

Next Chapter