chill-bundles/src/Bundle/ChillActivityBundle/Export/Aggregator/ActivityReasonAggregator.php

<?php

/**
 * 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.
 *
 * @see https://www.champs-libres.coop/
 */

declare(strict_types=1);

namespace Chill\ActivityBundle\Export\Aggregator;

use Chill\ActivityBundle\Security\Authorization\ActivityStatsVoter;
use Chill\MainBundle\Export\AggregatorInterface;
use Chill\MainBundle\Export\ExportElementValidatedInterface;
use Chill\MainBundle\Templating\TranslatableStringHelper;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Query\Expr\Join;
use Doctrine\ORM\QueryBuilder;
use RuntimeException;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Security\Core\Role\Role;
use Symfony\Component\Validator\Context\ExecutionContextInterface;

use function array_key_exists;
use function count;

class ActivityReasonAggregator implements
    AggregatorInterface,
    ExportElementValidatedInterface
{
    /**
     * @var EntityRepository
     */
    protected $categoryRepository;

    /**
     * @var EntityRepository
     */
    protected $reasonRepository;

    /**
     * @var TranslatableStringHelper
     */
    protected $stringHelper;

    public function __construct(
        EntityRepository $categoryRepository,
        EntityRepository $reasonRepository,
        TranslatableStringHelper $stringHelper
    ) {
        $this->categoryRepository = $categoryRepository;
        $this->reasonRepository = $reasonRepository;
        $this->stringHelper = $stringHelper;
    }

    public function addRole()
    {
        return new Role(ActivityStatsVoter::STATS);
    }

    public function alterQuery(QueryBuilder $qb, $data)
    {
        // add select element
        if ('reasons' === $data['level']) {
            $elem = 'reasons.id';
            $alias = 'activity_reasons_id';
        } elseif ('categories' === $data['level']) {
            $elem = 'category.id';
            $alias = 'activity_categories_id';
        } else {
            throw new RuntimeException('the data provided are not recognized');
        }

        $qb->addSelect($elem . ' as ' . $alias);

        // make a jointure only if needed
        $join = $qb->getDQLPart('join');

        if (
            (
                array_key_exists('activity', $join)
            && !$this->checkJoinAlreadyDefined($join['activity'], 'reasons')
            )
            || (!array_key_exists('activity', $join))
        ) {
            $qb->add(
                'join',
                ['activity' => new Join(Join::INNER_JOIN, 'activity.reasons', 'reasons'),
                ],
                true
            );
        }

        // join category if necessary
        if ('activity_categories_id' === $alias) {
            // add join only if needed
            if (!$this->checkJoinAlreadyDefined($qb->getDQLPart('join')['activity'], 'category')) {
                $qb->join('reasons.category', 'category');
            }
        }

        // add the "group by" part
        $groupBy = $qb->getDQLPart('groupBy');

        if (count($groupBy) > 0) {
            $qb->addGroupBy($alias);
        } else {
            $qb->groupBy($alias);
        }
    }

    public function applyOn()
    {
        return 'activity';
    }

    public function buildForm(FormBuilderInterface $builder)
    {
        $builder->add('level', ChoiceType::class, [
            'choices' => [
                'By reason' => 'reasons',
                'By category of reason' => 'categories',
            ],
            'multiple' => false,
            'expanded' => true,
            'label' => 'Reason\'s level',
        ]);
    }

    public function getLabels($key, array $values, $data)
    {
        // for performance reason, we load data from db only once
        switch ($data['level']) {
            case 'reasons':
                $this->reasonRepository->findBy(['id' => $values]);

                break;
            case 'categories':
                $this->categoryRepository->findBy(['id' => $values]);

                break;

            default:
                throw new RuntimeException(sprintf(
                    "the level data '%s' is invalid",
                    $data['level']
                ));
        }

        return function ($value) use ($data) {
            if ('_header' === $value) {
                return 'reasons' === $data['level'] ?
                        'Group by reasons'
                        :
                        'Group by categories of reason';
            }

            switch ($data['level']) {
                case 'reasons':
                    /** @var \Chill\ActivityBundle\Entity\ActivityReason $r */
                    $r = $this->reasonRepository->find($value);

                    return $this->stringHelper->localize($r->getCategory()->getName())
                            . ' > '
                            . $this->stringHelper->localize($r->getName());

                    break;
                case 'categories':
                    $c = $this->categoryRepository->find($value);

                    return $this->stringHelper->localize($c->getName());

                    break;
                // no need for a default : the default was already set above
            }
        };
    }

    public function getQueryKeys($data)
    {
        // add select element
        if ('reasons' === $data['level']) {
            return ['activity_reasons_id'];
        }

        if ('categories' === $data['level']) {
            return ['activity_categories_id'];
        }

        throw new RuntimeException('the data provided are not recognised');
    }

    public function getTitle()
    {
        return 'Aggregate by activity reason';
    }

    public function validateForm($data, ExecutionContextInterface $context)
    {
        if (null === $data['level']) {
            $context->buildViolation("The reasons's level should not be empty")
                ->addViolation();
        }
    }

    /**
     * Check if a join between Activity and another alias.
     *
     * @param Join[] $joins
     * @param string $alias the alias to search for
     *
     * @return bool
     */
    private function checkJoinAlreadyDefined(array $joins, $alias)
    {
        foreach ($joins as $join) {
            if ($join->getAlias() === $alias) {
                return true;
            }
        }

        return false;
    }
}