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

28.

Custom Filter apply()

|

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

7 Comments

Sort By

Login or Register to join the conversation

Bernard A. 4 years ago edited

Passing info from Filter to DataProvider as below seems unnecessary.

$context[self::FROM_FILTER_CONTEXT] = $fromDate;

The same information is available on the Context on the DataProvider ( dump below):

See the key "filters" below:


^ array:9 [
  0 => "filters": array:2 [
                                   "search" => "2020-09-01"
                                   "page" => "1"
                                 ]

  1 => "groups"
  2 => "operation_type"
  3 => "collection_operation_name"
  4 => "resource_class"
  5 => "input"
  6 => "output"
  7 => "request_uri"
  8 => "uri"
]

|

weaverryan SFCASTS Bernard A. 4 years ago edited

Hey Bernard A.!

Ah, excellent catch! Yes, it looks like you could grab that and do all the processing you want. However, if you wanted to do any "cleaning up" of the filter (it's minor, but we convert it from a string to a DateTimeImmutable), you could still do that in your filter and pass *that* forward.

Cheers!

1 |

adeoweb 4 years ago edited

Also wondering why you chose to use a setter for setting the date on DailyStatsPaginator and making it non-nullable, when you could both make it nullable and use it as a constructor argument instead. I do understand that it doesn't make any difference in the end, but just wondering what the reason for this inconsistency might be. :)

|

weaverryan SFCASTS adeoweb 4 years ago edited

Yo Adeoweb!

Hmm, fair question :). I think in either case, the property would need to be nullable because the "from date" is optional: it's only present the query parameter is present: https://symfonycasts.com/screencast/api-platform-extending/apply-filter#codeblock-10bf80c57d. So then - unless I'm forgetting a detail - since it needs to nullable either way, it comes down to a pure preference. The setter is a bit more expressive than adding a 4th constructor argument... however you could also use named parameters in the constructor if you wanted the new DailyStatsPaginator() code to be a bit more readable. So, yea, just coming down to preference here.

Cheers!

|

adeoweb 4 years ago edited

I just noticed while debugging that at least in Api Platform 2.6, the $this->pagination->getPagination() call in DailyStatsProvider line 28 actually needs a third argument – $context. Without it, $page is always 1.

|

weaverryan SFCASTS adeoweb 4 years ago edited

Hey Adeoweb!

Ah, good catch! I bet that's a change in API Platform - I'll check it out and we'll add a note if needed (it sounds like it is needed).

Cheers!

|

adeoweb weaverryan 4 years ago

Thanks for your replies. It seems like this was changed while preparing to release 2.4.0, in this commit.

|

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