trigger some deprecations for legacy methods

xabbuh · xabbuh · commit 600c817ad48e · 2017-11-23T12:02:13.000+01:00
diff --git a/UPGRADE-4.1.md b/UPGRADE-4.1.md
@@ -0,0 +1,18 @@
+UPGRADE FROM 4.0 to 4.1
+=======================
+
+Security
+--------
+
+ * the `ContextListener::setLogoutOnUserChange()` method is deprecated and will be removed in 5.0
+
+SecurityBundle
+--------------
+
+ * The `logout_on_user_change` firewall option is deprecated and will be removed in 5.0.
+
+Translation
+-----------
+
+ * the `FileDumper::setBackup()` method is deprecated and will be removed in 5.0
+ * the `TranslationWriter::disableBackup()` method is deprecated and will be removed in 5.0
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -0,0 +1,18 @@
+UPGRADE FROM 4.x to 5.0
+=======================
+
+Security
+--------
+
+ * the `ContextListener::setLogoutOnUserChange()` method has been removed
+
+SecurityBundle
+--------------
+
+ * The `logout_on_user_change` firewall option has been removed.
+
+Translation
+-----------
+
+ * the `FileDumper::setBackup()` method has been removed
+ * the `TranslationWriter::disableBackup()` method has been removed
diff --git a/src/Symfony/Component/Security/CHANGELOG.md b/src/Symfony/Component/Security/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.1.0
+-----
+
+ * the `ContextListener::setLogoutOnUserChange()` method is deprecated and will be removed in 5.0
+
 4.0.0
 -----
 
diff --git a/src/Symfony/Component/Security/Http/Firewall/ContextListener.php b/src/Symfony/Component/Security/Http/Firewall/ContextListener.php
@@ -46,8 +46,8 @@ class ContextListener implements ListenerInterface
     private $logoutOnUserChange = true;
 
     /**
-     * @param TokenStorageInterface                     $tokenStorage
-     * @param iterable|UserProviderInterface[]          $userProviders
+     * @param TokenStorageInterface            $tokenStorage
+     * @param iterable|UserProviderInterface[] $userProviders
      */
     public function __construct(TokenStorageInterface $tokenStorage, iterable $userProviders, string $contextKey, LoggerInterface $logger = null, EventDispatcherInterface $dispatcher = null, AuthenticationTrustResolverInterface $trustResolver = null)
     {
@@ -67,10 +67,12 @@ public function __construct(TokenStorageInterface $tokenStorage, iterable $userP
      * Enables deauthentication during refreshUser when the user has changed.
      *
      * @param bool $logoutOnUserChange
+     *
+     * @deprecated since version 4.1, to be removed in 5.0
      */
     public function setLogoutOnUserChange($logoutOnUserChange)
     {
-        // no-op, method to be deprecated in 4.1
+        @trigger_error(sprintf('The %s() method is deprecated since 4.1 and will be removed in 5.0.', __METHOD__), E_USER_DEPRECATED);
     }
 
     /**
diff --git a/src/Symfony/Component/Translation/CHANGELOG.md b/src/Symfony/Component/Translation/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+4.1.0
+-----
+
+ * the `FileDumper::setBackup()` method is deprecated and will be removed in 5.0
+ * the `TranslationWriter::disableBackup()` method is deprecated and will be removed in 5.0
+
 4.0.0
 -----
 
diff --git a/src/Symfony/Component/Translation/Dumper/FileDumper.php b/src/Symfony/Component/Translation/Dumper/FileDumper.php
@@ -46,15 +46,16 @@ public function setRelativePathTemplate($relativePathTemplate)
      * Sets backup flag.
      *
      * @param bool
+     *
+     * @deprecated since version 4.1, to be removed in 5.0
      */
     public function setBackup($backup)
     {
+        @trigger_error(sprintf('The %s() method is deprecated since 4.1 and will be removed in 5.0.', __METHOD__), E_USER_DEPRECATED);
+
         if (false !== $backup) {
             throw new \LogicException('The backup feature is no longer supported.');
         }
-
-        // the method is only present to not break BC
-        // to be deprecated in 4.1
     }
 
     /**
diff --git a/src/Symfony/Component/Translation/Tests/Writer/TranslationWriterTest.php b/src/Symfony/Component/Translation/Tests/Writer/TranslationWriterTest.php
@@ -30,6 +30,9 @@ public function testWrite()
         $writer->write(new MessageCatalogue('en'), 'test');
     }
 
+    /**
+     * @group legacy
+     */
     public function testDisableBackup()
     {
         $nonBackupDumper = new NonBackupDumper();
diff --git a/src/Symfony/Component/Translation/Writer/TranslationWriter.php b/src/Symfony/Component/Translation/Writer/TranslationWriter.php
@@ -38,10 +38,13 @@ public function addDumper($format, DumperInterface $dumper)
 
     /**
      * Disables dumper backup.
+     *
+     * @deprecated since version 4.1, to be removed in 5.0
      */
     public function disableBackup()
     {
-        // to be deprecated in 4.1
+        @trigger_error(sprintf('The %s() method is deprecated since 4.1 and will be removed in 5.0.', __METHOD__), E_USER_DEPRECATED);
+
         foreach ($this->dumpers as $dumper) {
             if (method_exists($dumper, 'setBackup')) {
                 $dumper->setBackup(false);

Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,8 @@ class ContextListener implements ListenerInterface`
`46`	`46`	`private $logoutOnUserChange = true;`
`47`	`47`
`48`	`48`	`/**`
`49`		`- * @param TokenStorageInterface $tokenStorage`
`50`		`- * @param iterable\|UserProviderInterface[] $userProviders`
	`49`	`+ * @param TokenStorageInterface $tokenStorage`
	`50`	`+ * @param iterable\|UserProviderInterface[] $userProviders`
`51`	`51`	`*/`
`52`	`52`	`public function __construct(TokenStorageInterface $tokenStorage, iterable $userProviders, string $contextKey, LoggerInterface $logger = null, EventDispatcherInterface $dispatcher = null, AuthenticationTrustResolverInterface $trustResolver = null)`
`53`	`53`	`{`
`@@ -67,10 +67,12 @@ public function __construct(TokenStorageInterface $tokenStorage, iterable $userP`
`67`	`67`	`* Enables deauthentication during refreshUser when the user has changed.`
`68`	`68`	`*`
`69`	`69`	`* @param bool $logoutOnUserChange`
	`70`	`+ *`
	`71`	`+ * @deprecated since version 4.1, to be removed in 5.0`
`70`	`72`	`*/`
`71`	`73`	`public function setLogoutOnUserChange($logoutOnUserChange)`
`72`	`74`	`{`
`73`		`- // no-op, method to be deprecated in 4.1`
	`75`	`+ @trigger_error(sprintf('The %s() method is deprecated since 4.1 and will be removed in 5.0.', __METHOD__), E_USER_DEPRECATED);`
`74`	`76`	`}`
`75`	`77`
`76`	`78`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -46,15 +46,16 @@ public function setRelativePathTemplate($relativePathTemplate)`
`46`	`46`	`* Sets backup flag.`
`47`	`47`	`*`
`48`	`48`	`* @param bool`
	`49`	`+ *`
	`50`	`+ * @deprecated since version 4.1, to be removed in 5.0`
`49`	`51`	`*/`
`50`	`52`	`public function setBackup($backup)`
`51`	`53`	`{`
	`54`	`+ @trigger_error(sprintf('The %s() method is deprecated since 4.1 and will be removed in 5.0.', __METHOD__), E_USER_DEPRECATED);`
	`55`	`+`
`52`	`56`	`if (false !== $backup) {`
`53`	`57`	`throw new \LogicException('The backup feature is no longer supported.');`
`54`	`58`	`}`
`55`		`-`
`56`		`- // the method is only present to not break BC`
`57`		`- // to be deprecated in 4.1`
`58`	`59`	`}`
`59`	`60`
`60`	`61`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,9 @@ public function testWrite()`
`30`	`30`	`$writer->write(new MessageCatalogue('en'), 'test');`
`31`	`31`	`}`
`32`	`32`
	`33`	`+ /**`
	`34`	`+ * @group legacy`
	`35`	`+ */`
`33`	`36`	`public function testDisableBackup()`
`34`	`37`	`{`
`35`	`38`	`$nonBackupDumper = new NonBackupDumper();`