Feature: add excerpt for v3 forms (#7287)

src/DonationForms/Properties/FormSettings.php

@@ -230,6 +230,14 @@ class FormSettings implements Arrayable, Jsonable
      */
     public $designSettingsImageOpacity;
 
+    /* @unreleased
+     * @var string
+     */
+    public $formExcerpt;
+
+    /**
+     * @unreleased Added formExcerpt
+
     /**
      * @since 3.2.0 Added registrationNotification
      * @since 3.0.0
@@ -327,6 +335,8 @@ public static function fromArray(array $array): self
 
         $self->designSettingsImageOpacity = $array['designSettingsImageOpacity'] ?? '';
 
+        $self->formExcerpt = $array['formExcerpt'] ?? '';
+
         return $self;
     }
 

src/FormBuilder/Actions/UpdateFormExcerpt.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Give\FormBuilder\Actions;
+
+use Give\DonationForms\Models\DonationForm;
+
+/**
+ * @unreleased
+ */
+class UpdateFormExcerpt
+{
+    /**
+     * @unreleased
+     *
+     * @param DonationForm $form
+     */
+    public function __invoke(DonationForm $form)
+    {
+        wp_update_post([
+            'ID' => $form->id,
+            'post_excerpt' => $form->settings->formExcerpt,
+        ]);
+    }
+}

src/FormBuilder/ServiceProvider.php

@@ -9,6 +9,7 @@
 use Give\FormBuilder\Actions\UpdateDonorCommentsMeta;
 use Give\FormBuilder\Actions\UpdateEmailSettingsMeta;
 use Give\FormBuilder\Actions\UpdateEmailTemplateMeta;
+use Give\FormBuilder\Actions\UpdateFormExcerpt;
 use Give\FormBuilder\Actions\UpdateFormGridMeta;
 use Give\FormBuilder\EmailPreview\Routes\RegisterEmailPreviewRoutes;
 use Give\FormBuilder\Routes\CreateFormRoute;
@@ -62,6 +63,7 @@ public function boot()
             give(UpdateEmailSettingsMeta::class)->__invoke($form);
             give(UpdateEmailTemplateMeta::class)->__invoke($form);
             give(UpdateDonorCommentsMeta::class)->__invoke($form);
+            give(UpdateFormExcerpt::class)->__invoke($form);
         });
 
         Hooks::addAction('givewp_form_builder_new_form', ConvertGlobalDefaultOptionsToDefaultBlocks::class);

src/FormBuilder/ViewModels/FormBuilderViewModel.php

@@ -20,6 +20,7 @@
 class FormBuilderViewModel
 {
     /**
+     * @unreleased Add support to isExcerptEnabled key in the compared array
      * @since 3.2.0 Add nameTitlePrefixes key to the returned array
      * @since 3.0.0
      */
@@ -76,6 +77,7 @@ public function storageData(int $donationFormId): array
             ],
             'goalTypeOptions' => $this->getGoalTypeOptions(),
             'nameTitlePrefixes' => give_get_option('title_prefixes'),
+            'isExcerptEnabled' => give_is_setting_enabled(give_get_option('forms_excerpt')),
         ];
     }
 

src/FormBuilder/resources/js/form-builder/src/common/getWindowData.ts

