Add 'Redirect URL' to CMS Form [release/2.2] (#12)

* Add 'Redirect URL' to CMS Form

Author: alexandrzhulev

src/B2bCode/Bundle/CmsFormBundle/Controller/Frontend/AjaxFormController.php

@@ -69,7 +69,11 @@ public function respondAction(
             // @todo extract
             $notification->process($formResponse);
 
-            return new JsonResponse(['success' => true, 'message' => '@todo']);
+            return new JsonResponse([
+                'success'     => true,
+                'message'     => '@todo',
+                'redirectUrl' => $cmsForm->getRedirectUrl()
+            ]);
         }
 
         $errors = [];

src/B2bCode/Bundle/CmsFormBundle/Entity/CmsForm.php

@@ -136,6 +136,13 @@ class CmsForm extends ExtendCmsForm implements DatesAwareInterface
      */
     protected $notifications;
 
+    /**
+     * @var string|null
+     *
+     * @ORM\Column(name="redirect_url", type="string", length=1024, nullable=true)
+     */
+    protected $redirectUrl;
+
     public function __construct()
     {
         $this->fields = new ArrayCollection();
@@ -343,6 +350,22 @@ public function removeNotification(CmsFormNotification $notification)
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
+    public function getRedirectUrl(): ?string
+    {
+        return $this->redirectUrl;
+    }
+
+    /**
+     * @param string|null $redirectUrl
+     */
+    public function setRedirectUrl(?string $redirectUrl): void
+    {
+        $this->redirectUrl = $redirectUrl;
+    }
+
     /**
      * Pre persist event handler.
      *

src/B2bCode/Bundle/CmsFormBundle/Form/Type/FormType.php

@@ -17,6 +17,7 @@
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\Extension\Core\Type\CollectionType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\Extension\Core\Type\UrlType;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -81,7 +82,17 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                     'entry_type'   => NotificationType::class,
                     'by_reference' => false,
                 ]
-            );
+            )
+            ->add(
+                'redirectUrl',
+                UrlType::class,
+                [
+                    'label'    => 'b2bcode.cmsform.redirect_url.label',
+                    'tooltip'  => 'b2bcode.cmsform.redirect_url.tooltip',
+                    'required' => false
+                ]
+            )
+        ;
     }
 
     /**

src/B2bCode/Bundle/CmsFormBundle/Migrations/Schema/B2bCodeCmsFormBundleInstaller.php

@@ -27,7 +27,7 @@ class B2bCodeCmsFormBundleInstaller implements Installation
      */
     public function getMigrationVersion()
     {
-        return 'v1_1';
+        return 'v1_2';
     }
 
     /**
@@ -140,6 +140,7 @@ protected function createB2BCodeCmsFormTable(Schema $schema)
         $table->addColumn('uuid', 'string', ['length' => 255]);
         $table->addColumn('preview_enabled', 'boolean', ['notnull' => false]);
         $table->addColumn('notifications_enabled', 'boolean', ['notnull' => false]);
+        $table->addColumn('redirect_url', 'string', ['length' => 1024, 'notnull' => false]);
         $table->setPrimaryKey(['id']);
         $table->addUniqueIndex(['alias'], 'uniq_e042b376e16c6b94');
         $table->addUniqueIndex(['uuid'], 'uniq_e042b376d17f50a6');

src/B2bCode/Bundle/CmsFormBundle/Migrations/Schema/v1_2/AddRedirectUrlField.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace B2bCode\Bundle\CmsFormBundle\Migrations\v1_2;
+
+use Doctrine\DBAL\Schema\Schema;
+use Oro\Bundle\MigrationBundle\Migration\Migration;
+use Oro\Bundle\MigrationBundle\Migration\QueryBag;
+
+class AddRedirectUrlField implements Migration
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function up(Schema $schema, QueryBag $queries)
+    {
+        $this->addRedirectUrlField($schema);
+    }
+
+    /**
+     * @param Schema $schema
+     */
+    protected function addRedirectUrlField(Schema $schema)
+    {
+        $table = $schema->getTable('b2b_code_cms_form');
+        $table->addColumn('redirect_url', 'string', ['length' => 1024, 'notnull' => false]);
+    }
+}

src/B2bCode/Bundle/CmsFormBundle/Resources/config/validation.yml

@@ -27,6 +27,8 @@ B2bCode\Bundle\CmsFormBundle\Entity\CmsForm:
             - NotBlank: ~
             # Slugs are used for simplicity
             - Oro\Bundle\ValidationBundle\Validator\Constraints\UrlSafe: ~
+        redirectUrl:
+            - Oro\Bundle\ValidationBundle\Validator\Constraints\Url: ~
 
 B2bCode\Bundle\CmsFormBundle\Entity\CmsFormNotification:
     properties:

src/B2bCode/Bundle/CmsFormBundle/Resources/public/js/app/components/form-component.js

@@ -70,8 +70,12 @@ define(function(require) {
                 __('b2bcode.cmsform.ajax.form_respond.success'),
                 {flash: true}
             );
-            // to reset form
-            mediator.execute('refreshPage');
+            if (response.redirectUrl) {
+                window.location.href = response.redirectUrl;
+            } else {
+                // to reset form
+                mediator.execute('refreshPage');
+            }
         },
 
         onErrorHandler: function(response) {

src/B2bCode/Bundle/CmsFormBundle/Resources/translations/messages.en.yml

@@ -35,7 +35,9 @@ b2bcode:
                 label: Template
             email:
                 label: Email
-
+        redirect_url:
+            label: Redirect URL
+            tooltip: URL to be redirected to after form is submitted successfully
 
         cmsformfield:
             entity_label: Cms Form Field

src/B2bCode/Bundle/CmsFormBundle/Resources/views/Form/update.html.twig

@@ -41,7 +41,8 @@
                 'data': [
                     form_row(form.name),
                     form_row(form.alias),
-                    form_row(form.previewEnabled)
+                    form_row(form.previewEnabled),
+                    form_row(form.redirectUrl)
                 ]
             }
         ]

src/B2bCode/Bundle/CmsFormBundle/Resources/views/Form/view.html.twig

@@ -66,6 +66,7 @@
                     {{ UI.renderProperty('b2bcode.cmsform.name.label'|trans, entity.name) }}
                     {{ UI.renderProperty('b2bcode.cmsform.alias.label'|trans, entity.alias) }}
                     {{ UI.renderHtmlProperty('b2bcode.cmsform.sections.preview'|trans, preview) }}
+                    {{ UI.renderProperty('b2bcode.cmsform.redirect_url.label'|trans, entity.redirectUrl) }}
                     {{ UI.renderProperty('b2bcode.cmsform.notifications_enabled.label'|trans, entity.notificationsEnabled ? 'Yes'|trans : 'No'|trans) }}
                     {{ UI.renderHtmlProperty('b2bcode.cmsform.sections.notifications.label'|trans, notifications) }}
                     {{ UI.renderHtmlProperty('b2bcode.cmsform.sections.code_markup'|trans, codeMarkup) }}