APIv4 - Add autocomplete action to CustomValue

diff --git a/Civi/Api4/CustomValue.php b/Civi/Api4/CustomValue.php
index 4201d3397afd7c7a0840a1e76ba8f32ec8db1082..1b99edc821700e4a9402a10c842c80ed12fd028d 100644 (file)
--- a/Civi/Api4/CustomValue.php
+++ b/Civi/Api4/CustomValue.php
@@ -26,6 +26,17 @@ namespace Civi\Api4;
  */
 class CustomValue {
 
+  /**
+   * @param string $customGroup
+   * @param bool $checkPermissions
+   * @return \Civi\Api4\Generic\AutocompleteAction
+   * @throws \API_Exception
+   */
+  public static function autocomplete(string $customGroup, $checkPermissions = TRUE) {
+    return (new \Civi\Api4\Generic\AutocompleteAction("Custom_$customGroup", __FUNCTION__))
+      ->setCheckPermissions($checkPermissions);
+  }
+
   /**
    * @param string $customGroup
    * @param bool $checkPermissions

diff --git a/Civi/Api4/Service/Autocomplete/CustomValueAutocompleteProvider.php b/Civi/Api4/Service/Autocomplete/CustomValueAutocompleteProvider.php
new file mode 100644 (file)
index 0000000..a799696
--- /dev/null
+++ b/Civi/Api4/Service/Autocomplete/CustomValueAutocompleteProvider.php
@@ -0,0 +1,76 @@
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+namespace Civi\Api4\Service\Autocomplete;
+
+use Civi\Api4\Utils\CoreUtil;
+use Civi\Core\Event\GenericHookEvent;
+use Civi\Core\HookInterface;
+
+/**
+ * @service
+ * @internal
+ */
+class CustomValueAutocompleteProvider extends \Civi\Core\Service\AutoService implements HookInterface {
+
+  /**
+   * Provide default SearchDisplay for autocompletes of multi-record custom values
+   *
+   * @param \Civi\Core\Event\GenericHookEvent $e
+   */
+  public static function on_civi_search_defaultDisplay(GenericHookEvent $e) {
+    if ($e->display['settings'] || $e->display['type'] !== 'autocomplete' || !str_starts_with($e->savedSearch['api_entity'], 'Custom_')) {
+      return;
+    }
+    $customGroupName = explode('_', $e->savedSearch['api_entity'], 2)[1];
+
+    // Custom groups could contain any fields & we have no idea what's in them
+    // but this is just the default display and can be overridden.
+    // Our best guess for a "title" is the first text field in the group
+    $titleField = \Civi\Api4\CustomValue::getFields('Multi_Stuff', FALSE)
+      ->addWhere('data_type', '=', 'String')
+      ->addWhere('input_type', '=', 'Text')
+      ->execute()->first()['name'] ?? NULL;
+
+    // Include search label of parent entity (e.g. `entity_id.sort_name` for Contact custom groups)
+    $customGroupExtends = \CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $customGroupName, 'extends', 'name');
+    $extendsLabelField = CoreUtil::getInfoItem($customGroupExtends, 'search_fields')[0] ?? NULL;
+
+    if (!$extendsLabelField && !$titleField) {
+      // Got nothing, fall back to the default which displays id only.
+      return;
+    }
+
+    $mainColumn = [
+      'type' => 'field',
+      'key' => $titleField ?? "entity_id.$extendsLabelField",
+    ];
+    if ($titleField && $extendsLabelField) {
+      $mainColumn['rewrite'] = "[entity_id.$extendsLabelField] - [$titleField]";
+    }
+
+    $e->display['settings'] = [
+      'sort' => [
+        [$mainColumn['key'], 'ASC'],
+      ],
+      'columns' => [
+        $mainColumn,
+        [
+          'type' => 'field',
+          'key' => 'id',
+          'rewrite' => '#[id]',
+        ],
+      ],
+    ];
+  }
+
+}

diff --git a/Civi/Api4/Service/Autocomplete/EntityAutocompleteProvider.php b/Civi/Api4/Service/Autocomplete/EntityAutocompleteProvider.php
index 652cb4c2a0be86ce79e2679da38bfa6e5cd02bfd..943cdad2b1cbd100ad411421a5b05b15a360ffa4 100644 (file)
--- a/Civi/Api4/Service/Autocomplete/EntityAutocompleteProvider.php
+++ b/Civi/Api4/Service/Autocomplete/EntityAutocompleteProvider.php
@@ -22,7 +22,7 @@ use Civi\Core\HookInterface;
 class EntityAutocompleteProvider extends \Civi\Core\Service\AutoService implements HookInterface {
 
   /**
-   * Provide default SearchDisplay for ContactType autocompletes
+   * Provide default SearchDisplay for autocompletes of API Entity names
    *
    * @param \Civi\Core\Event\GenericHookEvent $e
    */