From 97e8d0678299e5f1b67844ce2b7168cdd4cfb4b2 Mon Sep 17 00:00:00 2001
From: Erawat Chamanont <erawat@gmail.com>
Date: Fri, 25 Aug 2023 09:28:06 +0100
Subject: [PATCH] BTHAB-178: Allow creating custom field for membership type

---
 .../MembershipTypeCustomFieldManager.php      | 34 +++++++++++++++++++
 CRM/Civicase/Upgrader.php                     | 26 +++++++-------
 CRM/Civicase/Upgrader/Steps/Step0020.php      | 30 ++++++++++++++++
 3 files changed, 78 insertions(+), 12 deletions(-)
 create mode 100644 CRM/Civicase/Setup/Manage/MembershipTypeCustomFieldManager.php
 create mode 100644 CRM/Civicase/Upgrader/Steps/Step0020.php

diff --git a/CRM/Civicase/Setup/Manage/MembershipTypeCustomFieldManager.php b/CRM/Civicase/Setup/Manage/MembershipTypeCustomFieldManager.php
new file mode 100644
index 000000000..710425708
--- /dev/null
+++ b/CRM/Civicase/Setup/Manage/MembershipTypeCustomFieldManager.php
@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * Manages Membership Type Custom Field Entity.
+ */
+class CRM_Civicase_Setup_Manage_MembershipTypeCustomFieldManager extends CRM_Civicase_Setup_Manage_AbstractManager {
+
+  const OPTION_GROUP_NAME = 'cg_extend_objects';
+
+  /**
+   * Adds Membership Type entity to extend object.
+   */
+  public function create(): void {
+    CRM_Core_BAO_OptionValue::ensureOptionValueExists([
+      'option_group_id' => self::OPTION_GROUP_NAME,
+      "label" => "Membership Type",
+      "value" => "MembershipType",
+      "name" => "civicrm_membership_type",
+      'is_active' => TRUE,
+      'is_reserved' => TRUE,
+    ]);
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function remove(): void {}
+
+  /**
+   * {@inheritDoc}
+   */
+  protected function toggle($status): void {}
+
+}
diff --git a/CRM/Civicase/Upgrader.php b/CRM/Civicase/Upgrader.php
index f188ebf40..d3de92044 100644
--- a/CRM/Civicase/Upgrader.php
+++ b/CRM/Civicase/Upgrader.php
@@ -1,23 +1,24 @@
 <?php
 
-use CRM_Civicase_Setup_CaseTypeCategorySupport as CaseTypeCategorySupport;
-use CRM_Civicase_Setup_CreateCasesOptionValue as CreateCasesOptionValue;
+use CRM_Civicase_ExtensionUtil as E;
+use CRM_Civicase_Helper_CaseUrl as CaseUrlHelper;
+use CRM_Civicase_Service_CaseCategoryInstance as CaseCategoryInstance;
 use CRM_Civicase_Setup_AddCaseCategoryWordReplacementOptionGroup as AddCaseCategoryWordReplacementOptionGroup;
-use CRM_Civicase_Setup_MoveCaseTypesToCasesCategory as MoveCaseTypesToCasesCategory;
-use CRM_Civicase_Setup_CreateSafeFileExtensionOptionValue as CreateSafeFileExtensionOptionValue;
-use CRM_Civicase_Uninstall_RemoveCustomGroupSupportForCaseCategory as RemoveCustomGroupSupportForCaseCategory;
-use CRM_Civicase_Setup_ProcessCaseCategoryForCustomGroupSupport as ProcessCaseCategoryForCustomGroupSupport;
-use CRM_Civicase_Setup_CaseCategoryInstanceSupport as CaseCategoryInstanceSupport;
 use CRM_Civicase_Setup_AddChangeCaseRoleDateActivityTypes as AddChangeCaseRoleDateActivityTypes;
 use CRM_Civicase_Setup_AddManageWorkflowMenu as AddManageWorkflowMenu;
-use CRM_Civicase_Service_CaseCategoryInstance as CaseCategoryInstance;
-use CRM_Civicase_Helper_CaseUrl as CaseUrlHelper;
-use CRM_Civicase_Setup_AddSingularLabels as AddSingularLabels;
-use CRM_Civicase_ExtensionUtil as E;
 use CRM_Civicase_Setup_AddMyActivitiesMenu as AddMyActivitiesMenu;
-use CRM_Civicase_Setup_Manage_CaseTypeCategoryFeaturesManager as CaseTypeCategoryFeaturesManager;
+use CRM_Civicase_Setup_AddSingularLabels as AddSingularLabels;
+use CRM_Civicase_Setup_CaseCategoryInstanceSupport as CaseCategoryInstanceSupport;
+use CRM_Civicase_Setup_CaseTypeCategorySupport as CaseTypeCategorySupport;
+use CRM_Civicase_Setup_CreateCasesOptionValue as CreateCasesOptionValue;
+use CRM_Civicase_Setup_CreateSafeFileExtensionOptionValue as CreateSafeFileExtensionOptionValue;
 use CRM_Civicase_Setup_Manage_CaseSalesOrderStatusManager as CaseSalesOrderStatusManager;
+use CRM_Civicase_Setup_Manage_CaseTypeCategoryFeaturesManager as CaseTypeCategoryFeaturesManager;
+use CRM_Civicase_Setup_Manage_MembershipTypeCustomFieldManager as MembershipTypeCustomFieldManager;
 use CRM_Civicase_Setup_Manage_QuotationTemplateManager as QuotationTemplateManager;
+use CRM_Civicase_Setup_MoveCaseTypesToCasesCategory as MoveCaseTypesToCasesCategory;
+use CRM_Civicase_Setup_ProcessCaseCategoryForCustomGroupSupport as ProcessCaseCategoryForCustomGroupSupport;
+use CRM_Civicase_Uninstall_RemoveCustomGroupSupportForCaseCategory as RemoveCustomGroupSupportForCaseCategory;
 
 /**
  * Collection of upgrade steps.
@@ -154,6 +155,7 @@ public function install() {
     (new CaseTypeCategoryFeaturesManager())->create();
     (new CaseSalesOrderStatusManager())->create();
     (new QuotationTemplateManager())->create();
+    (new MembershipTypeCustomFieldManager())->create();
   }
 
   /**
diff --git a/CRM/Civicase/Upgrader/Steps/Step0020.php b/CRM/Civicase/Upgrader/Steps/Step0020.php
new file mode 100644
index 000000000..1011d2db4
--- /dev/null
+++ b/CRM/Civicase/Upgrader/Steps/Step0020.php
@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * Add custom fields.
+ */
+class CRM_Civicase_Upgrader_Steps_Step0020 {
+
+  /**
+   * Runs the upgrader changes.
+   *
+   * @return bool
+   *   Return value in boolean.
+   */
+  public function apply() {
+    try {
+      (new CRM_Civicase_Setup_Manage_MembershipTypeCustomFieldManager())->create();
+    }
+    catch (\Throwable $th) {
+      \Civi::log()->error('Error upgrading Civicase', [
+        'context' => [
+          'backtrace' => $th->getTraceAsString(),
+          'message' => $th->getMessage(),
+        ],
+      ]);
+    }
+
+    return TRUE;
+  }
+
+}