Merge pull request #11433 from octo-happiness/CRM-20866

CRM-20866: Soft credit appearance inconsistent in contribution search
civicrm · Dec 27, 2017 · ae2ea5a · ae2ea5a
2 parents 379acc7 + b4bb60f
commit ae2ea5a
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 3 deletions.
diff --git a/CRM/Contribute/BAO/Query.php b/CRM/Contribute/BAO/Query.php
@@ -730,8 +730,11 @@ public static function softCreditReturnProperties($isExportMode = FALSE) {
    *
    * The default return properties array returns far too many fields for 'everyday use. Every field you add to this array
    * kills a small kitten so add carefully.
+   *
+   * @param array $queryParams
+   * @return array
    */
-  public static function selectorReturnProperties() {
+  public static function selectorReturnProperties($queryParams) {
     $properties = array(
       'contact_type' => 1,
       'contact_sub_type' => 1,
@@ -758,7 +761,7 @@ public static function selectorReturnProperties() {
       'cancel_date' => 1,
       'contribution_recur_id' => 1,
     );
-    if (self::isSoftCreditOptionEnabled()) {
+    if (self::isSoftCreditOptionEnabled($queryParams)) {
       $properties = array_merge($properties, self::softCreditReturnProperties());
     }
 

diff --git a/CRM/Contribute/Selector/Search.php b/CRM/Contribute/Selector/Search.php
@@ -179,7 +179,7 @@ public function __construct(
 
     // type of selector
     $this->_action = $action;
-    $returnProperties = CRM_Contribute_BAO_Query::selectorReturnProperties();
+    $returnProperties = CRM_Contribute_BAO_Query::selectorReturnProperties($this->_queryParams);
     $this->_includeSoftCredits = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($this->_queryParams);
     $this->_query = new CRM_Contact_BAO_Query(
       $this->_queryParams,

diff --git a/tests/phpunit/CRM/Contribute/Selector/SearchTest.php b/tests/phpunit/CRM/Contribute/Selector/SearchTest.php
@@ -0,0 +1,57 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.7                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2017                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *  Class CRM_Contribute_Selector_SearchTest
+ *
+ * @package CiviCRM
+ */
+class CRM_Contribute_Selector_SearchTest extends CiviUnitTestCase {
+
+  /**
+   * CRM-20866 - Soft credit appearance inconsistent in contribution search
+   */
+  public function testSoftCreditFieldsSelected() {
+    $queryParams = array(array('contribution_or_softcredits', '=', 'both_related', 0, 0));
+    $searchSelector = new CRM_Contribute_Selector_Search($queryParams, CRM_Core_Action::VIEW);
+
+    list($select, $from, $where, $having) = $searchSelector->getQuery()->query();
+    self::assertContains('civicrm_contribution_soft.amount', $select);
+  }
+
+  /**
+   * CRM-20866 - Soft credit appearance inconsistent in contribution search
+   */
+  public function testSoftCreditFieldNotSelected() {
+    $queryParams = array(array('contribution_or_softcredits', '=', 'only_contribs', 0, 0));
+    $searchSelector = new CRM_Contribute_Selector_Search($queryParams, CRM_Core_Action::VIEW);
+
+    list($select, $from, $where, $having) = $searchSelector->getQuery()->query();
+    self::assertNotContains('civicrm_contribution_soft.amount', $select);
+  }
+
+}