Provide subnavigation and iframe layout for Enrollment Flow Plugin configs (CFM-428)

app/config/schema/schema.json

@@ -544,6 +544,91 @@
       }
     },
 
+    "enrollment_flows": {
+      "columns": {
+        "id": {},
+        "co_id": {},
+        "name": {},
+        "status": {},
+        "sor_label": {},
+        "authz_type": { "type": "string", "size": 2 },
+        "authz_cou_id": { "type": "integer", "foreignkey": { "table": "cous", "column": "id" }},
+        "authz_group_id": { "type": "integer", "foreignkey": { "table": "groups", "column": "id" }},
+        "collect_enrollee_email": { "type": "boolean" },
+        "redirect_on_finalize": { "type": "string", "size": 256 }
+      },
+      "indexes": {
+        "enrollment_flows_i1": { "columns": [ "co_id" ]},
+        "enrollment_flows_i2": { "needed": false, "columns": [ "authz_cou_id" ]},
+        "enrollment_flows_i3": { "needed": false, "columns": [ "authz_group_id" ]}
+      }
+    },
+
+    "enrollment_flow_steps": {
+      "columns": {
+        "id": {},
+        "enrollment_flow_id": { "type": "integer", "foreignkey": { "table": "enrollment_flows", "column": "id" }},
+        "description": {},
+        "status": {},
+        "plugin": {},
+        "ordr": {},
+        "actor_type": { "type": "string", "size": 2 }
+      },
+      "indexes": {
+        "enrollment_flow_steps_i1": { "columns": [ "enrollment_flow_id" ]}
+      }
+    },
+
+    "petitions": {
+      "columns": {
+        "id": {},
+        "enrollment_flow_id": { "type": "integer", "foreignkey": { "table": "enrollment_flows", "column": "id" }},
+        "status": {},
+        "cou_id": {},
+        "enrollee_email": { "type": "string", "size": 256 },
+        "enrollee_identifier": { "type": "string", "size": 256 },
+        "enrollee_person_id":  { "type": "integer", "foreignkey": { "table": "people", "column": "id" }},
+        "petitioner_identifier": { "type": "string", "size": 256 },
+        "petitioner_person_id": { "type": "integer", "foreignkey": { "table": "people", "column": "id" }},
+        "token": { "type": "string", "size": 256 }
+      },
+      "indexes": {
+        "petitions_i1": { "columns": [ "enrollment_flow_id" ]},
+        "petitions_i2": { "columns": [ "cou_id" ]},
+        "petitions_i3": { "columns": [ "enrollee_person_id" ]},
+        "petitions_i4": { "columns": [ "petitioner_person_id" ]}
+      }
+    },
+
+    "petition_step_results": {
+      "columns": {
+        "id": {},
+        "petition_id": {},
+        "enrollment_flow_step_id": {},
+        "comment": {}
+      },
+      "indexes": {
+        "petition_step_results_i1": { "columns": [ "petition_id" ] },
+        "petition_step_results_i2": { "needed": false, "columns": [ "enrollment_flow_step_id" ] }
+      }
+    },
+
+    "petition_history_records": {
+      "columns": {
+        "id": {},
+        "petition_id": {},
+        "enrollment_flow_step_id": {},
+        "action": {},
+        "comment": {},
+        "actor_person_id": { "type": "integer", "foreignkey": { "table": "people", "column": "id" } }
+      },
+      "indexes": {
+        "petition_history_records_i1": { "columns": [ "petition_id" ] },
+        "petition_history_records_i2": { "columns": [ "actor_person_id" ] },
+        "petition_history_records_i3": { "needed": false, "columns": [ "enrollment_flow_step_id" ] }
+      }
+    },
+
     "message_templates": {
       "columns": {
         "id": {},

app/plugins/CoreEnroller/src/Controller/EmailVerifiersController.php

@@ -41,6 +41,27 @@ class EmailVerifiersController extends StandardEnrollerController {
       'EmailVerifiers.id' => 'asc'
     ]
   ];
+
+  /**
+   * Callback run prior to the request render.
+   *
+   * @param   EventInterface  $event  Cake Event
+   *
+   * @return Response|void
+   * @since  COmanage Registry v5.0.0
+   */
+
+  public function beforeRender(\Cake\Event\EventInterface $event) {
+    $link = $this->getPrimaryLink(true);
+
+    if(!empty($link->value)) {
+      $this->set('vv_bc_parent_obj', $this->EmailVerifiers->EnrollmentFlowSteps->get($link->value));
+      $this->set('vv_bc_parent_displayfield', $this->EmailVerifiers->EnrollmentFlowSteps->getDisplayField());
+      $this->set('vv_bc_parent_primarykey', $this->EmailVerifiers->EnrollmentFlowSteps->getPrimaryKey());
+    }
+
+    return parent::beforeRender($event);
+  }
 
   /**
    * Dispatch an Enrollment Flow Step.

app/plugins/CoreEnroller/src/Controller/IdentifierCollectorsController.php

@@ -38,6 +38,27 @@ class IdentifierCollectorsController extends StandardEnrollerController {
       'IdentifierCollectors.id' => 'asc'
     ]
   ];
+
+  /**
+   * Callback run prior to the request render.
+   *
+   * @param   EventInterface  $event  Cake Event
+   *
+   * @return Response|void
+   * @since  COmanage Registry v5.0.0
+   */
+
+  public function beforeRender(\Cake\Event\EventInterface $event) {
+    $link = $this->getPrimaryLink(true);
+
+    if(!empty($link->value)) {
+      $this->set('vv_bc_parent_obj', $this->IdentifierCollectors->EnrollmentFlowSteps->get($link->value));
+      $this->set('vv_bc_parent_displayfield', $this->IdentifierCollectors->EnrollmentFlowSteps->getDisplayField());
+      $this->set('vv_bc_parent_primarykey', $this->IdentifierCollectors->EnrollmentFlowSteps->getPrimaryKey());
+    }
+
+    return parent::beforeRender($event);
+  }
 
   /**
    * Dispatch an Enrollment Flow Step.

app/plugins/CoreEnroller/src/Controller/InvitationAcceptersController.php

@@ -39,6 +39,27 @@ class InvitationAcceptersController extends StandardEnrollerController {
       'InvitationAccepters.id' => 'asc'
     ]
   ];
+
+  /**
+   * Callback run prior to the request render.
+   *
+   * @param   EventInterface  $event  Cake Event
+   *
+   * @return Response|void
+   * @since  COmanage Registry v5.0.0
+   */
+
+  public function beforeRender(\Cake\Event\EventInterface $event) {
+    $link = $this->getPrimaryLink(true);
+
+    if(!empty($link->value)) {
+      $this->set('vv_bc_parent_obj', $this->InvitationAccepters->EnrollmentFlowSteps->get($link->value));
+      $this->set('vv_bc_parent_displayfield', $this->InvitationAccepters->EnrollmentFlowSteps->getDisplayField());
+      $this->set('vv_bc_parent_primarykey', $this->InvitationAccepters->EnrollmentFlowSteps->getPrimaryKey());
+    }
+
+    return parent::beforeRender($event);
+  }
 
   /**
    * Dispatch an Enrollment Flow Step.

app/plugins/CoreEnroller/src/Model/Table/AttributeCollectorsTable.php

@@ -81,7 +81,7 @@ public function initialize(array $config): void {
       [
         // Ordered list of Tabs
         'tabs' => ['EnrollmentFlowSteps', 'CoreEnroller.AttributeCollectors', 'CoreEnroller.EnrollmentAttributes'],
-        // What actions will inlcude the subnavigation header
+        // What actions will include the subnavigation header
         'action' => [
           // If a model renders in a subnavigation mode in edit/view mode, it cannot
           // render in index mode for the same use case/context

app/plugins/CoreEnroller/src/Model/Table/EmailVerifiersTable.php

@@ -46,10 +46,12 @@
 class EmailVerifiersTable extends Table {
   use \App\Lib\Traits\AutoViewVarsTrait;
   use \App\Lib\Traits\CoLinkTrait;
-  use \App\Lib\Traits\LabeledLogTrait;
+  use \App\Lib\Traits\LabeledLogTrait;  
+  use \App\Lib\Traits\LayoutTrait;
   use \App\Lib\Traits\PermissionsTrait;
   use \App\Lib\Traits\PrimaryLinkTrait;
   use \App\Lib\Traits\TableMetaTrait;
+  use \App\Lib\Traits\TabTrait;
   use \App\Lib\Traits\ValidationTrait;
 
   /**
@@ -83,6 +85,22 @@ public function initialize(array $config): void {
     $this->setPrimaryLink('enrollment_flow_step_id');
     $this->setRequiresCO(true);
     $this->setAllowLookupPrimaryLink(['dispatch', 'display']);
+
+    // All the tabs share the same configuration in the ModelTable file
+    $this->setTabsConfig(
+      [
+        // Ordered list of Tabs
+        'tabs' => ['EnrollmentFlowSteps', 'CoreEnroller.EmailVerifiers'],
+        // What actions will include the subnavigation header
+        'action' => [
+          // If a model renders in a subnavigation mode in edit/view mode, it cannot
+          // render in index mode for the same use case/context
+          // XXX edit should go first.
+          'EnrollmentFlowSteps' => ['edit', 'view'],
+          'CoreEnroller.EmailVerifiers' => ['edit']
+        ]
+      ]
+    );
 
     $this->setAutoViewVars([
       'modes' => [

app/plugins/CoreEnroller/src/Model/Table/IdentifierCollectorsTable.php

@@ -40,9 +40,11 @@
 class IdentifierCollectorsTable extends Table {
   use \App\Lib\Traits\AutoViewVarsTrait;
   use \App\Lib\Traits\CoLinkTrait;
+  use \App\Lib\Traits\LayoutTrait;
   use \App\Lib\Traits\PermissionsTrait;
   use \App\Lib\Traits\PrimaryLinkTrait;
   use \App\Lib\Traits\TableMetaTrait;
+  use \App\Lib\Traits\TabTrait;
   use \App\Lib\Traits\ValidationTrait;
 
   /**
@@ -75,7 +77,23 @@ public function initialize(array $config): void {
     $this->setPrimaryLink('enrollment_flow_step_id');
     $this->setRequiresCO(true);
     $this->setAllowLookupPrimaryLink(['dispatch', 'display']);
-
+
+    // All the tabs share the same configuration in the ModelTable file
+    $this->setTabsConfig(
+      [
+        // Ordered list of Tabs
+        'tabs' => ['EnrollmentFlowSteps', 'CoreEnroller.IdentifierCollectors'],
+        // What actions will include the subnavigation header
+        'action' => [
+          // If a model renders in a subnavigation mode in edit/view mode, it cannot
+          // render in index mode for the same use case/context
+          // XXX edit should go first.
+          'EnrollmentFlowSteps' => ['edit', 'view'],
+          'CoreEnroller.IdentifierCollectors' => ['edit']
+        ]
+      ]
+    );
+
     $this->setAutoViewVars([
       'types' => [
         'type' => 'type',

app/plugins/CoreEnroller/src/Model/Table/InvitationAcceptersTable.php

@@ -41,9 +41,11 @@
 
 class InvitationAcceptersTable extends Table {
   use \App\Lib\Traits\CoLinkTrait;
+  use \App\Lib\Traits\LayoutTrait;
   use \App\Lib\Traits\PermissionsTrait;
   use \App\Lib\Traits\PrimaryLinkTrait;
   use \App\Lib\Traits\TableMetaTrait;
+  use \App\Lib\Traits\TabTrait;
   use \App\Lib\Traits\ValidationTrait;
 
   /**
@@ -75,6 +77,22 @@ public function initialize(array $config): void {
     $this->setPrimaryLink('enrollment_flow_step_id');
     $this->setRequiresCO(true);
     $this->setAllowLookupPrimaryLink(['dispatch', 'display']);
+
+    // All the tabs share the same configuration in the ModelTable file
+    $this->setTabsConfig(
+      [
+        // Ordered list of Tabs
+        'tabs' => ['EnrollmentFlowSteps', 'CoreEnroller.InvitationAccepters'],
+        // What actions will include the subnavigation header
+        'action' => [
+          // If a model renders in a subnavigation mode in edit/view mode, it cannot
+          // render in index mode for the same use case/context
+          // XXX edit should go first.
+          'EnrollmentFlowSteps' => ['edit', 'view'],
+          'CoreEnroller.InvitationAccepters' => ['edit']
+        ]
+      ]
+    );
 
     $this->setPermissions([
       // Actions that operate over an entity (ie: require an $id)

app/src/Lib/Traits/TabTrait.php

@@ -1,6 +1,10 @@
 <?php
 /**
+<<<<<<<< HEAD:app/src/Lib/Traits/TabTrait.php
  * COmanage Registry Tab Trait
+========
+ * COmanage Registry Tab Subnav Element
+>>>>>>>> 9a427e22 (feature-cfm31-subnavigation (#217)):app/templates/element/subnavigation/inlineList.php
  *
  * Portions licensed to the University Corporation for Advanced Internet
  * Development, Inc. ("UCAID") under one or more contributor license agreements.
@@ -25,8 +29,10 @@
  * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
  */
 
+
 declare(strict_types = 1);
 
+<<<<<<<< HEAD:app/src/Lib/Traits/TabTrait.php
 namespace App\Lib\Traits;
 
 trait TabTrait
@@ -68,4 +74,31 @@ public function setTabsConfig(array $tabsConfig): void
     $this->tabsConfig = $tabsConfig;
   }
 
-}
+}
+========
+$curAction = $this->request->getParam('action');
+$curController = $this->request->getParam('controller');
+$isNested = true;
+
+extract($vv_sub_nav_attributes, EXTR_PREFIX_ALL, 'vv_subnavigation');
+
+$curId = $this->request->getQuery($vv_primary_link)
+  ?? $vv_obj->id
+  ?? end($vv_bc_title_links[0]['target']);
+?>
+
+<?php foreach($vv_subnavigation_nested['tabs'] as $tab): ?>
+  <li class="list-inline-item">
+    <?php
+    // Construct Element Title
+    $title = $this->element('subnavigation/tabTitle', compact('tab', 'curId', 'isNested'));
+    // Construct Target URL
+    $url = $this->Tab->constructLinkUrl($tab, $curId, $isNested);
+    // Calculate Tab Style Class(es)
+    $linkClass = $this->Tab->getLinkClass($tab, $isNested);
+    // Import <a> element in the DOM
+    print $this->Html->link($title, $url, ['class' => $linkClass, 'escape' => false]);
+    ?>
+  </li>
+<?php endforeach; ?>
+>>>>>>>> 9a427e22 (feature-cfm31-subnavigation (#217)):app/templates/element/subnavigation/inlineList.php