Skip to content

feat: thanks to the argument resolver, no need to use $data anymore #1390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 23, 2021
Merged

feat: thanks to the argument resolver, no need to use $data anymore #1390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions core/controllers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ class CreateBookPublication
$this->bookPublishingHandler = $bookPublishingHandler;
}

public function __invoke(Book $data): Book
public function __invoke(Book $book): Book
{
$this->bookPublishingHandler->handle($data);
$this->bookPublishingHandler->handle($book);

return $data;
return $book;
}
}
```
Expand All @@ -65,7 +65,10 @@ This action will be automatically registered as a service (the service name is t
API Platform automatically retrieves the appropriate PHP entity using the data provider then deserializes user data in it,
and for `POST` and `PUT` requests updates the entity with data provided by the user.

**Warning: the `__invoke()` method parameter [MUST be called `$data`](https://symfony.com/doc/current/components/http_kernel.html#getting-the-controller-arguments)**, otherwise, it will not be filled correctly!
The entity is retrieved in the `__invoke` method thanks to a dedicated argument resolver.

When using `GET`, the `__invoke()` method parameter will receive the identifier and should be called the same as the resource identifier.
So for the path `/user/{uuid}/bookmarks`, you must use `__invoke(string $uuid)`.

Services (`$bookPublishingHandler` here) are automatically injected thanks to the autowiring feature. You can type-hint any service
you need and it will be autowired too.
Expand Down Expand Up @@ -386,11 +389,11 @@ class CreateBookPublication
* }
* )
*/
public function __invoke(Book $data): Book
public function __invoke(Book $book): Book
{
$this->bookPublishingHandler->handle($data);
$this->bookPublishingHandler->handle($book);

return $data;
return $book;
}
}
```
Expand All @@ -412,9 +415,9 @@ use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class BookController extends AbstractController
{
public function createPublication(Book $data, BookPublishingHandler $bookPublishingHandler): Book
public function createPublication(Book $book, BookPublishingHandler $bookPublishingHandler): Book
{
return $bookPublishingHandler->handle($data);
return $bookPublishingHandler->handle($book);
}
}
```
Expand Down
10 changes: 5 additions & 5 deletions core/operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,11 +432,11 @@ class CreateBookPublication
],
methods: ['POST'],
)]
public function __invoke(Book $data): Book
public function __invoke(Book $book): Book
{
$this->bookPublishingHandler->handle($data);
$this->bookPublishingHandler->handle($book);

return $data;
return $book;
}
}
```
Expand All @@ -458,9 +458,9 @@ use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class BookController extends AbstractController
{
public function createPublication(Book $data, BookPublishingHandler $bookPublishingHandler): Book
public function createPublication(Book $book, BookPublishingHandler $bookPublishingHandler): Book
{
return $bookPublishingHandler->handle($data);
return $bookPublishingHandler->handle($book);
}
}
```
Expand Down