[export] add a filter and aggregator on activity: by creator job

.changes/unreleased/Feature-20231011-155115.yaml

@@ -0,0 +1,5 @@
+kind: Feature
+body: '[export] add an aggregator for activities: group by job scope aggregator'
+time: 2023-10-11T15:51:15.022779832+02:00
+custom:
+  Issue: ""

src/Bundle/ChillActivityBundle/Export/Aggregator/CreatorScopeAggregator.php

@@ -93,7 +93,7 @@ class CreatorScopeAggregator implements AggregatorInterface
 
     public function getQueryKeys($data): array
     {
-        return ['_select'];
+        return [self::PREFIX . '_select'];
     }
 
     public function getTitle(): string

src/Bundle/ChillActivityBundle/Export/Aggregator/JobScopeAggregator.php

@@ -0,0 +1,104 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\ActivityBundle\Export\Aggregator;
+
+use Chill\ActivityBundle\Export\Declarations;
+use Chill\MainBundle\Entity\User\UserJobHistory;
+use Chill\MainBundle\Entity\User\UserScopeHistory;
+use Chill\MainBundle\Export\AggregatorInterface;
+use Chill\MainBundle\Repository\ScopeRepository;
+use Chill\MainBundle\Templating\TranslatableStringHelper;
+use Doctrine\ORM\Query\Expr\Join;
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Component\Form\FormBuilderInterface;
+
+class JobScopeAggregator implements AggregatorInterface
+{
+    private const PREFIX = 'acp_agg_creator_job';
+
+    public function __construct(
+        private readonly ScopeRepository $scopeRepository,
+        private readonly TranslatableStringHelper $translatableStringHelper
+    ) {}
+
+    public function addRole(): ?string
+    {
+        return null;
+    }
+
+    public function alterQuery(QueryBuilder $qb, $data)
+    {
+        $p = self::PREFIX;
+
+        $qb
+            ->leftJoin("activity.createdBy", "{$p}_user")
+            ->leftJoin(
+                UserJobHistory::class,
+                "{$p}_history",
+                Join::WITH,
+                $qb->expr()->eq("{$p}_history.user", "{$p}_user")
+            )
+            // job_at based on activity.date
+            ->andWhere(
+                $qb->expr()->andX(
+                    $qb->expr()->lte("{$p}_history.startDate", "activity.date"),
+                    $qb->expr()->orX(
+                        $qb->expr()->isNull("{$p}_history.endDate"),
+                        $qb->expr()->gt("{$p}_history.endDate", "activity.date")
+                    )
+                )
+            )
+            ->addSelect("IDENTITY({$p}_history.job) AS {$p}_select")
+            ->addGroupBy("{$p}_select");
+    }
+
+    public function applyOn(): string
+    {
+        return Declarations::ACTIVITY;
+    }
+
+    public function buildForm(FormBuilderInterface $builder) {}
+
+    public function getFormDefaultData(): array
+    {
+        return [];
+    }
+
+    public function getLabels($key, array $values, $data)
+    {
+        return function ($value): string {
+            if ('_header' === $value) {
+                return 'Scope';
+            }
+
+            if (null === $value || '' === $value) {
+                return '';
+            }
+
+            $s = $this->scopeRepository->find($value);
+
+            return $this->translatableStringHelper->localize(
+                $s->getName()
+            );
+        };
+    }
+
+    public function getQueryKeys($data): array
+    {
+        return [self::PREFIX . '_select'];
+    }
+
+    public function getTitle(): string
+    {
+        return 'export.aggregator.activity.by_creator_job.Group activity by creator job';
+    }
+}

src/Bundle/ChillActivityBundle/Tests/Export/Aggregator/JobScopeAggregatorTest.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\ActivityBundle\Tests\Export\Aggregator;
+
+use Chill\ActivityBundle\Entity\Activity;
+use Chill\ActivityBundle\Export\Aggregator\CreatorScopeAggregator;
+use Chill\ActivityBundle\Export\Aggregator\JobScopeAggregator;
+use Chill\MainBundle\Test\Export\AbstractAggregatorTest;
+use Doctrine\ORM\EntityManagerInterface;
+
+/**
+ * @internal
+ * @coversNothing
+ */
+final class JobScopeAggregatorTest extends AbstractAggregatorTest
+{
+    private JobScopeAggregator $aggregator;
+    protected function setUp(): void
+    {
+        self::bootKernel();
+
+        $this->aggregator = self::$container->get(JobScopeAggregator::class);
+    }
+
+    public function getAggregator()
+    {
+        return $this->aggregator;
+    }
+
+    public function getFormData(): array
+    {
+        return [
+            [],
+        ];
+    }
+
+    public function getQueryBuilders(): array
+    {
+        self::bootKernel();
+
+        $em = self::$container->get(EntityManagerInterface::class);
+
+        return [
+            $em->createQueryBuilder()
+                ->select('count(activity.id)')
+                ->from(Activity::class, 'activity')
+                ->leftJoin('activity.accompanyingPeriod', 'acp')
+                ->leftJoin('activity.user', 'actuser'),
+        ];
+    }
+}

src/Bundle/ChillActivityBundle/config/services/export.yaml

@@ -177,6 +177,10 @@ services:
         tags:
             - { name: chill.export_aggregator, alias: activity_creator_scope_aggregator }
 
+    Chill\ActivityBundle\Export\Aggregator\JobScopeAggregator:
+        tags:
+            - { name: chill.export_aggregator, alias: activity_creator_job_aggregator }
+
     Chill\ActivityBundle\Export\Aggregator\ActivityUsersAggregator:
         tags:
             - { name: chill.export_aggregator, alias: activity_users_aggregator }