Ability to specify identifier property of custom item operations

Author: abluchet

src/DataProvider/OperationDataProviderTrait.php

@@ -86,14 +86,16 @@ private function getSubresourceData($identifiers, array $attributes, array $cont
     private function extractIdentifiers(array $parameters, array $attributes)
     {
         if (isset($attributes['item_operation_name'])) {
-            if (!isset($parameters['id'])) {
-                throw new InvalidIdentifierException('Parameter "id" not found');
+            $property = $attributes['identified_by'] ?? 'id';
+
+            if (!isset($parameters[$property])) {
+                throw new InvalidIdentifierException(sprintf('Parameter "%s" not found', $property));
             }
 
-            $id = $parameters['id'];
+            $id = $parameters[$property];
 
             if (null !== $this->identifierConverter) {
-                return $this->identifierConverter->convert((string) $id, $attributes['resource_class']);
+                return $this->identifierConverter->convert((string) $id, $attributes['resource_class'], $attributes['identified_by'] ? [$attributes['identified_by']] : null);
             }
 
             return $id;

src/Identifier/IdentifierConverter.php

@@ -39,9 +39,9 @@ public function __construct(IdentifiersExtractorInterface $identifiersExtractor,
     /**
      * {@inheritdoc}
      */
-    public function convert(string $data, string $class): array
+    public function convert(string $data, string $class, array $keys = null): array
     {
-        $keys = $this->identifiersExtractor->getIdentifiersFromResourceClass($class);
+        $keys = $keys ?: $this->identifiersExtractor->getIdentifiersFromResourceClass($class);
 
         if (($numIdentifiers = \count($keys)) > 1) {
             $identifiers = CompositeIdentifierParser::parse($data);

src/Util/AttributesExtractor.php

@@ -63,6 +63,10 @@ public static function extractAttributes(array $attributes): array
             'persist' => (bool) ($attributes['_api_persist'] ?? true),
         ];
 
+        if (isset($attributes['identifiedBy'])) {
+            $result['identified_by'] = $attributes['identifiedBy'];
+        }
+
         return $result;
     }
 }

tests/Fixtures/TestBundle/Entity/Book.php

@@ -0,0 +1,54 @@
+<?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;
+
+/**
+ * Book.
+ *
+ * @author Antoine Bluchet <[email protected]>
+ *
+ * @ApiResource(itemOperations={
+ *     "get",
+ *     "put",
+ *     "get_by_isbn"={"method"="GET", "path"="/books/by_isbn/{isbn}.{_format}", "requirements"={"isbn"=".+"}, "defaults"={"identifiedBy"="isbn"}}
+ * })
+ * @ORM\Entity
+ */
+class Book
+{
+    /**
+     * @ORM\Column(type="integer")
+     * @ORM\Id
+     * @ORM\GeneratedValue(strategy="AUTO")
+     */
+    private $id;
+
+    /**
+     * @ORM\Column
+     */
+    public $name;
+
+    /**
+     * @ORM\Column(unique=true)
+     */
+    public $isbn;
+
+    public function getId()
+    {
+        return $this->id;
+    }
+}