Add trash functionality for forms (sulu#326)

.gitignore

@@ -43,4 +43,4 @@ npm-debug.log
 
 # php-cs-fixer
 .php_cs.cache
-php-cs-fixer
+.php-cs-fixer.cache

DependencyInjection/SuluFormExtension.php

@@ -207,6 +207,10 @@ public function load(array $configs, ContainerBuilder $container): void
             $loader->load('article.xml');
         }
 
+        if (\array_key_exists('SuluTrashBundle', $bundles)) {
+            $loader->load('services_trash.xml');
+        }
+
         if (\class_exists(\EWZ\Bundle\RecaptchaBundle\Form\Type\EWZRecaptchaType::class)) {
             $loader->load('type_recaptcha.xml');
         }

Domain/Event/FormRestoredEvent.php

@@ -0,0 +1,92 @@
+<?php
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Sulu\Bundle\FormBundle\Domain\Event;
+
+use Sulu\Bundle\ActivityBundle\Domain\Event\DomainEvent;
+use Sulu\Bundle\FormBundle\Admin\FormAdmin;
+use Sulu\Bundle\FormBundle\Entity\Form;
+use Sulu\Bundle\FormBundle\Entity\FormTranslation;
+
+class FormRestoredEvent extends DomainEvent
+{
+    /**
+     * @var Form
+     */
+    private $form;
+
+    /**
+     * @var mixed[]
+     */
+    private $payload;
+
+    /**
+     * @param mixed[] $payload
+     */
+    public function __construct(
+        Form $form,
+        array $payload
+    ) {
+        parent::__construct();
+
+        $this->form = $form;
+        $this->payload = $payload;
+    }
+
+    public function getForm(): Form
+    {
+        return $this->form;
+    }
+
+    public function getEventType(): string
+    {
+        return 'restored';
+    }
+
+    public function getEventPayload(): ?array
+    {
+        return $this->payload;
+    }
+
+    public function getResourceKey(): string
+    {
+        return Form::RESOURCE_KEY;
+    }
+
+    public function getResourceId(): string
+    {
+        return (string) $this->form->getId();
+    }
+
+    public function getResourceTitle(): ?string
+    {
+        $translation = $this->getFormTranslation();
+
+        return $translation ? $translation->getTitle() : null;
+    }
+
+    public function getResourceTitleLocale(): ?string
+    {
+        $translation = $this->getFormTranslation();
+
+        return $translation ? $translation->getLocale() : null;
+    }
+
+    private function getFormTranslation(): ?FormTranslation
+    {
+        return $this->form->getTranslation($this->form->getDefaultLocale());
+    }
+
+    public function getResourceSecurityContext(): ?string
+    {
+        return FormAdmin::SECURITY_CONTEXT;
+    }
+}

Entity/Form.php

@@ -100,6 +100,7 @@ public function getTranslation(string $locale, bool $create = false, bool $fallb
             $translation = new FormTranslation();
             $translation->setLocale($locale);
             $this->addTranslation($translation);
+            $translation->setForm($this);
 
             return $translation;
         }

Manager/FormManager.php

@@ -25,6 +25,7 @@
 use Sulu\Bundle\FormBundle\Entity\FormTranslationReceiver;
 use Sulu\Bundle\FormBundle\Exception\FormNotFoundException;
 use Sulu\Bundle\FormBundle\Repository\FormRepository;
+use Sulu\Bundle\TrashBundle\Application\TrashManager\TrashManagerInterface;
 
 class FormManager
 {
@@ -43,17 +44,24 @@ class FormManager
      */
     private $domainEventCollector;
 
+    /**
+     * @var TrashManagerInterface|null
+     */
+    private $trashManager;
+
     /**
      * EventManager constructor.
      */
     public function __construct(
         EntityManagerInterface $entityManager,
         FormRepository $formRepository,
-        DomainEventCollectorInterface $domainEventCollector
+        DomainEventCollectorInterface $domainEventCollector,
+        ?TrashManagerInterface $trashManager
     ) {
         $this->entityManager = $entityManager;
         $this->formRepository = $formRepository;
         $this->domainEventCollector = $domainEventCollector;
+        $this->trashManager = $trashManager;
     }
 
     public function findById(int $id, ?string $locale = null): ?Form
@@ -242,6 +250,10 @@ public function delete(int $id, ?string $locale = null): ?Form
             return null;
         }
 
+        if ($this->trashManager) {
+            $this->trashManager->store(Form::RESOURCE_KEY, $object);
+        }
+
         /** @var FormTranslation $translation */
         $translation = $object->getTranslation($locale, false, true);
         $this->domainEventCollector->collect(

Resources/config/services.xml

@@ -52,6 +52,7 @@
             <argument type="service" id="doctrine.orm.entity_manager" />
             <argument type="service" id="sulu_form.repository.form" />
             <argument type="service" id="sulu_activity.domain_event_collector"/>
+            <argument type="service" id="sulu_trash.trash_manager" on-invalid="null"/>
         </service>
 
         <!-- Content Types -->

Resources/config/services_trash.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <service id="sulu_form.form_trash_item_handler"
+                 class="Sulu\Bundle\FormBundle\Trash\FormTrashItemHandler">
+            <argument type="service" id="sulu_trash.trash_item_repository"/>
+            <argument type="service" id="doctrine.orm.entity_manager"/>
+            <argument type="service" id="sulu_trash.doctrine_restore_helper"/>
+            <argument type="service" id="sulu_activity.domain_event_collector"/>
+
+            <tag name="sulu_trash.store_trash_item_handler"/>
+            <tag name="sulu_trash.restore_trash_item_handler"/>
+            <tag name="sulu_trash.restore_configuration_provider"/>
+        </service>
+    </services>
+</container>

Resources/translations/admin.de.json

@@ -86,9 +86,11 @@
   "sulu_form.salutation_ms": "Frau",
   "sulu_form.single_form_selection.no_form_selected": "Kein Formular ausgewählt",
   "sulu_form.single_form_selection.overlay_title": "Wählen Sie ein Formular aus",
+  "sulu_activity.resource.forms": "Formular",
   "sulu_activity.description.forms.created": "{userFullName} hat das Formular \"{resourceTitle}\" erstellt",
   "sulu_activity.description.forms.modified": "{userFullName} hat das Formular \"{resourceTitle}\" geändert",
   "sulu_activity.description.forms.translation_added": "{userFullName} hat eine Übersetzung für \"{resourceLocale}\" zum Forumlar \"{resourceTitle}\" hinzugefügt",
   "sulu_activity.description.forms.removed": "{userFullName} hat das Formular \"{resourceTitle}\" gelöscht",
-  "sulu_activity.description.forms.copied": "{userFullName} hat das Formular \"{resourceTitle}\" kopiert"
+  "sulu_activity.description.forms.copied": "{userFullName} hat das Formular \"{resourceTitle}\" kopiert",
+  "sulu_activity.description.forms.restored": "{userFullName} hat das Formular \"{resourceTitle}\" wiederhergestellt"
 }

Resources/translations/admin.en.json

@@ -86,9 +86,11 @@
   "sulu_form.salutation_ms": "Ms.",
   "sulu_form.single_form_selection.no_form_selected": "No form selected",
   "sulu_form.single_form_selection.overlay_title": "Select a form",
+  "sulu_activity.resource.forms": "Form",
   "sulu_activity.description.forms.created": "{userFullName} has created the form \"{resourceTitle}\"",
   "sulu_activity.description.forms.modified": "{userFullName} has changed the form \"{resourceTitle}\"",
   "sulu_activity.description.forms.translation_added": "{userFullName} has added a translation \"{resourceLocale}\" to the form \"{resourceTitle}\"",
   "sulu_activity.description.forms.removed": "{userFullName} has removed the form \"{resourceTitle}\"",
-  "sulu_activity.description.forms.copied": "{userFullName} has copied the form \"{resourceTitle}\""
+  "sulu_activity.description.forms.copied": "{userFullName} has copied the form \"{resourceTitle}\"",
+  "sulu_activity.description.forms.restored": "{userFullName} has restored the form \"{resourceTitle}\""
 }

Tests/Application/Kernel.php

@@ -22,7 +22,7 @@ public function __construct($environment, $debug, $suluContext = self::CONTEXT_A
         parent::__construct($environment, $debug, $suluContext);
     }
 
-    public function registerBundles()
+    public function registerBundles(): iterable
     {
         return \array_merge(
             parent::registerBundles(),
@@ -39,7 +39,7 @@ public function registerContainerConfiguration(LoaderInterface $loader)
         $loader->load(__DIR__ . '/config/config_' . $this->getContext() . '.yml');
     }
 
-    protected function getKernelParameters()
+    protected function getKernelParameters(): array
     {
         $parameters = parent::getKernelParameters();
 

Tests/Functional/Controller/FormControllerTest.php

@@ -20,6 +20,7 @@
 use Sulu\Bundle\FormBundle\Entity\FormTranslation;
 use Sulu\Bundle\FormBundle\Entity\FormTranslationReceiver;
 use Sulu\Bundle\TestBundle\Testing\SuluTestCase;
+use Sulu\Bundle\TrashBundle\Domain\Model\TrashItemInterface;
 use Symfony\Bundle\FrameworkBundle\KernelBrowser;
 
 class FormControllerTest extends SuluTestCase
@@ -239,6 +240,10 @@ public function testDelete(): void
         $activity = $this->em->getRepository(ActivityInterface::class)->findOneBy(['type' => 'removed']);
         $this->assertNotNull($activity);
         $this->assertSame((string) $formId, $activity->getResourceId());
+
+        $trashItemRepository = $this->em->getRepository(TrashItemInterface::class);
+        $trashItem = $trashItemRepository->findOneBy(['resourceKey' => Form::RESOURCE_KEY, 'resourceId' => $formId]);
+        $this->assertNotNull($trashItem);
     }
 
     public function testDeleteNotFound(): void