Add description field to Enrollment Flows (CFM-435)

app/availableplugins/FileConnector/src/Controller/FileSourcesController.php

@@ -30,11 +30,34 @@
 namespace FileConnector\Controller;
 
 use App\Controller\StandardPluginController;
+use Cake\Event\EventInterface;
+use Cake\Http\Response;
 
 class FileSourcesController extends StandardPluginController {
   public $paginate = [
     'order' => [
       'FileSources.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(EventInterface $event) {
+    $link = $this->getPrimaryLink(true);
+
+    if(!empty($link->value)) {
+      $this->set('vv_bc_parent_obj', $this->FileSources->ExternalIdentitySources->get($link->value));
+      $this->set('vv_bc_parent_displayfield', $this->FileSources->ExternalIdentitySources->getDisplayField());
+      $this->set('vv_bc_parent_primarykey', $this->FileSources->ExternalIdentitySources->getPrimaryKey());
+    }
+
+    return parent::beforeRender($event);
+  }
 }

app/availableplugins/FileConnector/src/Model/Table/FileSourcesTable.php

@@ -44,7 +44,8 @@ class FileSourcesTable extends Table {
   use \App\Lib\Traits\PrimaryLinkTrait;
   use \App\Lib\Traits\TableMetaTrait;
   use \App\Lib\Traits\ValidationTrait;
-
+  use \App\Lib\Traits\TabTrait;
+
   // Cache of the field configuration
   protected $fieldCfg = null;
 
@@ -78,6 +79,23 @@ public function initialize(array $config): void {
       ]
     ]);
 
