Skip to content

Commit 5eb4948

Browse files
Halleck45Halleck45
committed
Add new ComponentPropertiesExtractor to extract properties from TwigComponent
1 parent a471878 commit 5eb4948

File tree

6 files changed

+269
-81
lines changed

6 files changed

+269
-81
lines changed

‎src/TwigComponent/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# CHANGELOG
22

3+
## 2.23.0
4+
5+
- Add `ComponentPropertiesExtractor` to extract component properties from a Twig component
6+
37
## 2.20.0
48

59
- Add Anonymous Component support for 3rd-party bundles #2019

‎src/TwigComponent/src/Command/TwigComponentDebugCommand.php

+10-80
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,9 @@
2121
use Symfony\Component\Console\Output\OutputInterface;
2222
use Symfony\Component\Console\Style\SymfonyStyle;
2323
use Symfony\Component\Finder\Finder;
24-
use Symfony\UX\TwigComponent\Attribute\ExposeInTemplate;
2524
use Symfony\UX\TwigComponent\ComponentFactory;
2625
use Symfony\UX\TwigComponent\ComponentMetadata;
27-
use Symfony\UX\TwigComponent\Twig\PropsNode;
26+
use Symfony\UX\TwigComponent\ComponentPropertiesExtractor;
2827
use Twig\Environment;
2928
use Twig\Loader\FilesystemLoader;
3029

@@ -37,6 +36,7 @@ public function __construct(
3736
private string $twigTemplatesPath,
3837
private ComponentFactory $componentFactory,
3938
private Environment $twig,
39+
private readonly ComponentPropertiesExtractor $componentPropertiesExtractor,
4040
private readonly array $componentClassMap,
4141
?string $anonymousDirectory = null,
4242
) {
@@ -212,12 +212,18 @@ private function displayComponentDetails(SymfonyStyle $io, string $name): void
212212
['Template', $metadata->getTemplate()],
213213
]);
214214

215+
$properties = $this->componentPropertiesExtractor->getComponentProperties($metadata);
216+
$propertiesAsArrayOfStrings = array_filter(array_map(
217+
fn (array $property) => $property['display'],
218+
$properties,
219+
));
220+
215221
// Anonymous Component
216222
if ($metadata->isAnonymous()) {
217223
$table->addRows([
218224
['Type', '<comment>Anonymous</comment>'],
219225
new TableSeparator(),
220-
['Properties', implode("\n", $this->getAnonymousComponentProperties($metadata))],
226+
['Properties', implode("\n", $propertiesAsArrayOfStrings)],
221227
]);
222228
$table->render();
223229

@@ -229,7 +235,7 @@ private function displayComponentDetails(SymfonyStyle $io, string $name): void
229235
new TableSeparator(),
230236
// ['Attributes Var', $metadata->get('attributes_var')],
231237
['Public Props', $metadata->isPublicPropsExposed() ? 'Yes' : 'No'],
232-
['Properties', implode("\n", $this->getComponentProperties($metadata))],
238+
['Properties', implode("\n", $propertiesAsArrayOfStrings)],
233239
]);
234240

