Simplify $subnav declaration (CFM-291)

COmanage · Mar 12, 2026 · 80ca5d9 · 80ca5d9
1 parent d9c5de4
commit 80ca5d9
Show file tree

Hide file tree

Showing 34 changed files with 48 additions and 80 deletions.
diff --git a/app/availableplugins/ApiConnector/templates/ApiSourceEndpoints/fields.inc b/app/availableplugins/ApiConnector/templates/ApiSourceEndpoints/fields.inc
@@ -39,8 +39,7 @@ $fields = [
   'external_identity_source_id'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['Apis', 'ApiConnector.ApiSourceEndpoints'],
   'action' => [
     'Apis' => ['edit'],

diff --git a/app/availableplugins/ApiConnector/templates/ApiSources/fields.inc b/app/availableplugins/ApiConnector/templates/ApiSources/fields.inc
@@ -39,8 +39,7 @@ $fields = [
   ]
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['ExternalIdentitySources', 'ApiConnector.ApiSources', 'ExternalIdentitySources@action.search'],
   'action' => [
     'ExternalIdentitySources' => ['edit', 'view', 'search'],

diff --git a/app/availableplugins/FileConnector/templates/FileProvisioners/fields.inc b/app/availableplugins/FileConnector/templates/FileProvisioners/fields.inc
@@ -29,8 +29,7 @@ $fields = [
   'filename'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['ProvisioningTargets', 'FileConnector.FileProvisioners'],
   'action' => [
     'ProvisioningTargets' => ['edit'],

diff --git a/app/availableplugins/FileConnector/templates/FileSources/fields.inc b/app/availableplugins/FileConnector/templates/FileSources/fields.inc
@@ -33,8 +33,7 @@ $fields = [
   'threshold_override',
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['ExternalIdentitySources', 'FileConnector.FileSources', 'ExternalIdentitySources@action.search'],
   'action' => [
     'ExternalIdentitySources' => ['edit', 'view', 'search'],

diff --git a/app/availableplugins/KerberosConnector/templates/KerberosServers/fields.inc b/app/availableplugins/KerberosConnector/templates/KerberosServers/fields.inc
@@ -33,8 +33,7 @@ $fields = [
   'keytab_path'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['Servers', 'KerberosConnector.KerberosServers'],
   'action' => [
     'Servers' => ['edit'],

diff --git a/app/availableplugins/PasswordAuthenticator/templates/PasswordAuthenticators/fields.inc b/app/availableplugins/PasswordAuthenticator/templates/PasswordAuthenticators/fields.inc
@@ -34,8 +34,7 @@ $fields = [
   'format_plaintext'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['Authenticators', 'PasswordAuthenticator.PasswordAuthenticators'],
   'action' => [
     'Authenticators' => ['edit'],

diff --git a/app/availableplugins/SqlConnector/templates/SqlProvisioners/fields.inc b/app/availableplugins/SqlConnector/templates/SqlProvisioners/fields.inc
@@ -32,8 +32,7 @@ $fields = [
   ]
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['ProvisioningTargets', 'SqlConnector.SqlProvisioners'],
   'action' => [
     'ProvisioningTargets' => ['edit'],

diff --git a/app/availableplugins/SqlConnector/templates/SqlSources/fields.inc b/app/availableplugins/SqlConnector/templates/SqlSources/fields.inc
@@ -52,8 +52,7 @@ $fields = array_merge($fields, [
   'threshold_override'
 ]);
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['ExternalIdentitySources', 'SqlConnector.SqlSources', 'ExternalIdentitySources@action.search'],
   'action' => [
     'ExternalIdentitySources' => ['edit', 'view', 'search'],

diff --git a/app/plugins/CoreApi/templates/MatchCallbacks/fields.inc b/app/plugins/CoreApi/templates/MatchCallbacks/fields.inc
@@ -38,8 +38,7 @@ $fields = [
   'server_id'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['Apis', 'CoreApi.MatchCallbacks'],
   'action' => [
     'Apis' => ['edit'],

diff --git a/app/plugins/CoreAssigner/templates/FormatAssigners/fields.inc b/app/plugins/CoreAssigner/templates/FormatAssigners/fields.inc
@@ -35,8 +35,7 @@ $fields = [
   'enable_transliteration'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['IdentifierAssignments', 'CoreAssigner.FormatAssigners'],
   'action' => [
     'IdentifierAssignments' => ['edit'],

diff --git a/app/plugins/CoreAssigner/templates/SqlAssigners/fields.inc b/app/plugins/CoreAssigner/templates/SqlAssigners/fields.inc
@@ -31,8 +31,7 @@ $fields = [
   'type_id'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['IdentifierAssignments', 'CoreAssigner.SqlAssigners'],
   'action' => [
     'IdentifierAssignments' => ['edit'],

diff --git a/app/plugins/CoreEnroller/templates/ApprovalCollectors/fields.inc b/app/plugins/CoreEnroller/templates/ApprovalCollectors/fields.inc
@@ -31,8 +31,7 @@ $fields = [
   'redirect_on_denial'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['EnrollmentFlowSteps', 'CoreEnroller.ApprovalCollectors'],
   'action' => [
     'EnrollmentFlowSteps' => ['edit', 'view'],

diff --git a/app/plugins/CoreEnroller/templates/AttributeCollectors/fields.inc b/app/plugins/CoreEnroller/templates/AttributeCollectors/fields.inc
@@ -45,8 +45,7 @@ $topLinks[] = [
   'class' => ''
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['EnrollmentFlowSteps', 'CoreEnroller.AttributeCollectors', 'EnrollmentFlowSteps.Hierarchy'],
   'action' => [
     'EnrollmentFlowSteps' => ['edit', 'view'],

diff --git a/app/plugins/CoreEnroller/templates/BasicAttributeCollectors/fields.inc b/app/plugins/CoreEnroller/templates/BasicAttributeCollectors/fields.inc
@@ -32,8 +32,7 @@ $fields = [
   'cou_id'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['EnrollmentFlowSteps', 'CoreEnroller.BasicAttributeCollectors'],
   'action' => [
     'EnrollmentFlowSteps' => ['edit', 'view'],

diff --git a/app/plugins/CoreEnroller/templates/EmailVerifiers/fields.inc b/app/plugins/CoreEnroller/templates/EmailVerifiers/fields.inc
@@ -118,8 +118,7 @@ $fields = [
   ]
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['EnrollmentFlowSteps', 'CoreEnroller.EmailVerifiers'],
   'action' => [
     'EnrollmentFlowSteps' => ['edit', 'view'],

diff --git a/app/plugins/CoreEnroller/templates/EnrollmentAttributes/columns.inc b/app/plugins/CoreEnroller/templates/EnrollmentAttributes/columns.inc
@@ -56,8 +56,7 @@ $indexColumns = [
   ]
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['EnrollmentFlowSteps', 'CoreEnroller.AttributeCollectors', 'EnrollmentFlowSteps.Hierarchy'],
   'action' => [
     'EnrollmentFlowSteps' => ['edit', 'view'],

diff --git a/app/plugins/CoreEnroller/templates/EnrollmentAttributes/fields.inc b/app/plugins/CoreEnroller/templates/EnrollmentAttributes/fields.inc
@@ -203,8 +203,7 @@ if (
   $fields[] = 'hidden';
 }
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['EnrollmentFlowSteps', 'CoreEnroller.AttributeCollectors', 'EnrollmentFlowSteps.Hierarchy'],
   'action' => [
     'EnrollmentFlowSteps' => ['edit', 'view'],

diff --git a/app/plugins/CoreEnroller/templates/IdentifierCollectors/fields.inc b/app/plugins/CoreEnroller/templates/IdentifierCollectors/fields.inc
@@ -29,8 +29,7 @@ $fields = [
   'type_id'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['EnrollmentFlowSteps', 'CoreEnroller.IdentifierCollectors'],
   'action' => [
     'EnrollmentFlowSteps' => ['edit', 'view'],

diff --git a/app/plugins/CoreEnroller/templates/InvitationAccepters/fields.inc b/app/plugins/CoreEnroller/templates/InvitationAccepters/fields.inc
@@ -32,8 +32,7 @@ $fields = [
   'welcome_message'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['EnrollmentFlowSteps', 'CoreEnroller.InvitationAccepters'],
   'action' => [
     'EnrollmentFlowSteps' => ['edit', 'view'],

diff --git a/app/plugins/CoreServer/templates/HttpServers/fields.inc b/app/plugins/CoreServer/templates/HttpServers/fields.inc
@@ -33,8 +33,7 @@ $fields = [
   'skip_ssl_verification'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['Servers', 'CoreServer.HttpServers'],
   'action' => [
     'Servers' => ['edit'],

diff --git a/app/plugins/CoreServer/templates/MatchServerAttributes/columns.inc b/app/plugins/CoreServer/templates/MatchServerAttributes/columns.inc
@@ -42,8 +42,7 @@ $indexColumns = [
   ]
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['Servers', 'CoreServer.MatchServers', 'CoreServer.MatchServerAttributes'],
   'action' => [
     'Servers' => ['edit'],

diff --git a/app/plugins/CoreServer/templates/MatchServerAttributes/fields.inc b/app/plugins/CoreServer/templates/MatchServerAttributes/fields.inc
@@ -47,8 +47,7 @@ foreach ([
 
 $fields[] = 'required';
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['Servers', 'CoreServer.MatchServers', 'CoreServer.MatchServerAttributes'],
   'action' => [
     'Servers' => ['edit'],

diff --git a/app/plugins/CoreServer/templates/MatchServers/fields.inc b/app/plugins/CoreServer/templates/MatchServers/fields.inc
@@ -46,8 +46,7 @@ if(!empty($vv_obj->url)) {
   ];
 }
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['Servers', 'CoreServer.MatchServers', 'CoreServer.MatchServerAttributes'],
   'action' => [
     'Servers' => ['edit'],

diff --git a/app/plugins/CoreServer/templates/Oauth2Servers/fields.inc b/app/plugins/CoreServer/templates/Oauth2Servers/fields.inc
@@ -64,8 +64,7 @@ $fields['access_token'] = [
   'labelIsTextOnly' => true
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['Servers', 'CoreServer.Oauth2Servers'],
   'action' => [
     'Servers' => ['edit'],

diff --git a/app/plugins/CoreServer/templates/SmtpServers/fields.inc b/app/plugins/CoreServer/templates/SmtpServers/fields.inc
@@ -40,8 +40,7 @@ $fields = [
   'override_to'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['Servers', 'CoreServer.SmtpServers'],
   'action' => [
     'Servers' => ['edit'],

diff --git a/app/plugins/CoreServer/templates/SqlServers/fields.inc b/app/plugins/CoreServer/templates/SqlServers/fields.inc
@@ -34,8 +34,7 @@ $fields = [
   'password'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['Servers', 'CoreServer.SqlServers'],
   'action' => [
     'Servers' => ['edit'],

diff --git a/app/plugins/EnvSource/templates/EnvSourceCollectors/fields.inc b/app/plugins/EnvSource/templates/EnvSourceCollectors/fields.inc
@@ -31,8 +31,7 @@ $fields = [
   ]
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['EnrollmentFlowSteps', 'EnvSource.EnvSourceCollectors'],
   'action' => [
     'EnrollmentFlowSteps' => ['edit', 'view'],

diff --git a/app/plugins/EnvSource/templates/EnvSources/fields.inc b/app/plugins/EnvSource/templates/EnvSources/fields.inc
@@ -74,8 +74,7 @@ foreach($defaultNames as $field => $envName) {
   ];
 }
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['ExternalIdentitySources', 'EnvSource.EnvSources', 'ExternalIdentitySources@action.search'],
   'action' => [
     'ExternalIdentitySources' => ['edit', 'view', 'search'],

diff --git a/app/plugins/OrcidSource/templates/OrcidSourceCollectors/fields.inc b/app/plugins/OrcidSource/templates/OrcidSourceCollectors/fields.inc
@@ -31,8 +31,7 @@ $fields = [
   ]
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['EnrollmentFlowSteps', 'OrcidSource.OrcidSourceCollectors'],
   'action' => [
     'EnrollmentFlowSteps' => ['edit', 'view'],

diff --git a/app/plugins/OrcidSource/templates/OrcidSources/fields.inc b/app/plugins/OrcidSource/templates/OrcidSources/fields.inc
@@ -68,8 +68,7 @@ $fields = [
   'name_type_id'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['ExternalIdentitySources', 'OrcidSource.OrcidSources', 'ExternalIdentitySources@action.search'],
   'action' => [
     'ExternalIdentitySources' => ['edit', 'view', 'search'],

diff --git a/app/plugins/SshKeyAuthenticator/templates/SshKeyAuthenticators/fields.inc b/app/plugins/SshKeyAuthenticator/templates/SshKeyAuthenticators/fields.inc
@@ -29,8 +29,7 @@ declare(strict_types = 1);
 
 $this->Field->disableFormEditMode();
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['Authenticators', 'SshKeyAuthenticator.SshKeyAuthenticators'],
   'action' => [
     'Authenticators' => ['edit'],

diff --git a/app/plugins/TermsAgreer/templates/AgreementCollectors/fields.inc b/app/plugins/TermsAgreer/templates/AgreementCollectors/fields.inc
@@ -29,8 +29,7 @@ $fields = [
   't_and_c_mode'
 ];
 
-$subnav = 'local';
-$subnavLocal = [
+$subnav = [
   'tabs' => ['EnrollmentFlowSteps', 'TermsAgreer.AgreementCollectors'],
   'action' => [
     'EnrollmentFlowSteps' => ['edit', 'view'],

diff --git a/app/templates/Servers/fields.inc b/app/templates/Servers/fields.inc
@@ -37,8 +37,7 @@ $fields = array_merge($fields, include(ROOT . DS . 'templates' . DS . 'Standard/
 
 // Match Servers have special subnavigation treatment (they have an extra tab for Match Server Attributes).
 if($vv_obj['plugin'] == 'CoreServer.MatchServers') {
-  $subnav = 'local';
-  $subnavLocal = [
+  $subnav = [
     'tabs' => ['Servers', 'Servers.Plugin', 'CoreServer.MatchServerAttributes'],
     'action' => [
       'Servers' => ['edit'],

diff --git a/app/templates/Standard/subnavigation.inc b/app/templates/Standard/subnavigation.inc
@@ -33,14 +33,16 @@ $modelsName = $this->getName();
 $tabsConfiguration = [];
 
 /**
- * Subnavigation is established by setting the $subnav array in fields.inc/columns.inc to a string that either
- * matches a named set from the $subnavConfig[] array below (e.g. $subnav = 'people')
- * or by setting $subnav = 'local' and then defining $subnavLocal = [the tab definition array].
- * For plugins, the tab definition will always be local in the plugin fields.inc config.
- *
+ * Subnavigation is established by setting a variable called $subnav in fields.inc/columns.inc  
+ * either to a string that matches a named set from the $subnavConfig[] array below
+ * or by setting $subnav = [a local tab definition array].
+ * 
+ * For core views, the tab definition will typically reference a named set below,
+ * e.g. $subnav = 'people', or $subnav = 'standard'.
+ * 
+ * For plugins, the tab definition will typically be local in the plugin fields.inc config.
  * For example (in app/availableplugins/PasswordAuthenticator/templates/PasswordAuthenticators/fields.inc):
- * $subnav = 'local';
- * $subnavLocal = [
+ * $subnav = [
  *   'tabs' => ['Authenticators', 'PasswordAuthenticator.PasswordAuthenticators'],
  *   'action' => [
  *     'Authenticators' => ['edit'],
@@ -53,11 +55,11 @@ $tabsConfiguration = [];
  */
 
 // Subnavigation configuration definitions for common subnavigation sets.
-// These are here to avoid duplicate configuration.
+// These are here to avoid duplicate configurations when handling core views.
 $subnavConfig = [
   // STANDARD: for any object that has a simple two-tab set of "PROPERTIES" and "PLUGIN CONFIGURATION".
   // Use $subnav = 'standard' for the properties tab; each plugin tab definition will live in the 
-  // plugin fields.inc config as $subnav = 'local' and $subnavLocal = [the tab definition array]
+  // plugin fields.inc config as $subnav = [the tab definition array]
   // as described above.
   'standard' => [
     'tabs' => [$modelsName, $modelsName . '.Plugin'],
@@ -153,11 +155,10 @@ $subnavConfig = [
 ];
 
 // Do not render subnavigation if $subnav is empty or if we have no configuration array. 
-if(!empty($subnav) && (!empty($subnavConfig[$subnav]) || !empty($subnavLocal))) {
-  if(!empty($subnavLocal)) {
-    // We are rendering tabs for a plugin configuration view.
-    // The tabs configuraton is defined as $subnavLocal in the plugin's fields.inc file.
-    $tabsConfiguration = $subnavLocal;
+if(!empty($subnav) && (is_array($subnav) || (is_string($subnav) && !empty($subnavConfig[$subnav])))) {
+  if(is_array($subnav)) {
+    // We are rendering a locally configured tabs configuration set in fields.inc or columns.inc.
+    $tabsConfiguration = $subnav;
   } else {
     // We are rendering a standard set of tabs as defined in $subnavConfig above.
     $tabsConfiguration = $subnavConfig[$subnav];