Add eventBundle exports

src/Bundle/ChillEventBundle/Export/Aggregator/EventDateAggregator.php

@@ -0,0 +1,110 @@
+<?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\EventBundle\Export\Aggregator;
+
+use Chill\EventBundle\Export\Declarations;
+use Chill\MainBundle\Export\AggregatorInterface;
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+class EventDateAggregator implements AggregatorInterface
+{
+    private const CHOICES = [
+        'by month' => 'month',
+        'by week' => 'week',
+        'by year' => 'year',
+    ];
+
+    private const DEFAULT_CHOICE = 'year';
+
+    public function addRole(): ?string
+    {
+        return null;
+    }
+
+    public function alterQuery(QueryBuilder $qb, $data)
+    {
+        $order = null;
+
+        switch ($data['frequency']) {
+            case 'month':
+                $fmt = 'YYYY-MM';
+
+                break;
+
+            case 'week':
+                $fmt = 'YYYY-IW';
+
+                break;
+
+            case 'year':
+                $fmt = 'YYYY';
+                $order = 'DESC';
+
+                break;
+
+            default:
+                throw new \RuntimeException(sprintf("The frequency data '%s' is invalid.", $data['frequency']));
+        }
+
+        $qb->addSelect(sprintf("TO_CHAR(event.date, '%s') AS date_aggregator", $fmt));
+        $qb->addGroupBy('date_aggregator');
+        $qb->addOrderBy('date_aggregator', $order);
+    }
+
+    public function applyOn(): string
+    {
+        return Declarations::EVENT;
+    }
+
+    public function buildForm(FormBuilderInterface $builder)
+    {
+        $builder->add('frequency', ChoiceType::class, [
+            'choices' => self::CHOICES,
+            'multiple' => false,
+            'expanded' => true,
+        ]);
+    }
+
+    public function getFormDefaultData(): array
+    {
+        return ['frequency' => self::DEFAULT_CHOICE];
+    }
+
+    public function getLabels($key, array $values, $data)
+    {
+        return static function ($value) use ($data): string {
+            if ('_header' === $value) {
+                return 'by '.$data['frequency'];
+            }
+
+            if (null === $value) {
+                return '';
+            }
+
+            return match ($data['frequency']) {
+                default => $value,
+            };
+        };
+    }
+
+    public function getQueryKeys($data): array
+    {
+        return ['date_aggregator'];
+    }
+
+    public function getTitle(): string
+    {
+        return 'Group event by date';
+    }
+}

src/Bundle/ChillEventBundle/Export/Aggregator/EventTypeAggregator.php

@@ -0,0 +1,83 @@
+<?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\EventBundle\Export\Aggregator;
+
+use Chill\EventBundle\Export\Declarations;
+use Chill\EventBundle\Repository\EventTypeRepository;
+use Chill\MainBundle\Export\AggregatorInterface;
+use Chill\MainBundle\Templating\TranslatableStringHelperInterface;
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Component\Form\FormBuilderInterface;
+
+class EventTypeAggregator implements AggregatorInterface
+{
+    final public const KEY = 'event_type_aggregator';
+
+    public function __construct(protected EventTypeRepository $eventTypeRepository, protected TranslatableStringHelperInterface $translatableStringHelper)
+    {
+    }
+
+    public function addRole(): ?string
+    {
+        return null;
+    }
+
+    public function alterQuery(QueryBuilder $qb, $data)
+    {
+        if (!\in_array('eventtype', $qb->getAllAliases(), true)) {
+            $qb->leftJoin('event.type', 'eventtype');
+        }
+
+        $qb->addSelect(sprintf('IDENTITY(event.type) AS %s', self::KEY));
+        $qb->addGroupBy(self::KEY);
+    }
+
+    public function applyOn(): string
+    {
+        return Declarations::EVENT;
+    }
+
+    public function buildForm(FormBuilderInterface $builder)
+    {
+        // no form required for this aggregator
+    }
+
+    public function getFormDefaultData(): array
+    {
+        return [];
+    }
+
+    public function getLabels($key, array $values, $data): \Closure
+    {
+        return function (int|string|null $value): string {
+            if ('_header' === $value) {
+                return 'Event type';
+            }
+
+            if (null === $value || '' === $value || null === $t = $this->eventTypeRepository->find($value)) {
+                return '';
+            }
+
+            return $this->translatableStringHelper->localize($t->getName());
+        };
+    }
+
+    public function getQueryKeys($data): array
+    {
+        return [self::KEY];
+    }
+
+    public function getTitle()
+    {
+        return 'Group by event type';
+    }
+}

