kimai2/src/Form/Toolbar/AbstractToolbarForm.php

<?php

/*
 * This file is part of the Kimai time-tracking app.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace App\Form\Toolbar;

use App\Form\Type\ActivityType;
use App\Form\Type\CustomerType;
use App\Form\Type\DateRangeType;
use App\Form\Type\PageSizeType;
use App\Form\Type\ProjectType;
use App\Form\Type\SearchTermType;
use App\Form\Type\TagsInputType;
use App\Form\Type\UserRoleType;
use App\Form\Type\UserType;
use App\Form\Type\VisibilityType;
use App\Repository\ActivityRepository;
use App\Repository\CustomerRepository;
use App\Repository\ProjectRepository;
use App\Repository\Query\ActivityFormTypeQuery;
use App\Repository\Query\BaseQuery;
use App\Repository\Query\CustomerFormTypeQuery;
use App\Repository\Query\ProjectFormTypeQuery;
use App\Repository\Query\TimesheetQuery;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormEvent;
use Symfony\Component\Form\FormEvents;
use Symfony\Component\Validator\Constraints\Choice;

/**
 * Defines the base form used for all toolbars.
 *
 * Extend this class and stack the elements defined here, they are coupled to each other and with the toolbar.js.
 */
abstract class AbstractToolbarForm extends AbstractType
{
    /**
     * Dirty hack to enable easy handling of GET form in controller and javascript.
     * Cleans up the name of all form elements (and unfortunately of the form itself).
     *
     * @return null|string
     */
    public function getBlockPrefix()
    {
        return '';
    }

    /**
     * Returns whether the Javascript select-picker is allowed.
     * TODO can be removed... once all bugs are fixed.
     *
     * @return bool
     */
    protected function getSelectpickerConfig(): bool
    {
        return true;
    }

    protected function addUserChoice(FormBuilderInterface $builder)
    {
        $builder->add('user', UserType::class, [
            'label' => 'label.user',
            'required' => false,
            'selectpicker' => $this->getSelectpickerConfig(),
        ]);
    }

    protected function addUsersChoice(FormBuilderInterface $builder)
    {
        $builder->add('users', UserType::class, [
            'label' => 'label.user',
            'multiple' => true,
            'required' => false,
            'selectpicker' => $this->getSelectpickerConfig(),
        ]);
    }

    protected function addCustomerChoice(FormBuilderInterface $builder, bool $required = false)
    {
        // just a fake field for having this field at the right position in the frontend
        $builder->add('customer', HiddenType::class);

        $builder->addEventListener(
            FormEvents::PRE_SUBMIT,
            function (FormEvent $event) use ($builder, $required) {
                $data = $event->getData();
                $event->getForm()->add('customer', CustomerType::class, [
                    'required' => $required,
                    'project_enabled' => true,
                    'query_builder' => function (CustomerRepository $repo) use ($builder, $data) {
                        $query = new CustomerFormTypeQuery();
                        $query->setUser($builder->getOption('user'));
                        if (isset($data['customer']) && !empty($data['customer'])) {
                            $query->setCustomer($data['customer']);
                        }

                        return $repo->getQueryBuilderForFormType($query);
                    },
                    'selectpicker' => $this->getSelectpickerConfig(),
                ]);
            }
        );
    }

    protected function addVisibilityChoice(FormBuilderInterface $builder, string $label = 'label.visible')
    {
        $builder->add('visibility', VisibilityType::class, [
            'required' => false,
            'placeholder' => null,
            'label' => $label,
            'selectpicker' => $this->getSelectpickerConfig(),
        ]);
    }

    protected function addPageSizeChoice(FormBuilderInterface $builder)
    {
        $builder->add('pageSize', PageSizeType::class, [
            'required' => false,
            'selectpicker' => $this->getSelectpickerConfig(),
        ]);
    }

    protected function addUserRoleChoice(FormBuilderInterface $builder)
    {
        $builder->add('role', UserRoleType::class, [
            'required' => false,
            'selectpicker' => $this->getSelectpickerConfig(),
        ]);
    }

    protected function addDateRangeChoice(FormBuilderInterface $builder, $allowEmpty = true)
    {
        $builder->add('daterange', DateRangeType::class, [
            'required' => false,
            'allow_empty' => $allowEmpty,
        ]);
    }

