Cookbook about Command in Application with AnsiToHtml #5062

rvanlaak · 2015-03-06T11:20:02Z

Q	A
Doc fix?	no
New docs?	yes
Applies to	>= 2.3
Fixed tickets	symfony/symfony#11392

javiereguiluz · 2015-03-06T12:19:58Z

cookbook/console/command_in_controller.rst

+   single: Console; Use commands in your Controller
+
+How to make use of a Command in your application
+===============================


Minor syntax issue: this line should be as long as its associated headline.

javiereguiluz · 2015-03-06T12:31:18Z

@rvanlaak thanks for submitting this nice new cookbook!

rvanlaak · 2015-03-06T12:33:31Z

Was thinking about adding more information about the Theming and a code sample about the Twig extension, but seems like that is too much info for the cookbook article. What do you think @javiereguiluz ?

javiereguiluz · 2015-03-06T15:10:30Z

@rvanlaak I agree with you: it looks like too much information for this cookbook. I personally love short and straight-to-the-point cookbooks, so I really like your tutorial as it is now. Thanks.

rvanlaak · 2015-03-06T15:21:01Z

Another thing, where can I find new decisions the such as the one you mentioned about not using acme examples? Could not find anything on http://symfony.com/doc/current/contributing/documentation/index.html and probably such decisions are made in the Google Groups, but we can not follow that the entire day 👍

javiereguiluz · 2015-03-06T15:41:23Z

I don't really know where we decided this, because I talk with doc maintainers via email, IRC and GitHub :( In any case, the #4740 PR is the one which made the biggest recent change to remove acme, demo, foo and nonsenses like those.

I'm going to check if we can add something about this in the formal document that you linked. Thanks for your comments.

wouterj · 2015-03-06T18:01:20Z

@rvanlaak we don't use the Google Groups and you sure don't have to watch them in order to contribute something (these reviews are just to help you adding amazing content to the docs, it doesn't matter if your PR isn't 100% correct at first).

Decisions like this aren't really strict standards or decisions. As an important rule, it is always better using real-world examples than foobaring your examples. While being more clear, it also works as an advertisement for the framework ("wow, can I also create X with this?").

Since the best practices, we are updating the docs to follow them. One of the most important changes is to no longer recommend using multiple bundles, but just one bundle: AppBundle. We are still in the process of it, as it's a very hard task to do nicely.

xabbuh · 2015-03-07T15:50:29Z

cookbook/console/command_in_controller.rst

+.. index::
+   single: Console; Use commands in your Controller
+
+How to make use of a Command in your application


I think something like "How to Call a Command from a Controller" better matches the contents.

xabbuh · 2015-03-07T15:55:46Z

Thank you for creating the pull request, @rvanlaak. It's nice work. However, I think we should start the text with a short introduction to show use cases when you might want to call a command from a controller.

I was thinking about something like:

You may have the need to execute some function that is only available in a console command. Usually, you should refactor the command and move some logic into a service that can be reused in the controller. However, when the command is part of a third-party library, you wouldn't want to modify or duplicate their code, but want to directly execute the command instead.

What do you think?

rvanlaak · 2015-03-08T10:38:34Z

Agree with you @xabbuh , so I've updated the example to a real world use case, eg. sending the SwiftMailer spool directly from the controller. Let me know if it's fine now, so I can squash the commits into one.

xabbuh · 2015-03-08T10:44:14Z

cookbook/console/index.rst

@@ -6,6 +6,7 @@ Console

    console_command
    usage
+    command_in_controller


You need to also add a reference to the document in /cookbook/map.rst.inc.

xabbuh · 2015-03-10T14:56:00Z

cookbook/console/command_in_controller.rst

+instead. 
+
+An example of this is sending the emails that Swift Mailer spooled earlier
+:doc:`using the ``swiftmailer:spool:send`` command </cookbook/email/spool>`. Symfony 


Unfortunately, you cannot use literals here.

rvanlaak · 2015-03-12T08:30:55Z

Rebased the latest changes @javiereguiluz

