Tweak your Form based on the Underlying Data

Hey Courtney-T,

It should be there, are you talking about Symfony form type or something else from the EA? Please, share more information on what you're doing so we could help.

Cheers!

Sure, I'm trying to have an EA form basically update in real time. I have a form where a user can write a sale. So, it would be effective to have fields like the subtotal and total sale amount update as a user is selecting items to put on the sale. I realize I probably need some ajax, but I'm not entirely sure where to plug that in. Or a custom JS controller. I think I'm not entirely sure what the best approach is. Here's how I have things set up so far and I'm hoping you can point me in the right direction.

This is the CRUD controller:

<?php

namespace App\Controller\Admin;

use App\Entity\Sale;
use App\Entity\User;
use App\Entity\Customer;
use App\Entity\SaleItems;
use App\Entity\Inventory;
use App\Entity\Packages;
use App\Form\SaleItemType;
use App\Form\ItemFormType;
use App\Form\QuantityType;
use App\Form\SubtotalType;
use App\Field\SaleItemField;
use App\Field\SubtotalField;
use Doctrine\ORM\QueryBuilder;
use App\Repository\InventoryRepository;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController;
use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
use EasyCorp\Bundle\EasyAdminBundle\Field\Field;
use EasyCorp\Bundle\EasyAdminBundle\Config\Filters;
use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
use EasyCorp\Bundle\EasyAdminBundle\Config\Actions;
use EasyCorp\Bundle\EasyAdminBundle\Field\ChoiceField;
use EasyCorp\Bundle\EasyAdminBundle\Field\IdField;
use EasyCorp\Bundle\EasyAdminBundle\Field\TextField;
use EasyCorp\Bundle\EasyAdminBundle\Field\AssociationField;
use EasyCorp\Bundle\EasyAdminBundle\Field\CollectionField;
use EasyCorp\Bundle\EasyAdminBundle\Field\DateField;
use EasyCorp\Bundle\EasyAdminBundle\Field\NumberField;
use EasyCorp\Bundle\EasyAdminBundle\Field\FormField;
use EasyCorp\Bundle\EasyAdminBundle\Field\ArrayField;
use Symfony\Bridge\Doctrine\Form\Type\EntityType;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\EntityManager;
use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
use EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext;
use EasyCorp\Bundle\EasyAdminBundle\Config\KeyValueStore;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormEvent;
use Symfony\Component\Form\FormEvents;
use Symfony\Component\Form\Extension\Core\Type\RepeatedType;
use Symfony\Component\Security\Http\Attribute\IsGranted;

class SaleCrudController extends AbstractCrudController
{
    public static function getEntityFqcn(): string
    {
        return Sale::class;
    }
    
    public function __construct(private InventoryRepository $inventoryRepository){

    }

