Skip to content

Commit

Permalink
[Hackday][Serializer] Deserialization ignores argument type hint from…
Browse files Browse the repository at this point in the history
… phpdoc for array in constructor argument
  • Loading branch information
karser authored and fabpot committed Dec 10, 2018
1 parent 9e84e0f commit 8741d00
Show file tree
Hide file tree
Showing 3 changed files with 162 additions and 12 deletions.
34 changes: 22 additions & 12 deletions src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php
Expand Up @@ -358,20 +358,9 @@ protected function instantiateObject(array &$data, $class, array &$context, \Ref
unset($data[$key]);
continue;
}
try {
if (null !== $constructorParameter->getClass()) {
if (!$this->serializer instanceof DenormalizerInterface) {
throw new LogicException(sprintf('Cannot create an instance of %s from serialized data because the serializer inject in "%s" is not a denormalizer', $constructorParameter->getClass(), static::class));
}
$parameterClass = $constructorParameter->getClass()->getName();
$parameterData = $this->serializer->denormalize($parameterData, $parameterClass, $format, $this->createChildContext($context, $paramName));
}
} catch (\ReflectionException $e) {
throw new RuntimeException(sprintf('Could not determine the class of the parameter "%s".', $key), 0, $e);
}

// Don't run set for a parameter passed to the constructor
$params[] = $parameterData;
$params[] = $this->denormalizeParameter($reflectionClass, $constructorParameter, $paramName, $parameterData, $context, $format);
unset($data[$key]);
} elseif ($constructorParameter->isDefaultValueAvailable()) {
$params[] = $constructorParameter->getDefaultValue();
Expand All @@ -390,6 +379,27 @@ protected function instantiateObject(array &$data, $class, array &$context, \Ref
return new $class();
}

/**
* @internal
*/
protected function denormalizeParameter(\ReflectionClass $class, \ReflectionParameter $parameter, $parameterName, $parameterData, array $context, $format = null)
{
try {
if (null !== $parameter->getClass()) {
if (!$this->serializer instanceof DenormalizerInterface) {
throw new LogicException(sprintf('Cannot create an instance of %s from serialized data because the serializer inject in "%s" is not a denormalizer', $parameter->getClass(), static::class));
}
$parameterClass = $parameter->getClass()->getName();

return $this->serializer->denormalize($parameterData, $parameterClass, $format, $this->createChildContext($context, $parameterName));
}

return $parameterData;
} catch (\ReflectionException $e) {
throw new RuntimeException(sprintf('Could not determine the class of the parameter "%s".', $parameterName), 0, $e);
}
}

/**
* @param array $parentContext
* @param string $attribute
Expand Down
Expand Up @@ -304,6 +304,18 @@ private function validateAndDenormalize($currentClass, $attribute, $data, $forma
throw new NotNormalizableValueException(sprintf('The type of the "%s" attribute for class "%s" must be one of "%s" ("%s" given).', $attribute, $currentClass, implode('", "', array_keys($expectedTypes)), \gettype($data)));
}

/**
* @internal
*/
protected function denormalizeParameter(\ReflectionClass $class, \ReflectionParameter $parameter, $parameterName, $parameterData, array $context, $format = null)
{
if (null === $this->propertyTypeExtractor || null === $types = $this->propertyTypeExtractor->getTypes($class->getName(), $parameterName)) {

This comment has been minimized.

Copy link
@gusarov112

gusarov112 Jan 31, 2019

What should I do in this case? All my request DTO's are build this way. I am using fos_rest param converter + symfony serializer... 😠

class SomeRequestDTO {
    /**
     * @var MyClassInterface
     **/
    private $property;
    /**
     * @var MyCollectionObject
     */
    private $collection;
    
    public function __construct(string $property, array $collection = [])
    {
        $this->property = MyClassImplementation::build($property);
        $this->collection = new MyObjectCollection();
        foreach ($collection as $item) {
            $this->collection->addItem(new MyObject($item));
        }
    }
}

This comment has been minimized.

Copy link
@xabbuh

xabbuh Jan 31, 2019

Member

Please open a new issues if you think that you found a bug or use one of the support channels to seek for help. Comments on a commit are very likely to be missed.

This comment has been minimized.

Copy link
@gusarov112
return parent::denormalizeParameter($class, $parameter, $parameterName, $parameterData, $context, $format);
}

return $this->validateAndDenormalize($class->getName(), $parameterName, $parameterData, $format, $context);
}

/**
* Sets an attribute and apply the name converter if necessary.
*
Expand Down
@@ -0,0 +1,128 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\Serializer\Tests;

use PHPUnit\Framework\TestCase;
use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Serializer;

class DeserializeNestedArrayOfObjectsTest extends TestCase
{
public function provider()
{
return array(
//from property PhpDoc
array(Zoo::class),
//from argument constructor PhpDoc
array(ZooImmutable::class),
);
}

/**
* @dataProvider provider
*/
public function testPropertyPhpDoc($class)
{
//GIVEN
$json = <<<EOF
{
"animals": [
{"name": "Bug"}
]
}
EOF;
$serializer = new Serializer(array(
new ObjectNormalizer(null, null, null, new PhpDocExtractor()),
new ArrayDenormalizer(),
), array('json' => new JsonEncoder()));
//WHEN
/** @var Zoo $zoo */
$zoo = $serializer->deserialize($json, $class, 'json');
//THEN
self::assertCount(1, $zoo->getAnimals());
self::assertInstanceOf(Animal::class, $zoo->getAnimals()[0]);
}
}

class Zoo
{
/** @var Animal[] */
private $animals = array();

/**
* @return Animal[]
*/
public function getAnimals()
{
return $this->animals;
}

/**
* @param Animal[] $animals
*/
public function setAnimals(array $animals)
{
$this->animals = $animals;
}
}

class ZooImmutable
{
/** @var Animal[] */
private $animals = array();

/**
* @param Animal[] $animals
*/
public function __construct(array $animals = array())
{
$this->animals = $animals;
}

/**
* @return Animal[]
*/
public function getAnimals()
{
return $this->animals;
}
}

class Animal
{
/** @var string */
private $name;

public function __construct()
{
echo '';
}

/**
* @return string|null
*/
public function getName()
{
return $this->name;
}

/**
* @param string|null $name
*/
public function setName($name)
{
$this->name = $name;
}
}

0 comments on commit 8741d00

Please sign in to comment.