Skip to content

Commit 2bb49f1

Browse files
fabpotfabpot
committed
feature #58035 [DependencyInjection] Add support for key-type in XmlFileLoader (alexandre-daubois)
This PR was merged into the 7.2 branch. Discussion ---------- [DependencyInjection] Add support for `key-type` in `XmlFileLoader` | Q | A | ------------- | --- | Branch? | 7.2 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | Fix #45708 | License | MIT Quoting the tests to show how this works: ```xml <?xml version="1.0" encoding="utf-8"?> <container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd"> <services> <service id="foo" class="Symfony\Component\DependencyInjection\Tests\Fixtures\Bar"> <argument type="collection"> <argument key-type="constant" key="PHP_INT_MAX">Value 1</argument> <argument key="PHP_INT_MAX">Value 2</argument> <argument key-type="binary" key="AQID">Value 3</argument> </argument> </service> </services> </container> ``` Makes the following pass: ```php public function testArgumentKeyType() { // ... $definition = $container->getDefinition('foo'); $this->assertSame([ \PHP_INT_MAX => 'Value 1', 'PHP_INT_MAX' => 'Value 2', "\x01\x02\x03" => 'Value 3', ], $definition->getArgument(0)); } ``` Commits ------- bf2b02eb1c [DependencyInjection] Add support for `key-type` in `XmlFileLoader`
2 parents d23e0e8 + e362450 commit 2bb49f1

File tree

8 files changed

+115
-0
lines changed

8 files changed

+115
-0
lines changed

‎CHANGELOG.md

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

77
* Deprecate `!tagged` tag, use `!tagged_iterator` instead
88
* Add a `ContainerBuilder::registerChild()` shortcut method for registering child definitions
9+
* Add support for `key-type` in `XmlFileLoader`
910

1011
7.1
1112
---

‎Loader/XmlFileLoader.php

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -560,6 +560,21 @@ private function getArgumentsAsPhp(\DOMElement $node, string $name, string $file
560560
$key = $arg->getAttribute('key');
561561
}
562562

563+
switch ($arg->getAttribute('key-type')) {
564+
case 'binary':
565+
if (false === $key = base64_decode($key, true)) {
566+
throw new InvalidArgumentException(\sprintf('Tag "<%s>" with key-type="binary" does not have a valid base64 encoded key in "%s".', $name, $file));
567+
}
568+
break;
569+
case 'constant':
570+
try {
571+
$key = \constant(trim($key));
572+
} catch (\Error) {
573+
throw new InvalidArgumentException(\sprintf('The key "%s" is not a valid constant in "%s".', $key, $file));
574+
}
575+
break;
576+
}
577+
563578
$trim = $arg->hasAttribute('trim') && XmlUtils::phpize($arg->getAttribute('trim'));
564579
$onInvalid = $arg->getAttribute('on-invalid');
565580
$invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;

‎Loader/schema/dic/services/services-1.0.xsd

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,7 @@
270270
<xsd:element name="property" type="property" maxOccurs="unbounded" />
271271
<xsd:element name="service" type="service" />
272272
</xsd:choice>
273+
<xsd:attribute name="key-type" type="key_type" />
273274
<xsd:attribute name="type" type="argument_type" />
274275
<xsd:attribute name="id" type="xsd:string" />
275276
<xsd:attribute name="key" type="xsd:string" />
@@ -315,6 +316,7 @@
315316
<xsd:element name="service" type="service" />
316317
<xsd:element name="exclude" type="xsd:string" maxOccurs="unbounded" />
317318
</xsd:choice>
319+
<xsd:attribute name="key-type" type="key_type" />
318320
<xsd:attribute name="type" type="argument_type" />
319321
<xsd:attribute name="id" type="xsd:string" />
320322
<xsd:attribute name="key" type="xsd:string" />
@@ -365,6 +367,13 @@
365367
</xsd:restriction>
366368
</xsd:simpleType>
367369

370+
<xsd:simpleType name="key_type">
371+
<xsd:restriction base="xsd:string">
372+
<xsd:enumeration value="binary" />
373+
<xsd:enumeration value="constant" />
374+
</xsd:restriction>
375+
</xsd:simpleType>
376+
368377
<xsd:simpleType name="ignore_errors">
369378
<xsd:restriction base="xsd:string">
370379
<xsd:pattern value="(true|false|not_found)" />

