8000 [DI] Renamed some PHP-DSL functions · symfony/symfony@366405b · GitHub
[go: up one dir, main page]
Skip to content

Commit 366405b

Browse files
javiereguiluznicolas-grekas
javiereguiluz
authored and
nicolas-grekas
committed
[DI] Renamed some PHP-DSL functions
1 parent a73523b commit 366405b

File tree

15 files changed

+69
-54
lines changed

15 files changed

+69
-54
lines changed

‎UPGRADE-5.1.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ DependencyInjection
2424
configure them explicitly instead.
2525
* Deprecated `Definition::getDeprecationMessage()`, use `Definition::getDeprecation()` instead.
2626
* Deprecated `Alias::getDeprecationMessage()`, use `Alias::getDeprecation()` instead.
27-
* The `inline()` function from the PHP-DSL has been deprecated, use `service()` instead
27+
* The `inline()` function from the PHP-DSL has been deprecated, use `inline_service()` instead
28+
* The `ref()` function from the PHP-DSL has been deprecated, use `service()` instead
2829

2930
Dotenv
3031
------

‎UPGRADE-6.0.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ DependencyInjection
2424
configure them explicitly instead.
2525
* Removed `Definition::getDeprecationMessage()`, use `Definition::getDeprecation()` instead.
2626
* Removed `Alias::getDeprecationMessage()`, use `Alias::getDeprecation()` instead.
27-
* The `inline()` function from the PHP-DSL has been removed, use `service()` instead
27+
* The `inline()` function from the PHP-DSL has been removed, use `inline_service()` instead.
28+
* The `ref()` function from the PHP-DSL has been removed, use `service()` instead.
2829

2930
Dotenv
3031
------

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ CHANGELOG
44
5.1.0
55
-----
66

7+
* deprecated `inline()` in favor of `inline_service()` and `ref()` in favor of `service()` when using the PHP-DSL
78
* allow decorators to reference their decorated service using the special `.inner` id
89
* added support to autowire public typed properties in php 7.4
910
* added support for defining method calls, a configurator, and property setters in `InlineServiceConfigurator`

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

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,28 +84,40 @@ final public function withPath(string $path): self
8484

8585
/**
8686
* Creates a service reference.
87+
*
88+
* @deprecated since Symfony 5.1, use service() instead.
8789
*/
8890
function ref(string $id): ReferenceConfigurator
8991
{
92+
trigger_deprecation('symfony/dependency-injection', '5.1', '"%s()" is deprecated, use "service()" instead.', __FUNCTION__);
93+
9094
return new ReferenceConfigurator($id);
9195
}
9296

97+
/**
98+
* Creates a reference to a service.
99+
*/
100+
function service(string $serviceId): ReferenceConfigurator
101+
{
102+
return new ReferenceConfigurator($serviceId);
103+
}
104+
93105
/**
94106
* Creates an inline service.
95107
*
96-
* @deprecated since Symfony 5.1, use service() instead.
108+
* @deprecated since Symfony 5.1, use inline_service() instead.
97109
*/
98110
function inline(string $class = null): InlineServiceConfigurator
99111
{
100-
trigger_deprecation('symfony/dependency-injection', '5.1', '"%s()" is deprecated, use "service()" instead.', __FUNCTION__);
112+
trigger_deprecation('symfony/dependency-injection', '5.1', '"%s()" is deprecated, use "inline_service()" instead.', __FUNCTION__);
101113

102114
return new InlineServiceConfigurator(new Definition($class));
103115
}
104116

105117
/**
106118
* Creates an inline service.
107119
*/
108-
function service(string $class = null): InlineServiceConfigurator
120+
function inline_service(string $class = null): InlineServiceConfigurator
109121
{
110122
return new InlineServiceConfigurator(new Definition($class));
111123
}

