Merge pull request civicrm#33377 from lemniscus/write-custom-defaults-on-create

APIv4 - Ensure custom field default values are respected on new records

Author: totten

Civi/Api4/Generic/Traits/DAOActionTrait.php

@@ -12,6 +12,7 @@
 
 namespace Civi\Api4\Generic\Traits;
 
+use Civi\Api4\Service\Spec\RequestSpec;
 use Civi\Api4\Utils\FormattingUtil;
 use Civi\Api4\Utils\CoreUtil;
 use Civi\Api4\Utils\ReflectionUtils;
@@ -160,6 +161,9 @@ protected function writeObjects($items) {
         $entityId = FormattingUtil::resolveContactID($idField, $entityId);
       }
       FormattingUtil::formatWriteParams($item, $this->entityFields());
+      if (!$entityId) {
+        self::ensureCustomFieldDefaultsAreWrittenOnCreate($item);
+      }
       $this->formatCustomParams($item, $entityId);
 
       if (!$entityId) {
@@ -281,6 +285,29 @@ protected function resolveFKValues(array &$record): void {
     }
   }
 
+  protected function ensureCustomFieldDefaultsAreWrittenOnCreate(array &$record): void {
+    $specFilters = $record;
+    // The following lines are adapted from \CRM_Custom_Form_CustomDataTrait::addCustomDataFieldsToForm
+    // Reuse the same spec-gatherer from Api4.getFields
+    $spec = new RequestSpec($this->getEntityName(), 'create', $specFilters);
+    $fieldFilters = \Civi::service('spec_gatherer')->getCustomGroupFilters($spec);
+    if ($fieldFilters === NULL) {
+      return;
+    }
+    $customGroups = \CRM_Core_BAO_CustomGroup::getAll($fieldFilters);
+
+    foreach ($customGroups as $customGroup) {
+      foreach ($customGroup['fields'] as $field) {
+        $fieldName = "{$customGroup['name']}.{$field['name']}";
+        if (isset($field['default_value']) && !isset($record[$fieldName])) {
+          $record[$fieldName] = $field['default_value'];
+          // Setting the value for one field in the group will ensure that all get written
+          break;
+        }
+      }
+    }
+  }
+
   /**
    * Converts params from flat array e.g. ['GroupName.Fieldname' => value] to the
    * hierarchy expected by the BAO, nested within $params['custom'].

tests/phpunit/api/v4/Custom/CreateCustomValueTest.php

@@ -23,6 +23,7 @@
 use Civi\Api4\Contact;
 use Civi\Api4\CustomField;
 use Civi\Api4\CustomValue;
+use Civi\Api4\IM;
 use Civi\Api4\OptionGroup;
 use Civi\Api4\OptionValue;
 use Civi\Api4\Activity;
@@ -182,4 +183,84 @@ public function testEmptyValueArrayForCustomFields(): void {
       ->execute();
   }
 
+  public function testCustomFieldDefaultsGetWrittenOnCreate(): void {
+    $contactID = $this->createTestRecord('Contact')['id'];
+    $this->createTestRecord('CustomGroup', [
+      'title' => 'IMCustom',
+      'extends' => 'IM',
+    ]);
+
+    // Set up custom field with default static string value
+    $optionValues = ['defaultval' => 'Default', 'otherval' => 'Other'];
+    $customSelectFieldDefault = 'defaultval';
+    CustomField::create(FALSE)
+      ->addValue('custom_group_id:name', 'IMCustom')
+      ->addValue('label', 'Select Field')
+      ->addValue('name', 'im_select_field')
+      ->addValue('data_type', 'String')
+      ->addValue('html_type', 'Select')
+      ->addValue('option_values', $optionValues)
+      ->addValue('default_value', $customSelectFieldDefault)
+      ->execute();
+
+    // Set up custom field with default static boolean value
+    $customBoolFieldDefault = FALSE;
+    CustomField::create(FALSE)
+      ->addValue('custom_group_id:name', 'IMCustom')
+      ->addValue('label', 'Yes/No Field')
+      ->addValue('name', 'im_boolean_field')
+      ->addValue('data_type', 'Boolean')
+      ->addValue('html_type', 'Radio')
+      ->addValue('default_value', $customBoolFieldDefault)
+      ->execute();
+
+    // Set up custom field with string value generated by callback
+    CustomField::create(FALSE)
+      ->addValue('custom_group_id:name', 'IMCustom')
+      ->addValue('label', 'Value from Callback')
+      ->addValue('name', 'im_callback_field')
+      ->addValue('data_type', 'String')
+      ->addValue('html_type', 'Text')
+      ->addValue('default_callback', ['CRM_Utils_System', 'version'])
+      ->execute();
+
+    // Core fields can have default values too, of course
+    $coreFieldDefault = IM::getFields(TRUE)
+      ->addWhere('name', '=', 'is_billing')
+      ->addSelect('default_value')
+      ->execute()->single()['default_value'];
+
+    // Test: No custom field values given to Create action
+    $result = IM::create()
+      ->addValue('contact_id', $contactID)
+      ->addValue('location_type_id:name', 'Home')
+      ->addChain('created_im', \Civi\Api4\IM::get()
+        ->addSelect('is_billing', 'custom.*')
+        ->addWhere('id', '=', '$id')
+      )
+      ->execute()->single()['created_im'][0];
+
+    self::assertEquals($coreFieldDefault, $result['is_billing']);
+    self::assertEquals($customSelectFieldDefault, $result['IMCustom.im_select_field']);
+    self::assertEquals($customBoolFieldDefault, $result['IMCustom.im_boolean_field']);
+    // Apparently 'default_callback' is not supported for custom fields?
+    // self::assertEquals(\CRM_Utils_System::version(), $result['IMCustom.im_callback_field']);
+
+    // Test: One custom field value given to Create action, the other left blank
+    $result = IM::create()
+      ->addValue('contact_id', $contactID)
+      ->addValue('location_type_id:name', 'Home')
+      ->addValue('IMCustom.im_select_field', 'otherval')
+      ->addChain('created_im', \Civi\Api4\IM::get()
+        ->addSelect('custom.*')
+        ->addWhere('id', '=', '$id')
+      )
+      ->execute()->single()['created_im'][0];
+
+    self::assertEquals('otherval', $result['IMCustom.im_select_field']);
+    self::assertEquals($customBoolFieldDefault, $result['IMCustom.im_boolean_field']);
+    // Apparently 'default_callback' is not supported for custom fields?
+    // self::assertEquals(\CRM_Utils_System::version(), $result['IMCustom.im_callback_field']);
+  }
+
 }