support custom fields for timesheets, customers, projects and activities (#871)

src/Form/API/ActivityApiEditForm.php

@@ -0,0 +1,40 @@
+<?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\API;
+
+use App\Form\ActivityEditForm;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class ActivityApiEditForm extends ActivityEditForm
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        parent::buildForm($builder, $options);
+
+        $builder->remove('metaFields');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        parent::configureOptions($resolver);
+
+        $resolver->setDefaults([
+            'csrf_protection' => false,
+            'create_more' => false,
+        ]);
+    }
+}

src/Form/API/CustomerApiEditForm.php

@@ -0,0 +1,39 @@
+<?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\API;
+
+use App\Form\CustomerEditForm;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class CustomerApiEditForm extends CustomerEditForm
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        parent::buildForm($builder, $options);
+
+        $builder->remove('metaFields');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        parent::configureOptions($resolver);
+
+        $resolver->setDefaults([
+            'csrf_protection' => false,
+        ]);
+    }
+}

src/Form/API/ProjectApiEditForm.php

@@ -0,0 +1,40 @@
+<?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\API;
+
+use App\Form\ProjectEditForm;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class ProjectApiEditForm extends ProjectEditForm
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        parent::buildForm($builder, $options);
+
+        $builder->remove('metaFields');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        parent::configureOptions($resolver);
+
+        $resolver->setDefaults([
+            'csrf_protection' => false,
+            'create_more' => false,
+        ]);
+    }
+}

src/Form/API/TimesheetApiEditForm.php

@@ -0,0 +1,37 @@
+<?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\API;
+
+use App\Form\TimesheetEditForm;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class TimesheetApiEditForm extends TimesheetEditForm
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        parent::buildForm($builder, $options);
+
+        $builder->remove('metaFields');
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        parent::configureOptions($resolver);
+
+        $resolver->setDefaults([
+            'csrf_protection' => false,
+            'allow_duration' => false,
+        ]);
+    }
+}

src/Form/EntityFormTrait.php

@@ -13,6 +13,7 @@ use App\Form\Type\ColorPickerType;
 use App\Form\Type\DurationType;
 use App\Form\Type\FixedRateType;
 use App\Form\Type\HourlyRateType;
+use App\Form\Type\MetaFieldsCollectionType;
 use App\Form\Type\YesNoType;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\Extension\Core\Type\MoneyType;
@@ -47,6 +48,8 @@ trait EntityFormTrait
             ;
         }
 
+        $builder->add('metaFields', MetaFieldsCollectionType::class);
+
         $builder
             ->add('visible', YesNoType::class, [
                 'label' => 'label.visible',

src/Form/TimesheetEditForm.php

@@ -19,6 +19,7 @@ use App\Form\Type\DateTimePickerType;
 use App\Form\Type\DurationType;
 use App\Form\Type\FixedRateType;
 use App\Form\Type\HourlyRateType;
+use App\Form\Type\MetaFieldsCollectionType;
 use App\Form\Type\ProjectType;
 use App\Form\Type\TagsInputType;
 use App\Form\Type\UserType;
@@ -134,6 +135,8 @@ class TimesheetEditForm extends AbstractType
         $this->addTags($builder);
         $this->addRates($builder, $currency, $options);
         $this->addUser($builder, $options);
+        $builder->add('metaFields', MetaFieldsCollectionType::class);
+
         $this->addExported($builder, $options);
     }
 

src/Form/Type/EntityMetaDefinitionType.php

@@ -0,0 +1,60 @@
+<?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\Type;
+
+use App\Entity\MetaTableTypeInterface;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * Custom form field type to edit entity meta field.
+ */
+class EntityMetaDefinitionType extends AbstractType
+{
+    /**
+     * @param FormBuilderInterface $builder
+     * @param array $options
+     */
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder->addEventListener(
+            FormEvents::PRE_SET_DATA,
+            function (FormEvent $event) {
+                /** @var MetaTableTypeInterface $definition */
+                $definition = $event->getData();
+
+                if (!($definition instanceof MetaTableTypeInterface)) {
+                    return;
+                }
+
+                // prevents unconfigured values from showing up in the form
+                if (null === $definition->getType()) {
+                    return;
+                }
+
+                $event->getForm()->add('value', $definition->getType(), [
+                    'label' => $definition->getName(),
+                    'constraints' => $definition->getConstraints(),
+                    'required' => $definition->isRequired(),
+                ]);
+            }
+        );
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'data_class' => MetaTableTypeInterface::class,
+        ]);
+    }
+}

src/Form/Type/MetaFieldsCollectionType.php

@@ -0,0 +1,39 @@
+<?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\Type;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\CollectionType;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * Custom form field type to edit entity meta fields.
+ */
+class MetaFieldsCollectionType extends AbstractType
+{
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'entry_type' => EntityMetaDefinitionType::class,
+            'entry_options' => ['label' => false],
+            'allow_add' => false,
+            'allow_delete' => false,
+            'label' => false,
+        ]);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getParent()
+    {
+        return CollectionType::class;
+    }
+}