adding table for controller as a service #5033

dbu · 2015-02-20T15:32:52Z

Q	A
Doc fix?	no
New docs?	yes
Applies to	all
Fixed tickets	-

an old thing from my todo list. talked with @beberlei about this at some point. he had a couple of interesting blog posts about this topic but i can't find it anymore. and afaik the symfony doc does not want this kind of external links anyways.

dbu · 2015-02-20T15:33:41Z

cookbook/controller/service.rst

+``forward``                 ``http_kernel``                    ``$httpKernel->forward($controller, $path, $query)``
+``generateUrl``             ``router``                         ``$router->generate($route, $params, $absolute)``
+``getDoctrine``             ``doctrine``
+``getRequest``              -                                  Use ``Request $request`` as parameter in your action method. The order of the parameters is not important, but the typehint must be there.


ugh. is there a way to better format tables in rst?

This syntax (which allows multiline too):

+---------+---------+-----+ | Column1 | Column2 | ... | +=========+=========+=====+ | Value 1 | multi- | ... | | | line 1 | | +---------+---------+-----+ | Value 2 | Value 2 | ... | +---------+---------+-----+ | ... | ... | ... | +---------+---------+-----+

The simple table syntax allows to wrap long lines in several shorter lines: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#simple-tables

let's remove this row btw, as getRequest is deprecated

@wouterj one of these days we should standardize the table syntax to use in the documentation. Hopefully, we'll never recommend to use the rigid grid syntax ;)

wouterj · 2015-02-20T15:38:45Z

I like this one :)

dbu · 2015-02-20T15:50:09Z

cookbook/controller/service.rst

+
+    ``getRequest`` has been deprecated. Instead, have an argument to your
+    controller action method called ``Request $request``. The order of the
+    parameters is not important, but the typehint must be provided.


converted this to a separate tip. i think it does not hurt to mention this here again. the whole doc segment is for people afraid to look at the controller source code.

dbu · 2015-02-20T15:50:39Z

should we mention the table in the introduction of the cookbook article?

stof · 2015-02-20T17:43:56Z

cookbook/controller/service.rst

+-----------------------------+------------------------------------+----------------------------------------------------------------+
+| Method                      | Service                            |  PHP Code                                                      |
+=============================+====================================+================================================================+
+| ``createForm``              | ``form.factory``                   | ``$formFactory->create($type, $data, $options)``               |


this is wrong. You are missing the ->getForm() call in the equivalent code

there is no `getForm()` here: https://github.com/symfony/symfony/blob/2.3/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php#L164

dbu · 2015-02-20T18:36:29Z

cookbook/controller/service.rst

+|                             |                      | $token = $securityContext->getToken();                          |
+|                             |                      | if (null !== $token && is_object($token->getUser())) {          |
+|                             |                      | $user = $token->getUser();                                      |
+|                             |                      | }                                                               |


this renders quite badly (all code lines floating) but i found no way how to include multiline source code in a table cell... ideas? btw, the indention is missing on purpose as otherwise we get a compile error.

Tables are a hell in Sphinx to get things like this working nicely. I don't know of a nice solution other than not using table...

I would suggest to use a definition list instead:

:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::createForm` (service: ``form.factory``) .. code-block:: php $formFactory->create($type, $data, $options);

and so on

dbu · 2015-02-21T15:28:08Z

thanks @xabbuh , switched to definition list. the rendering looks ok to me.

timglabisch · 2015-02-21T16:59:02Z

awesome PR 👍

xabbuh · 2015-02-23T10:10:30Z

cookbook/controller/service.rst

+:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::createNotFoundException`
+    .. code-block:: php
+
+        throw new NotFoundHttpException($message, $previous);


This is not exactly the same. The Controller class doesn't throw the exception.

oh, indeed. what a weird method anyways. will fix

dbu · 2015-02-23T12:37:28Z

fixed the comments. and thanks @timglabisch! credit goes to @sixty-nine, he started this ages ago and i said i would do a PR with it, but never got around to do it until now.

Pierstoval · 2015-03-08T14:26:36Z

cookbook/controller/service.rst