src/Bundle/ChillEventBundle/Export/Aggregator/RoleAggregator.php

@@ -0,0 +1,83 @@
+<?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\EventBundle\Export\Aggregator;
+
+use Chill\EventBundle\Export\Declarations;
+use Chill\EventBundle\Repository\RoleRepository;
+use Chill\MainBundle\Export\AggregatorInterface;
+use Chill\MainBundle\Templating\TranslatableStringHelperInterface;
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Component\Form\FormBuilderInterface;
+
+class RoleAggregator implements AggregatorInterface
+{
+    final public const KEY = 'part_role_aggregator';
+
+    public function __construct(protected RoleRepository $roleRepository, protected TranslatableStringHelperInterface $translatableStringHelper)
+    {
+    }
+
+    public function addRole(): ?string
+    {
+        return null;
+    }
+
+    public function alterQuery(QueryBuilder $qb, $data)
+    {
+        if (!\in_array('event_part', $qb->getAllAliases(), true)) {
+            $qb->leftJoin('event_part.role', 'role');
+        }
+
+        $qb->addSelect(sprintf('IDENTITY(event_part.role) AS %s', self::KEY));
+        $qb->addGroupBy(self::KEY);
+    }
+
+    public function applyOn(): string
+    {
+        return Declarations::EVENT_PARTICIPANTS;
+    }
+
+    public function buildForm(FormBuilderInterface $builder)
+    {
+        // no form required for this aggregator
+    }
+
+    public function getFormDefaultData(): array
+    {
+        return [];
+    }
+
+    public function getLabels($key, array $values, $data): \Closure
+    {
+        return function (int|string|null $value): string {
+            if ('_header' === $value) {
+                return 'Participant role';
+            }
+
+            if (null === $value || '' === $value || null === $r = $this->roleRepository->find($value)) {
+                return '';
+            }
+
+            return $this->translatableStringHelper->localize($r->getName());
+        };
+    }
+
+    public function getQueryKeys($data): array
+    {
+        return [self::KEY];
+    }
+
+    public function getTitle()
+    {
+        return 'Group by participant role';
+    }
+}

src/Bundle/ChillEventBundle/Export/Declarations.php

@@ -0,0 +1,22 @@
+<?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\EventBundle\Export;
+
+/**
+ * This class declare constants used for the export framework.
+ */
+abstract class Declarations
+{
+    final public const EVENT = 'event';
+
+    final public const EVENT_PARTICIPANTS = 'event_participants';
+}

src/Bundle/ChillEventBundle/Export/Export/CountEventParticipations.php

@@ -0,0 +1,127 @@
+<?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\EventBundle\Export\Export;
+
+use Chill\EventBundle\Export\Declarations;
+use Chill\EventBundle\Repository\ParticipationRepository;
+use Chill\EventBundle\Security\ParticipationVoter;
+use Chill\MainBundle\Export\ExportInterface;
+use Chill\MainBundle\Export\FormatterInterface;
+use Chill\MainBundle\Export\GroupedExportInterface;
+use Chill\PersonBundle\Entity\Person\PersonCenterHistory;
+use Doctrine\ORM\Query;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+use Symfony\Component\Form\FormBuilderInterface;
+use Chill\PersonBundle\Export\Declarations as PersonDeclarations;
+
+readonly class CountEventParticipations implements ExportInterface, GroupedExportInterface
+{
+    private bool $filterStatsByCenters;
+
+    public function __construct(
+        private ParticipationRepository $participationRepository,
+        ParameterBagInterface $parameterBag,
+    ) {
+        $this->filterStatsByCenters = $parameterBag->get('chill_main')['acl']['filter_stats_by_center'];
+    }
+
+    public function buildForm(FormBuilderInterface $builder)
+    {
+    }
+
+    public function getFormDefaultData(): array
+    {
+        return [];
+    }
+
+    public function getAllowedFormattersTypes()
+    {
+        return [FormatterInterface::TYPE_TABULAR];
+    }
+
+    public function getDescription()
+    {
+        return 'Count participants to an event by various parameters.';
+    }
+
+    public function getGroup(): string
+    {
+        return 'Exports of events';
+    }
+
+    public function getLabels($key, array $values, $data)
+    {
+        if ('export_count_event_participants' !== $key) {
+            throw new \LogicException("the key {$key} is not used by this export");
+        }
+
+        return static fn ($value) => '_header' === $value ? 'Count event participants' : $value;
+    }
+
+    public function getQueryKeys($data)
+    {
+        return ['export_count_event_participants'];
+    }
+
+    public function getResult($query, $data)
+    {
+        return $query->getQuery()->getResult(Query::HYDRATE_SCALAR);
+    }
+
+    public function getTitle()
+    {
+        return 'Count event participants';
+    }
+
+    public function getType(): string
+    {
+        return Declarations::EVENT_PARTICIPANTS;
+    }
+
+    public function initiateQuery(array $requiredModifiers, array $acl, array $data = [])
+    {
+        $centers = array_map(static fn ($el) => $el['center'], $acl);
+
+        $qb = $this->participationRepository
+            ->createQueryBuilder('event_part')
+            ->join('event_part.person', 'person');
+
+        $qb->select('COUNT(event_part.id) as export_count_event_participants');
+
+        if ($this->filterStatsByCenters) {
+            $qb
+                ->andWhere(
+                    $qb->expr()->exists(
+                        'SELECT 1 FROM '.PersonCenterHistory::class.' acl_count_person_history WHERE acl_count_person_history.person = person
+                    AND acl_count_person_history.center IN (:authorized_centers)
+                    '
+                    )
+                )
+                ->setParameter('authorized_centers', $centers);
+        }
+
+        return $qb;
+    }
+
+    public function requiredRole(): string
+    {
+        return ParticipationVoter::STATS;
+    }
+
+    public function supportsModifiers()
+    {
+        return [
+            Declarations::EVENT_PARTICIPANTS,
+            PersonDeclarations::PERSON_TYPE,
+        ];
+    }
+}

