From: Eileen McNaughton <emcnaughton@wikimedia.org>
Date: Mon, 4 Dec 2023 23:29:40 +0000 (+1300)
Subject: Add a warning about price fields where non_deductible amount potentially misconfigured
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=ac8d50facd2a10e3fe7ac5ce7dae116c1e689714;p=civicrm-core.git

Add a warning about price fields where non_deductible amount potentially misconfigured
---

diff --git a/CRM/Utils/Check/Component/PriceFields.php b/CRM/Utils/Check/Component/PriceFields.php
index 4c05ea74d7..3a3e8da93f 100644
--- a/CRM/Utils/Check/Component/PriceFields.php
+++ b/CRM/Utils/Check/Component/PriceFields.php
@@ -10,6 +10,8 @@
  +--------------------------------------------------------------------+
  */
 
+use Psr\Log\LogLevel;
+
 /**
  *
  * @package CRM
@@ -18,10 +20,11 @@
 class CRM_Utils_Check_Component_PriceFields extends CRM_Utils_Check_Component {
 
   /**
-   * Display warning about invalid priceFields
+   * Display warning about invalid priceFields.
+   *
    * @return CRM_Utils_Check_Message[]
    */
-  public function checkPriceFields() {
+  public function checkPriceFields(): array {
     $sql = "SELECT DISTINCT ps.title as ps_title, ps.id as ps_id, psf.label as psf_label
       FROM civicrm_price_set ps
       INNER JOIN civicrm_price_field psf ON psf.price_set_id = ps.id
@@ -62,11 +65,64 @@ class CRM_Utils_Check_Component_PriceFields extends CRM_Utils_Check_Component {
         __FUNCTION__,
        $msg,
        ts('Invalid Price Fields'),
-       \Psr\Log\LogLevel::WARNING,
+       LogLevel::WARNING,
        'fa-lock'
       );
     }
     return $messages;
   }
 
+  /**
+   * Display warning about invalid priceFields.
+   *
+   * @return CRM_Utils_Check_Message[]
+   */
+  public function checkPriceFieldDeductibility(): array {
+    $sql = "SELECT DISTINCT ps.title as ps_title, ps.id as ps_id, psf.label as psf_label
+      FROM civicrm_price_set ps
+      INNER JOIN civicrm_price_field psf ON psf.price_set_id = ps.id
+      INNER JOIN civicrm_price_field_value pfv ON pfv.price_field_id = psf.id
+      LEFT JOIN civicrm_financial_type cft ON cft.id = pfv.financial_type_id
+      INNER JOIN civicrm_price_set_entity pse ON entity_table = 'civicrm_contribution_page' AND ps.id = pse.price_set_id
+      INNER JOIN civicrm_contribution_page cp ON cp.id = pse.entity_id AND cp.is_active = 1
+      WHERE pfv.non_deductible_amount > 0 AND cft.is_deductible = 0
+      UNION
+      SELECT DISTINCT ps.title as ps_title, ps.id as ps_id, psf.label as psf_label
+      FROM civicrm_price_set ps
+      INNER JOIN civicrm_price_field psf ON psf.price_set_id = ps.id
+      INNER JOIN civicrm_price_field_value pfv ON pfv.price_field_id = psf.id
+      LEFT JOIN civicrm_financial_type cft ON cft.id = pfv.financial_type_id
+      INNER JOIN civicrm_price_set_entity pse ON entity_table = 'civicrm_event' AND ps.id = pse.price_set_id
+      INNER JOIN civicrm_event ce ON ce.id = pse.entity_id AND ce.is_active = 1
+      WHERE pfv.non_deductible_amount > 0 AND cft.is_deductible = 0";
+    $dao = CRM_Core_DAO::executeQuery($sql);
+    $count = 0;
+    $html = '';
+    $messages = [];
+    while ($dao->fetch()) {
+      $count++;
+      $url = CRM_Utils_System::url('civicrm/admin/price/field', [
+        'reset' => 1,
+        'action' => 'browse',
+        'sid' => $dao->ps_id,
+      ]);
+      $html .= "<tr><td>$dao->ps_title</td><td>$dao->psf_label</td><td><a href='$url'>" . ts('View Price Set Fields') . '</a></td></tr>';
+    }
+    if ($count > 0) {
+      $msg = '<p>' . ts('The following Price Set Fields have options with non_deductible amounts but financial types that are not configured to be deductible.') . '<p>'
+        . '<p><table><thead><tr><th>' . ts('Price Set') . '</th><th>' . ts('Price Set Field') . '</th><th>' . ts('Action') . '</th>'
+        . '</tr></thead><tbody>'
+        . $html
+        . '</tbody></table></p>';
+      $messages[] = new CRM_Utils_Check_Message(
+        __FUNCTION__,
+        $msg,
+        ts('Invalid Price Fields'),
+        LogLevel::WARNING,
+        'fa-lock'
+      );
+    }
+    return $messages;
+  }
+
 }