From 58c889cba230ab4398e12d2905205e03162d97b2 Mon Sep 17 00:00:00 2001
From: Erawat Chamanont <erawat@gmail.com>
Date: Fri, 22 Sep 2023 13:07:54 +0100
Subject: [PATCH] BTHAB-186: Update case opportunity details

Update case opportunity statuses, and total amounts when:
* Create or update sales order contribution
* Create or update sales order
* Create a payment
---
 .../AbstractBaseSalesOrderCalculator.php      | 21 ++++++++++++++++++-
 .../CaseSalesOrderContributionCalculator.php  |  2 +-
 .../CaseSalesOrderOpportunityCalculator.php   | 16 +++++++-------
 3 files changed, 29 insertions(+), 10 deletions(-)

diff --git a/CRM/Civicase/Service/AbstractBaseSalesOrderCalculator.php b/CRM/Civicase/Service/AbstractBaseSalesOrderCalculator.php
index b1de9106c..1e9b74b2c 100644
--- a/CRM/Civicase/Service/AbstractBaseSalesOrderCalculator.php
+++ b/CRM/Civicase/Service/AbstractBaseSalesOrderCalculator.php
@@ -1,9 +1,11 @@
 <?php
 
+use Civi\Api4\OptionValue;
+
 /**
  * An Abstract class for SalesOrder and Opportunity statuses and amounts.
  */
-class AbstractBaseSalesOrderCalculator {
+abstract class CRM_Civicase_Service_AbstractBaseSalesOrderCalculator {
 
   const
     INVOICING_STATUS_NO_INVOICES = 'no_invoices',
@@ -72,4 +74,21 @@ protected function getValueFromOptionValues($needle, $options) {
     return $options[$key]['value'];
   }
 
+  /**
+   * Gets status (option values' label) from the given options.
+   *
+   * @param string $needle
+   *   Search value.
+   * @param array $options
+   *   Option value.
+   *
+   * @return string
+   *   Option values' value.
+   */
+  protected function getLabelFromOptionValues($needle, $options) {
+    $key = array_search($needle, array_column($options, 'name'));
+
+    return $options[$key]['label'];
+  }
+
 }
diff --git a/CRM/Civicase/Service/CaseSalesOrderContributionCalculator.php b/CRM/Civicase/Service/CaseSalesOrderContributionCalculator.php
index b236f5f29..2e44c8470 100644
--- a/CRM/Civicase/Service/CaseSalesOrderContributionCalculator.php
+++ b/CRM/Civicase/Service/CaseSalesOrderContributionCalculator.php
@@ -9,7 +9,7 @@
  * This class provides calculations for payment and invoices that
  * attached to the sale order.
  */
-class CRM_Civicase_Service_CaseSalesOrderContributionCalculator extends AbstractBaseSalesOrderCalculator {
+class CRM_Civicase_Service_CaseSalesOrderContributionCalculator extends CRM_Civicase_Service_AbstractBaseSalesOrderCalculator {
 
   /**
    * Case Sales Order object.
diff --git a/CRM/Civicase/Service/CaseSalesOrderOpportunityCalculator.php b/CRM/Civicase/Service/CaseSalesOrderOpportunityCalculator.php
index 21c323d72..b73923908 100644
--- a/CRM/Civicase/Service/CaseSalesOrderOpportunityCalculator.php
+++ b/CRM/Civicase/Service/CaseSalesOrderOpportunityCalculator.php
@@ -6,7 +6,7 @@
 /**
  * A service class for calculate opportunity financial amounts and statuses.
  */
-class CRM_Civicase_Service_CaseSalesOrderOpportunityCalculator extends AbstractBaseSalesOrderCalculator {
+class CRM_Civicase_Service_CaseSalesOrderOpportunityCalculator extends CRM_Civicase_Service_AbstractBaseSalesOrderCalculator {
   /**
    * Case's total quoted amount.
    *
@@ -83,14 +83,14 @@ public function calculateTotalQuotedAmount(): float {
    */
   public function calculateInvoicingStatus() {
     if (!($this->totalInvoicedAmount > 0)) {
-      return $this->getValueFromOptionValues(parent::INVOICING_STATUS_NO_INVOICES, $this->invoicingStatusOptionValues);
+      return $this->getLabelFromOptionValues(parent::INVOICING_STATUS_NO_INVOICES, $this->invoicingStatusOptionValues);
     }
 
     if ($this->totalInvoicedAmount < $this->totalQuotedAmount) {
-      return $this->getValueFromOptionValues(parent::INVOICING_STATUS_PARTIALLY_INVOICED, $this->invoicingStatusOptionValues);
+      return $this->getLabelFromOptionValues(parent::INVOICING_STATUS_PARTIALLY_INVOICED, $this->invoicingStatusOptionValues);
     }
 
-    return $this->getValueFromOptionValues(parent::INVOICING_STATUS_FULLY_INVOICED, $this->invoicingStatusOptionValues);
+    return $this->getLabelFromOptionValues(parent::INVOICING_STATUS_FULLY_INVOICED, $this->invoicingStatusOptionValues);
   }
 
   /**
@@ -101,19 +101,19 @@ public function calculateInvoicingStatus() {
    */
   public function calculatePaymentStatus() {
     if (!($this->totalPaidAmount > 0)) {
-      return $this->getValueFromOptionValues(parent::PAYMENT_STATUS_NO_PAYMENTS, $this->paymentStatusOptionValues);
+      return $this->getLabelFromOptionValues(parent::PAYMENT_STATUS_NO_PAYMENTS, $this->paymentStatusOptionValues);
     }
 
     if ($this->totalPaidAmount < $this->totalInvoicedAmount) {
-      return $this->getValueFromOptionValues(parent::PAYMENT_STATUS_PARTIALLY_PAID, $this->paymentStatusOptionValues);
+      return $this->getLabelFromOptionValues(parent::PAYMENT_STATUS_PARTIALLY_PAID, $this->paymentStatusOptionValues);
     }
 
     if ($this->totalPaidAmount > $this->totalInvoicedAmount) {
-      return $this->getValueFromOptionValues(parent::PAYMENT_STATUS_OVERPAID, $this->paymentStatusOptionValues);
+      return $this->getLabelFromOptionValues(parent::PAYMENT_STATUS_OVERPAID, $this->paymentStatusOptionValues);
 
     }
 
-    return $this->getValueFromOptionValues(parent::PAYMENT_STATUS_FULLY_PAID, $this->paymentStatusOptionValues);
+    return $this->getLabelFromOptionValues(parent::PAYMENT_STATUS_FULLY_PAID, $this->paymentStatusOptionValues);
   }
 
   /**