Skip to content

Latest commit

 

History

History
149 lines (116 loc) · 5.8 KB

README.md

File metadata and controls

149 lines (116 loc) · 5.8 KB
Raw

Benefit Finder v2 Custom Drupal Module

Structure

/usagov_benefit_finder
  |-config
  |-modules
    |-usagov_benefit_finder_api
      |-src
        |-Controller
          LifeEventController.php
      usagov_benefit_finder_api.module
    |-usagov_benefit_finder_app
      |-usagov_benefit_finder_page
        |-css
          benefit-finder.min.css
        |-js
          benefit-finder.min.js
        |-templates
          page--benefit-finder-life-event.html.twig
        usagov_benefit_finder_page.libraries.yml
        usagov_benefit_finder_page.module
    |-usagov_benefit_finder_content
      |-src
      usagov_benefit_finder_content.module
  |-src
    |-Form
      BenefitFinderSettingsForm.php
    |-Traits
      BenefitFinderTrait.php
  |-tests
  |-README.md

Basics

File or folder Description
usagov_benefit_finder_api Benefit finder API module
LifeEventController.php Process benefit finder content to generate JSON data and JSON file
usagov_benefit_finder_api.module JSON file generation batch job
usagov_benefit_finder_page Benefit finder page module
benefit-finder.min.css Benefit finder app css
benefit-finder.min.js Benefit finder app JavaScript
page--benefit-finder-life-event.html.twig Benefit finder page template
usagov_benefit_finder_page.libraries.yml Benefit finder app library
usagov_benefit_finder_page.module Benefit finder page theme, preprocess, attach library
usagov_benefit_finder_content Benefit finder content module
usagov_benefit_finder_content.module Provide benefit finder content form validation
src/Form/BenefitFinderSettingsForm.php Form to set up automate JSON data file generation
src/Traits/BenefitFinderTrait.php Functions to get benefit finder node

Benefit finder API module

The usagov_benefit_finder_api custom Drupal module works on reading and processing benefit finder content, generating JSON data and JSON file for a given life event; creating and running batch job to update JSON files of all life events when content editors add/update benefit finder content.

Life event controller

The LifeEventController.php life event controller has the following functions:

  • Fetches benefit finder content of given life event
  • Processes the benefit finder content
  • Generates JSON data
  • Saves JSON data as JSON file

Benefit finder API module

The usagov_benefit_finder_api.module module creates and runs batch job of generating JSON data files of all life events when content editors add/update a benefit finder content. This keeps benefit finder JSON data files consistent with benefit finder content.

Benefit finder page module

The usagov_benefit_finder_page custom Drupal module works on defining benefit finder library including benefit finder app JavaScript and CSS file; providing twig page template with container for benefit finder app to attach to, with JSON data file path attribute for benefit finder app to fetch data from, and HTML content for benefit finder app to override.

Benefit finder App

The benefit-finder.min.js is a React program with following functions:

  • Fetches JSON data generated by Drupal custom module
  • Provides users life event form
  • Outputs result about benefit eligibility according to user inputs

The benefit-finder.min.css is the associated CSS file.

The usagov_benefit_finder_page.libraries.yml defines benefit_finder_app library.

benefit_finder_app:
  version: 1.x
  js:
    js/benefit-finder.min.js: {}
  css:
    theme:
      css/benefit-finder.min.css: {}

Twig Page Template

The page--benefit-finder-life-event.html.twig is the page template of life event page:

  • Outputs container for React app to attach to
  • Outputs draft and published JSON data file path for React app to fetch data from
  • Outputs HTML content for React app to override
  <div id="benefit-finder" json-data-file-path="{{ json_data_file_path }}" draft-json-data-file-path="{{ draft_json_data_file_path }}">
    {# app will rehydrate and replace innerHTML #}
    <h1 class="usa-sr-only" id="skip-to-h1" aria-level="1" hidden role="heading">{{ node.label }}</h1>
  </div>

Benefit finder page module

The usagov_benefit_finder_page.module module suggests life event page to use the benefit finder page template, and attaches benefit finder app JavaScript and CSS file to the life event page.

Benefit finder content module

The usagov_benefit_finder_content custom Drupal module works on benefit finder form alter and form validation.

Benefit finder content module

The usagov_benefit_finder_content.module module:

  • Validates agency form
  • Validates criteria form
  • Validates life event form
  • Alters benefit edit form
  • Validates benefit form

Benefit finder settings form

The src/Form/BenefitFinderSettingsForm.php form provides automate JSON data file generation setting.

Benefit finder trait

The src/Traits/BenefitFinderTrait.php trait provides functions to get benefit finder content.

  • Get life event
  • Get agency
  • Get criteria
  • Get benefit
  • Get life event form
  • Get node of a given node ID and content mode