Skip to content

[VarExporter] Fix serializing classes with __serialize() returning unprefixed private properties #61453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicolas-grekas merged 1 commit into from
Aug 18, 2025
Merged

[VarExporter] Fix serializing classes with __serialize() returning unprefixed private properties #61453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 20 additions & 28 deletions src/Symfony/Component/VarExporter/Internal/Exporter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,33 +76,23 @@ public static function prepare($values, $objectsPool, &$refsPool, &$objectsCount
$class = $value::class;
$reflector = Registry::$reflectors[$class] ??= Registry::getClassReflector($class);
$properties = [];
$sleep = null;
$proto = Registry::$prototypes[$class];

if ($reflector->hasMethod('__serialize')) {
if (!$reflector->getMethod('__serialize')->isPublic()) {
throw new \Error(\sprintf('Call to %s method "%s::__serialize()".', $reflector->getMethod('__serialize')->isProtected() ? 'protected' : 'private', $class));
}

if (!\is_array($serializeProperties = $value->__serialize())) {
if (!\is_array($arrayValue = $value->__serialize())) {
throw new \TypeError($class.'::__serialize() must return an array');
}

if ($reflector->hasMethod('__unserialize')) {
$properties = $serializeProperties;
} else {
foreach ($serializeProperties as $n => $v) {
$p = $reflector->hasProperty($n) ? $reflector->getProperty($n) : null;
$c = $p && (\PHP_VERSION_ID >= 80400 ? $p->isProtectedSet() || $p->isPrivateSet() : $p->isReadOnly()) ? $p->class : 'stdClass';
$properties[$c][$n] = $v;
}
$properties = $arrayValue;
goto prepare_value;
}

goto prepare_value;
}

$sleep = null;
$proto = Registry::$prototypes[$class];

if (($value instanceof \ArrayIterator || $value instanceof \ArrayObject) && null !== $proto) {
} elseif (($value instanceof \ArrayIterator || $value instanceof \ArrayObject) && null !== $proto) {
// ArrayIterator and ArrayObject need special care because their "flags"
// option changes the behavior of the (array) casting operator.
[$arrayValue, $properties] = self::getArrayObjectProperties($value, $proto);
Expand All @@ -118,10 +108,7 @@ public static function prepare($values, $objectsPool, &$refsPool, &$objectsCount
}
$properties = ['SplObjectStorage' => ["\0" => $properties]];
$arrayValue = (array) $value;
} elseif ($value instanceof \Serializable
|| $value instanceof \__PHP_Incomplete_Class
|| \PHP_VERSION_ID < 80200 && $value instanceof \DatePeriod
) {
} elseif ($value instanceof \Serializable || $value instanceof \__PHP_Incomplete_Class || \PHP_VERSION_ID < 80200 && $value instanceof \DatePeriod) {
++$objectsCount;
$objectsPool[$value] = [$id = \count($objectsPool), serialize($value), [], 0];
$value = new Reference($id);
Expand All @@ -145,16 +132,15 @@ public static function prepare($values, $objectsPool, &$refsPool, &$objectsCount
$i = 0;
$n = (string) $name;
if ('' === $n || "\0" !== $n[0]) {
$p = $reflector->hasProperty($n) ? $reflector->getProperty($n) : null;
$c = $p && (\PHP_VERSION_ID >= 80400 ? $p->isProtectedSet() || $p->isPrivateSet() : $p->isReadOnly()) ? $p->class : 'stdClass';
$parent = $reflector;
do {
$p = $parent->hasProperty($n) ? $parent->getProperty($n) : null;
} while (!$p && $parent = $parent->getParentClass());

$c = $p && (!$p->isPublic() || (\PHP_VERSION_ID >= 80400 ? $p->isProtectedSet() || $p->isPrivateSet() : $p->isReadOnly())) ? $p->class : 'stdClass';
} elseif ('*' === $n[1]) {
$n = substr($n, 3);
$c = $reflector->getProperty($n)->class;
if ('Error' === $c) {
$c = 'TypeError';
} elseif ('Exception' === $c) {
$c = 'ErrorException';
}
} else {
$i = strpos($n, "\0", 2);
$c = substr($n, 1, $i - 1);
Expand All @@ -167,8 +153,14 @@ public static function prepare($values, $objectsPool, &$refsPool, &$objectsCount
}
unset($sleep[$name], $sleep[$n]);
}
if (!\array_key_exists($name, $proto) || $proto[$name] !== $v || "\x00Error\x00trace" === $name || "\x00Exception\x00trace" === $name) {
if ("\x00Error\x00trace" === $name || "\x00Exception\x00trace" === $name) {
$properties[$c][$n] = $v;
} elseif (!\array_key_exists($name, $proto) || $proto[$name] !== $v) {
$properties[match ($c) {
'Error' => 'TypeError',
'Exception' => 'ErrorException',
default => $c,
}][$n] = $v;
}
}
if ($sleep) {
Expand Down
12 changes: 11 additions & 1 deletion src/Symfony/Component/VarExporter/Tests/Fixtures/__serialize-but-no-__unserialize.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,21 @@
],
null,
[
'stdClass' => [
'Symfony\\Component\\VarExporter\\Tests\\ParentOf__SerializeButNo__Unserialize' => [
'foo' => [
'foo',
],
],
'stdClass' => [
'baz' => [
'ccc',
],
],
'Symfony\\Component\\VarExporter\\Tests\\__SerializeButNo__Unserialize' => [
'bar' => [
'ddd',
],
],
],
$o[0],
[]
Expand Down
22 changes: 18 additions & 4 deletions src/Symfony/Component/VarExporter/Tests/VarExporterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,19 +468,33 @@ public function __unserialize(array $data): void
}
}

class __SerializeButNo__Unserialize
class ParentOf__SerializeButNo__Unserialize
{
public $foo;
private $foo = 'foo';

public function getFoo()
{
return $this->foo;
}
}

class __SerializeButNo__Unserialize extends ParentOf__SerializeButNo__Unserialize
{
public $baz;
private $bar;

public function __construct()
{
$this->foo = 'ccc';
$this->baz = 'ccc';
$this->bar = 'ddd';
}

public function __serialize(): array
{
return [
'foo' => $this->foo,
'foo' => $this->getFoo(),
'baz' => $this->baz,
'bar' => $this->bar,
];
}
}
Loading