From: colemanw <coleman@civicrm.org>
Date: Mon, 13 Nov 2023 19:43:40 +0000 (-0500)
Subject: dev/core#4759 - Respect Autocomplete Contact Search preferences in menubar quicksearch
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=c0aa8bd01f353a6a1e7b3862cdf58feb0d21596c;p=civicrm-core.git

dev/core#4759 - Respect Autocomplete Contact Search preferences in menubar quicksearch
---

diff --git a/Civi/Api4/Service/Autocomplete/ContactAutocompleteProvider.php b/Civi/Api4/Service/Autocomplete/ContactAutocompleteProvider.php
index 27440a7824..c031c25821 100644
--- a/Civi/Api4/Service/Autocomplete/ContactAutocompleteProvider.php
+++ b/Civi/Api4/Service/Autocomplete/ContactAutocompleteProvider.php
@@ -13,6 +13,7 @@
 namespace Civi\Api4\Service\Autocomplete;
 
 use Civi\API\Event\PrepareEvent;
+use Civi\Api4\Setting;
 use Civi\Api4\Utils\CoreUtil;
 use Civi\Core\Event\GenericHookEvent;
 use Civi\Core\HookInterface;
@@ -78,22 +79,48 @@ class ContactAutocompleteProvider extends \Civi\Core\Service\AutoService impleme
     // as the menubar autocomplete does not support descriptions
     if (($e->context['formName'] ?? NULL) === 'crmMenubar' && ($e->context['fieldName'] ?? NULL) === 'crm-qsearch-input') {
       $column = ['type' => 'field'];
-      // If doing a search by a field other than the default
+      // Map contact_autocomplete_options settings to v4 format
+      $autocompleteOptionsMap = [
+        2 => 'email_primary.email',
+        3 => 'phone_primary.phone',
+        4 => 'address_primary.street_address',
+        5 => 'address_primary.city',
+        6 => 'address_primary.state_province_id:abbr',
+        7 => 'address_primary.country_id:label',
+        8 => 'address_primary.postal_code',
+      ];
+      // If doing a search by a field other than the default,
+      // add that field to the main column
       if (!empty($e->context['filters'])) {
         $filterField = array_keys($e->context['filters'])[0];
       }
       elseif (\Civi::settings()->get('includeEmailInName')) {
         $filterField = 'email_primary.email';
       }
-      if ($filterField) {
+      // Search on name + filter/email
+      if (!empty($filterField)) {
         $column['key'] = $filterField;
         $column['rewrite'] = "[sort_name] :: [$filterField]";
         $column['empty_value'] = '[sort_name]';
+        $autocompleteOptionsMap = array_diff($autocompleteOptionsMap, [$filterField]);
       }
+      // No filter & email search disabled: search on name only
       else {
         $column['key'] = 'sort_name';
       }
       $e->display['settings']['columns'] = [$column];
+      // Add exta columns based on search preferences
+      $autocompleteOptions = Setting::get(FALSE)
+        ->addSelect('contact_autocomplete_options')->execute()
+        ->first();
+      foreach ($autocompleteOptions['value'] ?? [] as $option) {
+        if (isset($autocompleteOptionsMap[$option])) {
+          $e->display['settings']['columns'][] = [
+            'type' => 'field',
+            'key' => $autocompleteOptionsMap[$option],
+          ];
+        }
+      }
     }
   }
 
diff --git a/js/crm.menubar.js b/js/crm.menubar.js
index d5e98fd532..9da2de77cc 100644
--- a/js/crm.menubar.js
+++ b/js/crm.menubar.js
@@ -297,12 +297,16 @@
             } else {
               params.filters[option.val()] = request.term;
             }
+            // Specialized Autocomplete SearchDisplay: @see ContactAutocompleteProvider
             CRM.api4('Contact', 'autocomplete', params).then(function(result) {
               var ret = [];
               if (result.length > 0) {
                 $('#crm-qsearch-input').autocomplete('widget').menu('option', 'disabled', false);
                 $.each(result, function(key, item) {
-                  ret.push({value: item.id, label: item.label});
+                  // Add extra items from the description (see contact_autocomplete_options setting)
+                  let description = (item.description || []).filter((v) => v);
+                  let extra = description.length ? ' :: ' + description.join(' :: ') : '';
+                  ret.push({value: item.id, label: item.label + extra});
                 });
               } else {
                 $('#crm-qsearch-input').autocomplete('widget').menu('option', 'disabled', true);