Merge pull request #125 from MLKiiwy/#79-custom-identifier

#79 custom identifier

Author: dunglas

Api/IriConverter.php

@@ -11,6 +11,8 @@
 
 namespace Dunglas\ApiBundle\Api;
 
+use Dunglas\ApiBundle\Mapping\AttributeMetadataInterface;
+use Dunglas\ApiBundle\Mapping\ClassMetadataFactory;
 use Dunglas\ApiBundle\Model\DataProviderInterface;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\Routing\Exception\ResourceNotFoundException;
@@ -43,18 +45,24 @@ class IriConverter implements IriConverterInterface
      * @var \SplObjectStorage
      */
     private $routeCache;
+    /**
+     * @var ClassMetadataFactory
+     */
+    private $classMetadataFactory;
 
     public function __construct(
         ResourceCollectionInterface $resourceCollection,
         DataProviderInterface $dataProvider,
         RouterInterface $router,
-        PropertyAccessorInterface $propertyAccessor
+        PropertyAccessorInterface $propertyAccessor,
+        ClassMetadataFactory $classMetadataFactory
     ) {
         $this->resourceCollection = $resourceCollection;
         $this->dataProvider = $dataProvider;
         $this->router = $router;
         $this->propertyAccessor = $propertyAccessor;
         $this->routeCache = new \SplObjectStorage();
+        $this->classMetadataFactory = $classMetadataFactory;
     }
 
     /**
@@ -85,9 +93,11 @@ public function getItemFromIri($iri, $fetchData = false)
     public function getIriFromItem($item, $referenceType = RouterInterface::ABSOLUTE_PATH)
     {
         if ($resource = $this->resourceCollection->getResourceForEntity($item)) {
+            $identifier = $this->getIdentifierFromResource($resource);
+
             return $this->router->generate(
                 $this->getRouteName($resource, 'item'),
-                ['id' => $this->propertyAccessor->getValue($item, 'id')],
+                ['id' => $this->propertyAccessor->getValue($item, $identifier->getName())],
                 $referenceType
             );
         }
@@ -134,4 +144,21 @@ private function getRouteName(ResourceInterface $resource, $prefix)
             }
         }
     }
+
+    /**
+     * @param ResourceInterface $resource
+     *
+     * @return AttributeMetadataInterface
+     */
+    private function getIdentifierFromResource(ResourceInterface $resource)
+    {
+        $classMetadata = $this->classMetadataFactory->getMetadataFor(
+            $resource->getEntityClass(),
+            $resource->getNormalizationGroups(),
+            $resource->getDenormalizationGroups(),
+            $resource->getValidationGroups()
+        );
+
+        return $classMetadata->getIdentifier();
+    }
 }

Doctrine/Orm/DataProvider.php

@@ -118,8 +118,12 @@ public function getCollection(ResourceInterface $resource, Request $request)
             }
         }
 