javiereguiluz · 2015-03-12T08:49:21Z

@rvanlaak awesome! Thanks for working on this and for your infinite patience with our comments and suggestions.

@xabbuh this nice PR is now ready to be labeled as finished, don't you think?

rvanlaak · 2015-03-12T08:53:52Z

No problem, great way of getting known with the community guidelines 👍

xabbuh · 2015-03-12T17:45:49Z

cookbook/console/command_in_controller.rst

+
+The :doc:`Console component documentation </components/console/introduction>` covers
+how to create a console command. This cookbook article covers how to use a console command
+directly in your application. 


"[...] from a controller."?

this also works in any service? so i am fine with this statement.

the article is calld "from a controller". So I think we should change this.

rvanlaak · 2015-04-09T09:29:02Z

Fixed the outstanding issues. Let me know if the commits are ready for a rebase 👍

wouterj · 2015-04-09T09:37:03Z

👍

xabbuh · 2015-04-12T08:00:36Z

👍 Great work @rvanlaak!

rvanlaak · 2015-04-13T10:13:56Z

Completed the rebase, squased all commits into rvanlaak@62ae7c3

cordoval · 2015-04-13T12:00:04Z

cookbook/console/command_in_controller.rst

+            $content = stream_get_contents($output->getStream());
+            fclose($output->getStream());
+
+            return $content;


i think this is wrong no? why are you not returning a valid HttpResponse instead?

rvanlaak · 2015-05-05T09:49:26Z

@xabbuh anything I've got to change for this PR?

xabbuh · 2015-05-06T06:57:35Z

cookbook/console/command_in_controller.rst

+    use Symfony\Component\Console\Input\ArrayInput;
+    use Symfony\Component\Console\Output\StreamOutput;
+
+    class SpoolController extend Controller


xabbuh · 2015-05-06T06:58:49Z

@rvanlaak I left two minor comments. After that I think it's finished.

... and color coding Ansi output using SensioLabs AnsiToHtml Documentation about using Command in Controller ... and color coding Ansi output using SensioLabs AnsiToHtml Line syntax Change component link Update command_in_controller.rst with real world example about Swift Mailer. Update command_in_controller.rst Added command_in_controller to map.rst.inc Update map.rst.inc Documentation about using Command in Controller Update command_in_controller.rst Documentation about using Command in Controller Documentation about using Command in Controller Update command_in_controller.rst Update command_in_controller.rst Documentation about using Command in Controller

rvanlaak · 2015-05-06T07:06:21Z

@xabbuh nice pick, fixed and rebased it!

xabbuh · 2015-05-06T07:09:21Z

👍

…Rvanlaak) This PR was submitted for the 2.7 branch but it was merged into the 2.3 branch instead (closes #5062). Discussion ---------- Cookbook about Command in Application with AnsiToHtml | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | >= 2.3 | Fixed tickets | symfony/symfony#11392 Commits ------- 0799366 Documentation about using Command in Controller

weaverryan · 2015-05-23T16:11:11Z

Thanks so much @rvanlaak! This is exactly the small, targeted article that we love having. And welcome to the process and thanks for sticking with us through all the reviews.

I have now merged this into the 2.3 branch, and opened a new PR - #5299 - with a few further tweaks. If you can review that, it would be awesome.

Cheers!

This PR was merged into the 2.3 branch. Discussion ---------- Command controller tweaks to #5062 | Q | A | ------------- | --- | Doc fix? | yes #5062 | New docs? | no | Applies to | 2.3+ | Fixed tickets | #5062 Hi guys! This is a proofread and bug fix after merging #5062. Notably, I changed to use the `BufferedOutput` and returned a Response from the controller instead of the string. Please let me know if you see any errors - I was coding this right inside the docs 😇. Thanks! Commits ------- aad7277 Fixing things thanks to Wouter 59f8c95 Tweaks to the new using commands in a controller article

javiereguiluz reviewed Mar 6, 2015
View reviewed changes

xabbuh reviewed Mar 7, 2015
View reviewed changes

xabbuh added the Status: Needs Work label Mar 7, 2015

xabbuh reviewed Mar 8, 2015
View reviewed changes

rvanlaak force-pushed the 2.7 branch from 39af900 to d7722e8 Compare March 10, 2015 08:41

xabbuh reviewed Mar 10, 2015
View reviewed changes

rvanlaak force-pushed the 2.7 branch from 4090644 to cf5860f Compare March 12, 2015 08:29

xabbuh reviewed Mar 12, 2015
View reviewed changes

wouterj added Status: Reviewed and removed Status: Needs Work labels Apr 9, 2015

rvanlaak force-pushed the 2.7 branch from 7283d88 to 62ae7c3 Compare April 13, 2015 10:11

cordoval reviewed Apr 13, 2015
View reviewed changes

xabbuh added Status: Needs Work and removed Status: Reviewed labels Apr 13, 2015

xabbuh reviewed May 6, 2015
View reviewed changes

rvanlaak force-pushed the 2.7 branch from 62ae7c3 to 1f7acab Compare May 6, 2015 07:05

xabbuh added Status: Reviewed and removed Status: Needs Work labels May 6, 2015

weaverryan mentioned this pull request May 23, 2015

Command controller tweaks to #5062 #5299

Merged

weaverryan closed this May 23, 2015

wouterj removed the Status: Reviewed label May 31, 2015

rvanlaak deleted the 2.7 branch June 11, 2015 08:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cookbook about Command in Application with AnsiToHtml #5062

Cookbook about Command in Application with AnsiToHtml #5062

rvanlaak commented Mar 6, 2015

javiereguiluz Mar 6, 2015

javiereguiluz commented Mar 6, 2015

rvanlaak commented Mar 6, 2015

javiereguiluz commented Mar 6, 2015

rvanlaak commented Mar 6, 2015

javiereguiluz commented Mar 6, 2015

wouterj commented Mar 6, 2015

xabbuh Mar 7, 2015

xabbuh commented Mar 7, 2015

rvanlaak commented Mar 8, 2015

xabbuh Mar 8, 2015

rvanlaak Mar 8, 2015

xabbuh Mar 10, 2015

rvanlaak commented Mar 12, 2015

javiereguiluz commented Mar 12, 2015

rvanlaak commented Mar 12, 2015

xabbuh Mar 12, 2015

timglabisch Apr 8, 2015

wouterj Apr 9, 2015

rvanlaak commented Apr 9, 2015

wouterj commented Apr 9, 2015

xabbuh commented Apr 12, 2015

rvanlaak commented Apr 13, 2015

cordoval Apr 13, 2015

rvanlaak commented May 5, 2015

xabbuh May 6, 2015

xabbuh commented May 6, 2015

rvanlaak commented May 6, 2015

xabbuh commented May 6, 2015

weaverryan commented May 23, 2015

Cookbook about Command in Application with AnsiToHtml #5062

Cookbook about Command in Application with AnsiToHtml #5062

Conversation

rvanlaak commented Mar 6, 2015

Choose a reason for hiding this comment

javiereguiluz commented Mar 6, 2015

rvanlaak commented Mar 6, 2015

javiereguiluz commented Mar 6, 2015

rvanlaak commented Mar 6, 2015

javiereguiluz commented Mar 6, 2015

wouterj commented Mar 6, 2015

Choose a reason for hiding this comment

xabbuh commented Mar 7, 2015

rvanlaak commented Mar 8, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rvanlaak commented Mar 12, 2015

javiereguiluz commented Mar 12, 2015

rvanlaak commented Mar 12, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rvanlaak commented Apr 9, 2015

wouterj commented Apr 9, 2015

xabbuh commented Apr 12, 2015

rvanlaak commented Apr 13, 2015

Choose a reason for hiding this comment

rvanlaak commented May 5, 2015

Choose a reason for hiding this comment

xabbuh commented May 6, 2015

rvanlaak commented May 6, 2015

xabbuh commented May 6, 2015

weaverryan commented May 23, 2015