    protected function addProjectChoice(FormBuilderInterface $builder)
    {
        // just a fake field for having this field at the right position in the frontend
        $builder->add('project', HiddenType::class);

        $builder->addEventListener(
            FormEvents::PRE_SUBMIT,
            function (FormEvent $event) use ($builder) {
                $data = $event->getData();
                $event->getForm()->add('project', ProjectType::class, [
                    'required' => false,
                    'activity_enabled' => true,
                    'query_builder' => function (ProjectRepository $repo) use ($builder, $data) {
                        $query = new ProjectFormTypeQuery();
                        $query->setUser($builder->getOption('user'));

                        if (isset($data['customer']) && !empty($data['customer'])) {
                            $query->setCustomer($data['customer']);
                        }
                        if (isset($data['project']) && !empty($data['project'])) {
                            $query->setProject($data['project']);
                        }

                        return $repo->getQueryBuilderForFormType($query);
                    },
                    'selectpicker' => $this->getSelectpickerConfig(),
                ]);
            }
        );
    }

    protected function addActivityChoice(FormBuilderInterface $builder)
    {
        // just a fake field for having this field at the right position in the frontend
        $builder->add('activity', HiddenType::class);

        $builder->addEventListener(
            FormEvents::PRE_SUBMIT,
            function (FormEvent $event) {
                $data = $event->getData();
                $event->getForm()->add('activity', ActivityType::class, [
                    'required' => false,
                    'query_builder' => function (ActivityRepository $repo) use ($data) {
                        $query = new ActivityFormTypeQuery();

                        if (isset($data['activity']) && !empty($data['activity'])) {
                            $query->setActivity($data['activity']);
                        }
                        if (isset($data['project']) && !empty($data['project'])) {
                            $query->setProject($data['project']);
                        }

                        return $repo->getQueryBuilderForFormType($query);
                    },
                    'selectpicker' => $this->getSelectpickerConfig(),
                ]);
            }
        );
    }

    protected function addHiddenPagination(FormBuilderInterface $builder)
    {
        $builder->add('page', HiddenType::class, [
            'empty_data' => 1
        ]);
    }

    protected function addHiddenOrder(FormBuilderInterface $builder)
    {
        $builder->add('order', HiddenType::class, [
            'constraints' => [
                new Choice(['choices' => [BaseQuery::ORDER_ASC, BaseQuery::ORDER_DESC]])
            ]
        ]);
    }

    protected function addHiddenOrderBy(FormBuilderInterface $builder, array $allowedColumns)
    {
        $builder->add('orderBy', HiddenType::class, [
            'constraints' => [
                new Choice(['choices' => $allowedColumns])
            ]
        ]);
    }

    protected function addTagInputField(FormBuilderInterface $builder)
    {
        $builder->add('tags', TagsInputType::class, [
            'required' => false
        ]);
    }

    protected function addSearchTermInputField(FormBuilderInterface $builder)
    {
        $builder->add('searchTerm', SearchTermType::class);
    }

    protected function addTimesheetStateChoice(FormBuilderInterface $builder)
    {
        $builder->add('state', ChoiceType::class, [
            'label' => 'label.entryState',
            'required' => false,
            'placeholder' => null,
            'choices' => [
                'entryState.all' => TimesheetQuery::STATE_ALL,
                'entryState.running' => TimesheetQuery::STATE_RUNNING,
                'entryState.stopped' => TimesheetQuery::STATE_STOPPED
            ],
            'selectpicker' => $this->getSelectpickerConfig(),
        ]);
    }

    protected function addExportStateChoice(FormBuilderInterface $builder)
    {
        $builder->add('exported', ChoiceType::class, [
            'label' => 'label.exported',
            'required' => false,
            'placeholder' => null,
            'choices' => [
                'entryState.all' => TimesheetQuery::STATE_ALL,
                'entryState.exported' => TimesheetQuery::STATE_EXPORTED,
                'entryState.not_exported' => TimesheetQuery::STATE_NOT_EXPORTED
            ],
            'selectpicker' => $this->getSelectpickerConfig(),
        ]);
    }
}