Skip to content

Commit b7ccc56

Browse files
nicolas-grekasnicolas-grekas
committed
[DI] Add "service_defaults" configuration key
1 parent d0e8476 commit b7ccc56

File tree

3 files changed

+82
-12
lines changed

3 files changed

+82
-12
lines changed

‎src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -146,9 +146,25 @@ private function parseDefinitions($content, $file)
146146
if (!is_array($content['services'])) {
147147
throw new InvalidArgumentException(sprintf('The "services" key should contain an array in %s. Check your YAML syntax.', $file));
148148
}
149+
if (isset($content['services']['_defaults'])) {
150+
$defaults = $content['services']['_defaults'];
151+
$defaultKeys = array('public', 'tags', 'autowire');
152+
unset($content['services']['_defaults']);
153+
154+
if (!is_array($defaults)) {
155+
throw new InvalidArgumentException(sprintf('Service defaults must be an array, "%s" given in "%s".', gettype($defaults), $file));
156+
}
157+
foreach ($defaults as $key => $default) {
158+
if (!in_array($key, $defaultKeys)) {
159+
throw new InvalidArgumentException(sprintf('The configuration key "%s" cannot be used to define a default value in "%s". Allowed keys are "%s".', $key, $file, implode('", "', $defaultKeys)));
160+
}
161+
}
162+
} else {
163+
$defaults = array();
164+
}
149165

150166
foreach ($content['services'] as $id => $service) {
151-
$this->parseDefinition($id, $service, $file);
167+
$this->parseDefinition($id, $service, $file, $defaults);
152168
}
153169
}
154170

@@ -158,10 +174,11 @@ private function parseDefinitions($content, $file)
158174
* @param string $id
159175
* @param array $service
160176
* @param string $file
177+
* @param array $defaults
161178
*
162179
* @throws InvalidArgumentException When tags are invalid
163180
*/
164-
private function parseDefinition($id, $service, $file)
181+
private function parseDefinition($id, $service, $file, array $defaults)
165182
{
166183
if (is_string($service) && 0 === strpos($service, '@')) {
167184
$this->container->setAlias($id, substr($service, 1));
@@ -176,7 +193,7 @@ private function parseDefinition($id, $service, $file)
176193
static::checkDefinition($id, $service, $file);
177194

178195
if (isset($service['alias'])) {
179-
$public = !array_key_exists('public', $service) || (bool) $service['public'];
196+
$public = array_key_exists('public', $service) ? (bool) $service['public'] : !empty($defaults['public']);
180197
$this->container->setAlias($id, new Alias($service['alias'], $public));
181198

182199
foreach ($service as $key => $value) {
@@ -190,6 +207,7 @@ private function parseDefinition($id, $service, $file)
190207

191208
if (isset($service['parent'])) {
192209
$definition = new ChildDefinition($service['parent']);
210+
$defaults = array();
193211
} else {
194212
$definition = new Definition();
195213
}
@@ -210,8 +228,9 @@ private function parseDefinition($id, $service, $file)
210228
$definition->setLazy($service['lazy']);
211229
}
212230

213-
if (isset($service['public'])) {
214-
$definition->setPublic($service['public']);
231+
$public = isset($service['public']) ? $service['public'] : (isset($defaults['public']) ? $defaults['public'] : null);
232+
if (null !== $public) {
233+
$definition->setPublic($public);
215234
}
216235

217236
if (isset($service['abstract'])) {
@@ -260,12 +279,13 @@ private function parseDefinition($id, $service, $file)
260279
}
261280
}
262281

263-
if (isset($service['tags'])) {
264-
if (!is_array($service['tags'])) {
282+
$tags = isset($service['tags']) ? $service['tags'] : (isset($defaults['tags']) ? $defaults['tags'] : null);
283+
if (null !== $tags) {
284+
if (!is_array($tags)) {
265285
throw new InvalidArgumentException(sprintf('Parameter "tags" must be an array for service "%s" in %s. Check your YAML syntax.', $id, $file));
266286
}
267287

268-
foreach ($service['tags'] as $tag) {
288+
foreach ($tags as $tag) {
269289
if (!is_array($tag)) {
270290
$tag = array('name' => $tag);
271291
}
@@ -301,11 +321,12 @@ private function parseDefinition($id, $service, $file)
301321
$definition->setDecoratedService($service['decorates'], $renameId, $priority);
302322
}
303323

304-
if (isset($service['autowire'])) {
305-
if (is_array($service['autowire'])) {
306-
$definition->setAutowiredMethods($service['autowire']);
324+
$autowire = isset($service['autowire']) ? $service['autowire'] : (isset($defaults['autowire']) ? $defaults['autowire'] : null);
325+
if (null !== $autowire) {
326+
if (is_array($autowire)) {
327+
$definition->setAutowiredMethods($autowire);
307328
} else {
308-
$definition->setAutowired($service['autowire']);
329+
$definition->setAutowired($autowire);
309330
}
310331
}
311332

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/services28.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
services:
2+
_defaults:
3+
public: false
4+
autowire: true
5+
tags:
6+
- name: foo
7+
8+
with_defaults:
9+
class: Foo
10+
11+
with_null:
12+
class: Foo
13+
public: ~
14+
autowire: ~
15+
tags: ~
16+
17+
no_defaults:
18+
class: Foo
19+
public: true
20+
autowire: false
21+
tags: []
22+
23+
no_defaults_child:
24+
parent: no_defaults
25+
autowire: ~
26+
tags:
27+
- name: bar

‎src/Symfony/Component/DependencyInjection/Tests/Loader/YamlFileLoaderTest.php

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,28 @@ public function testAutowire()
329329
$this->assertEquals(array('set*', 'bar'), $container->getDefinition('autowire_array')->getAutowiredMethods());
330330
}
331331

332+
public function testDefaults()
333+
{
334+
$container = new ContainerBuilder();
335+
$loader = new YamlFileLoader($container, new FileLocator(self::$fixturesPath.'/yaml'));
336+
$loader->load('services28.yml');
337+
338+
$this->assertFalse($container->getDefinition('with_defaults')->isPublic());
339+
$this->assertFalse($container->getDefinition('with_null')->isPublic());
340+
$this->assertTrue($container->getDefinition('no_defaults')->isPublic());
341+
$this->assertTrue($container->getDefinition('no_defaults_child')->isPublic());
342+
343+
$this->assertSame(array('foo' => array(array())), $container->getDefinition('with_defaults')->getTags());
344+
$this->assertSame(array('foo' => array(array())), $container->getDefinition('with_null')->getTags());
345+
$this->assertSame(array(), $container->getDefinition('no_defaults')->getTags());
346+
$this->assertSame(array('bar' => array(array())), $container->getDefinition('no_defaults_child')->getTags());
347+
348+
$this->assertTrue($container->getDefinition('with_defaults')->isAutowired());
349+
$this->assertTrue($container->getDefinition('with_null')->isAutowired());
350+
$this->assertFalse($container->getDefinition('no_defaults')->isAutowired());
351+
$this->assertFalse($container->getDefinition('no_defaults_child')->isAutowired());
352+
}
353+
332354
/**
333355
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
334356
* @expectedExceptionMessage The value of the "decorates" option for the "bar" service must be the id of the service without the "@" prefix (replace "@foo" with "foo").

0 commit comments

Comments
 (0)