Add a cookbook about dealing with multiple channels in console commands #14654
Conversation
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
jakubtobiasz
added
the
Documentation
jakubtobiasz
force-pushed
the
docs/channel-context-in-cli
branch
2 times, most recently
from
4dd96eb
to
0003ea0
Compare
TheMilek
approved these changes
Dec 22, 2022
coldic3
reviewed
Dec 22, 2022
jakubtobiasz
force-pushed
the
docs/channel-context-in-cli
branch
from
0003ea0
to
eccb7dd
Compare
coldic3
approved these changes
Dec 22, 2022
|
Thank you, Jakub! 🎉 |
Comment on lines
+105
to
+107
| Now, we can use our custom channel context in our console command. For proof of our concept we will create a DummyCommand, | ||
| which will take a channel code as an option and will dispatch a dummy event. This event is handled by an event subscriber using | ||
| the channel context to get the channel and print its name. |
There was a problem hiding this comment.
Suggested change
| Now, we can use our custom channel context in our console command. For proof of our concept we will create a DummyCommand, | |
| which will take a channel code as an option and will dispatch a dummy event. This event is handled by an event subscriber using | |
| the channel context to get the channel and print its name. | |
| For our example, we will create a DummyCommand which will take a channel code as an option | |
| and dispatch a dummy event. This event is handled by a subscriber using | |
| the channel context to print the channel's name. |
Comment on lines
+10
to
+11
| To accomplish this task, we have to create a custom channel context available only from the CLI context. But this concrete channel context cannot only return a channel, | ||
| but also has to allow to pass a channel code as an argument (which we will get from the console command). This way, we can use the channel context in our services. |
There was a problem hiding this comment.
Suggested change
| To accomplish this task, we have to create a custom channel context available only from the CLI context. But this concrete channel context cannot only return a channel, | |
| but also has to allow to pass a channel code as an argument (which we will get from the console command). This way, we can use the channel context in our services. | |
| We have to create a custom channel context available only from the CLI context. This channel context should allow setting a channel code (which we will do inside the console command). This way, we can use the channel context in our services. |
| 1. Custom Channel Context | ||
| ------------------------- | ||
|
|
||
| First, we need to create a custom channel context. Let's remind our requirements: |
There was a problem hiding this comment.
Suggested change
| First, we need to create a custom channel context. Let's remind our requirements: | |
| First, we need to create a channel context. Let's remind the requirements: |
Comment on lines
+167
to
+168
| Your channel name is: Magic Web Channel | ||
| /app $ bin/console app:dummy -c FASHION_WEB |
There was a problem hiding this comment.
Suggested change
| Your channel name is: Magic Web Channel | |
| /app $ bin/console app:dummy -c FASHION_WEB | |
| Your channel name is: Magic Web Channel | |
| /app $ bin/console app:dummy -c FASHION_WEB |
A bit more clarity
There was a problem hiding this comment.
But this is an exact output from console :D.
There was a problem hiding this comment.
I'd leave it as suggested, but you could also split it into 2 blocks, either way, it's easier to read.
Comment on lines
+152
to
+153
| // it isn't important what happens inside the event subscriber. | ||
| // It just gets channel from the channel context service |
There was a problem hiding this comment.
Suggested change
| // it isn't important what happens inside the event subscriber. | |
| // It just gets channel from the channel context service | |
| // The subscriber just gets a channel from the channel context |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If you need a context, read Łukasz's comment in #14549.
Preview:
