Make resource constructor parameters writables

This is motivated because other tools are already
constructor friendly (ie Symfony serializer and
Doctrine).

Also using constructors must be recommended and not supporting
them is a serious feature missing.

Author: Nek-

features/serializer/deserialize_objects_using_constructor.feature

@@ -0,0 +1,31 @@
+Feature: Resource with constructor deserializable
+  In order to build non anemic resource object
+  As a developer
+  I should be able to deserialize data into objects with constructors
+
+  @createSchema
+  Scenario: post a resource built with constructor
+    When I add "Content-Type" header equal to "application/ld+json"
+    And I send a "POST" request to "/dummy_entity_with_constructors" with body:
+    """
+    {
+      "foo": "hello",
+      "bar": "world"
+    }
+    """
+    Then the response status code should be 201
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be equal to:
+    """
+    {
+      "@context": "/contexts/DummyEntityWithConstructor",
+      "@id": "/dummy_entity_with_constructors/1",
+      "@type": "DummyEntityWithConstructor",
+      "id": 1,
+      "foo": "hello",
+      "bar": "world",
+      "baz": null
+    }
+    """
+

src/Bridge/Symfony/Bundle/Resources/config/metadata/metadata.xml

@@ -69,6 +69,11 @@
             <argument type="service" id="api_platform.metadata.property.metadata_factory.serializer.inner" />
         </service>
 
+        <service id="api_platform.metadata.property.metadata_factory.constructor" class="ApiPlatform\Core\Metadata\Property\Factory\ConstructorPropertyMetadataFactory" decorates="api_platform.metadata.property.metadata_factory" decoration-priority="35" public="false">
+            <argument type="service" id="api_platform.operation_method_resolver" />
+            <argument type="service" id="api_platform.metadata.property.metadata_factory.constructor.inner" />
+        </service>
+
         <service id="api_platform.metadata.property.metadata_factory.cached" class="ApiPlatform\Core\Metadata\Property\Factory\CachedPropertyMetadataFactory" decorates="api_platform.metadata.property.metadata_factory" decoration-priority="-10" public="false">
             <argument type="service" id="api_platform.cache.metadata.property" />
             <argument type="service" id="api_platform.metadata.property.metadata_factory.cached.inner" />

src/Metadata/Property/Factory/ConstructorPropertyMetadataFactory.php

