Centralized logic for part creation form

src/Controller/InfoProviderController.php

@@ -30,6 +30,7 @@ use App\Services\Attachments\AttachmentSubmitHandler;
 use App\Services\InfoProviderSystem\PartInfoRetriever;
 use App\Services\InfoProviderSystem\ProviderRegistry;
 use App\Services\LogSystem\EventCommentHelper;
+use App\Services\Parts\PartFormHelper;
 use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\Form\FormInterface;
@@ -43,7 +44,7 @@ class InfoProviderController extends  AbstractController
 {
 
     public function __construct(private readonly ProviderRegistry $providerRegistry,
-        private readonly PartInfoRetriever $infoRetriever, private readonly EventCommentHelper $commentHelper)
+        private readonly PartInfoRetriever $infoRetriever)
     {
 
     }
@@ -81,74 +82,4 @@ class InfoProviderController extends  AbstractController
             'results' => $results,
         ]);
     }
-
-    #[Route('/part/{providerKey}/{providerId}/create', name: 'info_providers_create_part')]
-    public function createPart(Request $request, EntityManagerInterface $em, TranslatorInterface $translator,
-        AttachmentSubmitHandler $attachmentSubmitHandler, string $providerKey, string $providerId): Response
-    {
-        $this->denyAccessUnlessGranted('@info_providers.create_parts');
-
-        $dto = $this->infoRetriever->getDetails($providerKey, $providerId);
-        $new_part = $this->infoRetriever->dtoToPart($dto);
-
-        $form = $this->createForm(PartBaseType::class, $new_part, [
-            'info_provider_dto' => $dto,
-        ]);
-
-        $form->handleRequest($request);
-
-        if ($form->isSubmitted() && $form->isValid()) {
-            //Upload passed files
-            $attachments = $form['attachments'];
-            foreach ($attachments as $attachment) {
-                /** @var FormInterface $attachment */
-                $options = [
-                    'secure_attachment' => $attachment['secureFile']->getData(),
-                    'download_url' => $attachment['downloadURL']->getData(),
-                ];
-
-                try {
-                    $attachmentSubmitHandler->handleFormSubmit($attachment->getData(), $attachment['file']->getData(), $options);
-                } catch (AttachmentDownloadException $attachmentDownloadException) {
-                    $this->addFlash(
-                        'error',
-                        $translator->trans('attachment.download_failed').' '.$attachmentDownloadException->getMessage()
-                    );
-                }
-            }
-
-            $this->commentHelper->setMessage($form['log_comment']->getData());
-
-            $em->persist($new_part);
-            $em->flush();
-            $this->addFlash('success', 'part.created_flash');
-
-            //If a redirect URL was given, redirect there
-            if ($request->query->get('_redirect')) {
-                return $this->redirect($request->query->get('_redirect'));
-            }
-
-            //Redirect to clone page if user wished that...
-            //@phpstan-ignore-next-line
-            if ('save_and_clone' === $form->getClickedButton()->getName()) {
-                return $this->redirectToRoute('part_clone', ['id' => $new_part->getID()]);
-            }
-            //@phpstan-ignore-next-line
-            if ('save_and_new' === $form->getClickedButton()->getName()) {
-                return $this->redirectToRoute('part_new');
-            }
-
-            return $this->redirectToRoute('part_edit', ['id' => $new_part->getID()]);
-        }
-
-        if ($form->isSubmitted() && !$form->isValid()) {
-            $this->addFlash('error', 'part.created_flash.invalid');
-        }
-
-        return $this->render('parts/edit/new_part.html.twig',
-            [
-                'part' => $new_part,
-                'form' => $form,
-            ]);
-    }
 }

src/Controller/PartController.php

@@ -36,6 +36,7 @@ use App\Exceptions\AttachmentDownloadException;
 use App\Form\Part\PartBaseType;
 use App\Services\Attachments\AttachmentSubmitHandler;
 use App\Services\Attachments\PartPreviewGenerator;
+use App\Services\InfoProviderSystem\PartInfoRetriever;
 use App\Services\LogSystem\EventCommentHelper;
 use App\Services\LogSystem\HistoryHelper;
 use App\Services\LogSystem\TimeTravel;
@@ -63,7 +64,11 @@ use function Symfony\Component\Translation\t;
 #[Route(path: '/part')]
 class PartController extends AbstractController
 {
-    public function __construct(protected PricedetailHelper $pricedetailHelper, protected PartPreviewGenerator $partPreviewGenerator, protected EventCommentHelper $commentHelper)
+    public function __construct(protected PricedetailHelper $pricedetailHelper,
+        protected PartPreviewGenerator $partPreviewGenerator,
+        private readonly TranslatorInterface $translator,
+        private readonly AttachmentSubmitHandler $attachmentSubmitHandler, private readonly EntityManagerInterface $em,
+        protected EventCommentHelper $commentHelper)
     {
     }
 
@@ -121,65 +126,15 @@ class PartController extends AbstractController
     }
 
     #[Route(path: '/{id}/edit', name: 'part_edit')]
-    public function edit(Part $part, Request $request, EntityManagerInterface $em, TranslatorInterface $translator,
+    public function edit(Part $part, Request $request): Response
-        AttachmentSubmitHandler $attachmentSubmitHandler): Response
     {
         $this->denyAccessUnlessGranted('edit', $part);
 
-        $form = $this->createForm(PartBaseType::class, $part);
+        return $this->renderPartForm('edit', $request, $part);
-
-        $form->handleRequest($request);
-        if ($form->isSubmitted() && $form->isValid()) {
-            //Upload passed files
-            $attachments = $form['attachments'];
-            foreach ($attachments as $attachment) {
-                /** @var FormInterface $attachment */
-                $options = [
-                    'secure_attachment' => $attachment['secureFile']->getData(),
-                    'download_url' => $attachment['downloadURL']->getData(),
-                ];
-
-                try {
-                    $attachmentSubmitHandler->handleFormSubmit($attachment->getData(), $attachment['file']->getData(), $options);
-                } catch (AttachmentDownloadException $attachmentDownloadException) {
-                    $this->addFlash(
-                        'error',
-                        $translator->trans('attachment.download_failed').' '.$attachmentDownloadException->getMessage()
-                    );
-                }
-            }
-
-            $this->commentHelper->setMessage($form['log_comment']->getData());
-
-            $em->persist($part);
-            $em->flush();
-            $this->addFlash('success', 'part.edited_flash');
-
-            //Redirect to clone page if user wished that...
-            //@phpstan-ignore-next-line
-            if ('save_and_clone' === $form->getClickedButton()->getName()) {
-                return $this->redirectToRoute('part_clone', ['id' => $part->getID()]);
-            }
-            //@phpstan-ignore-next-line
-            if ('save_and_new' === $form->getClickedButton()->getName()) {
-                return $this->redirectToRoute('part_new');
-            }
-
-            //Reload form, so the SIUnitType entries use the new part unit
-            $form = $this->createForm(PartBaseType::class, $part);
-        } elseif ($form->isSubmitted() && !$form->isValid()) {
-            $this->addFlash('error', 'part.edited_flash.invalid');
-        }
-
-        return $this->render('parts/edit/edit_part_info.html.twig',
-            [
-                'part' => $part,
-                'form' => $form,
-            ]);
     }
 
     #[Route(path: '/{id}/delete', name: 'part_delete', methods: ['DELETE'])]
-    public function delete(Request $request, Part $part, EntityManagerInterface $entityManager): RedirectResponse
+    public function delete(Request $request, Part $part): RedirectResponse
     {
         $this->denyAccessUnlessGranted('delete', $part);
 
@@ -188,10 +143,10 @@ class PartController extends AbstractController
             $this->commentHelper->setMessage($request->request->get('log_comment', null));
 
             //Remove part
-            $entityManager->remove($part);
+            $this->em->remove($part);
 
             //Flush changes
-            $entityManager->flush();
+            $this->em->flush();
 
             $this->addFlash('success', 'part.deleted');
         }
@@ -262,7 +217,39 @@ class PartController extends AbstractController
             $new_part->addOrderdetail($orderdetail);
         }
 
-        $form = $this->createForm(PartBaseType::class, $new_part);
+        return $this->renderPartForm('new', $request, $new_part);
+    }
+
+    #[Route('/from_info_provider/{providerKey}/{providerId}/create', name: 'info_providers_create_part')]
+    public function createFromInfoProvider(Request $request, string $providerKey, string $providerId, PartInfoRetriever $infoRetriever): Response
+    {
+        $this->denyAccessUnlessGranted('@info_providers.create_parts');
+
+        $dto = $infoRetriever->getDetails($providerKey, $providerId);
+        $new_part = $infoRetriever->dtoToPart($dto);
+
+        return $this->renderPartForm('new', $request, $new_part, [
+            'info_provider_dto' => $dto,
+        ]);
+    }
+
+    /**
+     * This function provides a common implementation for methods, which use the part form.
+     * @param  Request  $request
+     * @param  Part  $new_part
+     * @param  array  $form_options
+     * @return Response
+     */
+    private function renderPartForm(string $mode, Request $request, Part $data, array $form_options = []): Response
+    {
+        //Ensure that mode is either 'new' or 'edit
+        if (!in_array($mode, ['new', 'edit'])) {
+            throw new \InvalidArgumentException('Invalid mode given');
+        }
+
+        $new_part = $data;
+
+        $form = $this->createForm(PartBaseType::class, $new_part, $form_options);
 
         $form->handleRequest($request);
 
@@ -277,20 +264,24 @@ class PartController extends AbstractController
                 ];
 
                 try {
-                    $attachmentSubmitHandler->handleFormSubmit($attachment->getData(), $attachment['file']->getData(), $options);
+                    $this->attachmentSubmitHandler->handleFormSubmit($attachment->getData(), $attachment['file']->getData(), $options);
                 } catch (AttachmentDownloadException $attachmentDownloadException) {
                     $this->addFlash(
                         'error',
-                        $translator->trans('attachment.download_failed').' '.$attachmentDownloadException->getMessage()
+                        $this->translator->trans('attachment.download_failed').' '.$attachmentDownloadException->getMessage()
                     );
                 }
             }
 
             $this->commentHelper->setMessage($form['log_comment']->getData());
 
-            $em->persist($new_part);
+            $this->em->persist($new_part);
-            $em->flush();
+            $this->em->flush();
+            if ($mode === 'new') {
                 $this->addFlash('success', 'part.created_flash');
+            } else if ($mode === 'edit') {
+                $this->addFlash('success', 'part.edited_flash');
+            }
 
             //If a redirect URL was given, redirect there
             if ($request->query->get('_redirect')) {
@@ -314,13 +305,20 @@ class PartController extends AbstractController
             $this->addFlash('error', 'part.created_flash.invalid');
         }
 
-        return $this->render('parts/edit/new_part.html.twig',
+        if ($mode === 'new') {
+            $template = 'parts/edit/new_part.html.twig';
+        } else if ($mode === 'edit') {
+            $template = 'parts/edit/edit_part_info.html.twig';
+        }
+
+        return $this->render($template,
             [
                 'part' => $new_part,
                 'form' => $form,
             ]);
     }
 
+
     #[Route(path: '/{id}/add_withdraw', name: 'part_add_withdraw', methods: ['POST'])]
     public function withdrawAddHandler(Part $part, Request $request, EntityManagerInterface $em, PartLotWithdrawAddHelper $withdrawAddHelper): Response
     {

src/Services/Parts/PartFormHelper.php

@@ -0,0 +1,108 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published
+ *  by the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Services\Parts;
+
+use App\Entity\Parts\Part;
+use App\Exceptions\AttachmentDownloadException;
+use App\Form\Part\PartBaseType;
+use App\Services\Attachments\AttachmentSubmitHandler;
+use App\Services\LogSystem\EventCommentHelper;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Form\FormFactoryInterface;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+final class PartFormHelper
+{
+    private function __construct(private readonly TranslatorInterface $translator, private readonly EventCommentHelper $commentHelper,
+        private readonly AttachmentSubmitHandler $attachmentSubmitHandler, private readonly EntityManagerInterface $em,
+        private readonly FormFactoryInterface $formFactory)
+    {
+
+    }
+
+    public function renderCreateForm(Request $request, Part $new_part = null, array $form_options = []): Response
+    {
+        $form = $this->formFactory->create(PartBaseType::class, $new_part, $form_options);
+
+        $form->handleRequest($request);
+
+        if ($form->isSubmitted() && $form->isValid()) {
+            //Upload passed files
+            $attachments = $form['attachments'];
+            foreach ($attachments as $attachment) {
+                /** @var FormInterface $attachment */
+                $options = [
+                    'secure_attachment' => $attachment['secureFile']->getData(),
+                    'download_url' => $attachment['downloadURL']->getData(),
+                ];
+
+                try {
+                    $this->attachmentSubmitHandler->handleFormSubmit($attachment->getData(), $attachment['file']->getData(), $options);
+                } catch (AttachmentDownloadException $attachmentDownloadException) {
+                    $this->addFlash(
+                        'error',
+                        $this->translator->trans('attachment.download_failed').' '.$attachmentDownloadException->getMessage()
+                    );
+                }
+            }
+
+            $this->commentHelper->setMessage($form['log_comment']->getData());
+
+            $this->em->persist($new_part);
+            $this->em->flush();
+            $this->addFlash('success', 'part.created_flash');
+
+            //If a redirect URL was given, redirect there
+            if ($request->query->get('_redirect')) {
+                return $this->redirect($request->query->get('_redirect'));
+            }
+
+            //Redirect to clone page if user wished that...
+            //@phpstan-ignore-next-line
+            if ('save_and_clone' === $form->getClickedButton()->getName()) {
+                return $this->redirectToRoute('part_clone', ['id' => $new_part->getID()]);
+            }
+            //@phpstan-ignore-next-line
+            if ('save_and_new' === $form->getClickedButton()->getName()) {
+                return $this->redirectToRoute('part_new');
+            }
+
+            return $this->redirectToRoute('part_edit', ['id' => $new_part->getID()]);
+        }
+
+        if ($form->isSubmitted() && !$form->isValid()) {
+            $this->addFlash('error', 'part.created_flash.invalid');
+        }
+
+        return $this->render('parts/edit/new_part.html.twig',
+            [
+                'part' => $new_part,
+                'form' => $form,
+            ]);
+    }
+}