10000 [Form] Add support for displaying nested options in `DebugCommand` by yceruto · Pull Request #59871 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Form] Add support for displaying nested options in DebugCommand #59871

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 1, 2025
Merged

[Form] Add support for displaying nested options in DebugCommand #59871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/Symfony/Component/Form/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
CHANGELOG
=========

7.3
---

* Add support for displaying nested options in DebugCommand

7.2
---

Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/Form/Console/Descriptor/Descriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ protected function getOptionDefinition(OptionsResolver $optionsResolver, string
'allowedValues' => 'getAllowedValues',
'normalizers' => 'getNormalizers',
'deprecation' => 'getDeprecation',
'nestedOptions' => 'getNestedOptions',
];

foreach ($map as $key => $method) {
Expand Down
18 changes: 17 additions & 1 deletion src/Symfony/Component/Form/Console/Descriptor/JsonDescriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@ protected function describeResolvedFormType(ResolvedFormTypeInterface $resolvedF
}

protected function describeOption(OptionsResolver $optionsResolver, array $options): void
{
$data = $this->getOptionDescription($optionsResolver, $options);
$this->writeData($data, $options);
}

private function getOptionDescription(OptionsResolver $optionsResolver, array $options): array
{
$definition = $this->getOptionDefinition($optionsResolver, $options['option']);

Expand Down Expand Up @@ -90,7 +96,17 @@ protected function describeOption(OptionsResolver $optionsResolver, array $optio
}
$data['has_normalizer'] = isset($definition['normalizers']);

$this->writeData($data, $options);
if ($data['has_nested_options'] = isset($definition['nestedOptions'])) {
$nestedResolver = new OptionsResolver();
foreach ($definition['nestedOptions'] as $nestedOption) {
$nestedOption($nestedResolver, $optionsResolver);
}
foreach ($nestedResolver->getDefinedOptions() as $option) {
$data['nested_options'][$option] = $this->getOptionDescription($nestedResolver, ['option' => $option]);
}
}

return $data;
}

private function writeData(array $data, array $options): void
Expand Down
7 changes: 7 additions & 0 deletions src/Symfony/Component/Form/Console/Descriptor/TextDescriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,12 +118,19 @@ protected function describeOption(OptionsResolver $optionsResolver, array $optio
'Allowed types' => 'allowedTypes',
'Allowed values' => 'allowedValues',
'Normalizers' => 'normalizers',
'Nested Options' => 'nestedOptions',
];
$rows = [];
foreach ($map as $label => $name) {
$value = \array_key_exists($name, $definition) ? $dump($definition[$name]) : '-';
if ('default' === $name && isset($definition['lazy'])) {
$value = "Value: $value\n\nClosure(s): ".$dump($definition['lazy']);
} elseif ('nestedOptions' === $name && isset($definition['nestedOptions'])) {
$nestedResolver = new OptionsResolver();
foreach ($definition['nestedOptions'] as $nestedOption) {
$nestedOption($nestedResolver, $optionsResolver);
}
$value = $dump($nestedResolver->getDefinedOptions());
}

$rows[] = ["<info>$label</info>", $value];
Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Component/Form/Tests/Command/DebugCommandTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,8 @@ class:%s
} %s
] %s
---------------- -----------%s
Nested Options - %s
---------------- -----------%s

TXT
, $tester->getDisplay(true));
Expand Down
9 changes: 9 additions & 0 deletions src/Symfony/Component/Form/Tests/Console/Descriptor/AbstractDescriptorTestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,11 @@ public static function getDescribeOptionTestData()
$options['option'] = 'bar';
$options['show_deprecated'] = true;
yield [$resolvedType->getOptionsResolver(), $options, 'deprecated_option'];

$resolvedType = new ResolvedFormType(new FooType(), [], $parent);
$options['type'] = $resolvedType->getInnerType();
$options['option'] = 'baz';
yield [$resolvedType->getOptionsResolver(), $options, 'nested_option'];
}

