Merge pull request #22649 from colemanw/api4CustomDateFormat

APIv4 - Correctly return date-only custom field values without the time
civicrm · Jan 28, 2022 · 640b9d8 · 640b9d8
2 parents fa0a6b7 + 4c5b993
commit 640b9d8
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 0 deletions.
diff --git a/Civi/Api4/Utils/FormattingUtil.php b/Civi/Api4/Utils/FormattingUtil.php
@@ -338,6 +338,10 @@ public static function convertDataType($value, $dataType) {
         case 'Money':
         case 'Float':
           return (float) $value;
+
+        case 'Date':
+          // Strip time from date-only fields
+          return substr($value, 0, 10);
       }
     }
     return $value;

diff --git a/tests/phpunit/api/v4/Action/BasicCustomFieldTest.php b/tests/phpunit/api/v4/Action/BasicCustomFieldTest.php
@@ -457,4 +457,45 @@ public function testUpdateWeights() {
     $this->assertEquals(['One' => 1, 'Two' => 2, 'Three' => 3, 'Four' => 4], $getValues('controlGroup'));
   }
 
+  /**
+   * Ensure custom date fields only return the date part
+   */
+  public function testCustomDateFields(): void {
+    $cgName = uniqid('My');
+
+    CustomGroup::create(FALSE)
+      ->addValue('title', $cgName)
+      ->addValue('extends', 'Contact')
+      ->addChain('field1', CustomField::create()
+        ->addValue('label', 'DateOnly')
+        ->addValue('custom_group_id', '$id')
+        ->addValue('html_type', 'Select Date')
+        ->addValue('data_type', 'Date')
+        ->addValue('date_format', 'mm/dd/yy'))
+      ->addChain('field2', CustomField::create()
+        ->addValue('label', 'DateTime')
+        ->addValue('custom_group_id', '$id')
+        ->addValue('html_type', 'Select Date')
+        ->addValue('data_type', 'Date')
+        ->addValue('date_format', 'mm/dd/yy')
+        ->addValue('time_format', '1'))
+      ->execute();
+
+    $cid = Contact::create(FALSE)
+      ->addValue('first_name', 'Parent')
+      ->addValue('last_name', 'Tester')
+      ->addValue("$cgName.DateOnly", '2025-05-10')
+      ->addValue("$cgName.DateTime", '2025-06-11 12:15:30')
+      ->execute()
+      ->first()['id'];
+    $contact = Contact::get(FALSE)
+      ->addSelect('custom.*')
+      ->addWhere('id', '=', $cid)
+      ->execute()->first();
+    // Date field should only return date part
+    $this->assertEquals('2025-05-10', $contact["$cgName.DateOnly"]);
+    // Date time field should return all
+    $this->assertEquals('2025-06-11 12:15:30', $contact["$cgName.DateTime"]);
+  }
+
 }