Skip to content

Commit e66a18c

Browse files
nicolas-grekasnicolas-grekas
committed
[DependencyInjection][Routing] Define array-shapes to help writing PHP configs using yaml-like arrays
1 parent 53bd8d7 commit e66a18c

File tree

20 files changed

+639
-153
lines changed

20 files changed

+639
-153
lines changed

‎src/Symfony/Component/DependencyInjection/CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ CHANGELOG
1212
* Allow multiple `#[AsDecorator]` attributes
1313
* Handle returning arrays and config-builders from config files
1414
* Handle declaring services using PHP arrays that follow the same shape as corresponding yaml files
15+
* Add `ServicesConfig` to help writing PHP configs using yaml-like array-shapes
1516
* Deprecate using `$this` or its internal scope from PHP config files; use the `$loader` variable instead
1617
* Deprecate XML configuration format, use YAML or PHP instead
1718
* Deprecate `ExtensionInterface::getXsdValidationBasePath()` and `getNamespace()`

‎src/Symfony/Component/DependencyInjection/Loader/Config/ServicesConfig.php‎

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
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\Config;
13+
14+
use Symfony\Component\DependencyInjection\ContainerInterface;
15+
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
16+
use Symfony\Component\DependencyInjection\Loader\Configurator\ReferenceConfigurator;
17+
use Symfony\Component\DependencyInjection\Reference;
18+
use Symfony\Component\ExpressionLanguage\Expression;
19+
20+
/**
21+
* @phpstan-type Imports list<string|array{
22+
* resource: string,
23+
* type?: string|null,
24+
* ignore_errors?: bool,
25+
* }>
26+
* @phpstan-type Parameters array<string, scalar|\UnitEnum|array<scalar|\UnitEnum|array|null>|null>
27+
* @phpstan-type Services array<string, Definition|Alias|Prototype|Stack>|array<class-string, Arguments|null>
28+
* @phpstan-type Defaults array{
29+
* public?: bool,
30+
* tags?: Tags,
31+
* resource_tags?: Tags,
32+
* autowire?: bool,
33+
* autoconfigure?: bool,
34+
* bind?: array<string, mixed>,
35+
* }
36+
* @phpstan-type Instanceof array{
37+
* shared?: bool,
38+
* lazy?: bool|string,
39+
* public?: bool,
40+
* properties?: array<string, mixed>,
41+
* configurator?: Callback,
42+
* calls?: list<Call>,
43+
* tags?: Tags,
44+
* resource_tags?: Tags,
45+
* autowire?: bool,
46+
* bind?: array<string, mixed>,
47+
* constructor?: string,
48+
* }
49+
* @phpstan-type Definition array{
50+
* class?: string,
51+
* file?: string,
52+
* parent?: string,
53+
* shared?: bool,
54+
* synthetic?: bool,
55+
* lazy?: bool|string,
56+
* public?: bool,
57+
* abstract?: bool,
58+
* deprecated?: Deprecation,
59+
* factory?: Callback,
60+
* configurator?: Callback,
61+
* arguments?: Arguments,
62+
* properties?: array<string, mixed>,
63+
* calls?: list<Call>,
64+
* tags?: Tags,
65+
* resource_tags?: Tags,
66+
* decorates?: string,
67+
* decoration_inner_name?: string,
68+
* decoration_priority?: int,
69+
* decoration_on_invalid?: 'exception'|'ignore'|null|ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE|ContainerInterface::IGNORE_ON_INVALID_REFERENCE|ContainerInterface::NULL_ON_INVALID_REFERENCE,
70+
* autowire?: bool,
71+
* autoconfigure?: bool,
72+
* bind?: array<string, mixed>,
73+
* constructor?: string,
74+
* from_callable?: mixed,
75+
* }
76+
* @phpstan-type Alias string|array{
77+
* alias: string,
78+
* public?: bool,
79+
* deprecated?: Deprecation,
80+
* }
81+
* @phpstan-type Prototype array{
82+
* resource: string,
83+
* namespace?: string,
84+
* exclude?: string|list<string>,
85+
* parent?: string,
86+
* shared?: bool,
87+
* lazy?: bool|string,
88+
* public?: bool,
89+
* abstract?: bool,
90+
* deprecated?: Deprecation,
91+
* factory?: Callback,
92+
* arguments?: Arguments,
93+
* properties?: array<string, mixed>,
94+
* configurator?: Callback,
95+
* calls?: list<Call>,
96+
* tags?: Tags,
97+
* resource_tags?: Tags,
98+
* autowire?: bool,
99+
* autoconfigure?: bool,
100+
* bind?: array<string, mixed>,
101+
* constructor?: string,
102+
* }
103+
* @phpstan-type Stack array{
104+
* stack: list<Definition|Alias|Prototype|array<class-string, Arguments|null>>,
105+
* public?: bool,
106+
* deprecated?: Deprecation,
107+
* }
108+
* @phpstan-type Arguments list<mixed>|array<string, mixed>
109+
* @phpstan-type Callback string|array{0:string|Reference|ReferenceConfigurator,1:string}|\Closure|Reference|ReferenceConfigurator|Expression
110+
* @phpstan-type Tags list<string|array<string, array<string, mixed>>>
111+
* @phpstan-type Deprecation array{package: string, version: string, message?: string}
112+
* @phpstan-type Call array<string, Arguments>|array{0:string, 1?:Arguments, 2?:bool}|array{method:string, arguments?:Arguments, returns_clone?:bool}
113+
*/
114+
class ServicesConfig
115+
{
116+
public readonly array $services;
117+
118+
/**
119+
* @param Imports $imports
120+
* @param Parameters $parameters
121+
* @param Defaults $defaults
122+
* @param Instanceof $instanceof
123+
* @param Services $services
124+
*/
125+
public function __construct(
126+
public readonly array $imports = [],
127+
public readonly array $parameters = [],
128+
array $defaults = [],
129+
array $instanceof = [],
130+
array $services = [],
131+
) {
132+
if (isset($services['_defaults']) || isset($services['_instanceof'])) {
133+
throw new InvalidArgumentException('The $services argument should not contain "_defaults" or "_instanceof" keys, use the $defaults and $instanceof parameters instead.');
134+
}
135+
136+
$services['_defaults'] = $defaults;
137+
$services['_instanceof'] = $instanceof;
138+
$this->services = $services;
139+
}
140+
}
141+
142+
/**
143+
* Pre-configured ServicesConfig for the App namespace.
144+
*
145+
* This class helps configuring the App namespace with autowiring and autoconfiguration enabled by default.
146+
* Use ServicesConfig directly if you don't want this behavior, or if you're a bundle author.
147+
*
148+
* @phpstan-import-type Imports from ServicesConfig
149+
* @phpstan-import-type Parameters from ServicesConfig
150+
* @phpstan-import-type Defaults from ServicesConfig
151+
* @phpstan-import-type Instanceof from ServicesConfig
152+
* @phpstan-import-type Services from ServicesConfig
153+
*/
154+
class AppServicesConfig extends ServicesConfig
155+
{
156+
/**
157+
* @param Imports $imports
158+
* @param Parameters $parameters
159+
* @param Defaults $defaults
160+
* @param Instanceof $instanceof
161+
* @param Services $services
162+
*/
163+
public function __construct(
164+
array $imports = [],
165+
array $parameters = [],
166+
array $defaults = [],
167+
array $instanceof = [],
168+
array $services = [],
169+
) {
170+
$services = array_merge(['App\\' => ['resource' => '../src']], $services);
171+
$defaults = array_merge([
172+
'autowire' => true,
173+
'autoconfigure' => true,
174+
], $defaults);
175+
176+
parent::__construct($imports, $parameters, $defaults, $instanceof, $services);
177+
}
178+
}
179+
180+
namespace Symfony\Component\DependencyInjection\Loader\Config;
181+
182+
class ServicesConfig extends \Symfony\Config\ServicesConfig
183+
{
184+
}

