Afform - Use entity-specific filter key, revert entity_id generic key

CRM/Utils/Array.php

@@ -1421,7 +1421,7 @@ public static function formatForSelect2(array $options, string $label = 'label',
       if (!empty($option['children'])) {
         $option['children'] = self::formatForSelect2($option['children'], $label, $id);
       }
-      $option = array_intersect_key($option, array_flip(['id', 'text', 'children', 'color', 'icon', 'description', 'grouping']));
+      $option = array_intersect_key($option, array_flip(['id', 'text', 'children', 'color', 'icon', 'description', 'grouping', 'filter']));
     }
     return $options;
   }

ang/afform/afsearchTabNote.aff.html

@@ -1,3 +1,3 @@
 <div af-fieldset="">
-  <crm-search-display-table search-name="Contact_Summary_Notes" display-name="Contact_Summary_Notes_Tab" filters="{entity_id: options.entity_id, entity_table: 'civicrm_contact'}"></crm-search-display-table>
+  <crm-search-display-table search-name="Contact_Summary_Notes" display-name="Contact_Summary_Notes_Tab" filters="{entity_id: options.contact_id, entity_table: 'civicrm_contact'}"></crm-search-display-table>
 </div>

ang/afform/afsearchTabRel.aff.html

@@ -1,8 +1,8 @@
 <div af-fieldset="">
-  <crm-search-display-table search-name="Contact_Summary_Relationships" display-name="Contact_Summary_Relationships_Active" filters="{near_contact_id: options.entity_id, is_current: true}"></crm-search-display-table>
+  <crm-search-display-table search-name="Contact_Summary_Relationships" display-name="Contact_Summary_Relationships_Active" filters="{near_contact_id: options.contact_id, is_current: true}"></crm-search-display-table>
   <h3>{{:: ts('Inactive Relationships') }}</h3>
   <div class="help">{{:: ts('These relationships are Disabled OR have a past End Date.') }}</div>
-  <crm-search-display-table search-name="Contact_Summary_Relationships" display-name="Contact_Summary_Relationships_Inactive" filters="{near_contact_id: options.entity_id, is_current: false}"></crm-search-display-table>
+  <crm-search-display-table search-name="Contact_Summary_Relationships" display-name="Contact_Summary_Relationships_Inactive" filters="{near_contact_id: options.contact_id, is_current: false}"></crm-search-display-table>
   <div class="help">
     <strong>{{:: ts('Permissioned Relationships:') }}</strong>
     <i class="crm-i fa-eye"></i> {{:: ts('This contact can be viewed by the other.') }}

ext/afform/admin/Civi/AfformAdmin/AfformAdminMeta.php

