VAGOV-TEAM-99444: Form Info page

docroot/modules/custom/va_gov_form_builder/css/va_gov_form_builder.css

@@ -44,6 +44,17 @@
   font-size: var(--vads-font-size-heading-level-6);
 }
 
+/* required fields */
+.form-builder-page-container .form-item__label.form-required::after {
+  color: var(--vads-color-secondary-dark);
+  content: "(*Required)";
+}
+
+/* form field descriptions/hint text */
+.form-builder-page-container .form-item__description {
+  color: var(--vads-color-gray-medium);
+}
+
 /* header */
 .form-builder-header {
   background-color: var(--va-blue-darkest);

docroot/modules/custom/va_gov_form_builder/css/va_gov_form_builder__form_info.css

@@ -0,0 +1,15 @@
+.form-builder-page-content--form-info {
+  width: 335px;
+}
+
+.form-builder-page-content--form-info .form-element {
+  width: 100%;
+}
+
+.form-builder-content-section {
+  border-bottom: 1px solid var(--vads-color-base-light);
+}
+
+h3.form-builder-content-section__header {
+  font-size: var(--vads-font-size-heading-level-4);
+}

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

@@ -5,6 +5,7 @@
 use Drupal\Core\Controller\ControllerBase;
 use Drupal\Core\Url;
 use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
  * Controller for the VA Form Builder experience.
@@ -40,26 +41,58 @@ class VaGovFormBuilderController extends ControllerBase {
    *
    * @var \Drupal\Core\Form\FormBuilderInterface
    */
-  private $drupalFormBuilder;
+  protected $drupalFormBuilder;
 
   /**
    * The Digital Forms service.
    *
    * @var \Drupal\va_gov_form_builder\Service\DigitalFormsService
    */
-  private $digitalFormsService;
+  protected $digitalFormsService;
+
+  /**
+   * The Digital Form node.
+   *
+   * When the page in question edits or references an existing
+   * digital form node, this property is populated. When the
+   * page creates a new digital form node or otherwise does
+   * not reference a node, this is empty.
+   *
+   * @var \Drupal\node\Entity\Node|null
+   */
+  protected $digitalFormNode;
 
   /**
    * {@inheritdoc}
    */
   public static function create(ContainerInterface $container) {
     $instance = parent::create($container);
+
     $instance->drupalFormBuilder = $container->get('form_builder');
     $instance->digitalFormsService = $container->get('va_gov_form_builder.digital_forms_service');
 
     return $instance;
   }
 
+  /**
+   * Loads and sets the Digital Form node.
+   *
+   * @param string $nid
+   *   The node id to load.
+   *
+   * @return bool
+   *   TRUE if successfully loaded. FALSE otherwise.
+   */
+  protected function loadDigitalFormNode($nid) {
+    $digitalFormNode = $this->digitalFormsService->getDigitalForm($nid);
+    if (!empty($digitalFormNode)) {
+      $this->digitalFormNode = $digitalFormNode;
+      return TRUE;
+    }
+
+    return FALSE;
+  }
+
   /**
    * Returns a render array representing the page with the passed-in content.
    *
@@ -71,7 +104,7 @@ public static function create(ContainerInterface $container) {
    *   Libraries for the page, in addition to the Form Builder general library,
    *   which is added automatically.
    */
-  private function getPage($pageContent, $subtitle, $libraries = NULL) {
+  protected function getPage($pageContent, $subtitle, $libraries = NULL) {
     $page = [
       '#type' => 'page',
       'content' => $pageContent,
@@ -106,12 +139,10 @@ private function getPage($pageContent, $subtitle, $libraries = NULL) {
    * @param string $libraries
    *   Libraries for the page, in addition to the Form Builder general library,
    *   which is added automatically.
-   * @param string $nid
-   *   The node id, passed in when the form in question edits an existing node.
    */
-  private function getFormPage($formName, $subtitle, $libraries = NULL, $nid = NULL) {
+  protected function getFormPage($formName, $subtitle, $libraries = NULL) {
     // @phpstan-ignore-next-line
-    $form = $this->drupalFormBuilder->getForm('Drupal\va_gov_form_builder\Form\\' . $formName, $nid);
+    $form = $this->drupalFormBuilder->getForm('Drupal\va_gov_form_builder\Form\\' . $formName, $this->digitalFormNode);
 
     return $this->getPage($form, $subtitle, $libraries);
   }
@@ -141,7 +172,7 @@ public function home() {
 
     $pageContent = [
       '#theme' => self::PAGE_CONTENT_THEME_PREFIX . 'home',
-      '#build_form_url' => Url::fromRoute('va_gov_form_builder.start_conversion')->toString(),
+      '#build_form_url' => Url::fromRoute('va_gov_form_builder.form_info.create')->toString(),
       '#recent_forms' => $recentForms,
     ];
     $subtitle = 'Select a form';
@@ -151,12 +182,25 @@ public function home() {
   }
 
   /**
-   * Start-conversion page.
+   * Form-info page.
+   *
+   * @param string $nid
+   *   The node id, passed in when the page edits an existing node.
    */
-  public function startConversion() {
-    $formName = 'StartConversion';
-    $subtitle = 'Subtitle Placeholder';
-    return $this->getFormPage($formName, $subtitle);
+  public function formInfo($nid = NULL) {
+    $formName = 'FormInfo';
+    $subtitle = 'Build a form';
+    $libraries = ['form_info'];
+
+    if (!empty($nid)) {
+      // This is an edit.
+      $nodeFound = $this->loadDigitalFormNode($nid);
+      if (!$nodeFound) {
+        throw new NotFoundHttpException();
+      }
+    }
+
+    return $this->getFormPage($formName, $subtitle, $libraries);
   }
 
   /**
@@ -165,7 +209,11 @@ public function startConversion() {
   public function nameAndDob($nid) {
     $formName = 'NameAndDob';
     $subtitle = 'Subtitle Placeholder';
-    return $this->getFormPage($formName, $subtitle, NULL, $nid);
+    $nodeFound = $this->loadDigitalFormNode($nid);
+    if (!$nodeFound) {
+      throw new NotFoundHttpException();
+    }
+    return $this->getFormPage($formName, $subtitle);
   }
 
 }

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

@@ -2,23 +2,185 @@
 
 namespace Drupal\va_gov_form_builder\Form\Base;
 
+use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Form\FormBase;
 use Drupal\Core\Form\FormStateInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Abstract base class for Form Builder form steps.
  */
 abstract class FormBuilderBase extends FormBase {
 
+  /**
+   * 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;
+
+  /**
+   * 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;
+
+  /**
+   * Flag indicating whether this form allows an empty node.
+   *
+   * This defaults to FALSE. The only time an empty node
+   * should be allowed is on the form that creates
+   * the node for the first time. Every other form should
+   * operate on an existing form and should require a
+   * node to be populated.
+   *
+   * @var bool
+   */
+  protected $allowEmptyDigitalFormNode;
+
+  /**
+   * {@inheritDoc}
+   */
+  public function __construct(EntityTypeManagerInterface $entityTypeManager) {
+    $this->entityTypeManager = $entityTypeManager;
+    $this->allowEmptyDigitalFormNode = FALSE;
+  }
+
+  /**
+   * {@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);
+
+  /**
+   * Returns a field value from the Digital Form node.
+   *
+   * If Digital Form node is not set, or `fieldName`
+   * does not exist, returns NULL. This is primarily
+   * used to populate forms with default values when the
+   * form edits an existing Digital Form node.
+   *
+   * @param string $fieldName
+   *   The name of the field whose value should be fetched.
+   */
+  protected function getDigitalFormNodeFieldValue($fieldName) {
+    if (empty($this->digitalFormNode)) {
+      return NULL;
+    }
+
+    try {
+      if ($fieldName === 'title') {
+        return $this->digitalFormNode->getTitle();
+      }
+
+      return $this->digitalFormNode->get($fieldName)->value;
+    }
+    catch (\Exception $e) {
+      return NULL;
+    }
+  }
+
   /**
    * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state, $node = NULL) {
+    // When form is first built, initialize flag to false.
+    $this->digitalFormNodeIsChanged = FALSE;
+
+    if (empty($node) && !$this->allowEmptyDigitalFormNode) {
+      throw new \InvalidArgumentException('Digital Form node cannot be null.');
+    }
+    $this->digitalFormNode = $node;
+
+    return $form;
+  }
+
+  /**
+   * Determines if `digitalFormNode` has a chapter (paragraph) of a given type.
+   *
+   * @param string $type
+   *   The chapter (paragraph) type.
    *
-   * After initially containing some logic, this function
-   * is now empty, and this entire class is a candiate
-   * for removal. Leaving it here for now, as it might prove
-   * necessary as we continue on.
+   * @return bool
+   *   TRUE if the chapter exists; FALSE if the chapter
+   *   does not exist or the node does not exist.
+   */
+  protected function digitalFormNodeHasChapterOfType($type) {
+    if (empty($this->digitalFormNode)) {
+      return FALSE;
+    }
+
+    $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) {
+        // Account for nested property path(e.g. `field_omb_number.0.value`).
+        $fieldName = explode('.', $violation->getPropertyPath())[0];
+
+        // 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 buildForm(array $form, FormStateInterface $form_state) {
+  public function submitForm(array &$form, FormStateInterface $form_state) {
+    // Save the previously validated node.
+    $this->digitalFormNode->save();
   }
 
 }