CustomField - Support filters in EntityReference fields on all forms

This ensures filters are applied on both quickforms and afforms when defined for a custom field. Note: There is still no UI for adding these filters to a custom field, but they can be set via api explorer.
civicrm · Mar 30, 2023 · c39aded · c39aded
1 parent 3e87784
commit c39aded
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 12 deletions.
diff --git a/Civi/Api4/Event/Subscriber/AutocompleteFieldSubscriber.php b/Civi/Api4/Event/Subscriber/AutocompleteFieldSubscriber.php
@@ -54,9 +54,15 @@ public function onApiPrepare(\Civi\API\Event\PrepareEvent $event): void {
         return;
       }
       try {
+        $where = ['name', '=', $fieldName];
+        // Legacy support for QuickForm custom field format (`custom_xx`)
+        if (strpos($fieldName, 'custom_') === 0 && strlen($fieldName) > 7 && is_numeric($fieldName[7])) {
+          [, $customId] = explode('_', $fieldName);
+          $where = ['custom_field_id', '=', $customId];
+        }
         $fieldSpec = civicrm_api4($entityName, 'getFields', [
           'checkPermissions' => FALSE,
-          'where' => [['name', '=', $fieldName]],
+          'where' => [$where],
         ])->single();
 
         // Auto-add filters defined in schema

diff --git a/tests/phpunit/api/v4/Action/AutocompleteTest.php b/tests/phpunit/api/v4/Action/AutocompleteTest.php
@@ -25,7 +25,6 @@
 use Civi\Api4\MockBasicEntity;
 use Civi\Api4\SavedSearch;
 use Civi\Core\Event\GenericHookEvent;
-use Civi\Test\CiviEnvBuilder;
 use Civi\Test\HookInterface;
 use Civi\Test\TransactionalInterface;
 
@@ -55,11 +54,6 @@ public function on_civi_api_prepare(\Civi\API\Event\PrepareEvent $event) {
     }
   }
 
-  public function setUpHeadless(): CiviEnvBuilder {
-    // TODO: search_kit should probably be part of the 'headless()' baseline.
-    return \Civi\Test::headless()->install(['org.civicrm.search_kit'])->apply();
-  }
-
   public function setUp(): void {
     $this->hookCallback = NULL;
     // Ensure MockBasicEntity gets added via above listener

diff --git a/tests/phpunit/api/v4/Api4TestBase.php b/tests/phpunit/api/v4/Api4TestBase.php
@@ -46,7 +46,8 @@ public function __construct($name = NULL, array $data = [], $dataName = '') {
   }
 
   public function setUpHeadless(): CiviEnvBuilder {
-    return Test::headless()->apply();
+    // TODO: search_kit should probably be part of the 'headless()' baseline.
+    return Test::headless()->install(['org.civicrm.search_kit'])->apply();
   }
 
   /**

diff --git a/tests/phpunit/api/v4/Custom/CustomEntityReferenceTest.php b/tests/phpunit/api/v4/Custom/CustomEntityReferenceTest.php
@@ -17,6 +17,7 @@
 
 namespace api\v4\Custom;
 
+use Civi\Api4\Activity;
 use Civi\Api4\Contact;
 use Civi\Api4\CustomGroup;
 use Civi\Api4\CustomField;
@@ -27,26 +28,52 @@
 class CustomEntityReferenceTest extends CustomTestBase {
 
   /**
-   * Ensure custom fields of type EntityReference show up correctly in getFields metadata.
+   * Ensure custom fields of type EntityReference correctly apply filters
    */
   public function testEntityReferenceCustomField() {
+    $subject = uniqid();
     CustomGroup::create()->setValues([
       'title' => 'EntityRefFields',
       'extends' => 'Individual',
     ])->execute();
-    CustomField::create()->setValues([
+    $field = CustomField::create()->setValues([
       'label' => 'TestActivityReference',
       'custom_group_id.name' => 'EntityRefFields',
       'html_type' => 'Autocomplete-Select',
       'data_type' => 'EntityReference',
       'fk_entity' => 'Activity',
-    ])->execute();
+      'filter' => "subject=$subject",
+    ])->execute()->single();
+    // Check metadata
     $spec = Contact::getFields(FALSE)
       ->addWhere('name', '=', 'EntityRefFields.TestActivityReference')
       ->execute()->single();
     $this->assertNull($spec['suffixes']);
     $this->assertEquals('EntityRef', $spec['input_type']);
     $this->assertEquals('Activity', $spec['fk_entity']);
+    $this->assertEquals($subject, $spec['input_attrs']['filter']['subject']);
+    // Check results
+    $activities = $this->saveTestRecords('Activity', [
+      'records' => [
+        ['subject' => $subject],
+        ['subject' => 'wrong one'],
+        ['subject' => $subject],
+      ],
+    ]);
+    // Filter using APIv4-style name
+    $result = Activity::autocomplete(FALSE)
+      ->setFieldName("Contact.EntityRefFields.TestActivityReference")
+      ->execute();
+    $this->assertCount(2, $result);
+    // No filter
+    $result = Activity::autocomplete(FALSE)
+      ->execute();
+    $this->assertGreaterThan(2, $result->countFetched());
+    // Filter using Quickform-style name
+    $result = Activity::autocomplete(FALSE)
+      ->setFieldName("Contact.custom_{$field['id']}")
+      ->execute();
+    $this->assertCount(2, $result);
   }
 
 }
diff --git a/tests/phpunit/api/v4/Entity/ConformanceTest.php b/tests/phpunit/api/v4/Entity/ConformanceTest.php
@@ -102,7 +102,8 @@ public function getEntitiesHitech(): array {
    * @return array
    */
   public function getEntitiesLotech(): array {
-    $manual['add'] = [];
+    // TODO: Auto-scan required core extensions like search_kit
+    $manual['add'] = ['SearchDisplay', 'SearchSegment'];
     $manual['remove'] = ['CustomValue'];
     $manual['transform'] = ['CiviCase' => 'Case'];