CRM/Contribute/Form/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2018
  32  */
  33
  34 /**
  35  * Class for contribute form task actions.
  36  * FIXME: This needs refactoring to properly inherit from CRM_Core_Form_Task and share more functions.
  37  */
  38 class CRM_Contribute_Form_Task extends CRM_Core_Form_Task {
  39
  40   /**
  41    * The array that holds all the contribution ids.
  42    *
  43    * @var array
  44    */
  45   protected $_contributionIds;
  46
  47   /**
  48    * The array that holds all the mapping contribution and contact ids.
  49    *
  50    * @var array
  51    */
  52   protected $_contributionContactIds = array();
  53
  54   /**
  55    * The flag to tell if there are soft credits included.
  56    *
  57    * @var boolean
  58    */
  59   public $_includesSoftCredits = FALSE;
  60
  61   /**
  62    * Build all the data structures needed to build the form.
  63    */
  64   public function preProcess() {
  65     self::preProcessCommon($this);
  66   }
  67
  68   /**
  69    * @param CRM_Core_Form $form
  70    * @param bool $useTable
  71    */
  72   public static function preProcessCommon(&$form, $useTable = FALSE) {
  73     $form->_contributionIds = array();
  74
  75     $values = $form->controller->exportValues($form->get('searchFormName'));
  76
  77     $form->_task = CRM_Utils_Array::value('task', $values);
  78     $contributeTasks = CRM_Contribute_Task::tasks();
  79     $form->assign('taskName', CRM_Utils_Array::value($form->_task, $contributeTasks));
  80
  81     $ids = array();
  82     if (isset($values['radio_ts']) && $values['radio_ts'] == 'ts_sel') {
  83       foreach ($values as $name => $value) {
  84         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
  85           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
  86         }
  87       }
  88     }
  89     else {
  90       $queryParams = $form->get('queryParams');
  91       $isTest = FALSE;
  92       if (is_array($queryParams)) {
  93         foreach ($queryParams as $fields) {
  94           if ($fields[0] == 'contribution_test') {
  95             $isTest = TRUE;
  96             break;
  97           }
  98         }
  99       }
 100       if (!$isTest) {
 101         $queryParams[] = array(
 102           'contribution_test',
 103           '=',
 104           0,
 105           0,
 106           0,
 107         );
 108       }
 109       $returnProperties = array('contribution_id' => 1);
 110       $sortOrder = $sortCol = NULL;
 111       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
 112         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
 113         //Include sort column in select clause.
 114         $sortCol = trim(str_replace(array('`', 'asc', 'desc'), '', $sortOrder));
 115         $returnProperties[$sortCol] = 1;
 116       }
 117
 118       $form->_includesSoftCredits = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($queryParams);
 119       $query = new CRM_Contact_BAO_Query($queryParams, $returnProperties, NULL, FALSE, FALSE,
 120         CRM_Contact_BAO_Query::MODE_CONTRIBUTE
 121       );
 122       // @todo the function CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled should handle this
 123       // can we remove? if not why not?
 124       if ($form->_includesSoftCredits) {
 125         $contactIds = $contributionContactIds = array();
 126         $query->_rowCountClause = " count(civicrm_contribution.id)";
 127         $query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
 128       }
 129       else {
 130         $query->_distinctComponentClause = ' civicrm_contribution.id';
 131         $query->_groupByComponentClause = ' GROUP BY civicrm_contribution.id ';
 132       }
 133       $result = $query->searchQuery(0, 0, $sortOrder);
 134       while ($result->fetch()) {
 135         $ids[] = $result->contribution_id;
 136         if ($form->_includesSoftCredits) {
 137           $contactIds[$result->contact_id] = $result->contact_id;
 138           $contributionContactIds["{$result->contact_id}-{$result->contribution_id}"] = $result->contribution_id;
 139         }
 140       }
 141       $result->free();
 142       $form->assign('totalSelectedContributions', $form->get('rowCount'));
 143     }
 144
 145     if (!empty($ids)) {
 146       $form->_componentClause = ' civicrm_contribution.id IN ( ' . implode(',', $ids) . ' ) ';
 147
 148       $form->assign('totalSelectedContributions', count($ids));
 149     }
 150     if (!empty($form->_includesSoftCredits) && !empty($contactIds)) {
 151       $form->_contactIds = $contactIds;
 152       $form->_contributionContactIds = $contributionContactIds;
 153     }
 154
 155     $form->_contributionIds = $form->_componentIds = $ids;
 156     $form->set('contributionIds', $form->_contributionIds);
 157
 158     //set the context for redirection for any task actions
 159     $session = CRM_Core_Session::singleton();
 160
 161     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
 162     $urlParams = 'force=1';
 163     if (CRM_Utils_Rule::qfKey($qfKey)) {
 164       $urlParams .= "&qfKey=$qfKey";
 165     }
 166
 167     $searchFormName = strtolower($form->get('searchFormName'));
 168     if ($searchFormName == 'search') {
 169       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contribute/search', $urlParams));
 170     }
 171     else {
 172       $session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/$searchFormName",
 173         $urlParams
 174       ));
 175     }
 176   }
 177
 178   /**
 179    * Sets contribution Ids for unit test.
 180    *
 181    * @param array $contributionIds
 182    */
 183   public function setContributionIds($contributionIds) {
 184     $this->_contributionIds = $contributionIds;
 185   }
 186
 187   /**
 188    * Given the contribution id, compute the contact id
 189    * since its used for things like send email
 190    */
 191   public function setContactIDs() {
 192     if (!$this->_includesSoftCredits) {
 193       $this->_contactIds = CRM_Core_DAO::getContactIDsFromComponent(
 194         $this->_contributionIds,
 195         'civicrm_contribution'
 196       );
 197     }
 198   }
 199
 200   /**
 201    * Simple shell that derived classes can call to add buttons to
 202    * the form with a customized title for the main Submit
 203    *
 204    * @param string $title
 205    *   Title of the main button.
 206    * @param string $nextType
 207    *   Button type for the form after processing.
 208    * @param string $backType
 209    * @param bool $submitOnce
 210    */
 211   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 212     $this->addButtons(array(
 213         array(
 214           'type' => $nextType,
 215           'name' => $title,
 216           'isDefault' => TRUE,
 217         ),
 218         array(
 219           'type' => $backType,
 220           'name' => ts('Cancel'),
 221         ),
 222       )
 223     );
 224   }
 225
 226 }