[FrameworkBundle] add class description to debug:container command #28117
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
713ec47 to
8f848e4
Compare
There was a problem hiding this comment.
Could be a good idea :)
Somehow related to #26142, ping @weaverryan
| @@ -11,6 +11,9 @@ | |||
|
|
|||
| namespace Symfony\Bundle\FrameworkBundle\Console\Descriptor; | |||
|
|
|||
| use phpDocumentor\Reflection\DocBlockFactory; | |||
| use ReflectionClass; | |||
| use ReflectionException; | |||
There was a problem hiding this comment.
we don't "use" root classes: they should prefixed with \ instead.
src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php
Outdated
Show resolved
Hide resolved
src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php
Outdated
Show resolved
Hide resolved
0ab9f2c to
ff14d22
Compare
ff14d22 to
3c334af
Compare
ro0NL
reviewed
Aug 8, 2018
src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php
Outdated
Show resolved
Hide resolved
| $classDescription = DocBlockFactory::createInstance()->create($reflectionProperty->getDocComment())->getSummary(); | ||
|
|
||
| if (!empty($classDescription)) { | ||
| $output = '- Description: `'.$classDescription.'`'."\n"; |
There was a problem hiding this comment.
i would put the description after the class entry, given it acts as a title sort of;
- Class: ShortValue
- Description: Much longer value ....
There was a problem hiding this comment.
Did not agree. I think the description is higher than class. The values are not sorted by alpha. I think they are sorted by prio.
...
$output .= '- Class: `'.$definition->getClass().'`'
."\n".'- Public: '.($definition->isPublic() && !$definition->isPrivate() ? 'yes' : 'no')
."\n".'- Synthetic: '.($definition->isSynthetic() ? 'yes' : 'no')
."\n".'- Lazy: '.($definition->isLazy() ? 'yes' : 'no')
."\n".'- Shared: '.($definition->isShared() ? 'yes' : 'no')
."\n".'- Abstract: '.($definition->isAbstract() ? 'yes' : 'no')
."\n".'- Autowired: '.($definition->isAutowired() ? 'yes' : 'no')
."\n".'- Autoconfigured: '.($definition->isAutoconfigured() ? 'yes' : 'no')
...
6c4966d to
7003c2e
Compare
|
@nicolas-grekas @ro0NL can you please re-review the PR. |
ro0NL
reviewed
Aug 23, 2018
| */ | ||
| protected function getClassDescription($class) | ||
| { | ||
| if (!interface_exists('phpDocumentor\Reflection\DocBlockFactoryInterface')) { |
There was a problem hiding this comment.
this can be DocBlockFactoryInterface::class with a use
|
This is a really interesting idea - using the phpdoc as the service description. What if a class extends some base class? Like, the actual class is a Debug wrapper, and the real description is on the parent? |
7003c2e to
ad50827
Compare
ad50827 to
5fc6155
Compare
fabpot
approved these changes
Sep 4, 2018
|
Thank you @gimler. |
fabpot
added a commit
that referenced
this pull request
Sep 4, 2018
…iner command (gimler) This PR was merged into the 4.2-dev branch. Discussion ---------- [FrameworkBundle] add class description to debug:container command | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | License | MIT | Doc PR | symfony/symfony-docs#... <!-- required for new features --> Our developer finds it useful when the `console debug:container <service>` command print out the class description.  * [x] json * [x] txt * [x] xml * [x] md Commits ------- 5fc6155 [FrameworkBundle] add class description to debug:container command
This was referenced Nov 3, 2018
Closed
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our developer finds it useful when the
console debug:container <service>command print out the class description.