src/Bundle/ChillEventBundle/Export/Export/CountEvents.php

@@ -0,0 +1,128 @@
+<?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\EventBundle\Export\Export;
+
+use Chill\EventBundle\Repository\EventRepository;
+use Chill\EventBundle\Security\EventVoter;
+use Chill\MainBundle\Export\ExportInterface;
+use Chill\MainBundle\Export\FormatterInterface;
+use Chill\MainBundle\Export\GroupedExportInterface;
+use Chill\PersonBundle\Entity\Person\PersonCenterHistory;
+use Doctrine\ORM\Query;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+use Symfony\Component\Form\FormBuilderInterface;
+use Chill\EventBundle\Export\Declarations;
+use Chill\PersonBundle\Export\Declarations as PersonDeclarations;
+
+readonly class CountEvents implements ExportInterface, GroupedExportInterface
+{
+    private bool $filterStatsByCenters;
+
+    public function __construct(
+        private EventRepository $eventRepository,
+        ParameterBagInterface $parameterBag,
+    ) {
+        $this->filterStatsByCenters = $parameterBag->get('chill_main')['acl']['filter_stats_by_center'];
+    }
+
+    public function buildForm(FormBuilderInterface $builder)
+    {
+    }
+
+    public function getFormDefaultData(): array
+    {
+        return [];
+    }
+
+    public function getAllowedFormattersTypes()
+    {
+        return [FormatterInterface::TYPE_TABULAR];
+    }
+
+    public function getDescription()
+    {
+        return 'Count events by various parameters.';
+    }
+
+    public function getGroup(): string
+    {
+        return 'Exports of events';
+    }
+
+    public function getLabels($key, array $values, $data)
+    {
+        if ('export_count_event' !== $key) {
+            throw new \LogicException("the key {$key} is not used by this export");
+        }
+
+        return static fn ($value) => '_header' === $value ? 'Number of events' : $value;
+    }
+
+    public function getQueryKeys($data)
+    {
+        return ['export_count_event'];
+    }
+
+    public function getResult($query, $data)
+    {
+        return $query->getQuery()->getResult(Query::HYDRATE_SCALAR);
+    }
+
+    public function getTitle()
+    {
+        return 'Count events';
+    }
+
+    public function getType(): string
+    {
+        return Declarations::EVENT;
+    }
+
+    public function initiateQuery(array $requiredModifiers, array $acl, array $data = [])
+    {
+        $centers = array_map(static fn ($el) => $el['center'], $acl);
+
+        $qb = $this->eventRepository
+            ->createQueryBuilder('event')
+            ->leftJoin('event.participations', 'epart')
+            ->leftJoin('epart.person', 'person');
+
+        $qb->select('COUNT(event.id) as export_count_event');
+
+        if ($this->filterStatsByCenters) {
+            $qb
+                ->andWhere(
+                    $qb->expr()->exists(
+                        'SELECT 1 FROM '.PersonCenterHistory::class.' acl_count_person_history WHERE acl_count_person_history.person = person
+                    AND acl_count_person_history.center IN (:authorized_centers)
+                    '
+                    )
+                )
+                ->setParameter('authorized_centers', $centers);
+        }
+
+        return $qb;
+    }
+
+    public function requiredRole(): string
+    {
+        return EventVoter::STATS;
+    }
+
+    public function supportsModifiers()
+    {
+        return [
+            Declarations::EVENT,
+            PersonDeclarations::PERSON_TYPE,
+        ];
+    }
+}

