[WIP] ReferenceType Configuration

Api/IriConverter.php

@@ -16,6 +16,7 @@
 use Dunglas\ApiBundle\Model\DataProviderInterface;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\Routing\Exception\ExceptionInterface;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Routing\RouterInterface;
 
 /**
@@ -50,19 +51,26 @@ class IriConverter implements IriConverterInterface
      */
     private $classMetadataFactory;
 
+    /**
+     * @var bool|string The type of reference to be generated (one of the {@see UrlGeneratorInterface} constants)
+     */
+    private $referenceType;
+
     public function __construct(
         ResourceCollectionInterface $resourceCollection,
         DataProviderInterface $dataProvider,
         ClassMetadataFactoryInterface $classMetadataFactory,
         RouterInterface $router,
-        PropertyAccessorInterface $propertyAccessor
+        PropertyAccessorInterface $propertyAccessor,
+        $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH
     ) {
         $this->resourceCollection = $resourceCollection;
         $this->dataProvider = $dataProvider;
         $this->classMetadataFactory = $classMetadataFactory;
         $this->router = $router;
         $this->propertyAccessor = $propertyAccessor;
         $this->routeCache = new \SplObjectStorage();
+        $this->referenceType = $referenceType;
     }
 
     /**
@@ -94,8 +102,12 @@ public function getItemFromIri($iri, $fetchData = false)
     /**
      * {@inheritdoc}
      */
