Add a "date" filter to analytics

Author: Pierstoval

config/packages/twig.yaml

@@ -0,0 +1,5 @@
+twig:
+    default_path: '%kernel.project_dir%/templates'
+    form_themes:
+        - '@EasyAdmin/form/bootstrap_4.html.twig'
+        - 'form/analytics_filter_form.html.twig'

src/Controller/AnalyticsController.php

@@ -13,38 +13,50 @@
 
 namespace App\Controller;
 
+use App\DTO\AnalyticsFilters;
+use App\Form\Type\AnalyticsFiltersType;
 use App\Highcharts\Chart\TagAmountChart;
 use App\Highcharts\Chart\TagUsageChart;
 use App\Repository\OperationRepository;
 use App\Repository\TagRepository;
+use Symfony\Component\Form\FormFactoryInterface;
+use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
 use Twig\Environment;
 
 class AnalyticsController
 {
     private Environment $twig;
+    private FormFactoryInterface $formFactory;
     private TagRepository $tagRepository;
     private OperationRepository $operationRepository;
 
     public function __construct(
         Environment $twig,
+        FormFactoryInterface $formFactory,
         TagRepository $tagRepository,
         OperationRepository $operationRepository
     ) {
         $this->twig = $twig;
+        $this->formFactory = $formFactory;
         $this->tagRepository = $tagRepository;
         $this->operationRepository = $operationRepository;
     }
 
     /**
      * @Route("/admin/analytics", name="analytics")
      */
-    public function analytics(): Response
+    public function analytics(Request $request): Response
     {
-        $operations = $this->operationRepository->findWithTags();
+        $filters = new AnalyticsFilters();
+        $form = $this->formFactory->createNamed('', AnalyticsFiltersType::class, $filters);
+        $form->handleRequest($request);
+
+        $operations = $this->operationRepository->findForAnalytics($filters);
 
         return new Response($this->twig->render('analytics.html.twig', [
+            'filters_form' => $form->createView(),
             'charts' => [
                 new TagUsageChart($operations),
                 new TagAmountChart($operations),

src/DTO/AnalyticsFilters.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Compotes package.
+ *
+ * (c) Alex "Pierstoval" Rock <pierstoval@gmail.com>.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\DTO;
+
+use DateTime;
+use Symfony\Component\Validator\Constraints as Assert;
+
+class AnalyticsFilters
+{
+    /**
+     * @Assert\LessThanOrEqual(propertyPath="endDate")
+     */
+    public ?DateTime $startDate = null;
+
+    /**
+     * @Assert\GreaterThanOrEqual(propertyPath="startDate")
+     */
+    public ?DateTime $endDate = null;
+}

src/Form/Type/AnalyticsFiltersType.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Compotes package.
+ *
+ * (c) Alex "Pierstoval" Rock <pierstoval@gmail.com>.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Form\Type;
+
+use App\DTO\AnalyticsFilters;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\DateType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class AnalyticsFiltersType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $builder
+            ->add('startDate', DateType::class, [
+                'widget' => 'single_text',
+                'required' => false,
+            ])
+            ->add('endDate', DateType::class, [
+                'widget' => 'single_text',
+                'required' => false,
+            ])
+        ;
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver
+            ->setDefaults([
+                'data_class' => AnalyticsFilters::class,
+                'method' => 'get',
+                'csrf_protection' => false,
+                'allow_extra_fields' => true,
+            ])
+        ;
+    }
+
+    public function getBlockPrefix()
+    {
+        return 'analytics_filter';
+    }
+}

src/Repository/OperationRepository.php

@@ -13,6 +13,7 @@
 
 namespace App\Repository;
 
+use App\DTO\AnalyticsFilters;
 use App\Entity\Operation;
 use DateTimeImmutable;
 use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
@@ -62,15 +63,28 @@ public function monthIsPopulated(DateTimeImmutable $month): bool
     /**
      * @return Operation[]
      */
-    public function findWithTags(): array
+    public function findForAnalytics(AnalyticsFilters $filters): array
     {
-        return $this->_em->createQuery(
-            <<<DQL
-            SELECT operation, tags
-            FROM {$this->_entityName} as operation
-            LEFT JOIN operation.tags as tags
-            DQL
-        )
+        $qb = $this->createQueryBuilder('operation')
+            ->addSelect('tags')
+            ->leftJoin('operation.tags', 'tags')
+        ;
+
+        if ($filters->startDate) {
+            $qb
+                ->andWhere('operation.operationDate >= :startDate')
+                ->setParameter('startDate', $filters->startDate)
+            ;
+        }
+        if ($filters->endDate) {
+            $qb
+                ->andWhere('operation.operationDate <= :endDate')
+                ->setParameter('endDate', $filters->endDate)
+            ;
+        }
+
+        return $qb
+            ->getQuery()
             ->getResult()
         ;
     }

templates/analytics.html.twig

@@ -5,6 +5,9 @@
 {% endblock %}
 
 {% block main %}
+
+    {{ form(filters_form) }}
+
     <ul class="nav nav-tabs" role="tablist">
         {% for chart in charts %}
             <li class="nav-item">

templates/form/analytics_filter_form.html.twig

@@ -0,0 +1,10 @@
+
+{% block analytics_filter_widget %}
+    {{ form_start(form) }}
+    <div class="row">
+        <div class="col s6">{{ form_row(form.startDate) }}</div>
+        <div class="col s6">{{ form_row(form.endDate) }}</div>
+    </div>
+    <button type="submit" class="btn">Submit</button>
+    {{ form_end(form) }}
+{% endblock %}