235241
$logMethod = function (\ReflectionMethod $m) {
@@ -280,80 +286,4 @@ private function displayComponentsTable(SymfonyStyle $io, array $components): vo
280286
}
281287
$table->render();
282288
}
283-
284-
/**
285-
* @return array<string, string>
286-
*/
287-
private function getComponentProperties(ComponentMetadata $metadata): array
288-
{
289-
$properties = [];
290-
$reflectionClass = new \ReflectionClass($metadata->getClass());
291-
foreach ($reflectionClass->getProperties() as $property) {
292-
$propertyName = $property->getName();
293-
294-
if ($metadata->isPublicPropsExposed() && $property->isPublic()) {
295-
$type = $property->getType();
296-
if ($type instanceof \ReflectionNamedType) {
297-
$typeName = $type->getName();
298-
} else {
299-
$typeName = (string) $type;
300-
}
301-
$value = $property->getDefaultValue();
302-
$propertyDisplay = $typeName.' $'.$propertyName.(null !== $value ? ' = '.json_encode($value) : '');
303-
$properties[$property->name] = $propertyDisplay;
304-
}
305-
306-
foreach ($property->getAttributes(ExposeInTemplate::class) as $exposeAttribute) {
307-
/** @var ExposeInTemplate $attribute */
308-
$attribute = $exposeAttribute->newInstance();
309-
$properties[$property->name] = $attribute->name ?? $property->name;
310-
}
311-
}
312-
313-
return $properties;
314-
}
315-
316-
/**
317-
* Extract properties from {% props %} tag in anonymous template.
318-
*
319-
* @return array<string, string>
320-
*/
321-
private function getAnonymousComponentProperties(ComponentMetadata $metadata): array
322-
{
323-
$source = $this->twig->load($metadata->getTemplate())->getSourceContext();
324-
$tokenStream = $this->twig->tokenize($source);
325-
$moduleNode = $this->twig->parse($tokenStream);
326-
327-
$propsNode = null;
328-
foreach ($moduleNode->getNode('body') as $bodyNode) {
329-
foreach ($bodyNode as $node) {
330-
if (PropsNode::class === $node::class) {
331-
$propsNode = $node;
332-
break 2;
333-
}
334-
}
335-
}
336-
if (!$propsNode instanceof PropsNode) {
337-
return [];
338-
}
339-
340-
$propertyNames = $propsNode->getAttribute('names');
341-
$properties = array_combine($propertyNames, $propertyNames);
342-
foreach ($propertyNames as $propName) {
343-
if ($propsNode->hasNode($propName)
344-
&& ($valueNode = $propsNode->getNode($propName))
345-
&& $valueNode->hasAttribute('value')
346-
) {
347-
$value = $valueNode->getAttribute('value');
348-
if (\is_bool($value)) {
349-
$value = $value ? 'true' : 'false';
350-
} else {
351-
$value = json_encode($value);
352-
}
353-
$properties[$propName] = $propName.' = '.$value;
354-
}
355-
}
356-
357-
return $properties;
358-
}
359289
}

‎src/TwigComponent/src/ComponentPropertiesExtractor.php

+141
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\UX\TwigComponent;
13+
14+
use Symfony\UX\TwigComponent\Attribute\ExposeInTemplate;
15+
use Symfony\UX\TwigComponent\Twig\PropsNode;
16+
use Twig\Environment;
17+
18+
final class ComponentPropertiesExtractor
19+
{
20+
public function __construct(
21+
private readonly Environment $twig,
22+
) {
23+
}
24+
25+
/**
26+
* @return array<string, string>
27+
*/
28+
public function getComponentProperties(ComponentMetadata $medata)
29+
{
30+
if ($medata->isAnonymous()) {
31+
return $this->getAnonymousComponentProperties($medata);
32+
}
33+
34+
return $this->getNonAnonymousComponentProperties($medata);
35+
}
36+
37+
/**
38+
* @return array<string, string>
39+
*/
40+
private function getNonAnonymousComponentProperties(ComponentMetadata $metadata): array
41+
{
42+
$properties = [];
43+
$reflectionClass = new \ReflectionClass($metadata->getClass());
44+
foreach ($reflectionClass->getProperties() as $property) {
45+
$propertyName = $property->getName();
46+
47+
if ($metadata->isPublicPropsExposed() && $property->isPublic()) {
48+
$type = $property->getType();
49+
if ($type instanceof \ReflectionNamedType) {
50+
$typeName = $type->getName();
51+
} else {
52+
$typeName = (string) $type;
53+
}
54+
$value = $property->getDefaultValue();
55+
$propertyDisplay = $typeName.' $'.$propertyName.(null !== $value ? ' = '.json_encode(
56+
$value
57+
) : '');
58+
$properties[$property->name] = [
59+
'name' => $propertyName,
60+
'display' => $propertyDisplay,
61+
'type' => $typeName,
62+
'default' => $value,
63+
];
64+
}
65+
66+
foreach ($property->getAttributes(ExposeInTemplate::class) as $exposeAttribute) {
67+
/** @var ExposeInTemplate $attribute */
68+
$attribute = $exposeAttribute->newInstance();
69+
$properties[$property->name] = [
70+
'name' => $attribute->name ?? $property->name,
71+
'display' => $attribute->name ?? $property->name,
72+
'type' => 'mixed',
73+
'default' => null,
74+
];
75+
}
76+
}
77+
78+
return $properties;
79+
}
80+
81+
/**
82+
* Extract properties from {% props %} tag in anonymous template.
83+
*
84+
* @return array<string, string>
85+
*/
86+
private function getAnonymousComponentProperties(ComponentMetadata $metadata): array
87+
{
88+
$source = $this->twig->load($metadata->getTemplate())->getSourceContext();
89+
$tokenStream = $this->twig->tokenize($source);
90+
$moduleNode = $this->twig->parse($tokenStream);
91+
92+
$propsNode = null;
93+
foreach ($moduleNode->getNode('body') as $bodyNode) {
94+
foreach ($bodyNode as $node) {
95+
if (PropsNode::class === $node::class) {
96+
$propsNode = $node;
97+
break 2;
98+
}
99+
}
100+
}
101+
if (!$propsNode instanceof PropsNode) {
102+
return [];
103+
}
104+
105+
$propertyNames = $propsNode->getAttribute('names');
106+
$properties = array_combine($propertyNames, $propertyNames);
107+
foreach ($propertyNames as $propName) {
108+
if ($propsNode->hasNode($propName)
109+
&& ($valueNode = $propsNode->getNode($propName))
110+
&& $valueNode->hasAttribute('value')
111+
) {
112+
$value = $valueNode->getAttribute('value');
113+
if (\is_bool($value)) {
114+
$value = $value ? 'true' : 'false';
115+
} else {
116+
$value = json_encode($value);
117+
}
118+
$display = $propName.' = '.$value;
119+
$properties[$propName] = [
120+
'name' => $propName,
121+
'display' => $display,
122+
'type' => 'mixed',
123+
'default' => $value,
124+
];
125+
}
126+
}
127+
128+
foreach ($properties as $propertyData) {
129+
if (\is_string($propertyData)) {
130+
$properties[$propertyData] = [
131+
'name' => $propertyData,
132+
'display' => $propertyData,
133+
'type' => 'mixed',
134+
'default' => null,
135+
];
136+
}
137+
}
138+
139+
return $properties;
140+
}
141+
}

