Remove the default values from setters with a nullable parameter.

derrabus · derrabus · commit 729ead492830 · 2020-11-05T01:12:58.000+01:00
diff --git a/UPGRADE-5.3.md b/UPGRADE-5.3.md
@@ -0,0 +1,14 @@
+UPGRADE FROM 5.2 to 5.3
+=======================
+
+DependencyInjection
+-------------------
+
+ * The signature of `ContainerAwareInterface::setContainer()` has been updated to `setContainer(?ContainerInterface $container)`. When calling an implementation of this interface, explicitly pass `null` if you want to unset the container.
+ * Calling `ContainerAwareTrait::setContainer()` without arguments is deprecated. Please explicitly pass `null` if you want to unset the container.
+
+Security
+-------------------
+
+ * The signature of `TokenStorageInterface::setToken()` has been updated to `setToken(?TokenInterface $token)`. When calling an implementation of this interface, explicitly pass `null` if you want to unset the token.
+ * Calling `TokenStorage::setToken()` or `UsageTrackingTokenStorage::setToken()` without arguments is deprecated. Please explicitly pass `null` if you want to unset the token.
diff --git a/UPGRADE-6.0.md b/UPGRADE-6.0.md
@@ -26,7 +26,8 @@ DependencyInjection
  * Removed `Alias::getDeprecationMessage()`, use `Alias::getDeprecation()` instead.
  * The `inline()` function from the PHP-DSL has been removed, use `inline_service()` instead.
  * The `ref()` function from the PHP-DSL has been removed, use `service()` instead.
- * Removed `Definition::setPrivate()` and `Alias::setPrivate()`, use `setPublic()` instead
+ * Removed `Definition::setPrivate()` and `Alias::setPrivate()`, use `setPublic()` instead.
+ * The signatures of `ContainerAwareInterface::setContainer()` and `ContainerAwareTrait::setContainer()` have been updated to `setContainer(?ContainerInterface $container)`. When calling an implementation of this interface, explicitly pass `null` if you want to unset the container.
 
 Dotenv
 ------
@@ -153,6 +154,7 @@ Security
    in `PreAuthenticatedToken`, `RememberMeToken`, `SwitchUserToken`, `UsernamePasswordToken`,
    `DefaultAuthenticationSuccessHandler`.
  * Removed the `AbstractRememberMeServices::$providerKey` property in favor of `AbstractRememberMeServices::$firewallName`
+ * The signatures of `TokenStorageInterface::setToken()`, `TokenStorage::setToken()` and `UsageTrackingTokenStorage::setToken()` have been updated to `setToken(?TokenInterface $token)`. When calling an implementation of this interface, explicitly pass `null` if you want to unset the token.
 
 TwigBundle
 ----------
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+5.3.0
+-----
+
+* changed the signature of `ContainerAwareInterface::setContainer()` to `setContainer(?ContainerInterface $container)`
+* deprecated calling `ContainerAwareTrait::setContainer()` without arguments
+
 5.2.0
 -----
 
diff --git a/src/Symfony/Component/DependencyInjection/ContainerAwareInterface.php b/src/Symfony/Component/DependencyInjection/ContainerAwareInterface.php
@@ -21,5 +21,5 @@ interface ContainerAwareInterface
     /**
      * Sets the container.
      */
-    public function setContainer(ContainerInterface $container = null);
+    public function setContainer(?ContainerInterface $container);
 }
diff --git a/src/Symfony/Component/DependencyInjection/ContainerAwareTrait.php b/src/Symfony/Component/DependencyInjection/ContainerAwareTrait.php
@@ -25,6 +25,10 @@ trait ContainerAwareTrait
 
     public function setContainer(ContainerInterface $container = null)
     {
+        if (1 > \func_num_args()) {
+            trigger_deprecation('symfony/dependency-injection', '5.3', 'Calling "%s::%s" without any arguments is deprecated. Please explicitly pass null if you want to unset the container.', static::class, __FUNCTION__);
+        }
+
         $this->container = $container;
     }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/ContainerAwareTraitTest.php b/src/Symfony/Component/DependencyInjection/Tests/ContainerAwareTraitTest.php
