Skip to content

Commit 81124f2

Browse files
alexandre-dauboisalexandre-daubois
committed
[FrameworkBundle] Add the config() function
1 parent 3b5f623 commit 81124f2

25 files changed

+1400
-14
lines changed

‎src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
CHANGELOG
22
=========
33

4+
7.3
5+
---
6+
7+
* Add the `Symfony\Config\config()` function
8+
49
7.2
510
---
611

‎src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ConfigBuilderCacheWarmer.php

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
use Psr\Log\LoggerInterface;
1515
use Symfony\Component\Config\Builder\ConfigBuilderGenerator;
16-
use Symfony\Component\Config\Builder\ConfigBuilderGeneratorInterface;
16+
use Symfony\Component\Config\Builder\ConfigFunctionAwareBuilderGeneratorInterface;
1717
use Symfony\Component\Config\Definition\ConfigurationInterface;
1818
use Symfony\Component\DependencyInjection\Container;
1919
use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -29,6 +29,7 @@
2929
* Generate all config builders.
3030
*
3131
* @author Tobias Nyholm <tobias.nyholm@gmail.com>
32+
* @author Alexandre Daubois <alex.daubois@gmail.com>
3233
*
3334
* @final since Symfony 7.1
3435
*/
@@ -68,19 +69,30 @@ public function warmUp(string $cacheDir, ?string $buildDir = null): array
6869
}
6970
}
7071

72+
$configurations = [];
7173
foreach ($extensions as $extension) {
74+
if (null === $configuration = $this->getConfigurationFromExtension($extension)) {
75+
continue;
76+
}
77+
78+
$configurations[$extension->getAlias()] = $configuration;
79+
7280
try {
73-
$this->dumpExtension($extension, $generator);
81+
$generator->build($configurations[$extension->getAlias()]);
7482
} catch (\Exception $e) {
7583
$this->logger?->warning('Failed to generate ConfigBuilder for extension {extensionClass}: '.$e->getMessage(), ['exception' => $e, 'extensionClass' => $extension::class]);
7684
}
7785
}
7886

87+
if (class_exists(ConfigFunctionAwareBuilderGeneratorInterface::class) && $configurations) {
88+
$generator->buildConfigFunction($configurations);
89+
}
90+
7991
// No need to preload anything
8092
return [];
8193
}
8294