‎src/TwigComponent/src/DependencyInjection/Compiler/TwigComponentPass.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public function process(ContainerBuilder $container): void
8686
$componentPropertiesDefinition->setArgument(1, array_fill_keys(array_keys($componentClassMap), null));
8787

8888
$debugCommandDefinition = $container->findDefinition('ux.twig_component.command.debug');
89-
$debugCommandDefinition->setArgument(3, $componentClassMap);
89+
$debugCommandDefinition->setArgument(4, $componentClassMap);
9090
}
9191

9292
private function findMatchingDefaults(string $className, array $componentDefaults): ?array

‎src/TwigComponent/src/DependencyInjection/TwigComponentExtension.php

+7
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
use Symfony\UX\TwigComponent\Command\TwigComponentDebugCommand;
3333
use Symfony\UX\TwigComponent\ComponentFactory;
3434
use Symfony\UX\TwigComponent\ComponentProperties;
35+
use Symfony\UX\TwigComponent\ComponentPropertiesExtractor;
3536
use Symfony\UX\TwigComponent\ComponentRenderer;
3637
use Symfony\UX\TwigComponent\ComponentRendererInterface;
3738
use Symfony\UX\TwigComponent\ComponentStack;
@@ -134,11 +135,17 @@ static function (ChildDefinition $definition, AsTwigComponent $attribute) {
134135
->setDecoratedService(new Reference('twig.configurator.environment'))
135136
->setArguments([new Reference('ux.twig_component.twig.environment_configurator.inner')]);
136137

138+
$container->register('ux.twig_component.extractor_properties', ComponentPropertiesExtractor::class)
139+
->setArguments([
140+
new Reference('twig'),
141+
]);
142+
137143
$container->register('ux.twig_component.command.debug', TwigComponentDebugCommand::class)
138144
->setArguments([
139145
new Parameter('twig.default_path'),
140146
new Reference('ux.twig_component.component_factory'),
141147
new Reference('twig'),
148+
new Reference('ux.twig_component.extractor_properties'),
142149
new AbstractArgument(\sprintf('Added in %s.', TwigComponentPass::class)),
143150
$config['anonymous_template_directory'],
144151
])

0 commit comments

Comments
 (0)