feature #2 add Symfony routing support for "action" type (sstok)

This PR was merged into the master branch.

Discussion
----------

|Q            |A  |
|---          |---|
|Bug Fix?     |no |
|New Feature? |yes|
|BC Breaks?   |no |
|Deprecations?|no |
|Fixed Tickets|   |

Commits
-------

c879f79 add Symfony routing support for "action" type

composer.json

@@ -16,8 +16,8 @@
     ],
     "require": {
         "php": ">=5.5.0",
-        "rollerworks/datagrid": "~0.4",
-        "rollerworks/datagrid-twig": "~0.2",
+        "rollerworks/datagrid": "^0.6.1",
+        "rollerworks/datagrid-twig": "~0.3",
         "symfony/framework-bundle": "~2.3",
         "symfony/twig-bundle": "~2.3"
     },

src/DependencyInjection/Compiler/RequestUriProviderPass.php

@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of the RollerworksDatagrid package.
+ *
+ * (c) Sebastiaan Stok <s.stok@rollerscapes.net>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Rollerworks\Bundle\DatagridBundle\DependencyInjection\Compiler;
+
+use Rollerworks\Component\Datagrid\Twig\Extension\DatagridExtension as TwigDatagridExtension;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * @author Sebastiaan Stok <s.stok@rollerscapes.net>
+ */
+class RequestUriProviderPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if (!$container->hasDefinition('rollerworks_datagrid.column_extension.action')) {
+            return;
+        }
+
+        $definition = $container->getDefinition('rollerworks_datagrid.column_extension.action');
+
+        // Symfony >=2.4
+        if ($container->hasDefinition('request_stack') || $container->hasAlias('request_stack')) {
+            $definition->addArgument(new Reference('rollerworks_datagrid.request_uri_provider.request_stack'));
+
+            $container->removeDefinition('rollerworks_datagrid.request_uri_provider.request_service');
+            $container->removeDefinition('rollerworks_datagrid.event_subscriber.request');
+        } else {
+            // Symfony 2.3
+            $definition->addArgument(new Reference('rollerworks_datagrid.request_uri_provider.request_service'));
+
+            $container->removeDefinition('rollerworks_datagrid.request_uri_provider.request_stack');
+        }
+    }
+}

src/Extension/Symfony/ColumnTypeExtension/ActionTypeExtension.php