@@ -0,0 +1,64 @@
+<?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\Component\DependencyInjection\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
+use Symfony\Component\DependencyInjection\ContainerAwareInterface;
+use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+class ContainerAwareTraitTest extends TestCase
+{
+    use ExpectDeprecationTrait;
+
+    /**
+     * @group legacy
+     */
+    public function testSetContainerLegacy()
+    {
+        $container = $this->createMock(ContainerInterface::class);
+
+        $dummy = new ContainerAwareDummy();
+        $dummy->setContainer($container);
+
+        self::assertSame($container, $dummy->getContainer());
+
+        $this->expectDeprecation('Since symfony/dependency-injection 5.3: Calling "Symfony\Component\DependencyInjection\Tests\ContainerAwareDummy::setContainer" without any arguments is deprecated. Please explicitly pass null if you want to unset the container.');
+
+        $dummy->setContainer();
+        self::assertNull($dummy->getContainer());
+    }
+
+    public function testSetContainer()
+    {
+        $container = $this->createMock(ContainerInterface::class);
+
+        $dummy = new ContainerAwareDummy();
+        $dummy->setContainer($container);
+
+        self::assertSame($container, $dummy->getContainer());
+
+        $dummy->setContainer(null);
+        self::assertNull($dummy->getContainer());
+    }
+}
+
+class ContainerAwareDummy implements ContainerAwareInterface
+{
+    use ContainerAwareTrait;
+
+    public function getContainer(): ?ContainerInterface
+    {
+        return $this->container;
+    }
+}
diff --git a/src/Symfony/Component/Security/CHANGELOG.md b/src/Symfony/Component/Security/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+5.3.0
+-----
+
+ * Changed the signature of `TokenStorageInterface::setToken()` to `setToken(?TokenInterface $token)`
+ * Deprecated calling `TokenStorage::setToken()` or `UsageTrackingTokenStorage::setToken()` without arguments
+
 5.2.0
 -----
 
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/Storage/TokenStorage.php b/src/Symfony/Component/Security/Core/Authentication/Token/Storage/TokenStorage.php
@@ -45,6 +45,10 @@ public function getToken()
      */
     public function setToken(TokenInterface $token = null)
     {
+        if (1 > \func_num_args()) {
+            trigger_deprecation('symfony/security-core', '5.3', 'Calling "%s" without any arguments is deprecated. Please explicitly pass null if you want to unset the token.', __METHOD__);
+        }
+
         if ($token) {
             // ensure any initializer is called
             $this->getToken();
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/Storage/TokenStorageInterface.php b/src/Symfony/Component/Security/Core/Authentication/Token/Storage/TokenStorageInterface.php
@@ -32,5 +32,5 @@ public function getToken();
      *
      * @param TokenInterface $token A TokenInterface token, or null if no further authentication information should be stored
      */
-    public function setToken(TokenInterface $token = null);
+    public function setToken(?TokenInterface $token);
 }
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/Storage/UsageTrackingTokenStorage.php b/src/Symfony/Component/Security/Core/Authentication/Token/Storage/UsageTrackingTokenStorage.php
@@ -51,6 +51,10 @@ public function getToken(): ?TokenInterface
      */
     public function setToken(TokenInterface $token = null): void
     {
+        if (1 > \func_num_args()) {
+            trigger_deprecation('symfony/security-core', '5.3', 'Calling "%s" without any arguments is deprecated. Please explicitly pass null if you want to unset the token.', __METHOD__);
+        }
+
         $this->storage->setToken($token);
 
         if ($token && $this->enableUsageTracking) {
diff --git a/src/Symfony/Component/Security/Core/Tests/Authentication/Token/Storage/TokenStorageTest.php b/src/Symfony/Component/Security/Core/Tests/Authentication/Token/Storage/TokenStorageTest.php
@@ -12,17 +12,38 @@
 namespace Symfony\Component\Security\Core\Tests\Authentication\Token\Storage;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
 use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
 
 class TokenStorageTest extends TestCase
 {
+    use ExpectDeprecationTrait;
+
+    /**
+     * @group legacy
+     */
+    public function testGetSetTokenLegacy()
+    {
+        $tokenStorage = new TokenStorage();
+        $token = new UsernamePasswordToken('username', 'password', 'provider');
+        $tokenStorage->setToken($token);
+        $this->assertSame($token, $tokenStorage->getToken());
+
+        $this->expectDeprecation('Since symfony/security-core 5.3: Calling "Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage::setToken" without any arguments is deprecated. Please explicitly pass null if you want to unset the token.');
+
+        $tokenStorage->setToken();
+        $this->assertNull($tokenStorage->getToken());
+    }
+
     public function testGetSetToken()
     {
         $tokenStorage = new TokenStorage();
         $this->assertNull($tokenStorage->getToken());
         $token = new UsernamePasswordToken('username', 'password', 'provider');
         $tokenStorage->setToken($token);
         $this->assertSame($token, $tokenStorage->getToken());
+        $tokenStorage->setToken(null);
+        $this->assertNull($tokenStorage->getToken());
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,5 @@ interface ContainerAwareInterface`
`21`	`21`	`/**`
`22`	`22`	`* Sets the container.`
`23`	`23`	`*/`
`24`		`- public function setContainer(ContainerInterface $container = null);`
	`24`	`+ public function setContainer(?ContainerInterface $container);`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,10 @@ trait ContainerAwareTrait`
`25`	`25`
`26`	`26`	`public function setContainer(ContainerInterface $container = null)`
`27`	`27`	`{`
	`28`	`+ if (1 > \func_num_args()) {`
	`29`	`+ trigger_deprecation('symfony/dependency-injection', '5.3', 'Calling "%s::%s" without any arguments is deprecated. Please explicitly pass null if you want to unset the container.', static::class, __FUNCTION__);`
	`30`	`+ }`
	`31`	`+`
`28`	`32`	`$this->container = $container;`
`29`	`33`	`}`
`30`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,5 +32,5 @@ public function getToken();`
`32`	`32`	`*`
`33`	`33`	`* @param TokenInterface $token A TokenInterface token, or null if no further authentication information should be stored`
`34`	`34`	`*/`
`35`		`- public function setToken(TokenInterface $token = null);`
	`35`	`+ public function setToken(?TokenInterface $token);`
`36`	`36`	`}`