Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 82db9c2

Browse files
fabpotfabpot
committed
[DependencyInjection] deprecated synchronized services
1 parent 7f8ff50 commit 82db9c2

29 files changed

+198
-100
lines changed

‎UPGRADE-3.0.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,10 @@ UPGRADE FROM 2.x to 3.0
9595
been removed in favor of `Definition::setFactory()`. Services defined using
9696
YAML or XML use the same syntax as configurators.
9797

98+
* Synchronized services are deprecated and the following methods have been
99+
removed: `ContainerBuilder::synchronize()`, `Definition::isSynchronized()`,
100+
and `Definition::setSynchronized()`.
101+
98102
### EventDispatcher
99103

100104
* The interface `Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcherInterface`

‎autoload.php.dist

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,7 @@ class DeprecationErrorHandler
4444
$class = isset($trace[$i]['object']) ? get_class($trace[$i]['object']) : $trace[$i]['class'];
4545
$method = $trace[$i]['function'];
4646

47-
$type =
48-
0 === strpos($method, 'testLegacy')
49-
|| 0 === strpos($method, 'provideLegacy')
50-
|| strpos($class, '\Legacy')
51-
? 'legacy' : 'remaining';
47+
$type = 0 === strpos($method, 'testLegacy') || 0 === strpos($method, 'provideLegacy') || 0 === strpos($method, 'getLegacy') || strpos($class, '\Legacy') ? 'legacy' : 'remaining';
5248

5349
if ('legacy' === $type && 0 === (error_reporting() & E_USER_DEPRECATED)) {
5450
@++$deprecations[$type]['Silenced']['count'];

‎src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,10 +215,13 @@ private function getContainerDefinitionData(Definition $definition, $omitTags =
215215
'public' => $definition->isPublic(),
216216
'synthetic' => $definition->isSynthetic(),
217217
'lazy' => $definition->isLazy(),
218-
'synchronized' => $definition->isSynchronized(),
219-
'abstract' => $definition->isAbstract(),
220-
'file' => $definition->getFile(),
221218
);
219+
if (method_exists($definition, 'isSynchronized')) {
220+
$data['synchronized'] = $definition->isSynchronized();
221+
}
222+
223+
$data['abstract'] = $definition->isAbstract();
224+
$data['file'] = $definition->getFile();
222225

223226
if ($definition->getFactoryClass()) {
224227
$data['factory_class'] = $definition->getFactoryClass();

‎src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,13 @@ protected function describeContainerDefinition(Definition $definition, array $op
183183
."\n".'- Public: '.($definition->isPublic() ? 'yes' : 'no')
184184
."\n".'- Synthetic: '.($definition->isSynthetic() ? 'yes' : 'no')
185185
."\n".'- Lazy: '.($definition->isLazy() ? 'yes' : 'no')
186-
."\n".'- Synchronized: '.($definition->isSynchronized() ? 'yes' : 'no')
187-
."\n".'- Abstract: '.($definition->isAbstract() ? 'yes' : 'no');
186+
;
187+
188+
if (method_exists($definition, 'isSynchronized')) {
189+
$output .= "\n".'- Synchronized: '.($definition->isSynchronized() ? 'yes' : 'no');
190+
}
191+
192+
$output .= "\n".'- Abstract: '.($definition->isAbstract() ? 'yes' : 'no');
188193

189194
if ($definition->getFile()) {
190195
$output .= "\n".'- File: `'.$definition->getFile().'`';

‎src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,9 @@ protected function describeContainerDefinition(Definition $definition, array $op
265265
$description[] = sprintf('<comment>Public</comment> %s', $definition->isPublic() ? 'yes' : 'no');
266266
$description[] = sprintf('<comment>Synthetic</comment> %s', $definition->isSynthetic() ? 'yes' : 'no');
267267
$description[] = sprintf('<comment>Lazy</comment> %s', $definition->isLazy() ? 'yes' : 'no');
268-
$description[] = sprintf('<comment>Synchronized</comment> %s', $definition->isSynchronized() ? 'yes' : 'no');
268+
if (method_exists($definition, 'isSynchronized')) {
269+
$description[] = sprintf('<comment>Synchronized</comment> %s', $definition->isSynchronized() ? 'yes' : 'no');
270+
}
269271
$description[] = sprintf('<comment>Abstract</comment> %s', $definition->isAbstract() ? 'yes' : 'no');
270272

271273
if ($definition->getFile()) {

‎src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,9 @@ private function getContainerDefinitionDocument(Definition $definition, $id = nu
366366
$serviceXML->setAttribute('public', $definition->isPublic() ? 'true' : 'false');
367367
$serviceXML->setAttribute('synthetic', $definition->isSynthetic() ? 'true' : 'false');
368368
$serviceXML->setAttribute('lazy', $definition->isLazy() ? 'true' : 'false');
369-
$serviceXML->setAttribute('synchronized', $definition->isSynchronized() ? 'true' : 'false');
369+
if (method_exists($definition, 'isSynchronized')) {
370+
$serviceXML->setAttribute('synchronized', $definition->isSynchronized(false) ? 'true' : 'false');
371+
}
370372
$serviceXML->setAttribute('abstract', $definition->isAbstract() ? 'true' : 'false');
371373
$serviceXML->setAttribute('file', $definition->getFile());
372374

‎src/Symfony/Component/DependencyInjection/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+
2.7.0
5+
-----
6+
7+
* deprecated synchronized services
8+
49
2.6.0
510
-----
611

‎src/Symfony/Component/DependencyInjection/ContainerBuilder.php

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ public function set($id, $service, $scope = self::SCOPE_CONTAINER)
412412

413413
parent::set($id, $service, $scope);
414414

415-
if (isset($this->obsoleteDefinitions[$id]) && $this->obsoleteDefinitions[$id]->isSynchronized()) {
415+
if (isset($this->obsoleteDefinitions[$id]) && $this->obsoleteDefinitions[$id]->isSynchronized(false)) {
416416
$this->synchronize($id);
417417
}
418418
}
@@ -1121,9 +1121,15 @@ private function getProxyInstantiator()
11211121
* service by calling all methods referencing it.
11221122
*
11231123
* @param string $id A service id
1124+
*
1125+
* @deprecated since version 2.7, will be removed in 3.0.
11241126
*/
11251127
private function synchronize($id)
11261128
{
1129+
if ('request' !== $id) {
1130+
trigger_error('The '.__METHOD__.' method is deprecated in version 2.7 and will be removed in version 3.0.', E_USER_DEPRECATED);
1131+
}
1132+
11271133
foreach ($this->definitions as $definitionId => $definition) {
11281134
// only check initialized services
11291135
if (!$this->initialized($definitionId)) {

‎src/Symfony/Component/DependencyInjection/Definition.php

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -661,9 +661,15 @@ public function isPublic()
661661
* @return Definition The current instance
662662
*
663663
* @api
664+
*
665+
* @deprecated since version 2.7, will be removed in 3.0.
664666
*/
665-
public function setSynchronized($boolean)
667+
public function setSynchronized($boolean, $triggerDeprecationError = true)
666668
{
669+
if ($triggerDeprecationError) {
670+
trigger_error('The '.__METHOD__.' method is deprecated in version 2.7 and will be removed in version 3.0.', E_USER_DEPRECATED);
671+
}
672+
667673
$this->synchronized = (bool) $boolean;
668674

669675
return $this;
@@ -675,9 +681,15 @@ public function setSynchronized($boolean)
675681
* @return bool
676682
*
677683
* @api
684+
*
685+
* @deprecated since version 2.7, will be removed in 3.0.
678686
*/
679-
public function isSynchronized()
687+
public function isSynchronized($triggerDeprecationError = true)
680688
{
689+
if ($triggerDeprecationError) {
690+
trigger_error('The '.__METHOD__.' method is deprecated in version 2.7 and will be removed in version 3.0.', E_USER_DEPRECATED);
691+
}
692+
681693
return $this->synchronized;
682694
}
683695

‎src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -695,13 +695,19 @@ private function addServices()
695695
* @param Definition $definition A Definition instance
696696
*
697697
* @return string|null
698+
*
699+
* @deprecated since version 2.7, will be removed in 3.0.
698700
*/
699701
private function addServiceSynchronizer($id, Definition $definition)
700702
{
701-
if (!$definition->isSynchronized()) {
703+
if (!$definition->isSynchronized(false)) {
702704
return;
703705
}
704706

707+
if ('request' !== $id) {
708+
trigger_error('Synchronized services were deprecated in version 2.7 and won\'t work anymore in 3.0.', E_USER_DEPRECATED);
709+
}
710+
705711
$code = '';
706712
foreach ($this->container->getDefinitions() as $definitionId => $definition) {
707713
foreach ($definition->getMethodCalls() as $call) {

‎src/Symfony/Component/DependencyInjection/Dumper/XmlDumper.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ private function addService($definition, $id, \DOMElement $parent)
135135
if ($definition->isSynthetic()) {
136136
$service->setAttribute('synthetic', 'true');
137137
}
138-
if ($definition->isSynchronized()) {
138+
if ($definition->isSynchronized(false)) {
139139
$service->setAttribute('synchronized', 'true');
140140
}
141141
if ($definition->isLazy()) {

‎src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ private function addService($id, $definition)
103103
$code .= sprintf(" synthetic: true\n");
104104
}
105105

106-
if ($definition->isSynchronized()) {
106+
if ($definition->isSynchronized(false)) {
107107
$code .= sprintf(" synchronized: true\n");
108108
}
109109

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,13 +145,17 @@ private function parseDefinition($id, \DOMElement $service, $file)
145145
$definition = new Definition();
146146
}
147147

148-
foreach (array('class', 'scope', 'public', 'factory-class', 'factory-method', 'factory-service', 'synthetic', 'synchronized', 'lazy', 'abstract') as $key) {
148+
foreach (array('class', 'scope', 'public', 'factory-class', 'factory-method', 'factory-service', 'synthetic', 'lazy', 'abstract') as $key) {
149149
if ($value = $service->getAttribute($key)) {
150150
$method = 'set'.str_replace('-', '', $key);
151151
$definition->$method(XmlUtils::phpize($value));
152152
}
153153
}
154154

155+
if ($value = $service->getAttribute('synchronized')) {
156+
$definition->setSynchronized(XmlUtils::phpize($value), 'request' !== $id);
157+
}
158+
155159
if ($files = $this->getChildren($service, 'file')) {
156160
$definition->setFile($files[0]->nodeValue);
157161
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ private function parseDefinition($id, $service, $file)
171171
}
172172

173173
if (isset($service['synchronized'])) {
174-
$definition->setSynchronized($service['synchronized']);
174+
$definition->setSynchronized($service['synchronized'], 'request' !== $id);
175175
}
176176

177177
if (isset($service['lazy'])) {

‎src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -683,8 +683,10 @@ public function testNoExceptionWhenSetSyntheticServiceOnAFrozenContainer()
683683
$this->assertEquals($a, $container->get('a'));
684684
}
685685

686-
public function testSetOnSynchronizedService()
686+
public function testLegacySetOnSynchronizedService()
687687
{
688+
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
689+
688690
$container = new ContainerBuilder();
689691
$container->register('baz', 'BazClass')
690692
->setSynchronized(true)
@@ -700,8 +702,10 @@ public function testSetOnSynchronizedService()
700702
$this->assertSame($baz, $container->get('bar')->getBaz());
701703
}
702704

703-
public function testSynchronizedServiceWithScopes()
705+
public function testLegacySynchronizedServiceWithScopes()
704706
{
707+
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
708+
705709
$container = new ContainerBuilder();
706710
$container->addScope(new Scope('foo'));
707711
$container->register('baz', 'BazClass')

‎src/Symfony/Component/DependencyInjection/Tests/DefinitionTest.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,10 @@ public function testSetIsSynthetic()
167167
* @covers Symfony\Component\DependencyInjection\Definition::setSynchronized
168168
* @covers Symfony\Component\DependencyInjection\Definition::isSynchronized
169169
*/
170-
public function testSetIsSynchronized()
170+
public function testLegacySetIsSynchronized()
171171
{
172+
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
173+
172174
$def = new Definition('stdClass');
173175
$this->assertFalse($def->isSynchronized(), '->isSynchronized() returns false by default');
174176
$this->assertSame($def, $def->setSynchronized(true), '->setSynchronized() implements a fluent interface');

‎src/Symfony/Component/DependencyInjection/Tests/Dumper/PhpDumperTest.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,15 @@ public function testAddService()
124124
}
125125
}
126126

127+
public function testLegacySynchronizedServices()
128+
{
129+
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
130+
131+
$container = include self::$fixturesPath.'/containers/container20.php';
132+
$dumper = new PhpDumper($container);
133+
$this->assertEquals(str_replace('%path%', str_replace('\\', '\\\\', self::$fixturesPath.DIRECTORY_SEPARATOR.'includes'.DIRECTORY_SEPARATOR), file_get_contents(self::$fixturesPath.'/php/services20.php')), $dumper->dump(), '->dump() dumps services');
134+
}
135+
127136
public function testServicesWithAnonymousFactories()
128137
{
129138
$container = include self::$fixturesPath.'/containers/container19.php';

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/containers/container20.php

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
require_once __DIR__.'/../includes/classes.php';
4+
5+
use Symfony\Component\DependencyInjection\ContainerInterface;
6+
use Symfony\Component\DependencyInjection\ContainerBuilder;
7+
use Symfony\Component\DependencyInjection\Reference;
8+
9+
$container = new ContainerBuilder();
10+
$container
11+
->register('request', 'Request')
12+
->setSynchronized(true)
13+
;
14+
$container
15+
->register('depends_on_request', 'stdClass')
16+
->addMethodCall('setRequest', array(new Reference('request', ContainerInterface::NULL_ON_INVALID_REFERENCE, false)))
17+
;
18+
19+
return $container;

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/containers/container9.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,6 @@
7777
$container
7878
->register('request', 'Request')
7979
->setSynthetic(true)
80-
->setSynchronized(true)
81-
;
82-
$container
83-
->register('depends_on_request', 'stdClass')
84-
->addMethodCall('setRequest', array(new Reference('request', ContainerInterface::NULL_ON_INVALID_REFERENCE, false)))
8580
;
8681
$container
8782
->register('configurator_service', 'ConfClass')

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/graphviz/services9.dot

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ digraph sc {
1313
node_inlined [label="inlined\nBar\n", shape=record, fillcolor="#eeeeee", style="filled"];
1414
node_baz [label="baz\nBaz\n", shape=record, fillcolor="#eeeeee", style="filled"];
1515
node_request [label="request\nRequest\n", shape=record, fillcolor="#eeeeee", style="filled"];
16-
node_depends_on_request [label="depends_on_request\nstdClass\n", shape=record, fillcolor="#eeeeee", style="filled"];
1716
node_configurator_service [label="configurator_service\nConfClass\n", shape=record, fillcolor="#eeeeee", style="filled"];
1817
node_configured_service [label="configured_service\nstdClass\n", shape=record, fillcolor="#eeeeee", style="filled"];
1918
node_decorated [label="decorated\nstdClass\n", shape=record, fillcolor="#eeeeee", style="filled"];
@@ -38,6 +37,5 @@ digraph sc {
3837
node_foo_with_inline -> node_inlined [label="setBar()" style="dashed"];
3938
node_inlined -> node_baz [label="setBaz()" style="dashed"];
4039
node_baz -> node_foo_with_inline [label="setFoo()" style="dashed"];
41-
node_depends_on_request -> node_request [label="setRequest()" style="dashed"];
4240
node_configurator_service -> node_baz [label="setFoo()" style="dashed"];
4341
}

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services20.php

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
<?php
2+
3+
use Symfony\Component\DependencyInjection\ContainerInterface;
4+
use Symfony\Component\DependencyInjection\Container;
5+
use Symfony\Component\DependencyInjection\Exception\InactiveScopeException;
6+
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
7+
use Symfony\Component\DependencyInjection\Exception\LogicException;
8+
use Symfony\Component\DependencyInjection\Exception\RuntimeException;
9+
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
10+
11+
/**
12+
* ProjectServiceContainer
13+
*
14+
* This class has been auto-generated
15+
* by the Symfony Dependency Injection Component.
16+
*/
17+
class ProjectServiceContainer extends Container
18+
{
19+
private $parameters;
20+
private $targetDirs = array();
21+
22+
/**
23+
* Constructor.
24+
*/
25+
public function __construct()
26+
{
27+
parent::__construct();
28+
$this->methodMap = array(
29+
'depends_on_request' => 'getDependsOnRequestService',
30+
'request' => 'getRequestService',
31+
);
32+
}
33+
34+
/**
35+
* Gets the 'depends_on_request' service.
36+
*
37+
* This service is shared.
38+
* This method always returns the same instance of the service.
39+
*
40+
* @return \stdClass A stdClass instance.
41+
*/
42+
protected function getDependsOnRequestService()
43+
{
44+
$this->services['depends_on_request'] = $instance = new \stdClass();
45+
46+
$instance->setRequest($this->get('request', ContainerInterface::NULL_ON_INVALID_REFERENCE));
47+
48+
return $instance;
49+
}
50+
51+
/**
52+
* Gets the 'request' service.
53+
*
54+
* This service is shared.
55+
* This method always returns the same instance of the service.
56+
*
57+
* @return \Request A Request instance.
58+
*/
59+
protected function getRequestService()
60+
{
61+
return $this->services['request'] = new \Request();
62+
}
63+
64+
/**
65+
* Updates the 'request' service.
66+
*/
67+
protected function synchronizeRequestService()
68+
{
69+
if ($this->initialized('depends_on_request')) {
70+
$this->get('depends_on_request')->setRequest($this->get('request', ContainerInterface::NULL_ON_INVALID_REFERENCE));
71+
}
72+
}
73+
}

0 commit comments

Comments
 (0)