src/Bundle/ChillEventBundle/Export/Filter/EventDateFilter.php

@@ -0,0 +1,97 @@
+<?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\EventBundle\Export\Filter;
+
+use Chill\EventBundle\Export\Declarations;
+use Chill\MainBundle\Export\FilterInterface;
+use Chill\MainBundle\Form\Type\PickRollingDateType;
+use Chill\MainBundle\Service\RollingDate\RollingDate;
+use Chill\MainBundle\Service\RollingDate\RollingDateConverterInterface;
+use Doctrine\ORM\Query\Expr;
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+class EventDateFilter implements FilterInterface
+{
+    public function __construct(protected TranslatorInterface $translator, private readonly RollingDateConverterInterface $rollingDateConverter)
+    {
+    }
+
+    public function addRole(): ?string
+    {
+        return null;
+    }
+
+    public function alterQuery(QueryBuilder $qb, $data)
+    {
+        $where = $qb->getDQLPart('where');
+        $clause = $qb->expr()->between(
+            'event.date',
+            ':date_from',
+            ':date_to'
+        );
+
+        if ($where instanceof Expr\Andx) {
+            $where->add($clause);
+        } else {
+            $where = $qb->expr()->andX($clause);
+        }
+
+        $qb->add('where', $where);
+        $qb->setParameter(
+            'date_from',
+            $this->rollingDateConverter->convert($data['date_from'])
+        );
+        $qb->setParameter(
+            'date_to',
+            $this->rollingDateConverter->convert($data['date_to'])
+        );
+    }
+
+    public function applyOn(): string
+    {
+        return Declarations::EVENT;
+    }
+
+    public function buildForm(FormBuilderInterface $builder)
+    {
+        $builder
+            ->add('date_from', PickRollingDateType::class, [
+                'label' => 'Events after this date',
+            ])
+            ->add('date_to', PickRollingDateType::class, [
+                'label' => 'Events before this date',
+            ]);
+    }
+
+    public function getFormDefaultData(): array
+    {
+        return ['date_from' => new RollingDate(RollingDate::T_YEAR_PREVIOUS_START), 'date_to' => new RollingDate(RollingDate::T_TODAY)];
+    }
+
+    public function describeAction($data, $format = 'string')
+    {
+        return [
+            'Filtered by date of event: only between %date_from% and %date_to%',
+            [
+                '%date_from%' => $this->rollingDateConverter->convert($data['date_from'])->format('d-m-Y'),
+                '%date_to%' => $this->rollingDateConverter->convert($data['date_to'])->format('d-m-Y'),
+            ],
+        ];
+    }
+
+    public function getTitle()
+    {
+        return 'Filtered by event date';
+    }
+}

src/Bundle/ChillEventBundle/Export/Filter/EventTypeFilter.php