‎src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/FactoryTrait.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ final public function factory($factory): self
2727
if (\is_string($factory) && 1 === substr_count($factory, ':')) {
2828
$factoryParts = explode(':', $factory);
2929

30-
throw new InvalidArgumentException(sprintf('Invalid factory "%s": the "service:method" notation is not available when using PHP-based DI configuration. Use "[ref(\'%s\'), \'%s\']" instead.', $factory, $factoryParts[0], $factoryParts[1]));
30+
throw new InvalidArgumentException(sprintf('Invalid factory "%s": the "service:method" notation is not available when using PHP-based DI configuration. Use "[service(\'%s\'), \'%s\']" instead.', $factory, $factoryParts[0], $factoryParts[1]));
3131
}
3232

3333
$this->definition->setFactory(static::processValue($factory, true));

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/anonymous.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
$s->set(null, StdClassDecorator::class)
1515
->decorate('decorated', 'decorator42')
16-
->args([ref('decorator42')]);
16+
->args([service('decorator42')]);
1717

1818
$s->set('listener_aggregator', FooClass::class)->public()->args([tagged_iterator('listener')]);
1919

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/basic.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@
77
return function (ContainerConfigurator $c) {
88
$s = $c->services()->defaults()->public();
99
$s->set(BarService::class)
10-
->args([service('FooClass')]);
10+
->args([inline_service('FooClass')]);
1111
};

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/child.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
1515
->parent(BarService::class)
1616
->public()
1717
->decorate('bar', 'b', 1)
18-
->args([ref('b')])
18+
->args([service('b')])
1919
->class('Class2')
2020
->file('file.php')
2121
->parent('bar')

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/defaults.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
->autoconfigure()
1414
->autowire()
1515
->tag('t', ['a' => 'b'])
16-
->bind(Foo::class, ref('bar'))
16+
->bind(Foo::class, service('bar'))
1717
->public();
1818

19-
$s->set(Foo::class)->args([ref('bar')])->public();
19+
$s->set(Foo::class)->args([service('bar')])->public();
2020
$s->set('bar', Foo::class)->call('setFoo')->autoconfigure(false);
2121
};

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/instanceof.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
$s = $c->services()->defaults()->public();
1010
$s->instanceof(Prototype\Foo::class)
1111
->property('p', 0)
12-
->call('setFoo', [ref('foo')])
12+
->call('setFoo', [service('foo')])
1313
->tag('tag', ['k' => 'v'])
1414
->share(false)
1515
->lazy()

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/object.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ public function __invoke(ContainerConfigurator $c)
99
{
1010
$s = $c->services()->defaults()->public();
1111
$s->set(BarService::class)
12-
->args([service('FooClass')]);
12+
->args([inline_service('FooClass')]);
1313
}
1414
};

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/php7.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
;
1212
$c->services()->defaults()->public()
1313
(Foo::class)
14-
->arg('$bar', ref('bar'))
14+
->arg('$bar', service('bar'))
1515
->public()
1616
('bar', Foo::class)
1717
->call('setFoo')

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/services9.php

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@
1818

1919
$s = $c->services()->defaults()->public();
2020
$s->set('foo')
21-
->args(['foo', ref('foo.baz'), ['%foo%' => 'foo is %foo%', 'foobar' => '%foo%'], true, ref('service_container')])
21+
->args(['foo', service('foo.baz'), ['%foo%' => 'foo is %foo%', 'foobar' => '%foo%'], true, service('service_container')])
2222
->class(FooClass::class)
2323
->tag('foo', ['foo' => 'foo'])
2424
->tag('foo', ['bar' => 'bar', 'baz' => 'baz'])
2525
->tag('foo', ['name' => 'bar', 'baz' => 'baz'])
2626
->factory([FooClass::class, 'getInstance'])
2727
->property('foo', 'bar')
28-
->property('moo', ref('foo.baz'))
28+
->property('moo', service('foo.baz'))
2929
->property('qux', ['%foo%' => 'foo is %foo%', 'foobar' => '%foo%'])
30-
->call('setBar', [ref('bar')])
30+
->call('setBar', [service('bar')])
3131
->call('initialize')
3232
->configurator('sc_configure');
3333

