-
Notifications
You must be signed in to change notification settings - Fork 156
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.
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
[Adr] Kernel events vs controllers #500
Open
loic425
wants to merge
2
commits into
Sylius:1.10
Choose a base branch
from
loic425:adr/kernel-events
base: 1.10
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
/adr export-ignore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# Kernel events | ||
|
||
* Status: new | ||
* Deciders: @lchrusciel, @loic425, @Zales0123 | ||
* External advices: @soyuka, @dunglas, @mtarld | ||
|
||
## Context and Problem Statement | ||
|
||
ResourceController has all the actions, a lot of pretty similar code on each action and hard to maintain/test. | ||
and it is not flexible enough in its behavior. | ||
|
||
## Considered Options | ||
|
||
* Use Kernel events | ||
* Use one controller per action | ||
|
||
## PreWriteListener | ||
|
||
### With kernel events | ||
|
||
```php | ||
$resourceEvent = $this->eventDispatcher->dispatchPreEvent($operation->getName(), $configuration, $controllerResult); | ||
$request->attributes->set('resource_event', $resourceEvent); | ||
|
||
if (!$resourceEvent->isStopped()) { | ||
return; | ||
} | ||
|
||
if (null !== $resourceEventResponse = $resourceEvent->getResponse()) { | ||
$event->setControllerResult($resourceEventResponse); | ||
|
||
return; | ||
} | ||
|
||
if ($operation instanceof CreateOperationInterface) { | ||
$event->setControllerResult($this->redirectHandler->redirectToIndex($configuration, $controllerResult)); | ||
|
||
return; | ||
} | ||
|
||
$event->setControllerResult($this->redirectHandler->redirectToResource($configuration, $controllerResult)); | ||
``` | ||
|
||
Moreover, it allows to use a custom controller free of dependencies injection. | ||
|
||
```php | ||
#[Resource(alias: 'app.book')] | ||
#[Create( | ||
factory: false, // to disable resource factory | ||
controller: CreateBookAction::class, | ||
template: 'book/create.html.twig', | ||
)] | ||
class Book implements ResourceInterface | ||
``` | ||
|
||
```php | ||
class CreateBookAction | ||
{ | ||
public function __invoke(#[CurrentUser] $user): Book | ||
{ | ||
return (new Book())->setCreatedBy($user); | ||
} | ||
} | ||
``` | ||
|
||
For end-user, he could also disable the existing listeners and build its own way to implement it. | ||
|
||
### With controllers | ||
|
||
With controllers, to have a quick look for all these little differences, we have to create a new service with this code and it creates another service injected in our controller. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.