Add the missing output variable

[harikt]

Q	A
Doc fix?	[yes]
New docs?	[no]
Applies to	[2.5, 2.6]
Fixed tickets	[NIL]

For the 2.3 branch there is no table.rst file as it is introduced in 2.5 .

I have checkout from 2.5 and created the PR .

Let me know if I need to send this to master for 2.5 is not LTS .

[xabbuh]

I would move this before the existing use statement.

[harikt]

@xabbuh not sure I understood you. What is the benefit ?

[xabbuh]

sorry for the confusion, it's right the way it is

[xabbuh]

@harikt Thanks for your pull request. 2.5 was exactly the right target branch as Symfony 2.5 is maintained until the end of this month.

[wouterj]

I'm -1 for this change honestly. This code demostrates the table helper. That means you'll always use it in one of the execute/interact/... methods of the Command, which means you'll have access to the $output parameter of those methods.

What's missing instead imo is a simple // ..., which will indicate that something is missing (the class + method). I'm afraid that the current code block would confuse people and makes people instantiating their own $output instead of using the parameter one.

[harikt]

@wouterj for you as an experienced symfonian it will be easy and may not find value in it. But if you ask from someone you may get some feedback :) .

[wouterj]

@harikt I'm aware that this can be confusing. What about adding the method and class definitions?

  use Symfony\Component\Console\Helper\Table;
+ // ...
+
+ class BookCommand extends Command
+ {
+     public function execute(InputInterface $input, OutputInterface $output)
+     {
- $table = new Table($output);
+         $table = new Table($output);
// ... the rest of the code
+     }
+ }

[harikt]

@wouterj when you can run without the command I wonder why you need to show like that. What is the advantage you are seeing ?

[wouterj]

@harikt the complete Symfony Console component is designed the way that you use this logic inside Command#execute or Command#interact. This is the official way we document, how would you use this helper?

[weaverryan]

Hi @harikt!

I actually agree with @wouterj - the "normal" use for this is inside the execute(InputInterface $input, OutputInterface $output) {} of a command, so the $output you're using is passed to you as an argument. However, you do technically bring up a valid usage - you could just use the Table class inside a flat PHP script (not inside a Console component *Command class) and create a ConsoleOutput to render things. Was this your use-case?

If it is, it's not the main usage, so if we show the creation of the ConsoleOutput being done, that will actually be incorrect for most users. I wonder if @wouterj's suggested change above would help - at least for more advanced use-cases, you'd realize that you are not in a Command and may need to create an Output manually.

Thanks!

[harikt]

I am ok with the comments #4812 (comment)

[xabbuh]

@harikt Cool, will you be able to make those changes? I think once that's done, the PR is ready to be merged.

[wouterj]

Hi @harikt! There is a doc sprint day tomorrow. I would like to have this PR finished at the end of tomorrow, can you work on it or should we put it on the list so someone else can finish it?

[harikt]

Hey @wouterj ,

You can assign this to someone else. My internet is broken and have very limited access. Else I wished I could. Also got busy with family and things :( .

Enjoy the sprint.

[harikt]

Hey @xabbuh , @wouterj ,

if no one has taken this. I will look into this in the weekend. ( tomorrow / day after tomorrow ) . How about that ?

[harikt]

I also noticed one thing . From the https://symfony.com/components there is no link to Validation docs. Why is it not added? Is there any other tickets already ?

[xabbuh]

@harikt This sounds good.

From the https://symfony.com/components there is no link to Validation docs. Why is it not added? Is there any other tickets already ?

They don't exist yet (see #958).

[harikt]

@xabbuh I forgot to ask a question. To which branch it should go ?

[harikt]

I send a PR to 2.7 as

@xabbuh as already mentioned the time frame

Thanks for your pull request. 2.5 was exactly the right target branch as Symfony 2.5 is maintained until the end of this month.

[wouterj]

Thanksfor your PR, @harikt! I'm going to close this one, as it's replaced by your new one.