Feature: add api endpoint for listing all geographical units covering an address

src/Bundle/ChillMainBundle/Controller/GeographicalUnitByAddressApiController.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace Chill\MainBundle\Controller;
+
+use Chill\MainBundle\Entity\Address;
+use Chill\MainBundle\Pagination\PaginatorFactory;
+use Chill\MainBundle\Repository\GeographicalUnitRepositoryInterface;
+use Chill\MainBundle\Serializer\Model\Collection;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
+use Symfony\Component\Routing\Annotation\Route;
+use Symfony\Component\Security\Core\Security;
+use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
+use Symfony\Component\Serializer\SerializerInterface;
+
+class GeographicalUnitByAddressApiController
+{
+    private PaginatorFactory $paginatorFactory;
+
+    private GeographicalUnitRepositoryInterface $geographicalUnitRepository;
+
+    private Security $security;
+
+    private SerializerInterface $serializer;
+
+    /**
+     * @param PaginatorFactory $paginatorFactory
+     * @param GeographicalUnitRepositoryInterface $geographicalUnitRepository
+     * @param Security $security
+     * @param SerializerInterface $serializer
+     */
+    public function __construct(
+        PaginatorFactory $paginatorFactory,
+        GeographicalUnitRepositoryInterface $geographicalUnitRepository,
+        Security $security,
+        SerializerInterface $serializer
+    ) {
+        $this->paginatorFactory = $paginatorFactory;
+        $this->geographicalUnitRepository = $geographicalUnitRepository;
+        $this->security = $security;
+        $this->serializer = $serializer;
+    }
+
+    /**
+     * @Route("/api/1.0/main/geographical-unit/by-address/{id}.{_format}", requirements={"_format": "json"})
+     */
+    public function getGeographicalUnitCoveringAddress(Address $address): JsonResponse
+    {
+        if (!$this->security->isGranted('ROLE_USER')) {
+            throw new AccessDeniedHttpException();
+        }
+
+        $count = $this->geographicalUnitRepository->countGeographicalUnitContainingAddress($address);
+        $pagination = $this->paginatorFactory->create($count);
+        $units = $this->geographicalUnitRepository->findGeographicalUnitContainingAddress($address, $pagination->getCurrentPageFirstItemNumber(), $pagination->getItemsPerPage());
+
+        $collection = new Collection($units, $pagination);
+
+        return new JsonResponse(
+            $this->serializer->serialize($collection, 'json', [AbstractNormalizer::GROUPS => ['read']]),
+            JsonResponse::HTTP_OK,
+            [],
+            true
+        );
+    }
+}