VAGOV-TEAM: 93059, 93060, 94023

docroot/modules/custom/va_gov_form_builder/src/Controller/VaGovFormBuilderController.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Drupal\va_gov_form_builder\Controller;
+
+use Drupal\Core\Controller\ControllerBase;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Controller for the VA Form Builder experience.
+ *
+ * Note:
+ *
+ * Drupal also has a something called "form builder"
+ * that is utilized in this controller (`drupalFormBuilder`).
+ * This `FormBuilder` service is responsible for building and
+ * processing forms in Drupal, and is called here so the controller can
+ * return the form that should be rendered for the given route.
+ *
+ * The naming can be confusing, so it's important to remember that
+ * `VaGovFormBuilder` is the tool built by this module (`va_gov_form_builder`),
+ * and used for building Veteran-facing VA forms, while Drupal's
+ * `FormBuilder` (service) is responsible for building and processing
+ * forms _within_ Drupal.
+ */
+class VaGovFormBuilderController extends ControllerBase {
+
+  /**
+   * The Drupal form builder.
+   *
+   * @var \Drupal\Core\Form\FormBuilderInterface
+   */
+  private $drupalFormBuilder;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    $instance = parent::create($container);
+    $instance->drupalFormBuilder = $container->get('form_builder');
+
+    return $instance;
+  }
+
+  /**
+   * Entry point for the VA Form Builder. Redirects to the intro page.
+   */
+  public function entry() {
+    return $this->redirect('va_gov_form_builder.intro');
+  }
+
+  /**
+   * Intro page.
+   */
+  public function intro() {
+    return $this->drupalFormBuilder->getForm('Drupal\va_gov_form_builder\Form\Intro');
+  }
+
+  /**
+   * Start-conversion page.
+   */
+  public function startConversion() {
+    return $this->drupalFormBuilder->getForm('Drupal\va_gov_form_builder\Form\StartConversion');
+  }
+
+  /**
+   * Name-and-date-of-birth page.
+   */
+  public function nameAndDob($nid) {
+    // @phpstan-ignore-next-line
+    return $this->drupalFormBuilder->getForm('Drupal\va_gov_form_builder\Form\NameAndDob', $nid);
+  }
+
+}

docroot/modules/custom/va_gov_form_builder/src/Form/Base/FormBuilderBase.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Drupal\va_gov_form_builder\Form\Base;
+
+use Drupal\Core\Form\FormBase;
+use Drupal\Core\Form\FormStateInterface;
+
+/**
+ * Abstract base class for Form Builder form steps.
+ */
+abstract class FormBuilderBase extends FormBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state) {
+    $form['#title'] = $this->t('Form Builder');
+
+    return $form;
+  }
+
+}

docroot/modules/custom/va_gov_form_builder/src/Form/Base/FormBuilderEditBase.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Drupal\va_gov_form_builder\Form\Base;
+
+use Drupal\Core\Form\FormStateInterface;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+
+/**
+ * Abstract base class for Form Builder form steps that edit an existing node.
+ */
+abstract class FormBuilderEditBase extends FormBuilderNodeBase {
+
+  /**
+   * Flag indicating if the node has been changed.
+   *
+   * Indicates if the node has been changed
+   * since the form was first instantiated.
+   *
+   * @var bool
+   */
+  protected $digitalFormNodeIsChanged;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state, $nid = NULL) {
+    // When form is first built, initialize flag to false.
+    $this->digitalFormNodeIsChanged = FALSE;
+
+    // Load the node indicated by the passed-in node id.
+    $digitalFormNode = $this->entityTypeManager->getStorage('node')->load($nid);
+    if (!$digitalFormNode) {
+      throw new NotFoundHttpException();
+    }
+    $this->digitalFormNode = $digitalFormNode;
+
+    $form = parent::buildForm($form, $form_state);
+    return $form;
+  }
+
+}

docroot/modules/custom/va_gov_form_builder/src/Form/Base/FormBuilderNodeBase.php