@@ -0,0 +1,95 @@
+<?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\EventBundle\Export\Filter;
+
+use Chill\EventBundle\Entity\EventType;
+use Chill\EventBundle\Export\Declarations;
+use Chill\EventBundle\Repository\EventTypeRepository;
+use Chill\MainBundle\Export\ExportElementValidatedInterface;
+use Chill\MainBundle\Export\FilterInterface;
+use Chill\MainBundle\Templating\TranslatableStringHelperInterface;
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Bridge\Doctrine\Form\Type\EntityType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Validator\Context\ExecutionContextInterface;
+
+class EventTypeFilter implements ExportElementValidatedInterface, FilterInterface
+{
+    public function __construct(
+        protected TranslatableStringHelperInterface $translatableStringHelper,
+        protected EventTypeRepository $eventTypeRepository
+    ) {
+    }
+
+    public function addRole(): ?string
+    {
+        return null;
+    }
+
+    public function alterQuery(QueryBuilder $qb, $data)
+    {
+        $clause = $qb->expr()->in('event.type', ':selected_event_types');
+
+        $qb->andWhere($clause);
+        $qb->setParameter('selected_event_types', $data['types']);
+    }
+
+    public function applyOn(): string
+    {
+        return Declarations::EVENT;
+    }
+
+    public function buildForm(FormBuilderInterface $builder)
+    {
+        $builder->add('types', EntityType::class, [
+            'choices' => $this->eventTypeRepository->findAllActive(),
+            'class' => EventType::class,
+            'choice_label' => fn (EventType $ety) => $this->translatableStringHelper->localize($ety->getName()),
+            'multiple' => true,
+            'expanded' => false,
+            'attr' => [
+                'class' => 'select2',
+            ],
+        ]);
+    }
+
+    public function getFormDefaultData(): array
+    {
+        return [];
+    }
+
+    public function describeAction($data, $format = 'string')
+    {
+        $typeNames = array_map(
+            fn (EventType $t): string => $this->translatableStringHelper->localize($t->getName()),
+            $this->eventTypeRepository->findBy(['id' => $data['types'] instanceof \Doctrine\Common\Collections\Collection ? $data['types']->toArray() : $data['types']])
+        );
+
+        return ['Filtered by event type: only %list%', [
+            '%list%' => implode(', ', $typeNames),
+        ]];
+    }
+
+    public function getTitle()
+    {
+        return 'Filtered by event type';
+    }
+
+    public function validateForm($data, ExecutionContextInterface $context)
+    {
+        if (null === $data['types'] || 0 === \count($data['types'])) {
+            $context
+                ->buildViolation('At least one type must be chosen')
+                ->addViolation();
+        }
+    }
+}

src/Bundle/ChillEventBundle/Export/Filter/RoleFilter.php

@@ -0,0 +1,95 @@
+<?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\EventBundle\Export\Filter;
+
+use Chill\EventBundle\Entity\Role;
+use Chill\EventBundle\Export\Declarations;
+use Chill\EventBundle\Repository\RoleRepository;
+use Chill\MainBundle\Export\ExportElementValidatedInterface;
+use Chill\MainBundle\Export\FilterInterface;
+use Chill\MainBundle\Templating\TranslatableStringHelperInterface;
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Bridge\Doctrine\Form\Type\EntityType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Validator\Context\ExecutionContextInterface;
+
+class RoleFilter implements ExportElementValidatedInterface, FilterInterface
+{
+    public function __construct(
+        protected TranslatableStringHelperInterface $translatableStringHelper,
+        protected RoleRepository $roleRepository
+    ) {
+    }
+
+    public function addRole(): ?string
+    {
+        return null;
+    }
+
+    public function alterQuery(QueryBuilder $qb, $data)
+    {
+        $clause = $qb->expr()->in('event_part.role', ':selected_part_roles');
+
+        $qb->andWhere($clause);
+        $qb->setParameter('selected_part_roles', $data['part_roles']);
+    }
+
+    public function applyOn(): string
+    {
+        return Declarations::EVENT_PARTICIPANTS;
+    }
+
+    public function buildForm(FormBuilderInterface $builder)
+    {
+        $builder->add('part_roles', EntityType::class, [
+            'choices' => $this->roleRepository->findAllActive(),
+            'class' => Role::class,
+            'choice_label' => fn (Role $r) => $this->translatableStringHelper->localize($r->getName()),
+            'multiple' => true,
+            'expanded' => false,
+            'attr' => [
+                'class' => 'select2',
+            ],
+        ]);
+    }
+
+    public function getFormDefaultData(): array
+    {
+        return [];
+    }
+
+    public function describeAction($data, $format = 'string')
+    {
+        $roleNames = array_map(
+            fn (Role $r): string => $this->translatableStringHelper->localize($r->getName()),
+            $this->roleRepository->findBy(['id' => $data['part_roles'] instanceof \Doctrine\Common\Collections\Collection ? $data['part_roles']->toArray() : $data['part_roles']])
+        );
+
+        return ['Filtered by participant roles: only %list%', [
+            '%list%' => implode(', ', $roleNames),
+        ]];
+    }
+
+    public function getTitle()
+    {
+        return 'Filter by participant roles';
+    }
+
+    public function validateForm($data, ExecutionContextInterface $context)
+    {
+        if (null === $data['part_roles'] || 0 === \count($data['part_roles'])) {
+            $context
+                ->buildViolation('At least one role must be chosen')
+                ->addViolation();
+        }
+    }
+}