Skip to content

[DependencyInjection] Add the Required attribute #37545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/patch-types.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
case false !== strpos($file, '/src/Symfony/Component/Debug/Tests/Fixtures/'):
case false !== strpos($file, '/src/Symfony/Component/DependencyInjection/Tests/Compiler/OptionalServiceClass.php'):
case false !== strpos($file, '/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/autowiring_classes.php'):
case false !== strpos($file, '/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/autowiring_classes_80.php'):
case false !== strpos($file, '/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/uniontype_classes.php'):
case false !== strpos($file, '/src/Symfony/Component/DependencyInjection/Tests/Fixtures/ParentNotExists.php'):
case false !== strpos($file, '/src/Symfony/Component/DependencyInjection/Tests/Fixtures/Prototype/BadClasses/MissingParent.php'):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
namespace Symfony\Component\DependencyInjection\Compiler;

use Symfony\Component\DependencyInjection\Definition;
use Symfony\Contracts\Service\Attribute\Required;

/**
* Looks for definitions with autowiring enabled and registers their corresponding "@required" methods as setters.
Expand Down Expand Up @@ -49,6 +50,14 @@ protected function processValue($value, bool $isRoot = false)
}

while (true) {
if (\PHP_VERSION_ID >= 80000 && $r->getAttributes(Required::class)) {
if ($this->isWither($r, $r->getDocComment() ?: '')) {
$withers[] = [$r->name, [], true];
} else {
$value->addMethodCall($r->name, []);
}
break;
}
if (false !== $doc = $r->getDocComment()) {
if (false !== stripos($doc, '@required') && preg_match('#(?:^/\*\*|\n\s*+\*)\s*+@required(?:\s|\*/$)#i', $doc)) {
if ($this->isWither($reflectionMethod, $doc)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\TypedReference;
use Symfony\Contracts\Service\Attribute\Required;

/**
* Looks for definitions with autowiring enabled and registers their corresponding "@required" properties.
Expand Down Expand Up @@ -45,10 +46,9 @@ protected function processValue($value, bool $isRoot = false)
if (!($type = $reflectionProperty->getType()) instanceof \ReflectionNamedType) {
continue;
}
if (false === $doc = $reflectionProperty->getDocComment()) {
continue;
}
if (false === stripos($doc, '@required') || !preg_match('#(?:^/\*\*|\n\s*+\*)\s*+@required(?:\s|\*/$)#i', $doc)) {
if ((\PHP_VERSION_ID < 80000 || !$reflectionProperty->getAttributes(Required::class))
&& ((false === $doc = $reflectionProperty->getDocComment()) || false === stripos($doc, '@required') || !preg_match('#(?:^/\*\*|\n\s*+\*)\s*+@required(?:\s|\*/$)#i', $doc))
) {
continue;
}
if (\array_key_exists($name = $reflectionProperty->getName(), $properties)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
use Symfony\Component\DependencyInjection\Tests\Fixtures\includes\FooVariadic;
use Symfony\Component\DependencyInjection\Tests\Fixtures\includes\MultipleArgumentsOptionalScalarNotReallyOptional;
use Symfony\Component\DependencyInjection\TypedReference;
use Symfony\Contracts\Service\Attribute\Required;

require_once __DIR__.'/../Fixtures/includes/autowiring_classes.php';

Expand Down Expand Up @@ -640,6 +641,32 @@ public function testSetterInjection()
);
}

/**
* @requires PHP 8
*/
public function testSetterInjectionWithAttribute()
{
if (!class_exists(Required::class)) {
$this->markTestSkipped('symfony/service-contracts 2.2 required');
}

$container = new ContainerBuilder();
$container->register(Foo::class);

$container
->register('setter_injection', AutowireSetter::class)
->setAutowired(true);

(new ResolveClassPass())->process($container);
(new AutowireRequiredMethodsPass())->process($container);
(new AutowirePass())->process($container);

$methodCalls = $container->getDefinition('setter_injection')->getMethodCalls();
$this->assertCount(1, $methodCalls);
$this->assertSame('setFoo', $methodCalls[0][0]);
$this->assertSame(Foo::class, (string) $methodCalls[0][1][0]);
}

public function testWithNonExistingSetterAndAutowiring()
{
$this->expectException(RuntimeException::class);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use Symfony\Component\DependencyInjection\Compiler\ResolveClassPass;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Tests\Fixtures\WitherStaticReturnType;
use Symfony\Contracts\Service\Attribute\Required;

require_once __DIR__.'/../Fixtures/includes/autowiring_classes.php';

Expand Down Expand Up @@ -54,6 +55,29 @@ public function testSetterInjection()
$this->assertEquals([], $methodCalls[1][1]);
}

