From 734a3b97e1b547a7d793f7e1b5a7ac8cf49529f5 Mon Sep 17 00:00:00 2001
From: colemanw <coleman@civicrm.org>
Date: Fri, 6 Dec 2024 14:22:26 -0500
Subject: [PATCH] Add ImportTemplateField entity

---
 CRM/Core/DAO/ImportTemplateField.php          | 12 ++++
 CRM/Utils/API/HTMLInputCoder.php              |  2 +
 Civi/Api4/ImportTemplateField.php             | 25 +++++++
 .../Core/ImportTemplateField.entityType.php   | 71 +++++++++++++++++++
 4 files changed, 110 insertions(+)
 create mode 100644 CRM/Core/DAO/ImportTemplateField.php
 create mode 100644 Civi/Api4/ImportTemplateField.php
 create mode 100644 schema/Core/ImportTemplateField.entityType.php

diff --git a/CRM/Core/DAO/ImportTemplateField.php b/CRM/Core/DAO/ImportTemplateField.php
new file mode 100644
index 000000000000..26e12c620884
--- /dev/null
+++ b/CRM/Core/DAO/ImportTemplateField.php
@@ -0,0 +1,12 @@
+<?php
+
+/**
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+/**
+ * Placeholder class retained for legacy compatibility.
+ */
+class CRM_Core_DAO_ImportTemplateField extends CRM_Core_DAO_Base {
+}
diff --git a/CRM/Utils/API/HTMLInputCoder.php b/CRM/Utils/API/HTMLInputCoder.php
index 7961fedd8f46..c85fc5f7988f 100644
--- a/CRM/Utils/API/HTMLInputCoder.php
+++ b/CRM/Utils/API/HTMLInputCoder.php
@@ -129,6 +129,8 @@ public function getSkipFields() {
         'items',
         // Survey entity
         'instructions',
+        // ImportTemplateField entity_data
+        'entity_data',
       ];
       $custom = CRM_Core_DAO::executeQuery('
         SELECT cf.id, cf.name AS field_name, cg.name AS group_name
diff --git a/Civi/Api4/ImportTemplateField.php b/Civi/Api4/ImportTemplateField.php
new file mode 100644
index 000000000000..8d61a4bc906d
--- /dev/null
+++ b/Civi/Api4/ImportTemplateField.php
@@ -0,0 +1,25 @@
+<?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;
+
+/**
+ * ImportTemplateField entity - stores field mappings for import templates.
+ *
+ * @see \Civi\Api4\UFGroup
+ * @orderBy column_number
+ * @groupWeightsBy user_job_id
+ * @since 5.82
+ * @package Civi\Api4
+ */
+class ImportTemplateField extends Generic\DAOEntity {
+  use Generic\Traits\SortableEntity;
+
+}
diff --git a/schema/Core/ImportTemplateField.entityType.php b/schema/Core/ImportTemplateField.entityType.php
new file mode 100644
index 000000000000..aeb43cb7f57c
--- /dev/null
+++ b/schema/Core/ImportTemplateField.entityType.php
@@ -0,0 +1,71 @@
+<?php
+
+return [
+  'name' => 'ImportTemplateField',
+  'table' => 'civicrm_import_template_field',
+  'class' => 'CRM_Core_DAO_ImportTemplateField',
+  'getInfo' => fn() => [
+    'title' => ts('Import Template Field'),
+    'title_plural' => ts('Import Template Fields'),
+    'description' => ts('Individual field for an import template'),
+    'add' => '5.82',
+  ],
+  'getFields' => fn() => [
+    'id' => [
+      'title' => ts('Field ID'),
+      'sql_type' => 'int unsigned',
+      'input_type' => 'Number',
+      'required' => TRUE,
+      'add' => '5.82',
+      'primary_key' => TRUE,
+      'auto_increment' => TRUE,
+    ],
+    'user_job_id' => [
+      'title' => ts('Job ID'),
+      'sql_type' => 'int unsigned',
+      'input_type' => 'EntityRef',
+      'required' => TRUE,
+      'description' => ts('Template to which this field belongs'),
+      'add' => '5.82',
+      'input_attrs' => [
+        'label' => ts('Template'),
+      ],
+      'entity_reference' => [
+        'entity' => 'UserJob',
+        'key' => 'id',
+        'on_delete' => 'CASCADE',
+      ],
+    ],
+    'name' => [
+      'title' => ts('Field Name'),
+      'sql_type' => 'varchar(1024)',
+      'input_type' => 'Text',
+      'description' => ts('Template field key'),
+      'add' => '5.82',
+    ],
+    'column_number' => [
+      'title' => ts('Column Number to map to'),
+      'sql_type' => 'int unsigned',
+      'input_type' => 'Number',
+      'required' => TRUE,
+      'description' => ts('Column number for the import dataset'),
+      'add' => '5.82',
+    ],
+    'default_value' => [
+      'title' => ts('Default Value'),
+      'sql_type' => 'varchar(1024)',
+      'input_type' => 'Text',
+      'description' => ts('SQL WHERE value for search-builder mapping fields.'),
+      'add' => '5.82',
+    ],
+    'entity_data' => [
+      'title' => ts('Entity Data'),
+      'sql_type' => 'text',
+      'input_type' => 'TextArea',
+      'description' => ts('Configuration data for the field'),
+      'add' => '5.82',
+      'default' => NULL,
+      'serialize' => CRM_Core_DAO::SERIALIZE_JSON,
+    ],
+  ],
+];