[WCM][Cookbook][Service container] Update event listener doc to document symfony/symfony#9941

[lemoinem]

Q	A
Doc fix?	no
New docs?	yes (symfony/symfony#9941)
Applies to	2.5+
Fixed tickets	N/A

[wouterj]

Event Dispatcher

[lemoinem]

Thank you all for your feedback. However since the Code Merge has been declined, I will close the doc PR too.

However, I pushed a new commit taking into account all your comments, and will leave the branch linger in my repo in case something similar or related ever get submitted.

Feel free to scavenge if ever needed.

[cordoval]

i think that is there is a concern, even you have to fight to adapt the PR or address the concern via documentation notes. Don't get discouraged. Encouragements 👶

[lemoinem]

@cordoval : Well, the point of @stof regarding the code merge is really from a conceptual point of view. I understand it and I don't have much arguments against it. I'm not discouraged, I simply understand that this particular feature might not have its own place in Symfony's core, everything doesn't... And I'm kind of over fighting for my PRs. 😉

On the other hand, If you think the current documentation could benefit from documenting the CompilerPass RegisterListenersPass, then I'd think this was not the right page to speak about it. A new Cookbook page in the EventDispatcher section seems much more appropriate.

[cordoval]

nice @lemoinem could you please do the RegisterListenersPass docu if it is not taken yet in the righteous proper ticket for it?

[lemoinem]

@cordoval Sure, as soon as I get some spare time to do so... After a quick research, I didn't see much (issue or PR) related to it in symfony-docs. So I'll create a new page and PR as soon as I have time to do so.

[cordoval]

you rock'n

[wouterj]

The docs about this are in reference/dic_tags. But we can add a small section in components/event_dispatcher/introduction saying that this class is also available by that component.

[lemoinem]

@wouterj: However, there is no mention of the compiler pass nor how it could be used to register listeners and subscribers on custom event dispatchers. That's what I wanted to focus on for this new page I mentioned. Do you think it would be worth it?

In much the same way, imho, the section "Core Event Listener Reference" feels like it deserves to be available on another page. I'd have never look for the list of default kernel event listeners in the Reference for DIC Tags... Perhaps something in "Configuring the Kernel" since that the goal of most of them?

[wouterj]

@lemoinem explaining how to use the CompilerPass in the EventDispatcher component docs means that we document something about the DependencyInjection component in the wrong component. Instead of that, you should just add a small piece of text in the intro saying that that compiler pass is available (as of 2.5) and link to the DI docs (components/dependency_injection/compiling iirc) on how to use the class.

And moving the core event listeners to "Configuring the Kernel" does not make sense imo. When you need to register an event listener, you go to that page and then you see usefull information. In any other case, there is no need to know the priorities of the core event listeners.

[lemoinem]

Ok, I'll go in this direction for a new PR then. Thanks @wouterj.

2014/1/6 Wouter J notifications@github.com

@lemoinem https://github.com/lemoinem explaining how to use the
CompilerPass in the EventDispatcher component docs means that we document
something about the DependencyInjection component in the wrong component.
Instead of that, you should just add a small piece of text in the intro
saying that that compiler pass is available (as of 2.5) and link to the DI
docs (components/dependency_injection/compiling iirc) on how to use the
class.

And moving the core event listeners to "Configuring the Kernel" does not
make sense imo. When you need to register an event listener, you go to that
page and then you see usefull information. In any other case, there is no
need to know the priorities of the core event listeners.

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/3425#issuecomment-31686966
.