Export: add an export which count persons on activity

.changes/unreleased/Feature-20231115-121431.yaml

@@ -0,0 +1,5 @@
+kind: Feature
+body: 'Export: add an export which count persons on activity'
+time: 2023-11-15T12:14:31.515840946+01:00
+custom:
+  Issue: "206"

src/Bundle/ChillActivityBundle/Export/Export/LinkedToACP/CountPersonsOnActivity.php

@@ -0,0 +1,138 @@
+<?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\Export\LinkedToACP;
+
+use Chill\ActivityBundle\Entity\Activity;
+use Chill\ActivityBundle\Export\Declarations;
+use Chill\ActivityBundle\Security\Authorization\ActivityStatsVoter;
+use Chill\MainBundle\Export\AccompanyingCourseExportHelper;
+use Chill\MainBundle\Export\ExportInterface;
+use Chill\MainBundle\Export\FormatterInterface;
+use Chill\MainBundle\Export\GroupedExportInterface;
+use Chill\PersonBundle\Entity\AccompanyingPeriodParticipation;
+use Chill\PersonBundle\Entity\Person\PersonCenterHistory;
+use Chill\PersonBundle\Export\Declarations as PersonDeclarations;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\EntityRepository;
+use Doctrine\ORM\Query;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+use Symfony\Component\Form\FormBuilderInterface;
+
+class CountPersonsOnActivity implements ExportInterface, GroupedExportInterface
+{
+    protected EntityRepository $repository;
+
+    private readonly bool $filterStatsByCenters;
+
+    public function __construct(
+        EntityManagerInterface $em,
+        ParameterBagInterface $parameterBag,
+    ) {
+        $this->repository = $em->getRepository(Activity::class);
+        $this->filterStatsByCenters = $parameterBag->get('chill_main')['acl']['filter_stats_by_center'];
+    }
+
+    public function buildForm(FormBuilderInterface $builder) {}
+
+    public function getFormDefaultData(): array
+    {
+        return [];
+    }
+
+    public function getAllowedFormattersTypes(): array
+    {
+        return [FormatterInterface::TYPE_TABULAR];
+    }
+
+    public function getDescription(): string
+    {
+        return 'export.export.count_person_on_activity.description';
+    }
+
+    public function getGroup(): string
+    {
+        return 'Exports of activities linked to an accompanying period';
+    }
+
+    public function getLabels($key, array $values, $data)
+    {
+        if ('export_count_activity' !== $key) {
+            throw new \LogicException("the key {$key} is not used by this export");
+        }
+
+        return static fn ($value) => '_header' === $value ? 'export.export.count_person_on_activity.header' : $value;
+    }
+
+    public function getQueryKeys($data): array
+    {
+        return ['export_count_activity'];
+    }
+
+    public function getResult($query, $data)
+    {
+        return $query->getQuery()->getResult(Query::HYDRATE_SCALAR);
+    }
+
+    public function getTitle(): string
+    {
+        return 'export.export.count_person_on_activity.title';
+    }
+
+    public function getType(): string
+    {
+        return Declarations::ACTIVITY;
+    }
+
+    public function initiateQuery(array $requiredModifiers, array $acl, array $data = [])
+    {
+        $centers = array_map(static fn ($el) => $el['center'], $acl);
+
+        $qb = $this->repository
+            ->createQueryBuilder('activity')
+            ->join('activity.persons', 'person')
+            ->join('activity.accompanyingPeriod', 'acp');
+
+        if ($this->filterStatsByCenters) {
+            $qb
+                ->andWhere(
+                    $qb->expr()->exists(
+                        'SELECT 1 FROM '.AccompanyingPeriodParticipation::class.' acl_count_part
+                    JOIN '.PersonCenterHistory::class.' acl_count_person_history WITH IDENTITY(acl_count_person_history.person) = IDENTITY(acl_count_part.person)
+                    WHERE acl_count_part.accompanyingPeriod = acp.id AND acl_count_person_history.center IN (:authorized_centers)
+                    '
+                    )
+                )
+                ->setParameter('authorized_centers', $centers);
+        }
+
+        AccompanyingCourseExportHelper::addClosingMotiveExclusionClause($qb);
+
+        $qb->select('COUNT(DISTINCT person.id) as export_count_activity');
+
+        return $qb;
+    }
+
+    public function requiredRole(): string
+    {
+        return ActivityStatsVoter::STATS;
+    }
+
+    public function supportsModifiers(): array
+    {
+        return [
+            Declarations::ACTIVITY,
+            Declarations::ACTIVITY_ACP,
+            PersonDeclarations::ACP_TYPE,
+            PersonDeclarations::PERSON_TYPE,
+        ];
+    }
+}

src/Bundle/ChillActivityBundle/Tests/Export/Export/LinkedToACP/CountPersonsOnActivityTest.php

@@ -0,0 +1,54 @@
+<?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\Export\LinkedToACP;
+
+use Chill\ActivityBundle\Export\Declarations;
+use Chill\ActivityBundle\Export\Export\LinkedToACP\CountPersonsOnActivity;
+use Chill\MainBundle\Test\Export\AbstractExportTest;
+use Chill\PersonBundle\Export\Declarations as PersonDeclarations;
+use Doctrine\ORM\EntityManagerInterface;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class CountPersonsOnActivityTest extends AbstractExportTest
+{
+    protected function setUp(): void
+    {
+        self::bootKernel();
+    }
+
+    public function getExport()
+    {
+        $em = self::$container->get(EntityManagerInterface::class);
+
+        yield new CountPersonsOnActivity($em, $this->getParameters(true));
+        yield new CountPersonsOnActivity($em, $this->getParameters(false));
+    }
+
+    public function getFormData()
+    {
+        return [[]];
+    }
+
+    public function getModifiersCombination()
+    {
+        return [[
+            Declarations::ACTIVITY,
+            Declarations::ACTIVITY_ACP,
+            PersonDeclarations::ACP_TYPE,
+            PersonDeclarations::PERSON_TYPE,
+        ]];
+    }
+}

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

@@ -16,6 +16,10 @@ services:
         tags:
             - { name: chill.export, alias: 'list_activity_linked_to_person' }
 
+    Chill\ActivityBundle\Export\Export\LinkedToACP\CountPersonsOnActivity:
+        tags:
+            - { name: chill.export, alias: 'count_person_on_activity' }
+
     chill.activity.export.count_activity_linked_to_acp:
         class: Chill\ActivityBundle\Export\Export\LinkedToACP\CountActivity
         tags:

src/Bundle/ChillActivityBundle/translations/messages.fr.yml

@@ -332,6 +332,11 @@ docgen:
     myWorksOnly: Prendre en compte uniquement les actions d'accompagnement dont je suis référent
 
 export:
+    export:
+        count_person_on_activity:
+            title: Nombre d'usagers concernés par les échanges
+            description: Compte le nombre d'usagers concernés par les échanges. Si un usager est présent dans plusieurs échanges, il n'est comptabilisé qu'une seule fois.
+            header: Nombre d'usagers concernés par des échanges
     list:
         activity:
             users name: Nom des utilisateurs