/**
* @requires PHP 8
*/
public function testSetterInjectionWithAttribute()
{
if (!class_exists(Required::class)) {
$this->markTestSkipped('symfony/service-contracts 2.2 required');
}

$container = new ContainerBuilder();
$container->register(Foo::class);

$container
->register('setter_injection', AutowireSetter::class)
->setAutowired(true);

(new ResolveClassPass())->process($container);
(new AutowireRequiredMethodsPass())->process($container);

$methodCalls = $container->getDefinition('setter_injection')->getMethodCalls();
$this->assertSame([['setFoo', []]], $methodCalls);
}

public function testExplicitMethodInjection()
{
$container = new ContainerBuilder();
Expand Down Expand Up @@ -124,4 +148,26 @@ public function testWitherWithStaticReturnTypeInjection()
];
$this->assertSame($expected, $methodCalls);
}

/**
* @requires PHP 8
*/
public function testWitherInjectionWithAttribute()
{
if (!class_exists(Required::class)) {
$this->markTestSkipped('symfony/service-contracts 2.2 required');
}

$container = new ContainerBuilder();
$container->register(Foo::class);

$container
->register('wither', AutowireWither::class)
->setAutowired(true);

(new ResolveClassPass())->process($container);
(new AutowireRequiredMethodsPass())->process($container);

$this->assertSame([['withFoo', [], true]], $container->getDefinition('wither')->getMethodCalls());
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use Symfony\Component\DependencyInjection\Compiler\AutowireRequiredPropertiesPass;
use Symfony\Component\DependencyInjection\Compiler\ResolveClassPass;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Contracts\Service\Attribute\Required;

require_once __DIR__.'/../Fixtures/includes/autowiring_classes.php';

Expand Down Expand Up @@ -43,4 +44,28 @@ public function testInjection()
$this->assertArrayHasKey('plop', $properties);
$this->assertEquals(Bar::class, (string) $properties['plop']);
}

/**
* @requires PHP 8
*/
public function testAttribute()
{
if (!class_exists(Required::class)) {
$this->markTestSkipped('symfony/service-contracts 2.2 required');
}

$container = new ContainerBuilder();
$container->register(Foo::class);

$container->register('property_injection', AutowireProperty::class)
->setAutowired(true);

(new ResolveClassPass())->process($container);
(new AutowireRequiredPropertiesPass())->process($container);

$properties = $container->getDefinition('property_injection')->getProperties();

$this->assertArrayHasKey('foo', $properties);
$this->assertEquals(Foo::class, (string) $properties['foo']);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

if (PHP_VERSION_ID >= 80000) {
require __DIR__.'/uniontype_classes.php';
require __DIR__.'/autowiring_classes_80.php';
}

class Foo
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

namespace Symfony\Component\DependencyInjection\Tests\Compiler;

use Symfony\Contracts\Service\Attribute\Required;

class AutowireSetter
{
#[Required]
public function setFoo(Foo $foo): void
{
}
}

class AutowireWither
{
#[Required]
public function withFoo(Foo $foo): static
{
return $this;
}
}

class AutowireProperty
{
#[Required]
public Foo $foo;
}
2 changes: 1 addition & 1 deletion src/Symfony/Contracts/Cache/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"minimum-stability": "dev",
"extra": {
"branch-alias": {
"dev-master": "2.1-dev"
"dev-master": "2.2-dev"
},
"thanks": {
"name": "symfony/contracts",
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Contracts/Deprecation/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"minimum-stability": "dev",
"extra": {
"branch-alias": {
"dev-master": "2.1-dev"
"dev-master": "2.2-dev"
},
"thanks": {
"name": "symfony/contracts",
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Contracts/EventDispatcher/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"minimum-stability": "dev",
"extra": {
"branch-alias": {
"dev-master": "2.1-dev"
"dev-master": "2.2-dev"
},
"thanks": {
"name": "symfony/contracts",
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Contracts/HttpClient/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"minimum-stability": "dev",
"extra": {
"branch-alias": {
"dev-master": "2.1-dev"
"dev-master": "2.2-dev"
},
"thanks": {
"name": "symfony/contracts",
Expand Down
27 changes: 27 additions & 0 deletions src/Symfony/Contracts/Service/Attribute/Required.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Contracts\Service\Attribute;

use Attribute;

/**
* A required dependency.
*
* This attribute indicates that a property holds a required dependency. The annotated property or method should be
* considered during the instantiation process of the containing class.
*
* @author Alexander M. Turek <me@derrabus.de>
*/
#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_PROPERTY)]
final class Required
{
}
2 changes: 1 addition & 1 deletion src/Symfony/Contracts/Service/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"minimum-stability": "dev",
"extra": {
"branch-alias": {
"dev-master": "2.1-dev"
"dev-master": "2.2-dev"
},
"thanks": {
"name": "symfony/contracts",
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Contracts/Translation/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"minimum-stability": "dev",
"extra": {
"branch-alias": {
"dev-master": "2.1-dev"
"dev-master": "2.2-dev"
},
"thanks": {
"name": "symfony/contracts",
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Contracts/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"minimum-stability": "dev",
"extra": {
"branch-alias": {
"dev-master": "2.1-dev"
"dev-master": "2.2-dev"
}
}
}