Refactor fields.inc to be configuration only (CFM-218) #342

arlen · 2025-09-18T17:46:16Z

No description provided.

arlen · 2025-09-18T17:48:35Z

app/plugins/OrcidSource/templates/OrcidSources/fields.inc

+    ]
+  ],
+  'SUBTITLE' => [


This is a convention used to insert an h3 subtitle between groups of fields. It looks like this:

'SUBTITLE' => [ 'subtitle' => __d('api_connector', 'field.ApiSources.push_mode') ]

This is documented in the Registry Wiki

arlen · 2025-09-18T17:53:15Z

app/templates/Standard/add-edit-view.php

-// By default, the form will POST to the current controller
-// Note we need to open the form for view so Cake will autopopulate values
-print $this->Form->create($vv_obj);
+if(!empty($vv_alternate_template)) {


The controller can assert $vv_alternate_template to have a non-standard template inserted here. It will be rendered without the standard form (but one could be included in the alternate template). This is currently used to render the Petition view.

This is documented in the Registry Wiki

arlen · 2025-09-18T17:56:24Z

app/templates/Standard/add-edit-view.php

+  // We will output the standard Form (for add, edit, and view).
+  // By default, the form will POST to the current controller.
+  // Note we need to open the form for view so Cake will autopopulate values.
+  if($this->Field->includesFileField($fields)) {


This is a simple test for whether or not we have a file field. If we do, we have to change the form encoding type to multipart/form-data. The function that does this (in FieldHelper) assumes we'll know the exact level of the configuration in the $fields[] array since this will be (marginally) faster than doing a recursive search through the whole array. We do this generically to support future plugins (and probably themes). At the moment, we only use a file field for SSH Key upload.

arlen · 2025-09-18T17:59:28Z

app/availableplugins/ApiConnector/templates/ApiSources/fields.inc

@@ -26,10 +26,18 @@
 */

 // This view does currently not support read-only


There were numerous fields.inc files (particularly in plugins) that locked down the fields exclusively to "edit". Where this test existed, I left it in - returning when $vv_action !== 'edit'.

Do we want to keep these or remove them? This looks like:

// This view only supports edit if($vv_action !== 'edit') { return; }

Remove these

All such references have been removed.

arlen · 2025-09-18T18:05:12Z

app/plugins/CoreEnroller/templates/EmailVerifiers/fields.inc

+    ]
+  ]
+];
+


The approach taken here to set up the verification_code_charset field in the beforeField block will not work because the php here is no longer being generated inside Cake's form element. We need to find a different way to accommodate what we are trying to do.

This is fixed.

arlen · 2025-09-18T18:20:34Z

app/templates/Addresses/fields.inc