@@ -14,7 +14,7 @@ class AfformAdminMeta {
    */
   public static function getAdminSettings() {
     $afformPlacement = \CRM_Utils_Array::formatForSelect2((array) \Civi\Api4\OptionValue::get(FALSE)
-      ->addSelect('value', 'label', 'icon', 'description', 'grouping')
+      ->addSelect('value', 'label', 'icon', 'description', 'grouping', 'filter')
       ->addWhere('is_active', '=', TRUE)
       ->addWhere('option_group_id:name', '=', 'afform_placement')
       ->addOrderBy('weight')

ext/afform/admin/ang/afGuiEditor/afGuiEditor.component.js

@@ -362,7 +362,7 @@
         let requiresServerRoute = false;
         editor.afform.placement.forEach(function(placement) {
           const item = editor.meta.afform_placement.find(item => item.id === placement);
-          if (item && item.grouping === 'server_route') {
+          if (item && item.filter) {
             requiresServerRoute = item.text;
           }
         });

ext/afform/admin/ang/afGuiEditor/afGuiSearch.html

@@ -19,7 +19,7 @@
               <a href ng-click="filter.mode = 'val'; filter.value = ''">{{:: ts('Fixed value') }}</a>
             </li>
             <li ng-if="$ctrl.editor.isContactSummary()">
-              <a href ng-click="filter.mode = 'options'; filter.value = 'entity_id';">{{:: ts('Contact being Viewed') }}</a>
+              <a href ng-click="filter.mode = 'options'; filter.value = 'contact_id';">{{:: ts('Contact being Viewed') }}</a>
             </li>
           </ul>
         </div>

ext/afform/core/Civi/Afform/Behavior/ContactAutofill.php

@@ -119,7 +119,7 @@ public static function onAfformPrefill(AfformPrefillEvent $event): void {
       }
       // Autofill with current entity (e.g. on the contact summary screen)
       if (!$id && $autoFillMode === 'entity_id' && $apiRequest->getFillMode() === 'form') {
-        $id = $apiRequest->getArgs()['entity_id'] ?? NULL;
+        $id = $apiRequest->getArgs()['contact_id'] ?? NULL;
         if ($id) {
           $apiRequest->loadEntity($entity, [['id' => $id]]);
         }

ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php

@@ -286,10 +286,14 @@ private function generateTabForm($item): array {
       'title' => $item['title'],
       'icon' => $item['icon'],
     ];
+    $entityIdFilter = \CRM_Utils_String::convertStringToSnakeCase($item['extends']) . '_id';
+    // Place in Contact Summary Tabs
     if ($item['extends'] === 'Contact') {
       $afform['placement'] = ['contact_summary_tab'];
     }
     elseif (CoreUtil::isContact($item['extends'])) {
+      // override e.g. "individual_id", we want "contact_id"
+      $entityIdFilter = 'contact_id';
       $afform['placement'] = ['contact_summary_tab'];
       $afform['summary_contact_type'] = [$item['extends']];
     }
@@ -308,6 +312,8 @@ private function generateTabForm($item): array {
           'saved_search' => 'Custom_' . $item['name'] . '_Search',
           'display_type' => 'table',
           'search_display' => 'Custom_' . $item['name'] . '_Tab',
+          // 'contact_id', 'event_id', etc.
+          'entity_id_filter' => $entityIdFilter,
         ]
       );
     }

ext/afform/core/afform.php

@@ -201,9 +201,7 @@ function afform_civicrm_tabset($tabsetName, &$tabs, $context) {
       // If this is the real contact summary page (and not a callback from ContactLayoutEditor), load module
       // and assign contact id to required smarty variable
       if (empty($context['caller'])) {
-        // Preferred key is entity_id but also assign contact_id to maintain backwards compatibility with older afforms
         CRM_Core_Smarty::singleton()->assign('afformOptions', [
-          'entity_id' => $context['contact_id'],
           'contact_id' => $context['contact_id'],
         ]);
         Civi::service('angularjs.loader')->addModules($afform['module_name']);
@@ -244,7 +242,7 @@ function afform_civicrm_summaryActions(&$actions, $contactID) {
         'weight' => $afform['summary_weight'] ?? 0,
         'icon' => 'crm-i ' . ($afform['icon'] ?: 'fa-list-alt'),
         'class' => 'crm-popup',
-        'href' => CRM_Utils_System::url($afform['server_route'], '', FALSE, "?entity_id=$contactID"),
+        'href' => CRM_Utils_System::url($afform['server_route'], '', FALSE, "?contact_id=$contactID"),
       ];
     }
   }
@@ -269,9 +267,7 @@ function afform_civicrm_pageRun(&$page) {
   $contact = NULL;
   $side = 'left';
   $weight = ['left' => 1, 'right' => 1];
-  // Preferred key is entity_id but also assign contact_id to maintain backwards compatibility with older afforms
   $afformOptions = [
-    'entity_id' => $cid,
     'contact_id' => $cid,
   ];
   foreach ($afforms as $afform) {

ext/afform/core/managed/AfformPlacement.mgd.php

@@ -102,7 +102,7 @@
         'is_active' => TRUE,
         'icon' => 'fa-bars',
         // Indicates that a server_route is required for this placement
-        'grouping' => 'server_route',
+        'filter' => 1,
         'description' => E::ts('Add to the contact summary actions menu.'),
       ],
       'match' => ['option_group_id', 'name'],

ext/afform/core/templates/afform/customGroups/afsearchTab.tpl

@@ -2,6 +2,6 @@
   <crm-search-display-{$display_type}
     search-name="{$saved_search}"
     display-name="{$search_display}"
-    filters="{ldelim}entity_id: options.entity_id{rdelim}"
+    filters="{ldelim}entity_id: options.{$entity_id_filter}{rdelim}"
     />
 </div>

ext/afform/core/tests/phpunit/Civi/Afform/AfformContactSummaryTest.php

@@ -151,12 +151,10 @@ public function testAfformContactSummaryBlock(): void {
     $blockA = \CRM_Core_Region::instance('contact-basic-info-left')->get('afform:' . $this->formNames[2]);
     $this->assertStringContainsString("<af-search-tab-test2 options=", $blockA['markup']);
     $this->assertStringContainsString("\"contact_id\":$cid", $blockA['markup']);
-    $this->assertStringContainsString("\"entity_id\":$cid", $blockA['markup']);
 
     $blockB = \CRM_Core_Region::instance('contact-basic-info-right')->get('afform:' . $this->formNames[1]);
     $this->assertStringContainsString("<af-form-tab-test1 options=", $blockB['markup']);
     $this->assertStringContainsString("\"contact_id\":$cid", $blockB['markup']);
-    $this->assertStringContainsString("\"entity_id\":$cid", $blockB['markup']);
 
     // Block for wrong contact type should not appear
     $this->assertNull(\CRM_Core_Region::instance('contact-basic-info-left')->get('afform:' . $this->formNames[0]));

ext/civicrm_admin_ui/ang/afformTabMember.aff.html

@@ -1,11 +1,11 @@
 <div af-fieldset="">
-  <crm-search-display-table search-name="Contact_Summary_Memberships" display-name="Contact_Summary_Memberships_Active" filters="{contact_id: options.entity_id, 'status_id.is_current_member': true}"></crm-search-display-table>
+  <crm-search-display-table search-name="Contact_Summary_Memberships" display-name="Contact_Summary_Memberships_Active" filters="{contact_id: options.contact_id, 'status_id.is_current_member': true}"></crm-search-display-table>
   <h3>{{:: ts('Pending and Inactive Memberships') }}</h3>
-  <crm-search-display-table search-name="Contact_Summary_Memberships" display-name="Contact_Summary_Memberships_Inactive" filters="{contact_id: options.entity_id, 'status_id.is_current_member': false}"></crm-search-display-table>
+  <crm-search-display-table search-name="Contact_Summary_Memberships" display-name="Contact_Summary_Memberships_Inactive" filters="{contact_id: options.contact_id, 'status_id.is_current_member': false}"></crm-search-display-table>
 </div>
 <div class="af-markup">
   <hr />
 </div>
 <div af-fieldset="" af-title="Membership Types">
-  <crm-search-display-table search-name="Contact_Summary_Membership_Type" display-name="Contact_Summary_Membership_Type" filters="{member_of_contact_id: options.entity_id, 'is_active': true}"></crm-search-display-table>
+  <crm-search-display-table search-name="Contact_Summary_Membership_Type" display-name="Contact_Summary_Membership_Type" filters="{member_of_contact_id: options.contact_id, 'is_active': true}"></crm-search-display-table>
 </div>

ext/civicrm_admin_ui/ang/afsearchTabActivity.aff.html

@@ -5,5 +5,5 @@
     <af-field name="status_id" defn="{input_attrs: {multiple: true, placeholder: ts('Status')}, label: false}" />
     <af-field name="activity_date_time" defn="{input_type: 'Select', search_range: true, input_attrs: {placeholder: ts('Date')}, label: false}" />
   </div>
-  <crm-search-display-table search-name="Contact_Summary_Activities" display-name="Contact_Summary_Activities_Tab" filters="{'Activity_ActivityContact_Contact_01.id': options.entity_id}"></crm-search-display-table>
+  <crm-search-display-table search-name="Contact_Summary_Activities" display-name="Contact_Summary_Activities_Tab" filters="{'Activity_ActivityContact_Contact_01.id': options.contact_id}"></crm-search-display-table>
 </div>

ext/civicrm_admin_ui/ang/afsearchTabMember.aff.html

@@ -1,5 +1,5 @@
 <div af-fieldset="">
-  <crm-search-display-table search-name="Contact_Summary_Memberships" display-name="Contact_Summary_Memberships_Active" filters="{contact_id: options.entity_id, 'status_id.is_current_member': true}"></crm-search-display-table>
+  <crm-search-display-table search-name="Contact_Summary_Memberships" display-name="Contact_Summary_Memberships_Active" filters="{contact_id: options.contact_id, 'status_id.is_current_member': true}"></crm-search-display-table>
   <h3>{{:: ts('Pending and Inactive Memberships') }}</h3>
-  <crm-search-display-table search-name="Contact_Summary_Memberships" display-name="Contact_Summary_Memberships_Inactive" filters="{contact_id: options.entity_id, 'status_id.is_current_member': false}"></crm-search-display-table>
+  <crm-search-display-table search-name="Contact_Summary_Memberships" display-name="Contact_Summary_Memberships_Inactive" filters="{contact_id: options.contact_id, 'status_id.is_current_member': false}"></crm-search-display-table>
 </div>

ext/civicrm_admin_ui/ang/afsearchTabParticipant.aff.html

@@ -1,3 +1,3 @@
 <div af-fieldset="">
-  <crm-search-display-table search-name="Contact_Summary_Events" display-name="Contact_Summary_Events_Tab" filters="{contact_id: options.entity_id}"></crm-search-display-table>
+  <crm-search-display-table search-name="Contact_Summary_Events" display-name="Contact_Summary_Events_Tab" filters="{contact_id: options.contact_id}"></crm-search-display-table>
 </div>

ext/civicrm_admin_ui/civicrm_admin_ui.php

@@ -88,7 +88,7 @@ function civicrm_admin_ui_civicrm_tabset($tabsetName, &$tabs, $context) {
     case 'civicrm/event/manage':
       $entities = ['Event'];
       \CRM_Core_Smarty::singleton()->assign('afformOptions', [
-        'entity_id' => $context['event_id'] ?? NULL,
+        'event_id' => $context['event_id'] ?? NULL,
       ]);
       break;
 

ext/civigrant/ang/afsearchTabGrant.aff.html

@@ -1,3 +1,3 @@
 <div af-fieldset="">
-  <crm-search-display-table search-name="CiviGrant_Summary" display-name="Grant_Tab" filters="{'contact_id': options.entity_id}"></crm-search-display-table>
+  <crm-search-display-table search-name="CiviGrant_Summary" display-name="Grant_Tab" filters="{'contact_id': options.contact_id}"></crm-search-display-table>
 </div>