@@ -36,48 +36,48 @@
3636
->configurator(['%baz_class%', 'configureStatic1']);
3737

3838
$s->set('bar', FooClass::class)
39-
->args(['foo', ref('foo.baz'), new Parameter('foo_bar')])
40-
->configurator([ref('foo.baz'), 'configure']);
39+
->args(['foo', service('foo.baz'), new Parameter('foo_bar')])
40+
->configurator([service('foo.baz'), 'configure']);
4141

4242
$s->set('foo_bar', '%foo_class%')
43-
->args([ref('deprecated_service')])
43+
->args([service('deprecated_service')])
4444
->share(false);
4545

4646
$s->set('method_call1', 'Bar\FooClass')
4747
->file(realpath(__DIR__.'/../includes/foo.php'))
48-
->call('setBar', [ref('foo')])
49-
->call('setBar', [ref('foo2')->nullOnInvalid()])
50-
->call('setBar', [ref('foo3')->ignoreOnInvalid()])
51-
->call('setBar', [ref('foobaz')->ignoreOnInvalid()])
48+
->call('setBar', [service('foo')])
49+
->call('setBar', [service('foo2')->nullOnInvalid()])
50+
->call('setBar', [service('foo3')->ignoreOnInvalid()])
51+
->call('setBar', [service('foobaz')->ignoreOnInvalid()])
5252
->call('setBar', [expr('service("foo").foo() ~ (container.hasParameter("foo") ? parameter("foo") : "default")')]);
5353

5454
$s->set('foo_with_inline', 'Foo')
55-
->call('setBar', [ref('inlined')]);
55+
->call('setBar', [service('inlined')]);
5656

5757
$s->set('inlined', 'Bar')
5858
->property('pub', 'pub')
59-
->call('setBaz', [ref('baz')])
59+
->call('setBaz', [service('baz')])
6060
->private();
6161

6262
$s->set('baz', 'Baz')
63-
->call('setFoo', [ref('foo_with_inline')]);
63+
->call('setFoo', [service('foo_with_inline')]);
6464

6565
$s->set('request', 'Request')
6666
->synthetic();
6767

6868
$s->set('configurator_service', 'ConfClass')
6969
->private()
70-
->call('setFoo', [ref('baz')]);
70+
->call('setFoo', [service('baz')]);
7171

7272
$s->set('configured_service', 'stdClass')
73-
->configurator([ref('configurator_service'), 'configureStdClass']);
73+
->configurator([service('configurator_service'), 'configureStdClass']);
7474

7575
$s->set('configurator_service_simple', 'ConfClass')
7676
->args(['bar'])
7777
->private();
7878

7979
$s->set('configured_service_simple', 'stdClass')
80-
->configurator([ref('configurator_service_simple'), 'configureStdClass']);
80+
->configurator([service('configurator_service_simple'), 'configureStdClass']);
8181

8282
$s->set('decorated', 'stdClass');
8383

@@ -95,11 +95,11 @@
9595
->private();
9696

9797
$s->set('factory_service', 'Bar')
98-
->factory([ref('foo.baz'), 'getInstance']);
98+
->factory([service('foo.baz'), 'getInstance']);
9999

100100
$s->set('new_factory_service', 'FooBarBaz')
101101
->property('foo', 'bar')
102-
->factory([ref('new_factory'), 'getInstance']);
102+
->factory([service('new_factory'), 'getInstance']);
103103

104104
$s->set('service_from_static_method', 'Bar\FooClass')
105105
->factory(['Bar\FooClass', 'getInstance']);
@@ -110,15 +110,15 @@
110110
->private();
111111

112112
$s->set('factory_service_simple', 'Bar')
113-
->factory([ref('factory_simple'), 'getInstance']);
113+
->factory([service('factory_simple'), 'getInstance']);
114114

115115
$s->set('lazy_context', 'LazyContext')
116-
->args([iterator(['k1' => ref('foo.baz'), 'k2' => ref('service_container')]), iterator([])]);
116+
->args([iterator(['k1' => service('foo.baz'), 'k2' => service('service_container')]), iterator([])]);
117117

118118
$s->set('lazy_context_ignore_invalid_ref', 'LazyContext')
119-
->args([iterator([ref('foo.baz'), ref('invalid')->ignoreOnInvalid()]), iterator([])]);
119+
->args([iterator([service('foo.baz'), service('invalid')->ignoreOnInvalid()]), iterator([])]);
120120

121-
$s->set('BAR', 'stdClass')->property('bar', ref('bar'));
121+
$s->set('BAR', 'stdClass')->property('bar', service('bar'));
122122
$s->set('bar2', 'stdClass');
123123
$s->set('BAR2', 'stdClass');
124124

@@ -138,5 +138,5 @@
138138
->public();
139139

140140
$s->alias('alias_for_foo', 'foo')->private()->public();
141-
$s->alias('alias_for_alias', ref('alias_for_foo'));
141+
$s->alias('alias_for_alias', service('alias_for_foo'));
142142
};

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/stack.php

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,43 +8,43 @@
88
$services = $c->services();
99

1010
$services->stack('stack_a', [
11-
service('stdClass')
11+
inline_service('stdClass')
1212
->property('label', 'A')
13-
->property('inner', ref('.inner')),
14-
service('stdClass')
13+
->property('inner', service('.inner')),
14+
inline_service('stdClass')
1515
->property('label', 'B')
16-
->property('inner', ref('.inner')),
17-
service('stdClass')
16+
->property('inner', service('.inner')),
17+
inline_service('stdClass')
1818
->property('label', 'C'),
1919
])->public();
2020

2121
$services->stack('stack_abstract', [
22-
service('stdClass')
22+
inline_service('stdClass')
2323
->property('label', 'A')
24-
->property('inner', ref('.inner')),
25-
service('stdClass')
24+
->property('inner', service('.inner')),
25+
inline_service('stdClass')
2626
->property('label', 'B')
27-
->property('inner', ref('.inner')),
27+
->property('inner', service('.inner')),
2828
]);
2929

3030
$services->stack('stack_b', [
31-
ref('stack_abstract'),
32-
service('stdClass')
31+
service('stack_abstract'),
32+
inline_service('stdClass')
3333
->property('label', 'C'),
3434
])->public();
3535

3636
$services->stack('stack_c', [
37-
service('stdClass')
37+
inline_service('stdClass')
3838
->property('label', 'Z')
39-
->property('inner', ref('.inner')),
40-
ref('stack_a'),
39+
->property('inner', service('.inner')),
40+
service('stack_a'),
4141
])->public();
4242

4343
$services->stack('stack_d', [
44-
service()
44+
inline_service()
4545
->parent('stack_abstract')
4646
->property('label', 'Z'),
47-
service('stdClass')
47+
inline_service('stdClass')
4848
->property('label', 'C'),
4949
])->public();
5050
};

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public function testAutoConfigureAndChildDefinition()
9696
public function testFactoryShortNotationNotAllowed()
9797
{
9898
$this->expectException('Symfony\Component\DependencyInjection\Exception\InvalidArgumentException');
99-
$this->expectExceptionMessage('Invalid factory "factory:method": the "service:method" notation is not available when using PHP-based DI configuration. Use "[ref(\'factory\'), \'method\']" instead.');
99+
$this->expectExceptionMessage('Invalid factory "factory:method": the "service:method" notation is not available when using PHP-based DI configuration. Use "[service(\'factory\'), \'method\']" instead.');
100100
$fixtures = realpath(__DIR__.'/../Fixtures');
101101
$container = new ContainerBuilder();
102102
$loader = new PhpFileLoader($container, new FileLocator());

0 commit comments

Comments
 (0)
0