+    // All the tabs share the same configuration in the ModelTable file
+    $this->setTabsConfig(
+      [
+        // Ordered list of Tabs
+        'tabs' => ['ExternalIdentitySources', 'FileConnector.FileSources', 'ExternalIdentitySources@action.search'],
+        // 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.
+          'ExternalIdentitySources' => ['edit', 'view', 'search'],
+          'FileConnector.FileSources' => ['edit'],
+          'ExternalIdentitySources@action.search' => [],
+        ],
+      ]
+    );
+
     $this->setPermissions([
       // Actions that operate over an entity (ie: require an $id)
       'entity' => [

app/composer.json

@@ -32,6 +32,7 @@
             "App\\": "src/",
             "ApiConnector\\": "availableplugins/ApiConnector/src/",
             "CoreAssigner\\": "plugins/CoreAssigner/src/",
+            "CoreEnroller\\": "plugins/CoreEnroller/src/",
             "CoreServer\\": "plugins/CoreServer/src/",
             "FileConnector\\": "availableplugins/FileConnector/src/",
             "PipelineToolkit\\": "availableplugins/PipelineToolkit/src/",
@@ -45,6 +46,7 @@
             "ApiConnector\\Test\\": "availableplugins/ApiConnector/tests/",
             "Cake\\Test\\": "vendor/cakephp/cakephp/tests/",
             "CoreAssigner\\Test\\": "plugins/CoreAssigner/tests/",
+            "CoreEnroller\\Test\\": "plugins/CoreEnroller/tests/",
             "CoreServer\\Test\\": "plugins/CoreServer/tests/",
             "FileConnector\\Test\\": "availableplugins/FileConnector/tests/",
             "PipelineToolkit\\Test\\": "availableplugins/PipelineToolkit/tests/",

app/config/routes.php

@@ -168,6 +168,20 @@ function (RouteBuilder $builder) {
      * ...and connect the rest of 'Pages' controller's URLs.
      */
     $builder->connect('/pages/*', ['controller' => 'Pages', 'action' => 'display']);
+
+    /**
+     * Registry allows URLs of the form /coid/name to render as a Mostly Static Page.
+     * 
+     * Note this will effectively route any URL of the form /registry/x, where x consists of
+     * digits, to the Pages controller. We need to filter on digits, or we'll end up taking
+     * over all controllers as well. (The implication is we can't have a controller whose
+     * name consists entirely of digits, but we probably shouldn't...)
+     */
+    $builder->connect(
+      '/{coid}/{name}',
+      ['controller' => 'Pages', 'action' => 'show' ],
+      ['coid' => '\d+', 'pass' => ['coid', 'name']]
+    );
 
     /*
      * Connect catchall routes for all controllers.

app/config/schema/schema.json

@@ -9,12 +9,14 @@
     "comment": "Columns with names matching those defined here will by default inherit these properties",
 
     "columns": {
+      "action": { "type": "string", "size": 4 },
       "api_user_id": { "type": "integer", "foreignkey": { "table": "api_users", "column": "id" } },
       "co_id": { "type": "integer", "foreignkey": { "table": "cos", "column": "id" }, "notnull": true },
       "comment": { "type": "string", "size": 256 },
       "context": { "type": "string", "size": 2 },
       "cou_id": { "type": "integer", "foreignkey": { "table": "cous", "column": "id" } },
       "description": { "type": "string", "size": 128 },
+      "enrollment_flow_step_id": { "type": "integer", "foreignkey": { "table": "enrollment_flow_steps", "column": "id" } },
       "external_identity_id": { "type": "integer", "foreignkey": { "table": "external_identities", "column": "id" } },
       "external_identity_role_id": { "type": "integer", "foreignkey": { "table": "external_identity_roles", "column": "id" } },
       "external_identity_source_id": { "type": "integer", "foreignkey": { "table": "external_identity_sources", "column": "id" } },
@@ -23,15 +25,19 @@
       "id": { "type": "integer", "autoincrement": true, "primarykey": true },
       "identifier_assignment_id": { "type": "integer", "foreignkey": { "table": "identifier_assignments", "column": "id" }, "notnull": true },
       "language": { "type": "string", "size": 16 },
+      "mail": { "type": "string", "size": 256 },
+      "message_template_id": { "type": "integer", "foreignkey": { "table": "message_templates", "column": "id" } },
       "name": { "type": "string", "size": 128, "notnull": true },
       "ordr": { "type": "integer" },
       "person_id": { "type": "integer", "foreignkey": { "table": "people", "column": "id" } },
       "person_role_id": { "type": "integer", "foreignkey": { "table": "person_roles", "column": "id" } },
+      "petition_id": { "type": "integer", "foreignkey": { "table": "petitions", "column": "id" } },
       "plugin": { "type": "string", "size": 80 },
       "provisioning_target_id": { "type": "integer", "foreignkey": { "table": "provisioning_targets", "column": "id" }, "notnull": true },
       "reference_identifier": { "type": "string", "size": 40 },
       "report_id": { "type": "integer", "foreignkey": { "table": "reports", "column": "id" }, "notnull": true },
       "server_id": { "type": "integer", "foreignkey": { "table": "servers", "column": "id" }, "notnull": true },
+      "sor_label": { "type": "string", "size": 40 },
       "status": { "type": "string", "size": 2 },
       "type_id": { "type": "integer", "foreignkey": { "table": "types", "column": "id" }, "notnull": true },
       "valid_from": { "type": "datetime" },
@@ -397,11 +403,11 @@
       "mvea": [ "person", "person_role", "external_identity", "external_identity_role" ],
       "sourced": true
     },
-    
+
     "email_addresses": {
       "columns": {
         "id": {},
-        "mail": { "type": "string", "size": 256 },
+        "mail": {},
         "description": {},
         "type_id": {},
         "verified": { "type": "boolean" }
@@ -517,8 +523,8 @@
     "history_records": {
       "columns": {
         "id": {},
-        "action": { "type": "string", "size": 4 },
-        "comment": { "type": "string", "size": 256 },
+        "action": {},
+        "comment": {},
         "person_id": {},
         "person_role_id": {},
         "external_identity_id": {},
@@ -594,6 +600,127 @@
       }
     },
 
+    "mostly_static_pages": {
+      "columns": {
+        "id": {},
+        "co_id": {},
+        "name": {},
+        "title": { "type": "string", "size": 256 },
+        "description": {},
+        "status": {},
+        "context": {},
+        "body": { "type": "text" }
+      },
+      "indexes": {
+        "mostly_static_pages_i1": { "columns": [ "co_id" ] }
+      }
+    },
+
+    "enrollment_flows": {
+      "columns": {
+        "id": {},
+        "co_id": {},
+        "name": {},
+        "description": { "size": 256 },
+        "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 },
+        "message_template_id": {},
+        "redirect_on_handoff": { "type": "string", "size": 256 }
+      },
+      "indexes": {
+        "enrollment_flow_steps_i1": { "columns": [ "enrollment_flow_id" ]},
+        "enrollment_flow_steps_i2": { "needed": false, "columns": [ "message_template_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" ] }
+      }
+    },
+
+    "verifications": {
+      "columns": {
+        "id": {},
+        "code": { "type": "string", "size": 32 },
+        "verification_time": { "type": "datetime" },
+        "request_expiration_time": { "type": "datetime" },
+        "method": { "type": "string", "size": 2 },
+        "email_address_id": { "type": "integer", "foreignkey": { "table": "email_addresses", "column": "id" } },
+        "petition_id": {}
+      },
+      "indexes": {
+        "verifications_i1": { "columns": [ "email_address_id" ] },
+        "verifications_i2": { "columns": [ "petition_id" ] }
+      }
+    },
+
     "jobs": {
       "columns": {
         "id": {},

app/plugins/CoreEnroller/composer.json

@@ -0,0 +1,24 @@
+{
+    "name": "your-name-here/core-enroller",
+    "description": "CoreEnroller plugin for CakePHP",
+    "type": "cakephp-plugin",
+    "license": "MIT",
+    "require": {
+        "php": ">=7.2",
+        "cakephp/cakephp": "4.4.*"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^8.5 || ^9.3"
+    },
+    "autoload": {
+        "psr-4": {
+            "CoreEnroller\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "CoreEnroller\\Test\\": "tests/",
+            "Cake\\Test\\": "vendor/cakephp/cakephp/tests/"
+        }
+    }
+}

app/plugins/CoreEnroller/phpunit.xml.dist

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    colors="true"
+    processIsolation="false"
+    stopOnFailure="false"
+    bootstrap="tests/bootstrap.php"
+    >
+    <php>
+        <ini name="memory_limit" value="-1"/>
+        <ini name="apc.enable_cli" value="1"/>
+    </php>
+
+    <!-- Add any additional test suites you want to run here -->
+    <testsuites>
+        <testsuite name="CoreEnroller">
+            <directory>tests/TestCase/</directory>
+        </testsuite>
+    </testsuites>
+
+    <!-- Setup fixture extension -->
+    <extensions>
+        <extension class="Cake\TestSuite\Fixture\PHPUnitExtension" />
+    </extensions>
+
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>