Symfony-docs: Add docs for the Firewall Config class

Created on 25 Nov 2016  路  4Comments  路  Source: symfony/symfony-docs

https://github.com/symfony/symfony/pull/19398 introduced a FirewallConfig class accessible from FirewallContext. Should we document it or at leas mention it?

Security hasPR

Most helpful comment

@ogizanagi is right about that use cases are limited but I would say it's still good to have in the documentation because of the considerable number of existing support questions and issues for which a small mention about this feature would have been useful:

Even if it's just about documenting what is actually possible to do on this subject so it would be clear what is not, and give the right way to do (especially since using the security token providerKey is neither always available nor always accurate).

Maybe we could start by adding a small mention in the bundle documentation and make it grows as we improve the feature (I feel it could be useful to add some more informations about the registered listeners for instance, but let's wait for concrete use cases).

If nobody pick it I can give it a try asap

All 4 comments

Use cases for accessing the firewall configs are probably too limited right now, so I don't think it worth documenting it. Your blog post is probably perfect and enough for mentioning this feature.

Plus, if more use cases are discovered, we may rework some parts (see https://github.com/symfony/symfony/pull/20591) which will expose a different entrypoint.

cc @chalasr

@ogizanagi is right about that use cases are limited but I would say it's still good to have in the documentation because of the considerable number of existing support questions and issues for which a small mention about this feature would have been useful:

Even if it's just about documenting what is actually possible to do on this subject so it would be clear what is not, and give the right way to do (especially since using the security token providerKey is neither always available nor always accurate).

Maybe we could start by adding a small mention in the bundle documentation and make it grows as we improve the feature (I feel it could be useful to add some more informations about the registered listeners for instance, but let's wait for concrete use cases).

If nobody pick it I can give it a try asap

@chalasr documenting this won't be easy for me. If you want to give a try, I can help you later polishing the docs if needed. Thanks!

Fixed by #9207.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

bobvandevijver picture bobvandevijver  路  4Comments

javiereguiluz picture javiereguiluz  路  3Comments

weaverryan picture weaverryan  路  3Comments

Kwadz picture Kwadz  路  3Comments

steevanb picture steevanb  路  4Comments