    public function configureFields(string $pageName): iterable
    {
            yield IdField::new('id')->onlyOnIndex();
            yield IdField::new('externalSalesOrderNumber', 'Sale Number')
                ->setColumns(6);
            yield IdField::new('BcOrderNumber')
                ->setFormTypeOption(
                    'disabled',
                    true
                )
                ->setColumns(6); 
            yield TextField::new('BcStatus')->setColumns(6)
                    ->setFormTypeOption(
                        'disabled',
                        true
                    );
            $PsStatus = [ 'Pending', 'Ready', 'Complete' ];
            yield ChoiceField::new( 'PsStatus' )
                ->setChoices( array_combine( $PsStatus, $PsStatus ) )
                ->renderAsBadges()
                ->setColumns(6);
            $order = [ 'REGULAR SALE', 'QUOTE', 'SERVICE' ];
            yield ChoiceField::new( 'OrderType' )
                    ->setChoices( array_combine( $order, $order ) )
                    ->renderAsBadges()
                    ->setColumns(6);
            yield FormField::addPanel('Sale Information')->collapsible();
            yield AssociationField::new('salesperson')
                ->setCrudController(UserCrudController::class)
                ->autocomplete()
                ->setColumns(6);
            yield AssociationField::new('customer')
                ->setCrudController(CustomerCrudController::class)
                ->autocomplete()
                ->formatValue(static function ($value, Sale $sale): ?string {
                    if (!$customer = $sale->getCustomer()) {
                        return null;
                    }
                    return sprintf('%s&nbsp;(%s)', $customer->getName(), $customer->getSalesOrders()->count());
                })
                ->setFormTypeOption(
                    'disabled',
                    $pageName !== Crud::PAGE_NEW
                )
                ->setColumns(6);
            yield DateField::new('deliveryDate')->setColumns(6);
            $delivery = [ 'OD', 'CPU' ];
            yield ChoiceField::new('shipViaCode')->setColumns(6)
                ->setChoices( array_combine( $delivery, $delivery ) )
                ->renderAsBadges();
            $payment = [ 'Cash', 'Check', 'Visa/MC', 'Other' ];
            yield ChoiceField::new('paymentMethod')
                ->setChoices( array_combine( $payment, $payment ) )
                ->renderAsBadges();
            
            yield SubtotalField::new('saleAmount')
                ->setFormTypeOption(
                    'disabled',
                    true
                )
                ->setFormTypeOptions([
                    'row_attr' => [
                        'data-controller' => 'subtotal_controller',
                    ],
                    'attr' => [
                        'data-action' => 'subtotal#render',
                    ],
                ]);
            yield NumberField::new('DeliveryAmount')->hideOnIndex();
            yield TextField::new('taxCode');
            $tax = [7.75, 8.25, 8.5, 8.75];
            yield ChoiceField::new('TaxPercentage', 'Tax Percentage')
                ->hideOnIndex()
                ->setChoices( array_combine( $tax, $tax ) );
            yield NumberField::new('taxAmount')
                ->setFormTypeOption(
                    'disabled',
                    true
                );
            
            yield NumberField::new('totalAmount')->hideOnIndex();
            
            yield FormField::addPanel('Items')->collapsible();
            yield CollectionField::new('SaleLineItems')
                ->setEntryType(QuantityType::class)
                ->setFormTypeOptions([
                    'by_reference' => false,
                    'attr' => [
                        'data-subtotal-target' => 'subtotal',
                    ],
                ])
                ->setColumns(12);
    }

    public function configureActions(Actions $actions): Actions
    {
        return parent::configureActions($actions)
            ->setPermission(Action::INDEX, 'ROLE_SALES')
            ->setPermission(Action::NEW, 'ROLE_SALES')
            ->setPermission(Action::DETAIL, 'ROLE_SALES')
            ->setPermission(Action::EDIT, 'ROLE_SALES')
            ->setPermission(Action::DELETE, 'ROLE_ADMIN')
            ->setPermission(Action::BATCH_DELETE, 'ROLE_ADMIN');
    }

    // public function createNewFormBuilder(EntityDto $entityDto, KeyValueStore $formOptions, AdminContext $context): FormBuilderInterface
    // {
    //     $formBuilder = parent::createNewFormBuilder($entityDto, $formOptions, $context);

    //     return $this->addTotalsEventListener($formBuilder);
    // }

    // private function addTotalsEventListener(FormBuilderInterface $formBuilder): FormBuilderInterface
    // {
    //     return $formBuilder->addEventListener(FormEvents::PRE_SUBMIT, $this->setTotals());
    // }

    // private function setTotals() {
    //     return function($event) {
    //         $form = $event->getForm();

    //         $id = $form->get('id');
    //         $form->get('externalSalesOrderNumber')->setExternalSalesOrderNumber($id + 100000);
    //         $items = $form->get('SaleLineItems')->getData();
    //         if ($items !== null) {
                
            
    //         $prices = array();

    //         foreach($data as $item){
    //             //dump($item);
    //             $itm = $this->inventoryRepository->findOneBy(['id' => $item->getItem()]);
    //             dump($itm);
    //             $price = $itm->getPrice() /100;
    //             array_push($prices, $price);
    //         }
    //         $subtotal = array_sum($prices);
    //         //dump($subtotal);
    //         $ship = $form->getData()->getShipViaCode();
    //         if($ship === 'OD'){
    //             $form->getData()->setDeliveryAmount(95);
    //         }
    //         else{
    //             $form->getData()->setDeliveryAmount(0);
    //         }
    //         $delivery = $form->getData()->getDeliveryAmount();
    //         //dump($delivery);

    //         $salestax = $form->getData()->getTaxPercentage();
    //         $tax = ($subtotal + $delivery) * $salestax;
    //         $total = $subtotal + $delivery + $tax;
    //         $form->getData()->setSaleAmount($subtotal);
    //         $form->getData()->setTaxAmount($tax);
    //         $form->getData()->setTotalAmount($total);
        
            
    //         };
    //         $form->getData()->setSaleAmount(0.0);
    //         $form->getData()->setDeliveryAmount(0.0);
    //         $form->getData()->setTotalAmount(0.0);
    //     };
    // }  
                
    
}

