Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.3k
added documentation for the dispatchable console application#2352
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
fabpot commentedMar 24, 2013
| Q | A |
|---|---|
| Doc fix? | yes |
| New docs? | yes (symfony/symfony#7466) |
| Applies to | master |
| Fixed tickets | n/a |
components/console/events.rst Outdated
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.
should it beConsoleEvents::COMMAND rather than the value ? (same goes for the code)
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.
fixed in the code
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.
Should it be only in the code ?console.code is an implementation detail that should not be exposed to end user I think.
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.
If it were just me, I would remove the constants altogether. I've followed what was done in the docs for HttpKernel.
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.
I think they're nice because:
- they allow autocompletion,
- magic values are bad (as seen on several other PRs)
Anyway, the current documentation is a bad compromise. If I were you I would pick one or the other way, not a weird mix.
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.
And of course a typo in a constant name would produce an error while a typo in a magic value would cause a sometime hard to debug issue.
This PR was merged into the master branch.Discussion----------Console dispatcher| Q | A| ------------- | ---| Bug fix? | no| New feature? | yes| BC breaks? | no| Deprecations? | no| Tests pass? | yes| Fixed tickets |#3889,#6124| License | MIT| Doc PR |symfony/symfony-docs#2352refs#1884,#1929This is an alternative implementation for adding events to console applications.This implementation has the following features:* Available for anyone using the Console component and it is not tied to FrameworkBundle (this is important as one thing we are trying to solve is email sending from a command, and frameworks like Silex using the Console component needs a solution too);* Non-intrusive as the current code has not been changed (except for renaming an internal variable that was wrongly named -- so that's not strictly needed for this PR)* The new DispatchableApplication class also works without a dispatcher, falling back to the regular behavior. That makes easy to create applications that can benefit from a dispatcher when available, but can still work otherwise.* Besides the *before* and *after* events, there is also an *exception* event that is dispatched whenever an exception is thrown.* Each event is quite powerful and can manipulate the input, the output, but also the command to be executed.Commits-------4f9a55a refactored the implementation of how a console application can handle events4edf29d added helperSet to console event objectsf224102 Added events for CLI commands
This PR was merged into the master branch.Discussion----------Console dispatcher| Q | A| ------------- | ---| Bug fix? | no| New feature? | yes| BC breaks? | no| Deprecations? | no| Tests pass? | yes| Fixed tickets | #3889, #6124| License | MIT| Doc PR |symfony/symfony-docs#2352refs #1884, #1929This is an alternative implementation for adding events to console applications.This implementation has the following features:* Available for anyone using the Console component and it is not tied to FrameworkBundle (this is important as one thing we are trying to solve is email sending from a command, and frameworks like Silex using the Console component needs a solution too);* Non-intrusive as the current code has not been changed (except for renaming an internal variable that was wrongly named -- so that's not strictly needed for this PR)* The new DispatchableApplication class also works without a dispatcher, falling back to the regular behavior. That makes easy to create applications that can benefit from a dispatcher when available, but can still work otherwise.* Besides the *before* and *after* events, there is also an *exception* event that is dispatched whenever an exception is thrown.* Each event is quite powerful and can manipulate the input, the output, but also the command to be executed.Commits-------4f9a55a refactored the implementation of how a console application can handle events4edf29d added helperSet to console event objectsf224102 Added events for CLI commands
wouterj commentedMar 25, 2013
@weaverryan this is ready for merging as the code is merged |
fabpot commentedMar 26, 2013
I've just changed all event name to use constants. Mergeable now. |
added documentation for the dispatchable console application
weaverryan commentedMar 30, 2013
Great new feature and well-explained! |