From 7b9d73d891cee0349c9a14cb824ea16e0346120a Mon Sep 17 00:00:00 2001 From: Nicolas Grekas Date: Wed, 30 Jan 2019 10:03:33 +0100 Subject: [PATCH] Mark some/most implementations of Serializable as `@internal` --- .../Component/Config/Resource/ClassExistenceResource.php | 4 ++-- .../Component/Config/Resource/ComposerResource.php | 6 ++++++ .../Component/Config/Resource/DirectoryResource.php | 6 ++++++ .../Component/Config/Resource/FileExistenceResource.php | 4 ++-- src/Symfony/Component/Config/Resource/FileResource.php | 6 ++++++ src/Symfony/Component/Config/Resource/GlobResource.php | 6 ++++++ .../Component/Config/Resource/ReflectionClassResource.php | 6 ++++++ .../Config/AutowireServiceResource.php | 6 ++++++ .../Config/ContainerParametersResource.php | 4 ++-- src/Symfony/Component/Form/FormError.php | 8 ++------ .../Component/HttpKernel/Config/EnvParametersResource.php | 6 ++++++ .../Component/HttpKernel/DataCollector/DataCollector.php | 6 ++++++ .../Component/HttpKernel/Debug/FileLinkFormatter.php | 6 ++++++ src/Symfony/Component/Validator/Constraint.php | 4 +--- 14 files changed, 63 insertions(+), 15 deletions(-) diff --git a/src/Symfony/Component/Config/Resource/ClassExistenceResource.php b/src/Symfony/Component/Config/Resource/ClassExistenceResource.php index 9f904a881e..273f262f16 100644 --- a/src/Symfony/Component/Config/Resource/ClassExistenceResource.php +++ b/src/Symfony/Component/Config/Resource/ClassExistenceResource.php @@ -97,7 +97,7 @@ class ClassExistenceResource implements SelfCheckingResourceInterface, \Serializ } /** - * {@inheritdoc} + * @internal */ public function serialize() { @@ -109,7 +109,7 @@ class ClassExistenceResource implements SelfCheckingResourceInterface, \Serializ } /** - * {@inheritdoc} + * @internal */ public function unserialize($serialized) { diff --git a/src/Symfony/Component/Config/Resource/ComposerResource.php b/src/Symfony/Component/Config/Resource/ComposerResource.php index 85ac555295..c826d1bb75 100644 --- a/src/Symfony/Component/Config/Resource/ComposerResource.php +++ b/src/Symfony/Component/Config/Resource/ComposerResource.php @@ -51,11 +51,17 @@ class ComposerResource implements SelfCheckingResourceInterface, \Serializable return self::$runtimeVendors === $this->vendors; } + /** + * @internal + */ public function serialize() { return serialize($this->vendors); } + /** + * @internal + */ public function unserialize($serialized) { $this->vendors = unserialize($serialized); diff --git a/src/Symfony/Component/Config/Resource/DirectoryResource.php b/src/Symfony/Component/Config/Resource/DirectoryResource.php index 7b314dd9b0..e79b19ec2d 100644 --- a/src/Symfony/Component/Config/Resource/DirectoryResource.php +++ b/src/Symfony/Component/Config/Resource/DirectoryResource.php @@ -104,11 +104,17 @@ class DirectoryResource implements SelfCheckingResourceInterface, \Serializable return true; } + /** + * @internal + */ public function serialize() { return serialize([$this->resource, $this->pattern]); } + /** + * @internal + */ public function unserialize($serialized) { list($this->resource, $this->pattern) = unserialize($serialized); diff --git a/src/Symfony/Component/Config/Resource/FileExistenceResource.php b/src/Symfony/Component/Config/Resource/FileExistenceResource.php index cbdf1b0c5a..34047651b7 100644 --- a/src/Symfony/Component/Config/Resource/FileExistenceResource.php +++ b/src/Symfony/Component/Config/Resource/FileExistenceResource.php @@ -59,7 +59,7 @@ class FileExistenceResource implements SelfCheckingResourceInterface, \Serializa } /** - * {@inheritdoc} + * @internal */ public function serialize() { @@ -67,7 +67,7 @@ class FileExistenceResource implements SelfCheckingResourceInterface, \Serializa } /** - * {@inheritdoc} + * @internal */ public function unserialize($serialized) { diff --git a/src/Symfony/Component/Config/Resource/FileResource.php b/src/Symfony/Component/Config/Resource/FileResource.php index 1d373a623a..bee062377b 100644 --- a/src/Symfony/Component/Config/Resource/FileResource.php +++ b/src/Symfony/Component/Config/Resource/FileResource.php @@ -63,11 +63,17 @@ class FileResource implements SelfCheckingResourceInterface, \Serializable return false !== ($filemtime = @filemtime($this->resource)) && $filemtime <= $timestamp; } + /** + * @internal + */ public function serialize() { return serialize($this->resource); } + /** + * @internal + */ public function unserialize($serialized) { $this->resource = unserialize($serialized); diff --git a/src/Symfony/Component/Config/Resource/GlobResource.php b/src/Symfony/Component/Config/Resource/GlobResource.php index 20648b585e..28ba0a6112 100644 --- a/src/Symfony/Component/Config/Resource/GlobResource.php +++ b/src/Symfony/Component/Config/Resource/GlobResource.php @@ -73,6 +73,9 @@ class GlobResource implements \IteratorAggregate, SelfCheckingResourceInterface, return $this->hash === $hash; } + /** + * @internal + */ public function serialize() { if (null === $this->hash) { @@ -82,6 +85,9 @@ class GlobResource implements \IteratorAggregate, SelfCheckingResourceInterface, return serialize([$this->prefix, $this->pattern, $this->recursive, $this->hash]); } + /** + * @internal + */ public function unserialize($serialized) { list($this->prefix, $this->pattern, $this->recursive, $this->hash) = unserialize($serialized); diff --git a/src/Symfony/Component/Config/Resource/ReflectionClassResource.php b/src/Symfony/Component/Config/Resource/ReflectionClassResource.php index 52f1ec53cd..a86a37ed8d 100644 --- a/src/Symfony/Component/Config/Resource/ReflectionClassResource.php +++ b/src/Symfony/Component/Config/Resource/ReflectionClassResource.php @@ -57,6 +57,9 @@ class ReflectionClassResource implements SelfCheckingResourceInterface, \Seriali return 'reflection.'.$this->className; } + /** + * @internal + */ public function serialize() { if (null === $this->hash) { @@ -67,6 +70,9 @@ class ReflectionClassResource implements SelfCheckingResourceInterface, \Seriali return serialize([$this->files, $this->className, $this->hash]); } + /** + * @internal + */ public function unserialize($serialized) { list($this->files, $this->className, $this->hash) = unserialize($serialized); diff --git a/src/Symfony/Component/DependencyInjection/Config/AutowireServiceResource.php b/src/Symfony/Component/DependencyInjection/Config/AutowireServiceResource.php index 6bb9bb0d1e..0c3d8f5758 100644 --- a/src/Symfony/Component/DependencyInjection/Config/AutowireServiceResource.php +++ b/src/Symfony/Component/DependencyInjection/Config/AutowireServiceResource.php @@ -58,11 +58,17 @@ class AutowireServiceResource implements SelfCheckingResourceInterface, \Seriali return 'service.autowire.'.$this->class; } + /** + * @internal + */ public function serialize() { return serialize([$this->class, $this->filePath, $this->autowiringMetadata]); } + /** + * @internal + */ public function unserialize($serialized) { if (\PHP_VERSION_ID >= 70000) { diff --git a/src/Symfony/Component/DependencyInjection/Config/ContainerParametersResource.php b/src/Symfony/Component/DependencyInjection/Config/ContainerParametersResource.php index 072f0580aa..7560c3356d 100644 --- a/src/Symfony/Component/DependencyInjection/Config/ContainerParametersResource.php +++ b/src/Symfony/Component/DependencyInjection/Config/ContainerParametersResource.php @@ -39,7 +39,7 @@ class ContainerParametersResource implements ResourceInterface, \Serializable } /** - * {@inheritdoc} + * @internal */ public function serialize() { @@ -47,7 +47,7 @@ class ContainerParametersResource implements ResourceInterface, \Serializable } /** - * {@inheritdoc} + * @internal */ public function unserialize($serialized) { diff --git a/src/Symfony/Component/Form/FormError.php b/src/Symfony/Component/Form/FormError.php index ce5b682402..7717c19019 100644 --- a/src/Symfony/Component/Form/FormError.php +++ b/src/Symfony/Component/Form/FormError.php @@ -135,9 +135,7 @@ class FormError implements \Serializable } /** - * Serializes this error. - * - * @return string The serialized error + * @internal */ public function serialize() { @@ -151,9 +149,7 @@ class FormError implements \Serializable } /** - * Unserializes a serialized error. - * - * @param string $serialized The serialized error + * @internal */ public function unserialize($serialized) { diff --git a/src/Symfony/Component/HttpKernel/Config/EnvParametersResource.php b/src/Symfony/Component/HttpKernel/Config/EnvParametersResource.php index a5be98ee81..26869ced2f 100644 --- a/src/Symfony/Component/HttpKernel/Config/EnvParametersResource.php +++ b/src/Symfony/Component/HttpKernel/Config/EnvParametersResource.php @@ -65,11 +65,17 @@ class EnvParametersResource implements SelfCheckingResourceInterface, \Serializa return $this->findVariables() === $this->variables; } + /** + * @internal + */ public function serialize() { return serialize(['prefix' => $this->prefix, 'variables' => $this->variables]); } + /** + * @internal + */ public function unserialize($serialized) { if (\PHP_VERSION_ID >= 70000) { diff --git a/src/Symfony/Component/HttpKernel/DataCollector/DataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/DataCollector.php index 4346e0ec0f..4a257ff5f8 100644 --- a/src/Symfony/Component/HttpKernel/DataCollector/DataCollector.php +++ b/src/Symfony/Component/HttpKernel/DataCollector/DataCollector.php @@ -40,6 +40,9 @@ abstract class DataCollector implements DataCollectorInterface, \Serializable */ private $cloner; + /** + * @internal + */ public function serialize() { $trace = debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT, 2); @@ -48,6 +51,9 @@ abstract class DataCollector implements DataCollectorInterface, \Serializable return $isCalledFromOverridingMethod ? $this->data : serialize($this->data); } + /** + * @internal + */ public function unserialize($data) { $this->data = \is_array($data) ? $data : unserialize($data); diff --git a/src/Symfony/Component/HttpKernel/Debug/FileLinkFormatter.php b/src/Symfony/Component/HttpKernel/Debug/FileLinkFormatter.php index 8a4aa62b74..af65f7ec57 100644 --- a/src/Symfony/Component/HttpKernel/Debug/FileLinkFormatter.php +++ b/src/Symfony/Component/HttpKernel/Debug/FileLinkFormatter.php @@ -61,11 +61,17 @@ class FileLinkFormatter implements \Serializable return false; } + /** + * @internal + */ public function serialize() { return serialize($this->getFileLinkFormat()); } + /** + * @internal + */ public function unserialize($serialized) { if (\PHP_VERSION_ID >= 70000) { diff --git a/src/Symfony/Component/Validator/Constraint.php b/src/Symfony/Component/Validator/Constraint.php index 4b7e6bc083..ae27ba2163 100644 --- a/src/Symfony/Component/Validator/Constraint.php +++ b/src/Symfony/Component/Validator/Constraint.php @@ -284,9 +284,7 @@ abstract class Constraint * * @return array The properties to serialize * - * @internal This method may be replaced by an implementation of - * {@link \Serializable} in the future. Please don't use or - * overwrite it. + * @internal */ public function __sleep() {