This is the custom type I created for the item selection field:

<?php

namespace App\Form;

use App\Entity\Sale;
use App\Entity\SaleLineItems;
use App\Entity\Inventory;
use App\Repository\InventoryRepository;
use App\Form\SaleItemType;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormEvent;
use Symfony\Component\Form\FormEvents;
use Symfony\Component\Form\FormBuilderInterface;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\QueryBuilder;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Form\Extension\Core\Type\CollectionType;
use Symfony\Component\Form\Extension\Core\Type\AssociationType;
use Symfony\Component\Form\Extension\Core\Type\NumberType;
use Symfony\Component\Form\Extension\Core\Type\ArrayType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\ChoiceList\ChoiceList;
use Symfony\Bridge\Doctrine\Form\Type\EntityType;
use Symfony\Component\Form\CallbackTransformer;
use Doctrine\ORM\EntityManagerInterface;

class QuantityType extends AbstractType
{

    public function __construct(private EntityManagerInterface $entityManager, private InventoryRepository $inventoryRepository)
    {

    }

    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        
        $builder->add('quantity', NumberType::class, ['label' => 'Quantity'])
                ->add('item', EntityType::class, [
                    'class' => Inventory::class,
                    'label' => 'Item',
                    'attr' => ['data-ea-widget' => 'ea-autocomplete'],
                    'query_builder' => function (EntityRepository $er) {
                        return $er->createQueryBuilder('i')
                            ->where('i.discontinued = :discontinued')
                            ->setParameter('discontinued', false);    
                    },
                ])
                ->add('price', NumberType::class, ['empty_data' => 0]);
                //->add('price', NumberType::class);

                $builder->addEventListener(FormEvents::POST_SET_DATA, function (FormEvent $event) use ($user): void {
                    if (null !== $event->getData()) {
                        // we don't need to add the friend field because
                        // the message will be addressed to a fixed friend
                        $price = 0;
                        if(null !==$event->getData()->getItem()){
                            $rawPrice = $event->getData()->getItem()->getPrice();
                            $price = $rawPrice/100; 
                            
                            $form = $event->getForm();
                            $item = $event->getData()->getItem();
                            $formOptions = [
                                'label' => 'Price',
                                'empty_data' => $price,
                            ];
        
                        // create the field, this is similar the $builder->add()
                        // field name, field type, field options
                            $form->remove('price');
                            $form->add('price', NumberType::class, $formOptions);
                            return;
                        }
                    }; 
                });
                
        
                $builder->get('price')->addEventListener(
                    FormEvents::POST_SUBMIT,
                    function (FormEvent $event) use ($formModifier) {
                         // It's important here to fetch $event->getForm()->getData(), as
                         // $event->getData() will get you the client data (that is, the ID)
                        $price = $event->getForm()->getData();
        
                        // since we've added the listener to the child, we'll have to pass on
                        // the parent to the callback functions!
                        $formModifier($event->getForm()->getParent(), $saleLineItems);
                    }
                );
        
             $builder->setAction($options['action']);
    }

    

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'data_class' => SaleLineItems::class,
            'compound' => true

        ]);
    }
}

I'm working on other custom field types as I think I need those to translate the data across fields.

Hey @Courtney-T!

I just replied over on your other question about this. So, let me know of that helps :).

Btw, perhaps unrelated to the "updating in real time part", it looks like you have some dynamic fields in your custom form type (e.g. the $formModifier stuff). In case it helps, there's a new bundle that makes "dynamic fields" a whole heck of a lot easier - https://github.com/SymfonyCasts/dynamic-forms

Cheers!

This is great! Now what I need to figure out is how to integrate this with easy admin. I know how to make custom form types for individual fields, but I'm having trouble finding how I can use $builder in the crud controller itself. I vaguely remember something about $createForm.

Hey @Courtney-T!

Ah of course, good point! Let's see.

There are a few methods you can override to get the raw FormBuilder - e.g. https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/src/Controller/AbstractCrudController.php#L528-L531. This will already be pre-built with all of the fields from configureFields(). Anyway, you can grab this, put it inside of the DynamicFormBuilder and then add your conditional fields. So, the weird part is that, any fields that are dynamic should not be added via configureFields(), but instead should be added manually to the FormBuilder instance inside the overridden method. I think that will work, but I'm not entirely sure!

I hope this helps - if you try it, let me know one way or another if it works. I haven't tried the dynamic forms library with EasyAdmin yet.

Cheers!