+
+        $templating->renderResponse($view, $parameters, $response);
+
+:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::renderViev` (service: ``templating``)


Typo : maybe change to renderView :)

dbu · 2015-03-09T07:14:54Z

thanks @Pierstoval , updated the things you noted.

xabbuh · 2015-03-09T19:10:50Z

Thanks @dbu! This looks really good to me.

@beberlei

This PR was merged into the 2.3 branch. Discussion ---------- adding table for controller as a service | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | all | Fixed tickets | - an old thing from my todo list. talked with @beberlei about this at some point. he had a couple of interesting blog posts about this topic but i can't find it anymore. and afaik the symfony doc does not want this kind of external links anyways. Commits ------- b17f422 use definition list instead of table 8e82db4 adding table for controller as a service

When I merge to 2.6, I'll properly change the service ids and variable names

* 2.3: [#5033] Tweaking variable name to "match" the service id [#5017] Minor language tweaks use definition list instead of table adding table for controller as a service Suggested ConEmu in addition to ANSICON to solve the Windows coloring limitation Minor rewording Reworded the note about Windows console and output coloring Update routing.rst Minor rewording add a note about apc for php recent versions Removed a wrong link to a included file Rewording Minor rewording Fixed an internal link Added a note about data transformers not being applied with inherit_data option set Added a commented config useful when you use symlinks Minor rewording Added a note about the class option of the services defined via factories Added a note about the server_version DBAL option Conflicts: components/dependency_injection/factories.rst

weaverryan · 2015-03-14T18:06:57Z

I think this is really cool! Even if you don't make your controllers into services, I love showing "the magic behind the scenes" to newer devs. So, thank you very much @dbu!

I updated the security service names at sha: 2035d62

* 2.6: (91 commits) [#5064] Minor language tweaks Fixing bad merge conflict (forgot to save!) Remove unnecessary component reference Correct RegisterListenersPass namespace Fix service id Switched the first example to a static constructor method added some more components for Tobion as a merger Fixed variable name in : Reference -> validation constraints -> count -> basic usage -> PHP [#5036] Typo fix (probably mine originally) caught by xabbuh reword to serves Adding a link to define "lts" Better wording Minor improvement for symfony-installer with LTS Updating for new security service names in 2.6 [#5033] Tweaking variable name to "match" the service id [#5017] Minor language tweaks [#5015] Updating the security service name for 2.6 - thanks to Cordoval [#5015] Very small tweak [#5011] Adding one more fix I missed [#5011] Fixing minor build issue ... Conflicts: book/security.rst

* 2.7: (103 commits) Backporting some stuff from 2.7, that I think must have gotten merged only there by accident [#5064] Minor language tweaks Fixing bad merge conflict (forgot to save!) Remove unnecessary component reference Correct RegisterListenersPass namespace Fix service id Switched the first example to a static constructor method added some more components for Tobion as a merger Fixed variable name in : Reference -> validation constraints -> count -> basic usage -> PHP [#5036] Typo fix (probably mine originally) caught by xabbuh reword to serves Adding a link to define "lts" Better wording Minor improvement for symfony-installer with LTS Updating for new security service names in 2.6 [#5033] Tweaking variable name to "match" the service id [#5017] Minor language tweaks [#5015] Updating the security service name for 2.6 - thanks to Cordoval [#5015] Very small tweak [#5011] Adding one more fix I missed ...

dbu reviewed Feb 20, 2015
View reviewed changes

stof reviewed Feb 20, 2015
View reviewed changes

adding table for controller as a service

8e82db4

dbu reviewed Feb 20, 2015
View reviewed changes

xabbuh reviewed Feb 23, 2015
View reviewed changes

xabbuh added the Status: Needs Work label Feb 23, 2015

Pierstoval reviewed Mar 8, 2015
View reviewed changes

use definition list instead of table

b17f422

xabbuh added Status: Reviewed and removed Status: Needs Work labels Mar 9, 2015

weaverryan merged commit b17f422 into symfony:2.3 Mar 14, 2015

weaverryan added a commit that referenced this pull request Mar 14, 2015

[#5033] Tweaking variable name to "match" the service id

42c9f53

When I merge to 2.6, I'll properly change the service ids and variable names

dbu deleted the controller-service branch October 18, 2018 17:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adding table for controller as a service #5033

adding table for controller as a service #5033

dbu commented Feb 20, 2015

dbu Feb 20, 2015

wouterj Feb 20, 2015

javiereguiluz Feb 20, 2015

wouterj Feb 20, 2015

javiereguiluz Feb 20, 2015

wouterj commented Feb 20, 2015

dbu Feb 20, 2015

GromNaN Mar 8, 2015

dbu commented Feb 20, 2015

stof Feb 20, 2015

dbu Feb 20, 2015 via email

dbu Feb 20, 2015

wouterj Feb 21, 2015

xabbuh Feb 21, 2015

dbu commented Feb 21, 2015

timglabisch commented Feb 21, 2015

xabbuh Feb 23, 2015

dbu Feb 23, 2015

dbu commented Feb 23, 2015

Pierstoval Mar 8, 2015

dbu commented Mar 9, 2015

xabbuh commented Mar 9, 2015

weaverryan commented Mar 14, 2015


		$templating->renderResponse($view, $parameters, $response);

		:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::renderViev` (service: ``templating``)

adding table for controller as a service #5033

adding table for controller as a service #5033

Conversation

dbu commented Feb 20, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wouterj commented Feb 20, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dbu commented Feb 20, 2015

Choose a reason for hiding this comment

dbu Feb 20, 2015 via email

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dbu commented Feb 21, 2015

timglabisch commented Feb 21, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dbu commented Feb 23, 2015

Choose a reason for hiding this comment

dbu commented Mar 9, 2015

xabbuh commented Mar 9, 2015

weaverryan commented Mar 14, 2015