abstract protected function getDescriptor();
Expand Down Expand Up @@ -172,5 +177,9 @@ public function configureOptions(OptionsResolver $resolver): void
$resolver->setAllowedTypes('foo', 'string');
$resolver->setAllowedValues('foo', ['bar', 'baz']);
$resolver->setNormalizer('foo', fn (Options $options, $value) => (string) $value);
$resolver->setOptions('baz', function (OptionsResolver $baz) {
$baz->setRequired('foo');
$baz->setDefaults(['foo' => true, 'bar' => true]);
});
}
}
3 cha A93C nges: 2 additions & 1 deletion src/Symfony/Component/Form/Tests/Fixtures/Descriptor/default_option_with_normalizer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@
"bool",
"string"
],
"has_normalizer": true
"has_normalizer": true,
"has_nested_options": false
}
2 changes: 2 additions & 0 deletions src/Symfony/Component/Form/Tests/Fixtures/Descriptor/default_option_with_normalizer.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,6 @@ Symfony\Component\Form\Extension\Core\Type\ChoiceType (choice_translation_domain
} %s
] %s
---------------- -----------%s
Nested Options - %s
---------------- -----------%s

3 changes: 2 additions & 1 deletion src/Symfony/Component/Form/Tests/Fixtures/Descriptor/deprecated_option.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
"deprecated": true,
"deprecation_message": "The option \"bar\" is deprecated.",
"required": false,
"has_normalizer": false
"has_normalizer": false,
"has_nested_options": false
}
4 changes: 3 additions & 1 deletion src/Symfony/Component/Form/Tests/Fixtures/Descriptor/deprecated_option.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,6 @@ Symfony\Component\Form\Tests\Console\Descriptor\FooType (bar)
Allowed values -
--------------------- -----------------------------------
Normalizers -
--------------------- -----------------------------------
--------------------- -----------------------------------
Nested Options -
--------------------- -----------------------------------
23 changes: 23 additions & 0 deletions src/Symfony/Component/Form/Tests/Fixtures/Descriptor/nested_option.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"required": false,
"default": [],
"is_lazy": false,
"has_normalizer": false,
"has_nested_options": true,
"nested_options": {
"foo": {
"required": true,
"default": true,
"is_lazy": false,
"has_normalizer": false,
"has_nested_options": false
},
"bar": {
"required": false,
"default": true,
"is_lazy": false,
"has_normalizer": false,
"has_nested_options": false
}
}
}
21 changes: 21 additions & 0 deletions src/Symfony/Component/Form/Tests/Fixtures/Descriptor/nested_option.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Symfony\Component\Form\Tests\Console\Descriptor\FooType (baz)
=============================================================

---------------- ----------
Info -
---------------- ----------
Required false
---------------- ----------
Default []
---------------- ----------
Allowed types -
---------------- ----------
Allowed values -
---------------- ----------
Normalizers -
---------------- ----------
Nested Options [
"foo",
"bar"
]
---------------- ----------
3 changes: 2 additions & 1 deletion ...ony/Component/Form/Tests/Fixtures/Descriptor/overridden_option_with_default_closures.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
"required": false,
"default": null,
"is_lazy": true,
"has_normalizer": false
"has_normalizer": false,
"has_nested_options": false
}
4 changes: 3 additions & 1 deletion ...fony/Component/Form/Tests/Fixtures/Descriptor/overridden_option_with_default_closures.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Symfony\Component\Form\Tests\Console\Descriptor\FooType (empty_data)
---------------- ----------------------%s
Allowed values - %s
---------------- ----------------------%s
Normalizers - %s
Normalizers - %s
---------------- ----------------------%s
Nested Options - %s
---------------- ----------------------%s

3 changes: 2 additions & 1 deletion ...Symfony/Component/Form/Tests/Fixtures/Descriptor/required_option_with_allowed_values.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@
"bar",
"baz"
],
"has_normalizer": true
"has_normalizer": true,
"has_nested_options": false
}
3 changes: 2 additions & 1 deletion src/Symfony/Component/Form/Tests/Fixtures/Descriptor/required_option_with_allowed_values.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,5 @@ Symfony\Component\Form\Tests\Console\Descriptor\FooType (foo)
} %s
] %s
---------------- -----------%s

Nested Options - %s
---------------- -----------%s
2 changes: 1 addition & 1 deletion src/Symfony/Component/Form/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"php": ">=8.2",
"symfony/deprecation-contracts": "^2.5|^3",
"symfony/event-dispatcher": "^6.4|^7.0",
"symfony/options-resolver": "^6.4|^7.0",
"symfony/options-resolver": "^7.3",
"symfony/polyfill-ctype": "~1.8",
"symfony/polyfill-intl-icu": "^1.21",
"symfony/polyfill-mbstring": "~1.0",
Expand Down
Loading
0