@@ -18,6 +18,7 @@ type GoalTypeOption = {
 };
 
 /**
+ * @unreleased Added isExcerptEnabled
  * @since 3.0.0
  */
 interface FormBuilderWindowData {
@@ -48,6 +49,7 @@ interface FormBuilderWindowData {
     termsAndConditions: TermsAndConditions;
     goalTypeOptions: GoalTypeOption[];
     nameTitlePrefixes: string[];
+    isExcerptEnabled: boolean;
 }
 
 /**
@@ -62,7 +64,7 @@ declare const window: {
                 [key: string]: Component;
             };
         };
-    }
+    };
 } & Window;
 
 /**

src/FormBuilder/resources/js/form-builder/src/settings/group-general/form-summary/index.jsx

@@ -1,14 +1,18 @@
-import { PanelRow, SelectControl, TextControl } from "@wordpress/components";
-import { __ } from "@wordpress/i18n";
+import {PanelRow, SelectControl, TextareaControl, TextControl} from '@wordpress/components';
+import {__} from '@wordpress/i18n';
 
-import { isFormPageEnabled, PageSlugControl } from "./page-slug";
-import { cleanForSlug } from "@wordpress/url";
+import {isFormPageEnabled, PageSlugControl} from './page-slug';
+import {cleanForSlug} from '@wordpress/url';
+import {getWindowData} from '@givewp/form-builder/common';
+
+const {isExcerptEnabled} = getWindowData();
 
 /**
+ * @unreleased Added formExcerpt text area
  * @since 3.1.0 dispatch page slug from form title on initial publish.
  */
 const FormSummarySettings = ({settings, setSettings}) => {
-    const {formTitle, pageSlug, formStatus, newFormStatus} = settings;
+    const {formTitle, pageSlug, formStatus, newFormStatus, formExcerpt} = settings;
     const isPublished = ['publish', 'private'].includes(formStatus);
     const isTitleSlug = !isPublished && cleanForSlug(formTitle) === pageSlug;
 
@@ -51,6 +55,20 @@ const FormSummarySettings = ({settings, setSettings}) => {
                     onChange={(newFormStatus) => setSettings({newFormStatus})}
                 />
             </PanelRow>
+
+            {isExcerptEnabled && (
+                <PanelRow>
+                    <TextareaControl
+                        label={'Excerpt'}
+                        help={__(
+                            'The excerpt is an optional summary or description of a donation form; in short, a summary as to why the user should give.',
+                            'give'
+                        )}
+                        value={formExcerpt}
+                        onChange={(formExcerpt) => setSettings({formExcerpt})}
+                    />
+                </PanelRow>
+            )}
         </>
     );
 };

src/FormBuilder/resources/js/form-builder/src/types/formSettings.ts

@@ -2,6 +2,7 @@ import {FormStatus} from '@givewp/form-builder/types/formStatus';
 import {EmailTemplateOption} from '@givewp/form-builder/types/emailTemplateOption';
 
 /**
+ * @unreleased Added formExcerpt
  * @since 3.0.0
  */
 export type FormSettings = {
@@ -50,4 +51,5 @@ export type FormSettings = {
     designSettingsTextFieldStyle: string;
     designSettingsImageOpacity: string;
     designSettingsImageColor: string;
+    formExcerpt: string;
 };

src/FormMigration/ServiceProvider.php

@@ -50,6 +50,7 @@ public function register()
                 Steps\FundsAndDesignations::class,
                 Steps\GiftAid::class,
                 Steps\FormFeaturedImage::class,
+                Steps\FormExcerpt::class,
             ]);
         });
     }

src/FormMigration/Steps/FormExcerpt.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Give\FormMigration\Steps;
+
+use Give\FormMigration\Contracts\FormMigrationStep;
+
+/**
+ * @unreleased
+ */
+class FormExcerpt extends FormMigrationStep
+{
+    /**
+     * @unreleased
+     */
+    public function process()
+    {
+        $this->formV3->settings->formExcerpt = get_the_excerpt($this->formV2->id);
+    }
+}

tests/Unit/ViewModels/FormBuilderViewModelTest.php

@@ -23,6 +23,8 @@ class FormBuilderViewModelTest extends TestCase
     use RefreshDatabase;
 
     /**
+     *
+     * @unreleased Add support to isExcerptEnabled key in the compared array
      * @since 3.2.0 Add support to nameTitlePrefixes key in the compared array
      * @since 3.0.0
      *
@@ -85,6 +87,7 @@ public function testShouldReturnStorageData()
                 ],
                 'goalTypeOptions' => $viewModel->getGoalTypeOptions(),
                 'nameTitlePrefixes' => give_get_option('title_prefixes'),
+                'isExcerptEnabled' => give_is_setting_enabled(give_get_option('forms_excerpt')),
             ],
             $viewModel->storageData($formId)
         );