@@ -0,0 +1,106 @@
+<?php
+
+namespace Drupal\va_gov_form_builder\Form\Base;
+
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Form\FormStateInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Abstract base class for Form Builder form steps that access a node.
+ */
+abstract class FormBuilderNodeBase extends FormBuilderBase {
+
+  /**
+   * The entity type manager.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+   */
+  protected $entityTypeManager;
+
+  /**
+   * The Digital Form node created or loaded by this form step.
+   *
+   * @var \Drupal\node\Entity\Node
+   */
+  protected $digitalFormNode;
+
+  /**
+   * {@inheritDoc}
+   */
+  public function __construct(EntityTypeManagerInterface $entityTypeManager) {
+    $this->entityTypeManager = $entityTypeManager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('entity_type.manager')
+    );
+  }
+
+  /**
+   * Returns the Digital Form fields accessed by this form step.
+   */
+  abstract protected function getFields();
+
+  /**
+   * Sets (creates or updates) a Digital Form node from the form-state data.
+   */
+  abstract protected function setDigitalFormNodeFromFormState(array &$form, FormStateInterface $form_state);
+
+  /**
+   * Determines if digitalFormNode has a chapter (paragraph) of a given type.
+   */
+  protected function digitalFormNodeHasChapterOfType($type) {
+    $chapters = $this->digitalFormNode->get('field_chapters')->getValue();
+
+    foreach ($chapters as $chapter) {
+      if (isset($chapter['target_id'])) {
+        $paragraph = $this->entityTypeManager->getStorage('paragraph')->load($chapter['target_id']);
+        if ($paragraph) {
+          if ($paragraph->bundle() === $type) {
+            return TRUE;
+          }
+        }
+      }
+    }
+
+    return FALSE;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function validateForm(array &$form, FormStateInterface $form_state) {
+    $this->setDigitalFormNodeFromFormState($form, $form_state);
+
+    // Validate the node entity.
+    /** @var \Symfony\Component\Validator\ConstraintViolationListInterface $violations */
+    $violations = $this->digitalFormNode->validate();
+
+    // Loop through each violation and set errors on the form.
+    if ($violations->count() > 0) {
+      foreach ($violations as $violation) {
+        $fieldName = $violation->getPropertyPath();
+
+        // Only concern ourselves with validation of fields used on this form.
+        if (in_array($fieldName, $this->getFields())) {
+          $message = $violation->getMessage();
+          $form_state->setErrorByName($fieldName, $message);
+        }
+      }
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitForm(array &$form, FormStateInterface $form_state) {
+    // Save the previously validated node.
+    $this->digitalFormNode->save();
+  }
+
+}

docroot/modules/custom/va_gov_form_builder/src/Form/Intro.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Drupal\va_gov_form_builder\Form;
+
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\va_gov_form_builder\Form\Base\FormBuilderBase;
+
+/**
+ * Form step for creating a new form (new conversion).
+ */
+class Intro extends FormBuilderBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFormId() {
+    return 'form_builder__intro';
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getFields() {
+    return [];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state) {
+    $form = parent::buildForm($form, $form_state);
+
+    $form['working_with_form_builder_header'] = [
+      '#type' => 'html_tag',
+      '#tag' => 'h2',
+      '#children' => $this->t('Working with the Form Builder'),
+    ];
+
+    $form['paragraph_1'] = [
+      '#type' => 'html_tag',
+      '#tag' => 'p',
+      '#children' => $this->t('This is where the conversion of an existing form, or the continued editing
+        of a converted form, takes place.'),
+    ];
+
+    $form['before_beginning_header'] = [
+      '#type' => 'html_tag',
+      '#tag' => 'h3',
+      '#children' => $this->t('Before beginning'),
+    ];
+
+    $form['paragraph_2'] = [
+      '#type' => 'html_tag',
+      '#tag' => 'p',
+      '#children' => $this->t('Make sure you have a copy of the form you are intending to convert.
+        This will make it easier to reference the information
+        that will be needed, and the order in which it appears for your users.'),
+    ];
+
+    $form['paragraph_3'] = [
+      '#type' => 'html_tag',
+      '#tag' => 'p',
+      '#children' => $this->t('When returning to update an existing conversion, your past projects
+        are listed under <b>Projects</b> at right.'),
+    ];
+
+    $form['paragraph_4'] = [
+      '#type' => 'html_tag',
+      '#tag' => 'p',
+      '#children' => $this->t('If you need to access a conversion that you did not create, you can use the
+      <b>content search</b> to find that project.'),
+    ];
+
+    $form['paragraph_5'] = [
+      '#type' => 'html_tag',
+      '#tag' => 'p',
+      '#children' => $this->t('To begin a new project select <b>Start conversion</b>.'),
+    ];
+
+    $form['actions']['start_conversion'] = [
+      '#type' => 'submit',
+      '#value' => $this->t('Start conversion'),
+      '#attributes' => [
+        'class' => [
+          'button',
+          'button--primary',
+          'js-form-submit',
+          'form-submit',
+        ],
+      ],
+    ];
+
+    return $form;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitForm(array &$form, FormStateInterface $form_state) {
+    $form_state->setRedirect('va_gov_form_builder.start_conversion');
+  }
+
+}