Implement custom route for data request to prevent partial rendering of the page and it's possible issues (f.e. form captcha changes) (Close #49).

src/Frontend/Action/LayerDataAction.php

@@ -0,0 +1,103 @@
+<?php
+
+/**
+ * Leaflet maps for Contao CMS.
+ *
+ * @package    contao-leaflet-maps
+ * @author     David Molineus <david.molineus@netzmacht.de>
+ * @copyright  2014-2018 netzmacht David Molineus. All rights reserved.
+ * @license    LGPL-3.0 https://github.com/netzmacht/contao-leaflet-maps/blob/master/LICENSE
+ * @filesource
+ */
+
+declare(strict_types=1);
+
+namespace Netzmacht\Contao\Leaflet\Frontend\Action;
+
+use Netzmacht\Contao\Leaflet\Filter\Filter;
+use Netzmacht\Contao\Leaflet\Filter\FilterFactory;
+use Netzmacht\Contao\Leaflet\MapProvider;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+
+/**
+ * Request action which handles request for layer data
+ */
+final class LayerDataAction
+{
+    /**
+     * Map provider.
+     *
+     * @var MapProvider
+     */
+    private $mapProvider;
+
+    /**
+     * Filter factory.
+     *
+     * @var FilterFactory
+     */
+    private $filterFactory;
+
+    /**
+     * LayerDataAction constructor.
+     *
+     * @param MapProvider   $mapProvider   Map provider.
+     * @param FilterFactory $filterFactory Filter factory.
+     */
+    public function __construct(MapProvider $mapProvider, FilterFactory $filterFactory)
+    {
+        $this->mapProvider   = $mapProvider;
+        $this->filterFactory = $filterFactory;
+    }
+
+    /**
+     * Handle the request.
+     *
+     * @param int     $layerId The layer id.
+     * @param string  $_format The requested output format.
+     * @param Request $request The request.
+     *
+     * @return Response
+     *
+     * @throws BadRequestHttpException When unsupported format is given.
+     *
+     * @SuppressWarnings(PHPMD.CamelCaseParameterName)
+     * @SuppressWarnings(PHPMD.CamelCaseVariableName)
+     */
+    public function __invoke(int $layerId, string $_format, Request $request): Response
+    {
+        $filter = $this->createFilter($request);
+        $data   = $this->mapProvider->getFeatureCollection($layerId, $filter);
+
+        if ($_format === 'geojson') {
+            $response = new JsonResponse($data);
+            $response->setEncodingOptions(JSON_UNESCAPED_SLASHES);
+
+            return $response;
+        }
+
+        throw new BadRequestHttpException(sprintf('Unsupported format "%s"', $_format));
+    }
+
+    /**
+     * Create the filter if defined in the request.
+     *
+     * @param Request $request The request.
+     *
+     * @return Filter|null
+     */
+    private function createFilter(Request $request): ?Filter
+    {
+        if (!$request->query->has('filter')) {
+            return null;
+        }
+
+        $filter = (string) $request->query->get('filter');
+        $values = (string) $request->query->get('values');
+
+        return $this->filterFactory->create($filter, $values);
+    }
+}

src/Frontend/DataController.php

@@ -12,14 +12,18 @@
 
 namespace Netzmacht\Contao\Leaflet\Frontend;
 
+use const E_USER_DEPRECATED;
 use Netzmacht\Contao\Leaflet\Filter\Filter;
 use Netzmacht\Contao\Leaflet\Filter\FilterFactory;
 use Netzmacht\Contao\Leaflet\MapProvider;
+use function trigger_error;
 
 /**
  * The data controller handles ajax request for sub data.
  *
  * @package Netzmacht\Contao\Leaflet\Frontend
+ *
+ * @deprecated
  */
 class DataController
 {
@@ -60,6 +64,13 @@ class DataController
     {
         $this->debugMode     = $debugMode;
         $this->filterFactory = $filterFactory;
+
+        // @codingStandardsIgnoreStart
+        @trigger_error(
+            'Deprecated since 3.1.0 and will be removed in 4.0.0 - Use properly route instead.',
+            E_USER_DEPRECATED
+        );
+        // @codingStandardsIgnoreEnd
     }
 
     /**

src/Frontend/PageIdDeterminator.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * Leaflet maps for Contao CMS.
+ *
+ * @package    contao-leaflet-maps
+ * @author     David Molineus <david.molineus@netzmacht.de>
+ * @copyright  2014-2018 netzmacht David Molineus. All rights reserved.
+ * @license    LGPL-3.0 https://github.com/netzmacht/contao-leaflet-maps/blob/master/LICENSE
+ * @filesource
+ */
+
+declare(strict_types=1);
+
+namespace Netzmacht\Contao\Leaflet\Frontend;
+
+use Netzmacht\Contao\PageContext\Exception\DeterminePageIdFailed;
+use Netzmacht\Contao\PageContext\Request\PageIdDeterminator as PageContextPageIdDeterminator;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Class ApiPageIdDeterminator
+ */
+final class PageIdDeterminator implements PageContextPageIdDeterminator
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function match(Request $request): bool
+    {
+        return ($request->attributes->get('_leaflet_scope') === 'page' && $request->query->get('context') === 'page');
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @throws DeterminePageIdFailed When no context id is given.
+     */
+    public function determinate(Request $request): int
+    {
+        if (!$request->query->has('contextId')) {
+            throw new DeterminePageIdFailed('Could not determine page id for from request.');
+        }
+
+        return $request->query->getInt('contextId');
+    }
+}

src/Frontend/RequestUrl.php

@@ -21,6 +21,8 @@ use Netzmacht\Contao\Leaflet\Mapper\Request;
  * Class RequestUrl creates the request url.
  *
  * @package Netzmacht\Contao\Leaflet\Request
+ *
+ * @deprecated
  */
 class RequestUrl implements \JsonSerializable
 {
@@ -89,6 +91,13 @@ class RequestUrl implements \JsonSerializable
     {
         $this->url  = $url;
         $this->hash = $hash;
+
+        // @codingStandardsIgnoreStart
+        @trigger_error(
+            'Deprecated since 3.1.0 and will be removed in 4.0.0. Use The router instead.',
+            E_USER_DEPRECATED
+        );
+        // @codingStandardsIgnoreEnd
     }
 
     /**