‎src/Symfony/Component/DependencyInjection/Loader/Config/functions.php‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
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\Config;
13+
14+
use Symfony\Component\Config\Loader\ParamConfigurator;
15+
use Symfony\Component\DependencyInjection\Argument\AbstractArgument;
16+
use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
17+
use Symfony\Component\DependencyInjection\Argument\ServiceLocatorArgument;
18+
use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
19+
use Symfony\Component\DependencyInjection\Definition;
20+
use Symfony\Component\DependencyInjection\Loader\Configurator\AbstractConfigurator;
21+
use Symfony\Component\DependencyInjection\Loader\Configurator\ClosureReferenceConfigurator;
22+
use Symfony\Component\DependencyInjection\Loader\Configurator\EnvConfigurator;
23+
use Symfony\Component\DependencyInjection\Loader\Configurator\InlineServiceConfigurator;
24+
use Symfony\Component\DependencyInjection\Loader\Configurator\ReferenceConfigurator;
25+
use Symfony\Component\ExpressionLanguage\Expression;
26+
27+
/**
28+
* Creates a parameter.
29+
*/
30+
function param(string $name): ParamConfigurator
31+
{
32+
return new ParamConfigurator($name);
33+
}
34+
35+
/**
36+
* Creates a reference to a service.
37+
*/
38+
function service(string $serviceId): ReferenceConfigurator
39+
{
40+
return new ReferenceConfigurator($serviceId);
41+
}
42+
43+
/**
44+
* Creates an inline service.
45+
*/
46+
function inline_service(?string $class = null): InlineServiceConfigurator
47+
{
48+
return new InlineServiceConfigurator(new Definition($class));
49+
}
50+
51+
/**
52+
* Creates a service locator.
53+
*
54+
* @param array<ReferenceConfigurator|InlineServiceConfigurator> $values
55+
*/
56+
function service_locator(array $values): ServiceLocatorArgument
57+
{
58+
$values = AbstractConfigurator::processValue($values, true);
59+
60+
return new ServiceLocatorArgument($values);
61+
}
62+
63+
/**
64+
* Creates a lazy iterator.
65+
*
66+
* @param ReferenceConfigurator[] $values
67+
*/
68+
function iterator(array $values): IteratorArgument
69+
{
70+
return new IteratorArgument(AbstractConfigurator::processValue($values, true));
71+
}
72+
73+
/**
74+
* Creates a lazy iterator by tag name.
75+
*/
76+
function tagged_iterator(string $tag, ?string $indexAttribute = null, ?string $defaultIndexMethod = null, ?string $defaultPriorityMethod = null, string|array $exclude = [], bool $excludeSelf = true): TaggedIteratorArgument
77+
{
78+
return new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod, false, $defaultPriorityMethod, (array) $exclude, $excludeSelf);
79+
}
80+
81+
/**
82+
* Creates a service locator by tag name.
83+
*/
84+
function tagged_locator(string $tag, ?string $indexAttribute = null, ?string $defaultIndexMethod = null, ?string $defaultPriorityMethod = null, string|array $exclude = [], bool $excludeSelf = true): ServiceLocatorArgument
85+
{
86+
return new ServiceLocatorArgument(new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod, true, $defaultPriorityMethod, (array) $exclude, $excludeSelf));
87+
}
88+
89+
/**
90+
* Creates an expression.
91+
*/
92+
function expr(string $expression): Expression
93+
{
94+
return new Expression($expression);
95+
}
96+
97+
/**
98+
* Creates an abstract argument.
99+
*/
100+
function abstract_arg(string $description): AbstractArgument
101+
{
102+
return new AbstractArgument($description);
103+
}
104+
105+
/**
106+
* Creates an environment variable reference.
107+
*/
108+
function env(string $name): EnvConfigurator
109+
{
110+
return new EnvConfigurator($name);
111+
}
112+
113+
/**
114+
* Creates a closure service reference.
115+
*/
116+
function service_closure(string $serviceId): ClosureReferenceConfigurator
117+
{
118+
return new ClosureReferenceConfigurator($serviceId);
119+
}
120+
121+
/**
122+
* Creates a closure.
123+
*/
124+
function closure(string|array|\Closure|ReferenceConfigurator|Expression $callable): InlineServiceConfigurator
125+
{
126+
return (new InlineServiceConfigurator(new Definition('Closure')))
127+
->factory(['Closure', 'fromCallable'])
128+
->args([$callable]);
129+
}

‎src/Symfony/Component/DependencyInjection/Loader/Configurator/AbstractConfigurator.php‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,9 @@ public static function processValue(mixed $value, bool $allowServices = false):
101101
case $value instanceof \UnitEnum:
102102
return $value;
103103

104+
case $value instanceof \Closure:
105+
return self::processClosure($value);
106+
104107
case $value instanceof ArgumentInterface:
105108
case $value instanceof Definition:
106109
case $value instanceof Expression:
@@ -120,7 +123,7 @@ public static function processValue(mixed $value, bool $allowServices = false):
120123
*
121124
* @throws InvalidArgumentException if the closure is anonymous or references a non-static method
122125
*/
123-
final public static function processClosure(\Closure $closure): callable
126+
private static function processClosure(\Closure $closure): callable
124127
{
125128
$function = new \ReflectionFunction($closure);
126129
if ($function->isAnonymous()) {

0 commit comments

Comments
 (0)