‎Tests/Fixtures/xml/key_type_argument.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd">
3+
<services>
4+
<service id="foo" class="Symfony\Component\DependencyInjection\Tests\Fixtures\Bar">
5+
<argument type="collection">
6+
<argument key-type="constant" key="PHP_INT_MAX">Value 1</argument>
7+
<argument key="PHP_INT_MAX">Value 2</argument>
8+
<argument key-type="binary" key="AQID">Value 3</argument>
9+
</argument>
10+
</service>
11+
</services>
12+
</container>

‎Tests/Fixtures/xml/key_type_incorrect_bin.xml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd">
3+
<services>
4+
<service id="foo" class="Symfony\Component\DependencyInjection\Tests\Fixtures\Bar">
5+
<property key-type="binary" key="My_Key">Value 3</property>
6+
</service>
7+
</services>
8+
</container>

‎Tests/Fixtures/xml/key_type_property.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd">
3+
<services>
4+
<service id="foo" class="Symfony\Component\DependencyInjection\Tests\Fixtures\Bar">
5+
<property type="collection" key="quz">
6+
<property key-type="constant" key="PHP_INT_MAX">Value 1</property>
7+
<property key="PHP_INT_MAX">Value 2</property>
8+
<property key-type="binary" key="AQID">Value 3</property>
9+
</property>
10+
</service>
11+
</services>
12+
</container>

‎Tests/Fixtures/xml/key_type_wrong_constant.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd">
3+
<services>
4+
<service id="foo" class="Symfony\Component\DependencyInjection\Tests\Fixtures\Bar">
5+
<property type="collection" key="quz">
6+
<property key-type="constant" key="PHP_Unknown_CONST">Value 1</property>
7+
</property>
8+
</service>
9+
</services>
10+
</container>

‎Tests/Loader/XmlFileLoaderTest.php

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1284,6 +1284,54 @@ public function testStaticConstructorWithFactoryThrows()
12841284
$loader->load('static_constructor_and_factory.xml');
12851285
}
12861286

1287+
public function testArgumentKeyType()
1288+
{
1289+
$container = new ContainerBuilder();
1290+
$loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath.'/xml'));
1291+
$loader->load('key_type_argument.xml');
1292+
1293+
$definition = $container->getDefinition('foo');
1294+
$this->assertSame([
1295+
\PHP_INT_MAX => 'Value 1',
1296+
'PHP_INT_MAX' => 'Value 2',
1297+
"\x01\x02\x03" => 'Value 3',
1298+
], $definition->getArgument(0));
1299+
}
1300+
1301+
public function testPropertyKeyType()
1302+
{
1303+
$container = new ContainerBuilder();
1304+
$loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath.'/xml'));
1305+
$loader->load('key_type_property.xml');
1306+
1307+
$definition = $container->getDefinition('foo');
1308+
$this->assertSame([
1309+
\PHP_INT_MAX => 'Value 1',
1310+
'PHP_INT_MAX' => 'Value 2',
1311+
"\x01\x02\x03" => 'Value 3',
1312+
], $definition->getProperties()['quz']);
1313+
}
1314+
1315+
public function testInvalidBinaryKeyType()
1316+
{
1317+
$container = new ContainerBuilder();
1318+
$loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath.'/xml'));
1319+
1320+
$this->expectException(InvalidArgumentException::class);
1321+
$this->expectExceptionMessage(\sprintf('Tag "<property>" with key-type="binary" does not have a valid base64 encoded key in "%s".', self::$fixturesPath.'/xml/key_type_incorrect_bin.xml'));
1322+
$loader->load('key_type_incorrect_bin.xml');
1323+
}
1324+
1325+
public function testUnknownConstantAsKey()
1326+
{
1327+
$container = new ContainerBuilder();
1328+
$loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath.'/xml'));
1329+
1330+
$this->expectException(InvalidArgumentException::class);
1331+
$this->expectExceptionMessage(\sprintf('The key "PHP_Unknown_CONST" is not a valid constant in "%s".', self::$fixturesPath.'/xml/key_type_wrong_constant.xml'));
1332+
$loader->load('key_type_wrong_constant.xml');
1333+
}
1334+
12871335
/**
12881336
* @group legacy
12891337
*/

0 commit comments

Comments
 (0)