@@ -0,0 +1,80 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Metadata\Property\Factory;
+
+use ApiPlatform\Core\Api\OperationMethodResolverInterface;
+use ApiPlatform\Core\Exception\PropertyNotFoundException;
+use ApiPlatform\Core\Exception\RuntimeException;
+use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
+
+/**
+ * Set properties available in the constructor as writable.
+ *
+ * @author Maxime Veber <[email protected]>
+ */
+final class ConstructorPropertyMetadataFactory implements PropertyMetadataFactoryInterface
+{
+    private $decorated;
+    private $operationMethodResolver;
+
+    public function __construct(OperationMethodResolverInterface $operationMethodResolver, PropertyMetadataFactoryInterface $decorated = null)
+    {
+        $this->decorated = $decorated;
+        $this->operationMethodResolver = $operationMethodResolver;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function create(string $resourceClass, string $property, array $options = []): PropertyMetadata
+    {
+        if (null === $this->decorated) {
+            $propertyMetadata = new PropertyMetadata();
+        } else {
+            try {
+                $propertyMetadata = $this->decorated->create($resourceClass, $property, $options);
+            } catch (PropertyNotFoundException $propertyNotFoundException) {
+                $propertyMetadata = new PropertyMetadata();
+            }
+        }
+
+        if (!isset($options['collection_operation_name'])) {
+            return $propertyMetadata;
+        }
+
+        // Constructor arguments are obviously accessible only on post operation, put will result in an error.
+        try {
+            $method = $this->operationMethodResolver->getCollectionOperationMethod($resourceClass, $options['collection_operation_name']);
+        } catch (RuntimeException $e) {
+            return $propertyMetadata;
+        }
+
+        if ('POST' !== $method) {
+            return $propertyMetadata;
+        }
+
+        $ref = new \ReflectionClass($resourceClass);
+        if (!$ref->isInstantiable() || !$constructor = $ref->getConstructor()) {
+            return $propertyMetadata;
+        }
+
+        foreach ($constructor->getParameters() as $constructorParameter) {
+            if ($constructorParameter->name === $property) {
+                return $propertyMetadata->withWritable(true);
+            }
+        }
+
+        return $propertyMetadata;
+    }
+}

tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php

@@ -506,6 +506,7 @@ private function getPartialContainerBuilderProphecy($test = false)
             'api_platform.metadata.property.name_collection_factory.inherited',
             'api_platform.metadata.property.name_collection_factory.property_info',
             'api_platform.metadata.property.name_collection_factory.xml',
+            'api_platform.metadata.property.metadata_factory.constructor',
             'api_platform.metadata.resource.metadata_factory.cached',
             'api_platform.metadata.resource.metadata_factory.operation',
             'api_platform.metadata.resource.metadata_factory.short_name',

tests/Fixtures/DummyObjectWithConstructor.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures;
+
+/**
+ * @author Maxime Veber <[email protected]>
+ */
+class DummyObjectWithConstructor
+{
+    private $foo;
+    private $bar;
+
+    public function __construct(string $foo, \stdClass $bar)
+    {
+        $this->foo = $foo;
+        $this->bar = $bar;
+    }
+}

tests/Fixtures/DummyObjectWithoutConstructor.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures;
+
+/**
+ * @author Maxime Veber <[email protected]>
+ */
+class DummyObjectWithoutConstructor
+{
+    private $foo;
+
+    public function getFoo()
+    {
+        return $this->foo;
+    }
+
+    public function setFoo($foo)
+    {
+        $this->foo = $foo;
+    }
+}

tests/Fixtures/TestBundle/Entity/DummyEntityWithConstructor.php

@@ -0,0 +1,112 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Core\Annotation\ApiResource;
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Annotation\Groups;
+
+/**
+ * Dummy entity built with constructor.
+ * https://github.com/api-platform/core/issues/1747.
+ *
+ * @author Maxime Veber <[email protected]>
+ *
+ * @ApiResource(
+ *     itemOperations={
+ *          "get",
+ *          "put"={"denormalization_context"={"groups"={"put"}}}
+ *     }
+ * )
+ * @ORM\Entity
+ */
+class DummyEntityWithConstructor
+{
+    /**
+     * @var int The id
+     *
+     * @ORM\Column(type="integer")
+     * @ORM\Id
+     * @ORM\GeneratedValue(strategy="AUTO")
+     */
+    private $id;
+
+    /**
+     * @var string The tour name
+     *
+     * @ORM\Column
+     */
+    private $foo;
+
+    /**
+     * @var string The tour name
+     *
+     * @ORM\Column
+     */
+    private $bar;
+
+    /**
+     * @var string The tour name
+     *
+     * @ORM\Column(nullable=true)
+     * @Groups({"put"})
+     */
+    private $baz;
+
+    public function __construct(string $foo, string $bar)
+    {
+        $this->foo = $foo;
+        $this->bar = $bar;
+    }
+
+    /**
+     * @return int
+     */
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    /**
+     * @return string
+     */
+    public function getFoo(): string
+    {
+        return $this->foo;
+    }
+
+    /**
+     * @return string
+     */
+    public function getBar(): string
+    {
+        return $this->bar;
+    }
+
+    /**
+     * @return string
+     */
+    public function getBaz()
+    {
+        return $this->baz;
+    }
+
+    /**
+     * @param string $baz
+     */
+    public function setBaz(string $baz)
+    {
+        $this->baz = $baz;
+    }
+}