83-
private function dumpExtension(ExtensionInterface $extension, ConfigBuilderGeneratorInterface $generator): void
95+
private function getConfigurationFromExtension(ExtensionInterface $extension): ?ConfigurationInterface
8496
{
8597
$configuration = null;
8698
if ($extension instanceof ConfigurationInterface) {
@@ -90,11 +102,7 @@ private function dumpExtension(ExtensionInterface $extension, ConfigBuilderGener
90102
$configuration = $extension->getConfiguration([], new ContainerBuilder($container instanceof Container ? new ContainerBag($container) : new ParameterBag()));
91103
}
92104

93-
if (!$configuration) {
94-
return;
95-
}
96-
97-
$generator->build($configuration);
105+
return $configuration;
98106
}
99107

100108
public function isOptional(): bool

‎src/Symfony/Component/Config/Builder/ArrayShapeGenerator.php

Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
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\Component\Config\Builder;
13+
14+
use Symfony\Component\Config\Definition\ArrayNode;
15+
use Symfony\Component\Config\Definition\BaseNode;
16+
use Symfony\Component\Config\Definition\BooleanNode;
17+
use Symfony\Component\Config\Definition\EnumNode;
18+
use Symfony\Component\Config\Definition\FloatNode;
19+
use Symfony\Component\Config\Definition\IntegerNode;
20+
use Symfony\Component\Config\Definition\NodeInterface;
21+
use Symfony\Component\Config\Definition\NumericNode;
22+
use Symfony\Component\Config\Definition\PrototypedArrayNode;
23+
use Symfony\Component\Config\Definition\ScalarNode;
24+
use Symfony\Component\Config\Definition\StringNode;
25+
use Symfony\Component\Config\Definition\VariableNode;
26+
27+
/**
28+
* @author Alexandre Daubois <alex.daubois@gmail.com>
29+
*
30+
* @internal
31+
*/
32+
final class ArrayShapeGenerator
33+
{
34+
public const FORMAT_PHPDOC = 'phpdoc';
35+
public const FORMAT_JETBRAINS_ATTRIBUTE = 'jetbrains_attribute';
36+
37+
/**
38+
* @param self::FORMAT_* $format
39+
*/
40+
public static function generate(ArrayNode $node, string $format): string
41+
{
42+
if (self::FORMAT_PHPDOC === $format) {
43+
return self::prependPhpDocWithStar(self::doGeneratePhpDoc($node));
44+
}
45+
46+
if (self::FORMAT_JETBRAINS_ATTRIBUTE === $format) {
47+
return self::doGenerateJetBrainsArrayShape($node);
48+
}
49+
50+
throw new \LogicException(\sprintf('Unsupported format to generate array shape. Expected one of "%s", got "%s".', implode('", "', [self::FORMAT_PHPDOC, self::FORMAT_JETBRAINS_ATTRIBUTE]), $format));
51+
}
52+
53+
private static function doGeneratePhpDoc(NodeInterface $node, int $nestingLevel = 1): string
54+
{
55+
if (!$node instanceof ArrayNode) {
56+
return $node->getName();
57+
}
58+
59+
if (!$children = $node->getChildren()) {
60+
return 'array<array-key, mixed>';
61+
}
62+
63+
if ($node instanceof PrototypedArrayNode) {
64+
$prototype = $node->getPrototype();
65+
if ($prototype instanceof ArrayNode) {
66+
return 'array<'.self::doGeneratePhpDoc($prototype, 1 + $nestingLevel).'>';
67+
}
68+
69+
return 'array<'.self::handleNodeType($prototype).'>';
70+
}
71+
72+
$arrayShape = 'array{'.\PHP_EOL;
73+
74+
$handleNode = function (NodeInterface $node, int $nestingLevel): string {
75+
if ($node instanceof ArrayNode) {
76+
return self::doGeneratePhpDoc($node, 1 + $nestingLevel);
77+
} else {
78+
return self::handleNodeType($node);
79+
}
80+
};
81+
82+
/** @var NodeInterface $child */
83+
foreach ($children as $child) {
84+
$arrayShape .= str_repeat(' ', $nestingLevel * 4).self::dumpNodeKey($child).': ';
85+
86+
if ($child instanceof PrototypedArrayNode) {
87+
$arrayShape .= 'array<'.$handleNode($child->getPrototype(), $nestingLevel).'>';
88+
} else {
89+
$arrayShape .= $handleNode($child, $nestingLevel);
90+
}
91+
92+
$arrayShape .= ','.\PHP_EOL;
93+
}
94+
95+
return $arrayShape.str_repeat(' ', 4 * ($nestingLevel - 1)).'}';
96+
}
97+
98+
private static function doGenerateJetBrainsArrayShape(NodeInterface $node, int $nestingLevel = 1): string
99+
{
100+
if (!$node instanceof ArrayNode) {
101+
return $node->getName();
102+
}
103+
104+
$children = $node->getChildren();
105+
106+
$shape = '';
107+
if (1 === $nestingLevel) {
108+
$shape = '#[ArrayShape(';
109+
} elseif (!$children) {
110+
return "'array<array-key, mixed>'";
111+
}
112+
113+
if ($node instanceof PrototypedArrayNode) {
114+
$prototype = $node->getPrototype();
115+
if ($prototype instanceof ArrayNode) {
116+
return 'array<'.self::doGeneratePhpDoc($prototype, 1 + $nestingLevel).'>';
117+
}
118+
119+
return 'array<'.self::handleNodeType($prototype).'>';
120+
}
121+
122+
$shape .= '['.\PHP_EOL;
123+
124+
$handleNode = function (NodeInterface $node, int $nestingLevel): string {
125+
if ($node instanceof ArrayNode) {
126+
return self::doGenerateJetBrainsArrayShape($node, 1 + $nestingLevel);
127+
} else {
128+
return "'".self::handleNodeType($node)."'";
129+
}
130+
};
131+
132+
/** @var BaseNode $child */
133+
foreach ($children as $child) {
134+
$shape .= \sprintf("%s'%s' => ", str_repeat(' ', 4 * $nestingLevel), $child->getName());
135+
136+
if ($child instanceof PrototypedArrayNode) {
137+
$shape .= '['.$handleNode($child->getPrototype(), $nestingLevel).']';
138+
} else {
139+
$shape .= $handleNode($child, $nestingLevel);
140+
}
141+
142+
$shape .= ','.self::generateInlinePhpDocForNode($child).\PHP_EOL;
143+
}
144+
145+
$shape .= str_repeat(' ', 4 * ($nestingLevel - 1)).']';
146+
147+
return $shape.(1 === $nestingLevel ? ')]' : '');
148+
}
149+
150+
private static function dumpNodeKey(NodeInterface $node): string
151+
{
152+
return $node->getName().($node->isRequired() ? '' : '?');
153+
}
154+
155+
private static function handleNumericNode(NumericNode $node): string
156+
{
157+
if ($node instanceof IntegerNode) {
158+
$type = 'int<%s, %s>';
159+
} elseif ($node instanceof FloatNode) {
160+
$type = 'float<%s, %s>';
161+
} else {
162+
$type = 'int<%s, %s>|float<%1$s, %2$s>';
163+
}
164+
165+
$min = $node->getMin() ?? 'min';
166+
$max = $node->getMax() ?? 'max';
167+
168+
return \sprintf($type, $min, $max);
169+
}
170+
171+
private static function prependPhpDocWithStar(string $shape): string
172+
{
173+
return str_replace("\n", "\n * ", $shape);
174+
}
175+
176+
private static function generateInlinePhpDocForNode(BaseNode $node): string
177+
{
178+
$hasContent = false;
179+
$comment = ' /* ';
180+
181+
if ($node->hasDefaultValue() || $node->getInfo() || $node->isDeprecated()) {
182+
if ($node->isDeprecated()) {
183+
$hasContent = true;
184+
$comment .= 'Deprecated: '.$node->getDeprecation($node->getName(), $node->getPath())['message'].' ';
185+
}
186+
187+
if ($info = $node->getInfo()) {
188+
$hasContent = true;
189+
$comment .= $info.' ';
190+
}
191+
192+
if ($node->hasDefaultValue() && !\is_array($defaultValue = $node->getDefaultValue())) {
193+
$hasContent = true;
194+
$comment .= 'Default: '.json_encode($defaultValue).'. ';
195+
}
196+
197+
$comment .= '*/';
198+
}
199+
200+
return $hasContent ? $comment : '';
201+
}
202+
203+
private static function handleNodeType(NodeInterface $node): string
204+
{
205+
return match (true) {
206+
$node instanceof BooleanNode => 'bool',
207+
$node instanceof StringNode => 'string',
208+
$node instanceof NumericNode => self::handleNumericNode($node),
209+
$node instanceof EnumNode => $node->getPermissibleValues('|'),
210+
$node instanceof ScalarNode => 'string|int|float|bool',
211+
$node instanceof VariableNode => 'mixed',
212+
};
213+
}
214+
}

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy