minor #31866 [Routing] revert deprecation of Serializable in routing (Tobion)

Tobion · Tobion · commit 3242392b1b01 · 2019-06-05T13:36:12.000+02:00
This PR was merged into the 4.3 branch. Discussion ---------- [Routing] revert deprecation of Serializable in routing | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | no | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | | License | MIT | Doc PR | we still need to implement Serializable as long as we support PHP < 7.4. otherwise serialized data in php 7.2 would not work anymore when people upgrade to php 7.4. see discussion in #31792 (comment) partly reverts #30286 Commits ------- d32a295 [Routing] revert deprecation of Serializable in routing
diff --git a/UPGRADE-4.3.md b/UPGRADE-4.3.md
@@ -121,8 +121,9 @@ Routing
 
  * The `generator_base_class`, `generator_cache_class`, `matcher_base_class`, and `matcher_cache_class` router
    options have been deprecated.
- * Implementing `Serializable` for `Route` and `CompiledRoute` is deprecated; if you serialize them, please
-   ensure your unserialization logic can recover from a failure related to an updated serialization format
+ * `Serializable` implementing methods for `Route` and `CompiledRoute` are marked as `@internal` and `@final`.
+   Instead of overwriting them, use `__serialize` and `__unserialize` as extension points which are forward compatible
+   with the new serialization methods in PHP 7.4.
 
 Security
 --------
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -282,8 +282,9 @@ Routing
 
  * The `generator_base_class`, `generator_cache_class`, `matcher_base_class`, and `matcher_cache_class` router
    options have been removed.
- * `Route` and `CompiledRoute` don't implement `Serializable` anymore; if you serialize them, please
-   ensure your unserialization logic can recover from a failure related to an updated serialization format
+ * `Serializable` implementing methods for `Route` and `CompiledRoute` are final.
+   Instead of overwriting them, use `__serialize` and `__unserialize` as extension points which are forward compatible
+   with the new serialization methods in PHP 7.4.
 
 Security
 --------
diff --git a/src/Symfony/Component/Routing/CHANGELOG.md b/src/Symfony/Component/Routing/CHANGELOG.md
@@ -8,8 +8,9 @@ CHANGELOG
  * added `CompiledUrlGenerator` and `CompiledUrlGeneratorDumper`
  * deprecated `PhpGeneratorDumper` and `PhpMatcherDumper`
  * deprecated `generator_base_class`, `generator_cache_class`, `matcher_base_class` and `matcher_cache_class` router options
- * deprecated implementing `Serializable` for `Route` and `CompiledRoute`; if you serialize them, please
-   ensure your unserialization logic can recover from a failure related to an updated serialization format
+ * `Serializable` implementing methods for `Route` and `CompiledRoute` are marked as `@internal` and `@final`.
+   Instead of overwriting them, use `__serialize` and `__unserialize` as extension points which are forward compatible
+   with the new serialization methods in PHP 7.4.
  * exposed `utf8` Route option, defaults "locale" and "format" in configuration loaders and configurators
  * added support for invokable route loader services
 
diff --git a/src/Symfony/Component/Routing/CompiledRoute.php b/src/Symfony/Component/Routing/CompiledRoute.php
@@ -64,7 +64,8 @@ public function __serialize(): array
     }
 
     /**
-     * @internal since Symfony 4.3, will be removed in Symfony 5 as the class won't implement Serializable anymore
+     * @internal since Symfony 4.3
+     * @final since Symfony 4.3
      */
     public function serialize()
     {
@@ -84,7 +85,8 @@ public function __unserialize(array $data): void
     }
 
     /**
-     * @internal since Symfony 4.3, will be removed in Symfony 5 as the class won't implement Serializable anymore
+     * @internal since Symfony 4.3
+     * @final since Symfony 4.3
      */
     public function unserialize($serialized)
     {
diff --git a/src/Symfony/Component/Routing/Route.php b/src/Symfony/Component/Routing/Route.php
@@ -78,7 +78,8 @@ public function __serialize(): array
     }
 
     /**
-     * @internal since Symfony 4.3, will be removed in Symfony 5 as the class won't implement Serializable anymore
+     * @internal since Symfony 4.3
+     * @final since Symfony 4.3
      */
     public function serialize()
     {
@@ -104,7 +105,8 @@ public function __unserialize(array $data): void
     }
 
     /**
-     * @internal since Symfony 4.3, will be removed in Symfony 5 as the class won't implement Serializable anymore
+     * @internal since Symfony 4.3
+     * @final since Symfony 4.3
      */
     public function unserialize($serialized)
     {

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,8 @@ public function __serialize(): array`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`/**`
`67`		`- * @internal since Symfony 4.3, will be removed in Symfony 5 as the class won't implement Serializable anymore`
	`67`	`+ * @internal since Symfony 4.3`
	`68`	`+ * @final since Symfony 4.3`
`68`	`69`	`*/`
`69`	`70`	`public function serialize()`
`70`	`71`	`{`
`@@ -84,7 +85,8 @@ public function __unserialize(array $data): void`
`84`	`85`	`}`
`85`	`86`
`86`	`87`	`/**`
`87`		`- * @internal since Symfony 4.3, will be removed in Symfony 5 as the class won't implement Serializable anymore`
	`88`	`+ * @internal since Symfony 4.3`
	`89`	`+ * @final since Symfony 4.3`
`88`	`90`	`*/`
`89`	`91`	`public function unserialize($serialized)`
`90`	`92`	`{`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,8 @@ public function __serialize(): array`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`/**`
`81`		`- * @internal since Symfony 4.3, will be removed in Symfony 5 as the class won't implement Serializable anymore`
	`81`	`+ * @internal since Symfony 4.3`
	`82`	`+ * @final since Symfony 4.3`
`82`	`83`	`*/`
`83`	`84`	`public function serialize()`
`84`	`85`	`{`
`@@ -104,7 +105,8 @@ public function __unserialize(array $data): void`
`104`	`105`	`}`
`105`	`106`
`106`	`107`	`/**`
`107`		`- * @internal since Symfony 4.3, will be removed in Symfony 5 as the class won't implement Serializable anymore`
	`108`	`+ * @internal since Symfony 4.3`
	`109`	`+ * @final since Symfony 4.3`
`108`	`110`	`*/`
`109`	`111`	`public function unserialize($serialized)`
`110`	`112`	`{`