Add financial_type_id field to SepaTransactionGroup entity

Project60 · Sep 13, 2024 · d4d95ed · d4d95ed
1 parent 4a875cf
commit d4d95ed
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 23 deletions.
diff --git a/CRM/Sepa/DAO/SEPATransactionGroup.php b/CRM/Sepa/DAO/SEPATransactionGroup.php
@@ -67,6 +67,16 @@ class CRM_Sepa_DAO_SEPATransactionGroup extends CRM_Core_DAO {
    */
   public $collection_date;
 
+  /**
+   * Financial type of contained contributions if CiviSEPA is generating groups
+   * matching financial types.
+   *
+   * @var int|string|null
+   *   (SQL type: int unsigned)
+   *   Note that values will be retrieved from the database as a string.
+   */
+  public $financial_type_id;
+
   /**
    * Latest submission date
    *
@@ -233,6 +243,25 @@ public static function &fields() {
           'localizable' => 0,
           'add' => NULL,
         ],
+        'financial_type_id' => [
+          'name' => 'financial_type_id',
+          'type' => CRM_Utils_Type::T_INT,
+          'title' => E::ts('Financial Type ID'),
+          'description' => E::ts('Financial type of contained contributions if CiviSEPA is generating groups matching financial types.'),
+          'required' => FALSE,
+          'usage' => [
+            'import' => FALSE,
+            'export' => FALSE,
+            'duplicate_matching' => FALSE,
+            'token' => FALSE,
+          ],
+          'where' => 'civicrm_sdd_txgroup.financial_type_id',
+          'table_name' => 'civicrm_sdd_txgroup',
+          'entity' => 'SEPATransactionGroup',
+          'bao' => 'CRM_Sepa_DAO_SEPATransactionGroup',
+          'localizable' => 0,
+          'add' => NULL,
+        ],
         'latest_submission_date' => [
           'name' => 'latest_submission_date',
           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,

diff --git a/CRM/Sepa/Upgrader.php b/CRM/Sepa/Upgrader.php
@@ -15,7 +15,7 @@
 +--------------------------------------------------------*/
 
 use CRM_Sepa_ExtensionUtil as E;
-  
+
 /**
  * Collection of upgrade steps.
  */
@@ -491,4 +491,24 @@ public function upgrade_1804() {
     $customData->syncOptionGroup(E::path('resources/formats_option_group.json'));
     return TRUE;
   }
+
+  public function upgrade_11301() {
+    $this->ctx->log->info('Adding financial_type_id column to civicrm_sdd_txgroup table.');
+    $column = CRM_Core_DAO::singleValueQuery(
+      <<<SQL
+      SHOW COLUMNS FROM `civicrm_sdd_txgroup` LIKE 'financial_type_id';
+      SQL
+    );
+    if (!$column) {
+      $this->executeSql(
+        <<<SQL
+        ALTER TABLE civicrm_sdd_txgroup
+          ADD COLUMN `financial_type_id`
+            int unsigned
+          COMMENT 'Financial type of contained contributions if CiviSEPA is generating groups matching financial types.';
+        SQL
+      );
+    }
+    return TRUE;
+  }
 }
diff --git a/sql/sepa.sql b/sql/sepa.sql
@@ -103,6 +103,7 @@ CREATE TABLE IF NOT EXISTS `civicrm_sdd_txgroup` (
      `reference`                varchar(64)             COMMENT 'End-to-end reference for this tx group.',
      `type`                     char(4)                 COMMENT 'FRST, RCUR, OOFF or RTRY',
      `collection_date`          datetime                COMMENT 'Target collection date',
+     `financial_type_id`        int unsigned            COMMENT 'Financial type of contained contributions if CiviSEPA is generating groups matching financial types.',
      `latest_submission_date`   datetime                COMMENT 'Latest submission date',
      `created_date`             datetime                COMMENT 'When was this item created',
      `status_id`                int unsigned NOT NULL   COMMENT 'fk to Batch Status options in civicrm_option_values',

diff --git a/xml/schema/CRM/Sepa/TransactionGroup.xml b/xml/schema/CRM/Sepa/TransactionGroup.xml
@@ -1,21 +1,21 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>  
+<?xml version="1.0" encoding="iso-8859-1" ?>
 <table>
-  <base>CRM/Sepa</base>  
-  <class>SEPATransactionGroup</class>  
-  <name>civicrm_sdd_txgroup</name>  
+  <base>CRM/Sepa</base>
+  <class>SEPATransactionGroup</class>
+  <name>civicrm_sdd_txgroup</name>
   <log>true</log>
 
-  <field>  
-    <name>id</name>  
-    <type>int unsigned</type>  
-    <required>true</required>  
-    <comment>ID</comment>  
+  <field>
+    <name>id</name>
+    <type>int unsigned</type>
+    <required>true</required>
+    <comment>ID</comment>
     <export>true</export>
-  </field>  
-  <primaryKey>  
-    <name>id</name>  
-    <autoincrement>true</autoincrement>  
-  </primaryKey>  
+  </field>
+  <primaryKey>
+    <name>id</name>
+    <autoincrement>true</autoincrement>
+  </primaryKey>
 
   <field>
     <name>reference</name>
@@ -41,6 +41,13 @@
     <type>datetime</type>
     <comment>Target collection date</comment>
   </field>
+
+  <field>
+    <name>financial_type_id</name>
+    <type>int unsigned</type>
+    <comment>Financial type of contained contributions if CiviSEPA is generating groups matching financial types.</comment>
+  </field>
+
   <field>
     <name>latest_submission_date</name>
     <type>datetime</type>
@@ -67,10 +74,10 @@
     <fieldName>sdd_creditor_id</fieldName>
     <add>4.3</add>
   </index>
-  <foreignKey> 
-    <name>sdd_creditor_id</name> 
-    <table>civicrm_sdd_creditor</table> 
-    <key>id</key> 
+  <foreignKey>
+    <name>sdd_creditor_id</name>
+    <table>civicrm_sdd_creditor</table>
+    <key>id</key>
       <onDelete>SET NULL</onDelete>
   </foreignKey>
 
@@ -83,10 +90,10 @@
     <name>file_id</name>
     <fieldName>sdd_file_id</fieldName>
   </index>
-  <foreignKey> 
-    <name>sdd_file_id</name> 
-    <table>civicrm_sdd_file</table> 
-    <key>id</key> 
+  <foreignKey>
+    <name>sdd_file_id</name>
+    <table>civicrm_sdd_file</table>
+    <key>id</key>
       <onDelete>SET NULL</onDelete>
   </foreignKey>