-    public function getIriFromItem($item, $referenceType = RouterInterface::ABSOLUTE_PATH)
+    public function getIriFromItem($item, $referenceType = null)
     {
+        if ($referenceType === null) {
+            $referenceType = $this->referenceType;
+        }
+
         if ($resource = $this->resourceCollection->getResourceForEntity($item)) {
             $identifierName = $this->getIdentifierNameFromResource($resource);
 
@@ -112,8 +124,12 @@ public function getIriFromItem($item, $referenceType = RouterInterface::ABSOLUTE
     /**
      * {@inheritdoc}
      */
-    public function getIriFromResource(ResourceInterface $resource, $referenceType = RouterInterface::ABSOLUTE_PATH)
+    public function getIriFromResource(ResourceInterface $resource, $referenceType = null)
     {
+        if ($referenceType === null) {
+            $referenceType = $this->referenceType;
+        }
+
         try {
             return $this->router->generate($this->getRouteName($resource, 'collection'), [], $referenceType);
         } catch (ExceptionInterface $e) {

DependencyInjection/Configuration.php

@@ -33,6 +33,12 @@ public function getConfigTreeBuilder()
             ->children()
                 ->scalarNode('title')->cannotBeEmpty()->isRequired()->info('The title of the API.')->end()
                 ->scalarNode('description')->cannotBeEmpty()->isRequired()->info('The description of the API.')->end()
+                ->enumNode('reference_type')
+                    ->values(['absolute_url', 'absolute_path', 'relative_path', 'network_path'])
+                    ->cannotBeEmpty()
+                    ->defaultValue('absolute_path')
+                    ->info('The type how context URIs are generated')
+                ->end()
                 ->arrayNode('supported_formats')
                     ->defaultValue(['jsonld'])
                     ->cannotBeEmpty()

DependencyInjection/DunglasApiExtension.php

@@ -17,6 +17,7 @@
 use Symfony\Component\DependencyInjection\Loader;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
 /**
  * The extension of this bundle.
@@ -52,6 +53,7 @@ public function load(array $configs, ContainerBuilder $container)
         $container->setParameter('api.title', $config['title']);
         $container->setParameter('api.description', $config['description']);
         $container->setParameter('api.supported_formats', $config['supported_formats']);
+        $container->setParameter('api.reference_type', $this->getContextReferenceType($config['reference_type']));
         $container->setParameter('api.collection.filter_name.order', $config['collection']['filter_name']['order']);
         $container->setParameter('api.collection.order', $config['collection']['order']);
         $container->setParameter('api.collection.pagination.enabled', $config['collection']['pagination']['enabled']);
@@ -90,6 +92,27 @@ public function load(array $configs, ContainerBuilder $container)
         }
     }
 
+    /**
+     * Translates the string reference types to the constant values of the UrlGeneratorInterface.
+     *
+     * @param $contextReferenceType string One of absolute_url, absolute_path, relative_path or network_path
+     * @return bool|string
+     */
+    private function getContextReferenceType($contextReferenceType) {
+        switch ($contextReferenceType) {
+            case 'absolute_url':
+                return UrlGeneratorInterface::ABSOLUTE_URL;
+            case 'absolute_path':
+                return UrlGeneratorInterface::ABSOLUTE_PATH;
+            case 'relative_path':
+                return UrlGeneratorInterface::RELATIVE_PATH;
+            case 'network_path':
+                return UrlGeneratorInterface::NETWORK_PATH;
+            default:
+                break;
+        }
+    }
+
     /**
      * Enables JSON-LD and Hydra support.
      *

Doctrine/EventListener/ManagerViewListener.php

@@ -11,8 +11,8 @@
 
 namespace Dunglas\ApiBundle\Doctrine\EventListener;
 
-use Doctrine\Common\Persistence\ObjectManager;
 use Doctrine\Common\Persistence\ManagerRegistry;
+use Doctrine\Common\Persistence\ObjectManager;
 use Dunglas\ApiBundle\Api\ResourceInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;

Doctrine/Orm/Extension/EagerLoadingExtension.php

@@ -11,8 +11,8 @@
 
 namespace Dunglas\ApiBundle\Doctrine\Orm\Extension;
 
-use Doctrine\ORM\QueryBuilder;
 use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\QueryBuilder;
 use Dunglas\ApiBundle\Api\ResourceInterface;
 use Dunglas\ApiBundle\Doctrine\Orm\QueryCollectionExtensionInterface;
 use Dunglas\ApiBundle\Doctrine\Orm\QueryItemExtensionInterface;

FosUser/EventListener.php

@@ -11,8 +11,8 @@
 
 namespace Dunglas\ApiBundle\FosUser;
 
-use FOS\UserBundle\Model\UserManagerInterface;
 use FOS\UserBundle\Model\UserInterface;
+use FOS\UserBundle\Model\UserManagerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
 

Hydra/Serializer/CollectionNormalizer.php

@@ -63,7 +63,7 @@ public function supportsNormalization($data, $format = null)
     /**
      * {@inheritdoc}
      */
-    public function normalize($object, $format = null, array $context = array())
+    public function normalize($object, $format = null, array $context = [])
     {
         $resource = $this->resourceResolver->guessResource($object, $context);
 

Hydra/Serializer/ConstraintViolationListNormalizer.php

@@ -33,6 +33,7 @@ public function __construct(RouterInterface $router)
     {
         $this->router = $router;
     }
+
     /**
      * {@inheritdoc}
      */

Hydra/Serializer/ErrorNormalizer.php

@@ -48,7 +48,7 @@ public function __construct(RouterInterface $router, $debug)
     /**
      * {@inheritdoc}
      */
-    public function normalize($object, $format = null, array $context = array())
+    public function normalize($object, $format = null, array $context = [])
     {
         if ($object instanceof \Exception || $object instanceof FlattenException) {
             $message = $object->getMessage();

JsonLd/ContextBuilder.php

@@ -43,14 +43,21 @@ class ContextBuilder
      */
     private $resourceCollection;
 
+    /**
+     * @var bool|string The type of reference to be generated (one of the {@see UrlGeneratorInterface} constants)
+     */
+    private $referenceType;
+
     public function __construct(
         RouterInterface $router,
         EventDispatcherInterface $eventDispatcher,
-        ResourceCollectionInterface $resourceCollection
+        ResourceCollectionInterface $resourceCollection,
+        $referenceType
     ) {
         $this->router = $router;
         $this->eventDispatcher = $eventDispatcher;
         $this->resourceCollection = $resourceCollection;
+        $this->referenceType = $referenceType;
     }
 
     /**
@@ -114,7 +121,7 @@ public function getContext(ResourceInterface $resource = null)
      */
     public function getContextUri(ResourceInterface $resource)
     {
-        return $this->router->generate('api_jsonld_context', ['shortName' => $resource->getShortName()]);
+        return $this->router->generate('api_jsonld_context', ['shortName' => $resource->getShortName()], $this->referenceType);
     }
 
     /**

JsonLd/Serializer/ItemNormalizer.php

@@ -14,13 +14,13 @@
 use Dunglas\ApiBundle\Api\IriConverterInterface;
 use Dunglas\ApiBundle\Api\ResourceCollectionInterface;
 use Dunglas\ApiBundle\Api\ResourceInterface;
+use Dunglas\ApiBundle\Api\ResourceResolver;
 use Dunglas\ApiBundle\Exception\InvalidArgumentException;
 use Dunglas\ApiBundle\Exception\RuntimeException;
-use Dunglas\ApiBundle\Api\ResourceResolver;
 use Dunglas\ApiBundle\JsonLd\ContextBuilder;
+use Dunglas\ApiBundle\Mapping\AttributeMetadataInterface;
 use Dunglas\ApiBundle\Mapping\ClassMetadataInterface;
 use Dunglas\ApiBundle\Mapping\Factory\ClassMetadataFactoryInterface;
-use Dunglas\ApiBundle\Mapping\AttributeMetadataInterface;
 use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\Serializer\Exception\CircularReferenceException;

Mapping/Loader/DoctrineIdentifierLoader.php

@@ -12,8 +12,8 @@
 namespace Dunglas\ApiBundle\Mapping\Loader;
 
 use Doctrine\Common\Persistence\ManagerRegistry;
-use Dunglas\ApiBundle\Mapping\Factory\AttributeMetadataFactoryInterface;
 use Dunglas\ApiBundle\Mapping\ClassMetadataInterface;
+use Dunglas\ApiBundle\Mapping\Factory\AttributeMetadataFactoryInterface;
 
 /**
  * Doctrine identifier loader.

Mapping/Loader/ReflectionLoader.php

@@ -11,9 +11,9 @@
 
 namespace Dunglas\ApiBundle\Mapping\Loader;
 
-use Dunglas\ApiBundle\Mapping\Factory\AttributeMetadataFactoryInterface;
 use Dunglas\ApiBundle\Mapping\AttributeMetadataInterface;
 use Dunglas\ApiBundle\Mapping\ClassMetadataInterface;
+use Dunglas\ApiBundle\Mapping\Factory\AttributeMetadataFactoryInterface;
 
 /**
  * Uses serialization groups or alternatively reflection to populate attributes.

Mapping/Loader/SerializerMetadataLoader.php

@@ -11,9 +11,9 @@
 
 namespace Dunglas\ApiBundle\Mapping\Loader;
 
-use Dunglas\ApiBundle\Mapping\Factory\AttributeMetadataFactoryInterface;
 use Dunglas\ApiBundle\Mapping\AttributeMetadataInterface;
 use Dunglas\ApiBundle\Mapping\ClassMetadataInterface;
+use Dunglas\ApiBundle\Mapping\Factory\AttributeMetadataFactoryInterface;
 use Symfony\Component\Serializer\Mapping\AttributeMetadataInterface as SerializerAttributeMetadataInterface;
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
 

Resources/config/api.xml

@@ -34,6 +34,7 @@
             <argument type="service" id="api.mapping.class_metadata_factory" />
             <argument type="service" id="api.router" />
             <argument type="service" id="api.property_accessor" />
+            <argument key="referenceType">%api.reference_type%</argument>
         </service>
 
         <service id="api.format_negotiator" class="Negotiation\FormatNegotiator" public="false" />

Resources/config/jsonld.xml

@@ -15,6 +15,7 @@
             <argument type="service" id="router" />
             <argument type="service" id="event_dispatcher" />
             <argument type="service" id="api.resource_collection" />
+            <argument key="referenceType">%api.reference_type%</argument>
         </service>
 
         <!-- Serializer -->

Routing/Router.php

@@ -56,7 +56,7 @@ public function getRouteCollection()
         return $this->router->getRouteCollection();
     }
 
-    /*
+    /**
      * {@inheritdoc}
      */
     public function match($pathInfo)
@@ -78,7 +78,7 @@ public function match($pathInfo)
         }
     }
 
-    /*
+    /**
      * {@inheritdoc}
      */
     public function generate($name, $parameters = [], $referenceType = self::ABSOLUTE_PATH)

Tests/Behat/TestBundle/Entity/CustomNormalizedDummy.php

@@ -83,7 +83,7 @@ public function getAlias()
         return $this->alias;
     }
 
-    /**n
+    /**
      * @param string $alias
      */
     public function setAlias($alias)

Tests/Behat/TestBundle/Entity/Dummy.php

@@ -85,7 +85,7 @@ class Dummy
      */
     public $relatedDummies;
     /**
-     * @var Array serialize data.
+     * @var array serialize data.
      *
      * @ORM\Column(type="json_array", nullable=true)
      */

Tests/Behat/TestBundle/Entity/RelatedDummy.php

@@ -11,8 +11,8 @@
 
 namespace Dunglas\ApiBundle\Tests\Behat\TestBundle\Entity;
 
-use Dunglas\ApiBundle\Annotation\Iri;
 use Doctrine\ORM\Mapping as ORM;
+use Dunglas\ApiBundle\Annotation\Iri;
 use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Validator\Constraints as Assert;
 

Tests/DependencyInjection/ConfigurationTest.php

@@ -22,6 +22,7 @@ class ConfigurationTest extends \PHPUnit_Framework_TestCase
     private static $defaultConfig = [
         'title' => 'title',
         'description' => 'description',
+        'reference_type' => 'absolute_path',
         'supported_formats' => ['jsonld'],
         'cache' => false,
         'enable_fos_user' => false,

Tests/Doctrine/Orm/Extension/PaginationExtensionTest.php

@@ -13,6 +13,7 @@
 
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\ORM\QueryBuilder;
+use Dunglas\ApiBundle\Api\Resource;
 use Dunglas\ApiBundle\Api\ResourceInterface;
 use Dunglas\ApiBundle\Doctrine\Orm\Extension\PaginationExtension;
 use Prophecy\Argument;

Tests/Fixtures/Query.php

@@ -19,6 +19,7 @@ class Query
     public function getFirstResult()
     {
     }
+
     public function getMaxResults()
     {
     }

Tests/Routing/RouterTest.php

@@ -15,7 +15,6 @@
 use Prophecy\Argument;
 use Symfony\Component\Routing\RequestContext;
 use Symfony\Component\Routing\RouteCollection;
-use Symfony\Component\Routing\Router as SymfonyRouter;
 
 /**
  * @author Kévin Dunglas <[email protected]>