@@ -0,0 +1,153 @@
+<?php
+
+/*
+ * This file is part of the RollerworksDatagrid package.
+ *
+ * (c) Sebastiaan Stok <s.stok@rollerscapes.net>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Rollerworks\Bundle\DatagridBundle\Extension\Symfony\ColumnTypeExtension;
+
+use Rollerworks\Bundle\DatagridBundle\Extension\Symfony\RequestUriProviderInterface;
+use Rollerworks\Component\Datagrid\Column\AbstractColumnTypeExtension;
+use Symfony\Component\OptionsResolver\Options;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Component\OptionsResolver\OptionsResolverInterface;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+/**
+ * @author Sebastiaan Stok <s.stok@rollerscapes.net>
+ */
+class ActionTypeExtension extends AbstractColumnTypeExtension
+{
+    /**
+     * Router to generate urls.
+     *
+     * @var UrlGeneratorInterface
+     */
+    private $router;
+
+    /**
+     * RequestUriProvider.
+     *
+     * This is used for getting the current URI for redirects.
+     *
+     * @var RequestUriProviderInterface
+     */
+    private $requestUriProvider;
+
+    /**
+     * Constructor.
+     *
+     * @param UrlGeneratorInterface       $router
+     * @param RequestUriProviderInterface $requestUriProvider
+     */
+    public function __construct(UrlGeneratorInterface $router, RequestUriProviderInterface $requestUriProvider)
+    {
+        $this->router = $router;
+        $this->requestUriProvider = $requestUriProvider;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults(
+            [
+                'route_name' => null,
+                'parameters_field_mapping' => [],
+                'additional_parameters' => [],
+                'uri_scheme' => function (Options $options, $value) {
+                    // Value was already provided so just use that one.
+                    // Always do this check as lazy options don't overwrite.
+                    if (is_string($value)) {
+                        return $value;
+                    }
+
+                    if (null !== $options['route_name']) {
+                        return $this->createRouteGenerator(
+                            $options['route_name'],
+                            $options['reference_type'],
+                            $options['parameters_field_mapping'],
+                            $options['additional_parameters']
+                        );
+                    }
+                },
+                'reference_type' => UrlGeneratorInterface::ABSOLUTE_PATH,
+
+                'redirect_route' => null,
+                'redirect_parameters_field_mapping' => [],
+                'redirect_additional_parameters' => [],
+                'redirect_uri' => function (Options $options, $value) {
+                    // Value was already provided so just use that one.
+                    // Always do this check as lazy options don't overwrite.
+                    if (is_string($value)) {
+                        return $value;
+                    }
+
+                    if (null !== $options['redirect_route']) {
+                        return $this->createRouteGenerator(
+                            $options['redirect_route'],
+                            $options['reference_type'],
+                            $options['redirect_parameters_field_mapping'],
+                            $options['redirect_additional_parameters']
+                        );
+                    }
+
+                    return $this->requestUriProvider->getRequestUri();
+                },
+            ]
+        );
+
+        if ($resolver instanceof OptionsResolverInterface) {
+            $resolver->setAllowedTypes(
+                [
+                    'route_name' => ['string', 'null'],
+                    'parameters_field_mapping' => ['array'],
+                    'additional_parameters' => ['array'],
+
+                    'redirect_route' => ['string', 'null'],
+                    'redirect_parameters_field_mapping' => ['array'],
+                    'redirect_additional_parameters' => ['array'],
+                ]
+            );
+        } else {
+            $resolver->setAllowedTypes('route_name', ['string', 'null']);
+            $resolver->setAllowedTypes('parameters_field_mapping', ['array']);
+            $resolver->setAllowedTypes('additional_parameters', ['array']);
+
+            $resolver->setAllowedTypes('redirect_route', ['string', 'null']);
+            $resolver->setAllowedTypes('redirect_parameters_field_mapping', ['array']);
+            $resolver->setAllowedTypes('redirect_additional_parameters', ['array']);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getExtendedType()
+    {
+        return 'action';
+    }
+
+    private function createRouteGenerator($routeName, $referenceType, array $fieldMapping, array $additionalParameters)
+    {
+        return function (array $values) use ($routeName, $referenceType, $fieldMapping, $additionalParameters) {
+            $routeParameters = [];
+
+            foreach ($fieldMapping as $parameterName => $mappingField) {
+                $routeParameters[$parameterName] = $values[$mappingField];
+            }
+
+            return $this->router->generate(
+                $routeName,
+                array_merge($routeParameters, $additionalParameters),
+                $referenceType
+            );
+        };
+    }
+}

src/Extension/Symfony/EventSubscriber/RequestSubscriber.php

@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of the RollerworksDatagrid package.
+ *
+ * (c) Sebastiaan Stok <s.stok@rollerscapes.net>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Rollerworks\Bundle\DatagridBundle\Extension\Symfony\EventSubscriber;
+
+use Rollerworks\Bundle\DatagridBundle\Extension\Symfony\RequestUriProviderByListener;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\KernelEvent;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+class RequestSubscriber implements EventSubscriberInterface
+{
+    /**
+     * @var RequestUriProviderByListener
+     */
+    private $uriProvider;
+
+    /**
+     * @param RequestUriProviderByListener $uriProvider
+     */
+    public function __construct(RequestUriProviderByListener $uriProvider)
+    {
+        $this->uriProvider = $uriProvider;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents()
+    {
+        return [
+            KernelEvents::REQUEST => 'onRequest'
+        ];
+    }
+
+    /**
+     * @param KernelEvent $event
+     */
+    public function onRequest(KernelEvent $event)
+    {
+        if ($event->getRequestType() === HttpKernelInterface::MASTER_REQUEST) {
+            $this->uriProvider->setRequest($event->getRequest());
+        }
+    }
+}

src/Extension/Symfony/RequestUriProviderByListener.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the RollerworksDatagrid package.
+ *
+ * (c) Sebastiaan Stok <s.stok@rollerscapes.net>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Rollerworks\Bundle\DatagridBundle\Extension\Symfony;
+
+use Symfony\Component\HttpFoundation\Request;
+
+class RequestUriProviderByListener implements RequestUriProviderInterface
+{
+    /**
+     * @var Request
+     */
+    private $request;
+
+    /**
+     * @return string
+     */
+    public function getRequestUri()
+    {
+        if (null === $this->request) {
+            throw new \LogicException(
+                'No Request set for RequestUriProviderByListener. Do not use this service manually.'
+            );
+        }
+
+        return $this->request->getRequestUri();
+    }
+
+    /**
+     * @param Request $request
+     */
+    public function setRequest(Request $request = null)
+    {
+        $this->request = $request;
+    }
+}

src/Extension/Symfony/RequestUriProviderByRequestStack.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the RollerworksDatagrid package.
+ *
+ * (c) Sebastiaan Stok <s.stok@rollerscapes.net>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Rollerworks\Bundle\DatagridBundle\Extension\Symfony;
+
+use Symfony\Component\HttpFoundation\RequestStack;
+
+class RequestUriProviderByRequestStack implements RequestUriProviderInterface
+{
+    /**
+     * @var RequestStack
+     */
+    private $requestStack;
+
+    public function __construct(RequestStack $requestStack)
+    {
+        $this->requestStack = $requestStack;
+    }
+
+    /**
+     * @return string
+     */
+    public function getRequestUri()
+    {
+        return $this->requestStack->getMasterRequest()->getRequestUri();
+    }
+}

src/Extension/Symfony/RequestUriProviderInterface.php

@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the RollerworksDatagrid package.
+ *
+ * (c) Sebastiaan Stok <s.stok@rollerscapes.net>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Rollerworks\Bundle\DatagridBundle\Extension\Symfony;
+
+/**
+ * The RequestUriProvide provides access to the current URI of the master-request.
+ *
+ * This interface only exists to be compatible with Symfony <2.4,
+ * where the RequestStack did not exist yet.
+ */
+interface RequestUriProviderInterface
+{
+    /**
+     * @return string
+     */
+    public function getRequestUri();
+}