-        if (null !== $this->order) {
-            $queryBuilder->addOrderBy('o.id', $this->order);
+        $classMetaData = $manager->getClassMetadata($entityClass);
+        $identifiers = $classMetaData->getIdentifier();
+
+        if (null !== $this->order && 1 === count($identifiers)) {
+            $identifier = $identifiers[0];
+            $queryBuilder->addOrderBy('o.'.$identifier, $this->order);
         }
 
         return new Paginator(new DoctrineOrmPaginator($queryBuilder));

Hydra/ApiDocumentationBuilder.php

@@ -123,6 +123,10 @@ public function getApiDocumentation()
 
             $properties = [];
             foreach ($classMetadata->getAttributes() as $attributeName => $attributeMetadata) {
+                if ($attributeMetadata->isIdentifier() && !$attributeMetadata->isWritable()) {
+                    continue;
+                }
+
                 if ($attributeMetadata->isNormalizationLink()) {
                     $type = 'Hydra:Link';
                 } else {
@@ -139,7 +143,7 @@ public function getApiDocumentation()
                     ],
                     'hydra:title' => $attributeName,
                     'hydra:required' => $attributeMetadata->isRequired(),
-                    'hydra:readable' => $attributeMetadata->isReadable(),
+                    'hydra:readable' => $attributeMetadata->isIdentifier() ? false : $attributeMetadata->isReadable(),
                     'hydra:writable' => $attributeMetadata->isWritable(),
                 ];
 

JsonLd/EventListener/ResourceContextBuilderListener.php

@@ -65,6 +65,9 @@ public function onContextBuilder(ContextBuilderEvent $event)
         )->getAttributes();
 
         foreach ($attributes as $attributeName => $attribute) {
+            if ($attribute->isIdentifier()) {
+                continue;
+            }
             $convertedName = $this->nameConverter ? $this->nameConverter->normalize($attributeName) : $attributeName;
 
             if (!$id = $attribute->getIri()) {

JsonLd/Serializer/ItemNormalizer.php

@@ -124,12 +124,10 @@ public function normalize($object, $format = null, array $context = [])
         $data['@type'] = ($iri = $classMetadata->getIri()) ? $iri : $resource->getShortName();
 
         foreach ($attributesMetadata as $attributeMetadata) {
-            $attributeName = $attributeMetadata->getName();
-
-            if ('id' === $attributeName || !$attributeMetadata->isReadable()) {
+            if ($attributeMetadata->isIdentifier() || !$attributeMetadata->isReadable()) {
                 continue;
             }
-
+            $attributeName = $attributeMetadata->getName();
             $attributeValue = $this->propertyAccessor->getValue($object, $attributeName);
 
             if ($this->nameConverter) {

Mapping/AttributeMetadata.php

@@ -18,6 +18,8 @@
  */
 class AttributeMetadata implements AttributeMetadataInterface
 {
+    const DEFAULT_IDENTIFIER_NAME = 'id';
+
     /**
      * @var string
      *
@@ -90,13 +92,23 @@ class AttributeMetadata implements AttributeMetadataInterface
      *           {@link getIri()} instead.
      */
     public $iri;
+    /**
+     * @var bool
+     *
+     * @internal This property is public in order to reduce the size of the
+     *           class' serialized representation. Do not access it. Use
+     *           {@link isIdentifier()} instead.
+     */
+    public $identifier;
 
     /**
-     * @param string $name
+     * @param string    $name
+     * @param bool|null $identifier
      */
-    public function __construct($name)
+    public function __construct($name, $identifier = null)
     {
         $this->name = $name;
+        $this->identifier = ($identifier === null) ? $name === self::DEFAULT_IDENTIFIER_NAME : $identifier;
     }
 
     /**
@@ -235,6 +247,22 @@ public function getIri()
         return $this->iri;
     }
 
+    /**
+     * @return bool
+     */
+    public function isIdentifier()
+    {
+        return $this->identifier;
+    }
+
+    /**
+     * @param bool $identifier
+     */
+    public function setIdentifier($identifier)
+    {
+        $this->identifier = $identifier;
+    }
+
     /**
      * Returns the names of the properties that should be serialized.
      *
@@ -251,6 +279,7 @@ public function __sleep()
             'required',
             'link',
             'iri',
+            'identifier',
         ];
     }
 }

Mapping/AttributeMetadataInterface.php

@@ -136,4 +136,11 @@ public function setIri($iri);
      * @return string|null
      */
     public function getIri();
+
+    /**
+     * Is attribute the identifier of the class.
+     *
+     * @return bool
+     */
+    public function isIdentifier();
 }

Mapping/ClassMetadata.php

@@ -105,6 +105,20 @@ public function getIri()
         return $this->iri;
     }
 
+    /**
+     * @return AttributeMetadataInterface
+     */
+    public function getIdentifier()
+    {
+        foreach ($this->attributes as $attribute) {
+            if ($attribute->isIdentifier()) {
+                return $attribute;
+            }
+        }
+
+        return;
+    }
+
     /**
      * {@inheritdoc}
      */

Mapping/ClassMetadataInterface.php

@@ -73,4 +73,11 @@ public function getAttributes();
      * @return \ReflectionClass
      */
     public function getReflectionClass();
+
+    /**
+     * Gets the attribute identifier of the class.
+     *
+     * @return AttributeMetadataInterface
+     */
+    public function getIdentifier();
 }