+  'postal_code',
+  'country',
+  'type_id' => [
+    // XXX fix fieldOptions - just make this flat


We want to flatten the fieldOptions sub-array, and list its elements at the top level. (We did this in Match.) That has not yet been done here.

So this structure:

'type_id' => [ // XXX fix fieldOptions - just make this flat 'fieldOptions' => [ 'default' => $vv_default_type ] ]

would become this structure:

'type_id' => [ 'default' => $vv_default_type ]

All references to 'fieldOptions' in fields.inc files have been removed and its sub-elements flattened upward. Note that references to 'fieldOptions' remain in specialized (non-standard) templates where elements are called directly, such as in app/plugins/CoreEnroller/templates/InvitationAccepters/dispatch.inc.

arlen · 2025-09-18T18:25:08Z

app/templates/Standard/add-edit-view.php

+// Include fields configuration for the form. This will typically include the $fields array.
+$fields = []; // Backstop the fields array: some configs have no fields.
+$fieldsFile = "fields.inc"; // This is the default.
+if(file_exists($templatePath . DS . 'fields-' . $vv_action . '.inc')) {


This is a new convention:

if(file_exists($templatePath . DS . 'fields-' . $vv_action . '.inc')) { // We have an action file override in the form of "fields-ACTION.inc". Use it. $fieldsFile = 'fields-' . $vv_action . '.inc'; }

This allows us to follow a general convention for non-standard actions.

This is documented in the Registry Wiki.

arlen · 2025-09-18T18:30:03Z

app/availableplugins/ApiConnector/src/Model/Table/ApiSourcesTable.php

@@ -74,6 +75,24 @@ public function initialize(array $config): void {
    $this->setPrimaryLink(['external_identity_source_id']);
    $this->setRequiresCO(true);

+    // All the tabs share the same configuration in the ModelTable file
+    // XXX Reenable when this doesn't throw an error (same error as https://todos.internet2.edu/browse/CFM-475 )


I attempted to add the subnavigation for API Sources config similar to File Sources, Sql Sources (etc). When this block is included it throws an error similar to what we see in https://todos.internet2.edu/browse/CFM-475

Ioannis · 2025-09-19T08:14:16Z

app/src/View/Helper/FieldHelper.php

+   * @return bool
+   * @since  COmanage Registry v5.2.0
+   */
+  function includesFileField(array $array): bool {


@arlen add missing public access modifier

Added to both new functions - thanks!

… (CFM-218)

arlen commented Sep 18, 2025

View reviewed changes

arlen force-pushed the feature-cfm218-fieldsIncConfigOnly branch 2 times, most recently from 984681b to 46b3261 Compare September 23, 2025 17:57

arlen changed the title ~~Refactor fields.inc to be configuration only - first pass. (CFM-218)~~ Refactor fields.inc to be configuration only (CFM-218) Sep 24, 2025

arlen marked this pull request as ready for review September 24, 2025 18:26

arlen requested review from Ioannis and benno September 24, 2025 18:26

arlen force-pushed the feature-cfm218-fieldsIncConfigOnly branch from 29c718b to 620cdf5 Compare October 7, 2025 14:40

Ioannis approved these changes Oct 9, 2025

View reviewed changes

arlen added 8 commits October 21, 2025 14:14

Refactor fields.inc to be configuration only - first pass. (CFM-218)

6396fb5

Fix fields.inc for EmailVerifiers to use grouped controls. (CFM-218)

ac6729a

Simplify fields.inc configuration. (CFM-218)

7968dee

Remove 'edit only' blocking statements. (CFM-218)

f4fadb1

Remove leftover call to jsLocalOnLoad function (CFM-218)

4300519

Standardize fields.inc 'type' and 'options'; add arbitrary HTML field…

2238508

… (CFM-218)

Add 'public' keyword to new FieldHelper functions (CFM-218)

c02b883

Improve tests for COmanange CO (CFM-218)

1856b00

arlen force-pushed the feature-cfm218-fieldsIncConfigOnly branch from 0e2698b to 1856b00 Compare October 21, 2025 19:01

Refactor fields.inc to be configuration only (CFM-218) #342

Refactor fields.inc to be configuration only (CFM-218) #342

arlen commented Sep 18, 2025

arlen Sep 18, 2025 •

edited

Loading

arlen Oct 7, 2025

arlen Sep 18, 2025

arlen Oct 7, 2025

arlen Sep 18, 2025 •

edited

Loading

arlen Sep 18, 2025 •

edited

Loading

arlen Sep 24, 2025

arlen Sep 24, 2025

arlen Sep 18, 2025

arlen Sep 24, 2025

arlen Sep 18, 2025 •

edited

Loading

arlen Oct 7, 2025

arlen Sep 18, 2025 •

edited

Loading

arlen Oct 7, 2025

arlen Sep 18, 2025

Ioannis Sep 19, 2025 •

edited

Loading

arlen Oct 9, 2025

		@@ -26,10 +26,18 @@
		*/

		// This view does currently not support read-only

Refactor fields.inc to be configuration only (CFM-218) #342

Are you sure you want to change the base?

Refactor fields.inc to be configuration only (CFM-218) #342

Conversation

arlen commented Sep 18, 2025

arlen Sep 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arlen Sep 18, 2025 • edited Loading

Choose a reason for hiding this comment

arlen Sep 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arlen Sep 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arlen Sep 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ioannis Sep 19, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arlen Sep 18, 2025 •

edited

Loading

arlen Sep 18, 2025 •

edited

Loading

arlen Sep 18, 2025 •

edited

Loading

arlen Sep 18, 2025 •

edited

Loading

arlen Sep 18, 2025 •

edited

Loading

Ioannis Sep 19, 2025 •

edited

Loading