Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Console] Note about semantic verbosity methods & OutputInterface #5123

Closed
apfelbox opened this issue Mar 30, 2015 · 4 comments
Closed

[Console] Note about semantic verbosity methods & OutputInterface #5123

apfelbox opened this issue Mar 30, 2015 · 4 comments
Labels
actionable Clear and specific issues ready for anyone to take them. Console good first issue Ideal for your first contribution! (some Symfony experience may be required) hasPR A Pull Request has already been submitted for this issue.

Comments

@apfelbox
Copy link
Contributor

Hi,

the part about the more semantic methods in The Console Component > Creating a basic Command > Verbosity Levels could include a small note:

The semantic methods (isQuiet, isVerbose, etc.) are only defined in the implementation class, not the interface. So if you typehint against the interface (as you should), your IDE will complain about missing methods.

Maybe a small note there would clear that up? Or is it not necessary? What do you think?

@javiereguiluz
Copy link
Member

@apfelbox thanks for opening this issue. I agree that this information could be useful ... but I have doubts whether this may be too much.

@apfelbox
Copy link
Contributor Author

@javiereguiluz thanks for your response.

I thought the same thing. On one hand, one should not cram all possible information into the docs, on the other hand this can be quite a puzzling experience. I just wanted to send in the hint about this possible issue, not sure on how to proceed here.

@ofbeaton
Copy link

ofbeaton commented May 5, 2015

I came here thinking the methods did not actually exist and the document was wrong. I did not realize phpstorm was type hinting this way. So it's definitely confusing and I thought I was doing something wrong.

@wouterj
Copy link
Member

wouterj commented May 11, 2015

Let's add a little sentence to this section: "For backwards compatibility, these methods do not exist in the interface until Symfony 3.0."

@wouterj wouterj added good first issue Ideal for your first contribution! (some Symfony experience may be required) actionable Clear and specific issues ready for anyone to take them. Console labels May 11, 2015
@wouterj wouterj added the hasPR A Pull Request has already been submitted for this issue. label Jun 27, 2015
weaverryan added a commit that referenced this issue Jul 15, 2015
…mantic methods (javiereguiluz)

This PR was submitted for the 2.7 branch but it was merged into the 2.6 branch instead (closes #5443).

Discussion
----------

Added a note about the implementation of the verbosity semantic methods

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes
| Applies to    | 2.6+
| Fixed tickets | #5123

Commits
-------

a88d1c6 Reworded a note about BC
28b98b9 Added a note about the implementation of the verbosity semantic methods
@wouterj wouterj closed this as completed Jul 29, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actionable Clear and specific issues ready for anyone to take them. Console good first issue Ideal for your first contribution! (some Symfony experience may be required) hasPR A Pull Request has already been submitted for this issue.
Projects
None yet
Development

No branches or pull requests

4 participants