Use __serialize() instead of __sleep()

Author: sebastianbergmann

ChangeLog-12.3.md

@@ -2,6 +2,12 @@
 
 All notable changes are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
 
+## [12.3.7] - 2025-MM-DD
+
+### Changed
+
+* Do not use `__sleep()` method (which will be deprecated in PHP 8.5)
+
 ## [12.3.6] - 2025-09-02
 
 ### Fixed
@@ -50,6 +56,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
 
 * [#1080](https://github.com/sebastianbergmann/php-code-coverage/pull/1080): Support for reporting code coverage information in OpenClover XML format; unlike the existing Clover XML reporter, which remains unchanged, the XML documents generated by this new reporter validate against the OpenClover project's XML schema definition, with one exception: we do not generate the `<testproject>` element. This feature is experimental and the generated XML might change in order to improve compliance with the OpenClover project's XML schema definition further. Such changes will be made in bugfix and/or minor releases even if they break backward compatibility.
 
+[12.3.7]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.3.6...main
 [12.3.6]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.3.5...12.3.6
 [12.3.5]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.3.4...12.3.5
 [12.3.4]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.3.3...12.3.4

src/CodeCoverage.php

@@ -78,23 +78,34 @@ public function __construct(Driver $driver, Filter $filter)
     }
 
     /**
-     * @return non-empty-list<non-empty-string>
+     * @return array{
+     *     cacheDirectory: ?string,
+     *     checkForUnintentionallyCoveredCode: bool,
+     *     includeUncoveredFiles: bool,
+     *     ignoreDeprecatedCode: bool,
+     *     parentClassesExcludedFromUnintentionallyCoveredCodeCheck: list<class-string>,
+     *     filter: Filter,
+     *     data: ProcessedCodeCoverageData,
+     *     tests: array<string, TestType>
+     * }
      */
-    public function __sleep(): array
+    public function __serialize(): array
     {
+        $prefix = "\x00" . self::class . "\x00";
+
         return [
             // Configuration
-            'cacheDirectory',
-            'checkForUnintentionallyCoveredCode',
-            'includeUncoveredFiles',
-            'ignoreDeprecatedCode',
-            'parentClassesExcludedFromUnintentionallyCoveredCodeCheck',
-            'useAnnotationsForIgnoringCode',
-            'filter',
+            $prefix . 'cacheDirectory'                                           => $this->cacheDirectory,
+            $prefix . 'checkForUnintentionallyCoveredCode'                       => $this->checkForUnintentionallyCoveredCode,
+            $prefix . 'includeUncoveredFiles'                                    => $this->includeUncoveredFiles,
+            $prefix . 'ignoreDeprecatedCode'                                     => $this->ignoreDeprecatedCode,
+            $prefix . 'parentClassesExcludedFromUnintentionallyCoveredCodeCheck' => $this->parentClassesExcludedFromUnintentionallyCoveredCodeCheck,
+            $prefix . 'useAnnotationsForIgnoringCode'                            => $this->useAnnotationsForIgnoringCode,
+            $prefix . 'filter'                                                   => $this->filter,
 
             // Data
-            'data',
-            'tests',
+            $prefix . 'data'  => $this->data,
+            $prefix . 'tests' => $this->tests,
         ];
     }